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

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 take effect after you redeploy the module or restart the server.

createSAFQueue

SAFQueueBean createSAFQueue(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(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 take effect after you redeploy the module or restart the server.

createSAFTopic

SAFTopicBean createSAFTopic(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(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

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(String jndiPrefix)
                   throws IllegalArgumentException

Sets the value of the JNDIPrefix attribute.

Throws:

IllegalArgumentException

See Also:

SAFImportedDestinationsBean.getJNDIPrefix()

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

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 IllegalArgumentException

Sets the value of the SAFRemoteContext attribute.

Throws:

IllegalArgumentException

See Also:

SAFRemoteContextBean.getSAFLoginContext()

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

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 IllegalArgumentException

Sets the value of the SAFErrorHandling attribute.

Throws:

IllegalArgumentException

See Also:

SAFImportedDestinationsBean.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.

Default Value:

3600000

setTimeToLiveDefault

void setTimeToLiveDefault(long timeToLiveDefault)
                          throws IllegalArgumentException

Sets the value of the TimeToLiveDefault attribute.

Throws:

IllegalArgumentException

See Also:

SAFImportedDestinationsBean.getTimeToLiveDefault()

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

Default Value:

3600000

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 IllegalArgumentException

Sets the value of the SAFTimeToLiveDefault attribute.

Throws:

IllegalArgumentException

See Also:

SAFImportedDestinationsBean.isUseSAFTimeToLiveDefault()

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

Default Value:

false

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 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(String unitOfOrderRouting)
                           throws IllegalArgumentException

Sets the value of the UnitOfOrderRouting attribute.

This attribute is not dynamically configurable.

Parameters:

unitOfOrderRouting -

Throws:

IllegalArgumentException

See Also:

SAFImportedDestinationsBean.getUnitOfOrderRouting()

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