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.

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()

Changes take effect after you redeploy the module or restart the server.

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()

Changes take effect after you redeploy the module or restart the server.

getPersistentQos

String getPersistentQos()

Specifies the quality-of-service for persistent messages.

• Exactly-Once indicates that messages will be forwarded to the remote side once and only once

• At-Least-Once indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once.

• At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.

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

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXACTLY_ONCE

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_MOST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_LEAST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXACTLY_ONCE

setPersistentQos

void setPersistentQos(String persistentQos)
                      throws IllegalArgumentException

Sets the value of the PersistentQos attribute.

Throws:

IllegalArgumentException

See Also:

SAFDestinationBean.getPersistentQos()

Changes take effect after you redeploy the module or restart the server.

This method can NOT set a null value.

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXACTLY_ONCE

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_MOST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_LEAST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXACTLY_ONCE

getNonPersistentQos

String getNonPersistentQos()

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

• Exactly-Once indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes.

• At-Least-Once indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once.

• At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.

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

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_LEAST_ONCE

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_MOST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_LEAST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXACTLY_ONCE

setNonPersistentQos

void setNonPersistentQos(String NonPersistentQos)
                         throws IllegalArgumentException

Sets the value of the NonPersistentQos attribute.

Throws:

IllegalArgumentException

See Also:

SAFDestinationBean.getNonPersistentQos()

Changes take effect after you redeploy the module or restart the server.

This method can NOT set a null value.

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_LEAST_ONCE

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_MOST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.AT_LEAST_ONCE,weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXACTLY_ONCE

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.

Default Value:

null

setSAFErrorHandling

void setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling)
                         throws IllegalArgumentException

Sets the value of the SAFErrorHandling attribute.

Throws:

IllegalArgumentException

See Also:

SAFDestinationBean.getSAFErrorHandling()

Default Value:

null

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.

Changes take effect after you redeploy the module or restart the server.

setTimeToLiveDefault

void setTimeToLiveDefault(long timeToLiveDefault)
                          throws IllegalArgumentException

Sets the value of the TimeToLiveDefault attribute.

Throws:

IllegalArgumentException

See Also:

SAFDestinationBean.getTimeToLiveDefault()

Changes take effect after you redeploy the module or restart the server.

Minimum Value:

-1

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()

Changes take effect after you redeploy the module or restart the server.

getUnitOfOrderRouting

String getUnitOfOrderRouting()

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

• Hash indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent.

• PathService indicates that producers use the Path Service to find a SAF agent.

setUnitOfOrderRouting

void setUnitOfOrderRouting(String unitOfOrderRouting)
                           throws IllegalArgumentException

Sets the value of the UnitOfOrderRouting attribute.

Parameters:

unitOfOrderRouting -

Throws:

IllegalArgumentException

See Also:

SAFDestinationBean.getUnitOfOrderRouting()

This method can NOT set a null value.

Valid Values:

weblogic.j2ee.descriptor.wl.constants.PathServiceConstants.HASH_POLICY,weblogic.j2ee.descriptor.wl.constants.PathServiceConstants.PATH_SERVICE

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