Package weblogic.j2ee.descriptor.wl

Interface SAFImportedDestinationsBean

All Superinterfaces:

NamedEntityBean, SettableBean, TargetableBean

public interface SAFImportedDestinationsBean
extends TargetableBean

Store-and-Forward (SAF) Imported Destinations is a collection of a SAF queues and topics that reside in a different cluster or server. These sets of SAF queues and topics refer to the same SAF Remote Context. They can also share the same JNDI prefix, Time-To-Live default, and SAF Error Handling name.

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method	Description
SAFQueueBean	createSAFQueue(java.lang.String name)	Create a SAF Queue bean for this SAF Imported Destinations bean.
SAFTopicBean	createSAFTopic(java.lang.String name)	Create a SAF topic for this SAF Imported Destinations bean.
void	destroySAFQueue(SAFQueueBean safQueue)	Destroys a SAF Queue bean defined in this SAF Imported Destinations bean.
void	destroySAFTopic(SAFTopicBean safTopic)	Destroy a SAF Topic bean for this SAF Imported Destinations bean.
java.lang.String	getExactlyOnceLoadBalancingPolicy()	Controls the load balancing behavior when the SAF service forwards messages to a distributed destination with the Exactly-Once quality of service (QOS).
java.lang.String	getJNDIPrefix()	Specifies the string that will prefix the local JNDI name of a remote destination.
MessageLoggingParamsBean	getMessageLoggingParams()	These parameters control how the SAF destination performs message logging.
SAFErrorHandlingBean	getSAFErrorHandling()	Specifies the error handling configuration used for the imported destinations.
SAFQueueBean[]	getSAFQueues()	Specifies an array of SAF queues defined in this SAF Imported Destinations bean.
SAFRemoteContextBean	getSAFRemoteContext()	Specifies the remote context used for the imported destinations.
SAFTopicBean[]	getSAFTopics()	Specifies an array of SAF topics defined in this SAF Imported Destinations bean.
long	getTimeToLiveDefault()	Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages.
java.lang.String	getUnitOfOrderRouting()	Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.
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.
SAFQueueBean	lookupSAFQueue(java.lang.String name)	Finds a SAF Queue bean with the given name.
SAFTopicBean	lookupSAFTopic(java.lang.String name)	Find the SAF Topic bean with the given name.
void	setExactlyOnceLoadBalancingPolicy(java.lang.String exactlyOnceLoadBalancingPolicy)	Sets the value of the ExactlyOnceLoadBalancingPolicy attribute.
void	setJNDIPrefix(java.lang.String jndiPrefix)	Sets the value of the JNDIPrefix attribute.
void	setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling)	Sets the value of the SAFErrorHandling attribute.
void	setSAFRemoteContext(SAFRemoteContextBean safRemoteContextBean)	Sets the value of the SAFRemoteContext attribute.
void	setTimeToLiveDefault(long timeToLiveDefault)	Sets the value of the TimeToLiveDefault attribute.
void	setUnitOfOrderRouting(java.lang.String unitOfOrderRouting)	Sets the value of the UnitOfOrderRouting attribute.
void	setUseSAFTimeToLiveDefault(boolean useSafTimeToLiveDefault)	Sets the value of the SAFTimeToLiveDefault attribute.

Methods inherited from interface weblogic.j2ee.descriptor.wl.NamedEntityBean

getId, getName, getNotes, setName, setNotes

Methods inherited from interface weblogic.j2ee.descriptor.wl.TargetableBean

getSubDeploymentName, isDefaultTargetingEnabled, setDefaultTargetingEnabled, setSubDeploymentName

Method Detail

getSAFQueues

SAFQueueBean[] getSAFQueues()

Specifies an array of SAF queues defined in this SAF Imported Destinations bean.

SAF Queue bean defines an imported JMS queue from a remote server in the local server.

Returns:

Array of SAFQueueBean defined in this SAFImportedDestinationsBean

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createSAFQueue

SAFQueueBean createSAFQueue(java.lang.String name)

Create a SAF Queue bean for this SAF Imported Destinations bean.

SAFQueueBean defines an imported JMS queue from a remote server in the local server.

Parameters:

name - the name for the SAFQueueBean to be created

Returns:

SAFQueueBean created for this SAFImportedDestinationsBean

destroySAFQueue

void destroySAFQueue(SAFQueueBean safQueue)

Destroys a SAF Queue bean defined in this SAF Imported Destinations bean.

SAFQueueBean defines an imported JMS queue from a remote server in the local server.

Parameters:

safQueue - SAFQueueBean to be destroyed in this SAFImportedDestinationsBean

lookupSAFQueue

SAFQueueBean lookupSAFQueue(java.lang.String name)

Finds a SAF Queue bean with the given name.

SAF Queue bean defines an imported JMS queue from a remote server in the local server.

Parameters:

name - The name of the SAF Queue bean to find

Returns:

A SAF Queue bean with the given name, or null if none can be found

getSAFTopics

SAFTopicBean[] getSAFTopics()

Specifies an array of SAF topics defined in this SAF Imported Destinations bean.

SAF Topic bean defines an imported JMS topic from a remote server in the local server.

Returns:

Array of SAFTopicBean defined in this SAFImportedDestinationsBean

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createSAFTopic

SAFTopicBean createSAFTopic(java.lang.String name)

Create a SAF topic for this SAF Imported Destinations bean.

SAF Topic bean defines an imported JMS topic from a remote server in the local server.

Parameters:

name - the name for the SAFTopicBean to be created

Returns:

SAFTopicBean created for this

destroySAFTopic

void destroySAFTopic(SAFTopicBean safTopic)

Destroy a SAF Topic bean for this SAF Imported Destinations bean.

SAF Topic bean defines an imported JMS topic from a remote server in the local server.

Parameters:

safTopic - to be destroyed in this SAFImportedDestinationsBean

lookupSAFTopic

SAFTopicBean lookupSAFTopic(java.lang.String name)

Find the SAF Topic bean with the given name.

SAF Topic bean defines an imported JMS topic from a remote server in the local server.

Parameters:

name - The name of the SAF Topic bean to find

Returns:

A SAF Topic bean with the given name, or null if none could be found

getJNDIPrefix

java.lang.String getJNDIPrefix()

Specifies the string that will prefix the local JNDI name of a remote destination.

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

setJNDIPrefix

void setJNDIPrefix(java.lang.String jndiPrefix)
            throws java.lang.IllegalArgumentException

Sets the value of the JNDIPrefix attribute.

Throws:

java.lang.IllegalArgumentException

See Also:

getJNDIPrefix()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getSAFRemoteContext

SAFRemoteContextBean getSAFRemoteContext()

Specifies the remote context used for the imported destinations.

Changing the remote context name affects both stored messages and incoming messages.

setSAFRemoteContext

void setSAFRemoteContext(SAFRemoteContextBean safRemoteContextBean)
                  throws java.lang.IllegalArgumentException

Sets the value of the SAFRemoteContext attribute.

Throws:

java.lang.IllegalArgumentException

See Also:

SAFRemoteContextBean.getSAFLoginContext()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getSAFErrorHandling

SAFErrorHandlingBean getSAFErrorHandling()

Specifies the error handling configuration used for the imported destinations.

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

Default Value:

null

setSAFErrorHandling

void setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling)
                  throws java.lang.IllegalArgumentException

Sets the value of the SAFErrorHandling attribute.

Throws:

java.lang.IllegalArgumentException

See Also:

getSAFErrorHandling()

Default Value:

null

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

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.

Default Value:

3600000

setTimeToLiveDefault

void setTimeToLiveDefault(long timeToLiveDefault)
                   throws java.lang.IllegalArgumentException

Sets the value of the TimeToLiveDefault attribute.

Throws:

java.lang.IllegalArgumentException

See Also:

getTimeToLiveDefault()

Default Value:

3600000

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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.

Default Value:

false

setUseSAFTimeToLiveDefault

void setUseSAFTimeToLiveDefault(boolean useSafTimeToLiveDefault)
                         throws java.lang.IllegalArgumentException

Sets the value of the SAFTimeToLiveDefault attribute.

Throws:

java.lang.IllegalArgumentException

See Also:

isUseSAFTimeToLiveDefault()

Default Value:

false

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getUnitOfOrderRouting

java.lang.String getUnitOfOrderRouting()

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

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

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

Default Value:

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

setUnitOfOrderRouting

void setUnitOfOrderRouting(java.lang.String unitOfOrderRouting)
                    throws java.lang.IllegalArgumentException

Sets the value of the UnitOfOrderRouting attribute.

This attribute is not dynamically configurable.

Parameters:

unitOfOrderRouting -

Throws:

java.lang.IllegalArgumentException

See Also:

getUnitOfOrderRouting()

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

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

getExactlyOnceLoadBalancingPolicy

java.lang.String getExactlyOnceLoadBalancingPolicy()

Controls the load balancing behavior when the SAF service forwards messages to a distributed destination with the Exactly-Once quality of service (QOS).

The valid values are:

• Per-Member - The default value. All active members of the target distributed destination (DD) will be the candidates for load balancing. If there are multiple members of the same DD running on a WebLogic server JVM, these members will all receive forwarded messages.

• Per-JVM - On each WebLogic server JVM, only one of the active members of the target distributed destination(DD) will be the candidate for load balancing. When the DD has members associated with the instances of a cluster-targeted JMS server, the load balancing algorithm will bias to the "preferred member", which has natural affinity or preference to a particular JVM. Otherwise, the algorithm will bias to the member whose name is lexicographically smallest among all candidate members on the same JVM.

Notes:

• When each JVM hosts only one member of a DD, the two options behave the same.
• You can override the Exactly Once Load Balancing Policy on SAF Imported Destinations Beans defined in all JMS modules or a particular JMS module by specifying the system properties weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy or weblogic.jms.saf.ExactlyOnceLoadBalancingPolicy.MODULENAME on every WebLogic Server in a cluster (the latter property takes precedence over the former). If a SAF Imported Destinations is overridden by one of these system properties, then the host WebLogic Server will log an Info message BEA-281034 with the name of the SAF Imported Destinations, the system property, and the system property value once the first SAF message is forwarded.
• The setting does not apply to the SAF configurations that use the At-Last-Once or At-Most-Once QOS. Neither does it apply to forwarding messages to a "standalone" destination, or forwarding unit-of-order messages.
• The setting is honored in both server store-and-forward and client store-and-forward.
• For a similar setting that controls the load balancing of messages on a local distributed Imported Destination, see the Producer Load Balancing Policy attribute on Connection Factory Load Balancing Params Bean.

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.SAF_EXACTLY_ONCE_LB_POLICY_PER_MEMBER

setExactlyOnceLoadBalancingPolicy

void setExactlyOnceLoadBalancingPolicy(java.lang.String exactlyOnceLoadBalancingPolicy)
                                throws java.lang.IllegalArgumentException

Sets the value of the ExactlyOnceLoadBalancingPolicy attribute.

This attribute is not dynamically changeable, and a server restart is required in order for the new value to take effect.

Parameters:

exactlyOnceLoadBalancingPolicy -

Throws:

java.lang.IllegalArgumentException

See Also:

getExactlyOnceLoadBalancingPolicy()

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.SAF_EXACTLY_ONCE_LB_POLICY_PER_MEMBER,weblogic.j2ee.descriptor.wl.constants.JMSConstants.SAF_EXACTLY_ONCE_LB_POLICY_PER_JVM