Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.j2ee.descriptor.wl
Interface SAFDestinationBean

All Superinterfaces:
NamedEntityBean, SettableBean
All Known Subinterfaces:
SAFQueueBean, SAFTopicBean

public interface SAFDestinationBean
extends NamedEntityBean

Store-and-Forward (SAF) destinations are used for asynchronous and disconnected peer communications. A message delivered to a SAF queue or a SAF topic will be forwarded to a queue or a topic in a remote cluster or server. Aspects of a SAF queues and topics behavior can be configured with a SAF queue or topic bean.


Method Summary
abstract  String getLocalJNDIName()
          The local JNDI name of the remote destination.
abstract  MessageLoggingParamsBean getMessageLoggingParams()
          These parameters control how the SAF destination performs message logging.
abstract  String getNonPersistentQos()
          Specifies the quality-of-service for non-persistent messages.
abstract  String getPersistentQos()
          Specifies the quality-of-service for persistent messages.
abstract  String getRemoteJNDIName()
          The remote JNDI name of the remote destination.
abstract  SAFErrorHandlingBean getSAFErrorHandling()
          Specifies the error handling configuration used by this SAF destination.
abstract  long getTimeToLiveDefault()
          Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages.
abstract  String getUnitOfOrderRouting()
          Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.
abstract  boolean isUseSAFTimeToLiveDefault()
          Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.
abstract  void setLocalJNDIName(String localJndiName)
          Sets the value of the LocalJNDIName attribute.
abstract  void setNonPersistentQos(String NonPersistentQos)
          Sets the value of the NonPersistentQos attribute.
abstract  void setPersistentQos(String persistentQos)
          Sets the value of the PersistentQos attribute.
abstract  void setRemoteJNDIName(String remoteJndiName)
          Sets the value of the RemoteJNDIName attribute.
abstract  void setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling)
          Sets the value of the SAFErrorHandling attribute.
abstract  void setTimeToLiveDefault(long timeToLiveDefault)
          Sets the value of the TimeToLiveDefault attribute.
abstract  void setUnitOfOrderRouting(String unitOfOrderRouting)
          Sets the value of the UnitOfOrderRouting attribute.
abstract  void setUseSAFTimeToLiveDefault(boolean useSafTimeToLiveDefault)
          Sets the value of the UseSAFTimeToLiveDefault attribute.

 

Methods inherited from interface weblogic.j2ee.descriptor.wl.NamedEntityBean
getId, getName, getNotes, setName, setNotes

 

Method Detail

getRemoteJNDIName

String getRemoteJNDIName()

The remote JNDI name of the remote destination.


setRemoteJNDIName

void setRemoteJNDIName(String remoteJndiName)
                       throws IllegalArgumentException

Sets the value of the RemoteJNDIName attribute.

Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.getRemoteJNDIName()

getLocalJNDIName

String getLocalJNDIName()

The local JNDI name of the remote destination.


setLocalJNDIName

void setLocalJNDIName(String localJndiName)
                      throws IllegalArgumentException

Sets the value of the LocalJNDIName attribute.

Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.getLocalJNDIName()

getPersistentQos

String getPersistentQos()

Specifies the quality-of-service for persistent messages.

Any change to this parameter affects only incoming messages; stored messages are not affected.


setPersistentQos

void setPersistentQos(String persistentQos)
                      throws IllegalArgumentException

Sets the value of the PersistentQos attribute.

Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.getPersistentQos()

getNonPersistentQos

String getNonPersistentQos()

Specifies the quality-of-service for non-persistent messages.

Any change to this parameter affects only incoming messages; stored messages are not affected.


setNonPersistentQos

void setNonPersistentQos(String NonPersistentQos)
                         throws IllegalArgumentException

Sets the value of the NonPersistentQos attribute.

Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.getNonPersistentQos()

getSAFErrorHandling

SAFErrorHandlingBean getSAFErrorHandling()

Specifies the error handling configuration used by this SAF destination.

Any change to this parameter affects only incoming messages; stored messages are not affected.


setSAFErrorHandling

void setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling)
                         throws IllegalArgumentException

Sets the value of the SAFErrorHandling attribute.

Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.getSAFErrorHandling()

getTimeToLiveDefault

long getTimeToLiveDefault()

Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations.

Any change to this value affects only incoming messages; stored messages are not affected.


setTimeToLiveDefault

void setTimeToLiveDefault(long timeToLiveDefault)
                          throws IllegalArgumentException

Sets the value of the TimeToLiveDefault attribute.

Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.getTimeToLiveDefault()

isUseSAFTimeToLiveDefault

boolean isUseSAFTimeToLiveDefault()

Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.

Any change to this parameter affects only incoming messages; stored messages are not affected.


setUseSAFTimeToLiveDefault

void setUseSAFTimeToLiveDefault(boolean useSafTimeToLiveDefault)
                                throws IllegalArgumentException

Sets the value of the UseSAFTimeToLiveDefault attribute.

Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.isUseSAFTimeToLiveDefault()

getUnitOfOrderRouting

String getUnitOfOrderRouting()

Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.


setUnitOfOrderRouting

void setUnitOfOrderRouting(String unitOfOrderRouting)
                           throws IllegalArgumentException

Sets the value of the UnitOfOrderRouting attribute.

Parameters:
unitOfOrderRouting -
Throws:
IllegalArgumentException
See Also:
SAFDestinationBean.getUnitOfOrderRouting()

getMessageLoggingParams

MessageLoggingParamsBean getMessageLoggingParams()

These parameters control how the SAF destination performs message logging.

They allow the adminstrator to configure the SAF destination to change message logging when message life cycle changes are detected.

Returns:
The message logging parameters bean that describing the actions to take on message life cycle change

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09