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


Method Summary
abstract  SAFQueueBean createSAFQueue(String name)
          Create a SAF Queue bean for this SAF Imported Destinations bean.
abstract  SAFTopicBean createSAFTopic(String name)
          Create a SAF topic for this SAF Imported Destinations bean.
abstract  void destroySAFQueue(SAFQueueBean safQueue)
          Destroys a SAF Queue bean defined in this SAF Imported Destinations bean.
abstract  void destroySAFTopic(SAFTopicBean safTopic)
          Destroy a SAF Topic bean for this SAF Imported Destinations bean.
abstract  String getJNDIPrefix()
          Specifies the string that will prefix the local JNDI name of a remote destination.
abstract  MessageLoggingParamsBean getMessageLoggingParams()
          These parameters control how the SAF destination performs message logging.
abstract  SAFErrorHandlingBean getSAFErrorHandling()
          Specifies the error handling configuration used for the imported destinations.
abstract  SAFQueueBean[] getSAFQueues()
          Specifies an array of SAF queues defined in this SAF Imported Destinations bean.
abstract  SAFRemoteContextBean getSAFRemoteContext()
          Specifies the remote context used for the imported destinations.
abstract  SAFTopicBean[] getSAFTopics()
          Specifies an array of SAF topics defined in this SAF Imported Destinations bean.
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  SAFQueueBean lookupSAFQueue(String name)
          Finds a SAF Queue bean with the given name.
abstract  SAFTopicBean lookupSAFTopic(String name)
          Find the SAF Topic bean with the given name.
abstract  void setJNDIPrefix(String jndiPrefix)
          Sets the value of the JNDIPrefix attribute.
abstract  void setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling)
          Sets the value of the SAFErrorHandling attribute.
abstract  void setSAFRemoteContext(SAFRemoteContextBean safRemoteContextBean)
          Sets the value of the SAFRemoteContext 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 SAFTimeToLiveDefault attribute.

 

Methods inherited from interface weblogic.j2ee.descriptor.wl.TargetableBean
getSubDeploymentName, isDefaultTargetingEnabled, setDefaultTargetingEnabled, setSubDeploymentName

 

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

 

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

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

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

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

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.


setSAFErrorHandling

void setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling)
                         throws IllegalArgumentException

Sets the value of the SAFErrorHandling attribute.

Throws:
IllegalArgumentException
See Also:
SAFImportedDestinationsBean.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:
SAFImportedDestinationsBean.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 SAFTimeToLiveDefault attribute.

Throws:
IllegalArgumentException
See Also:
SAFImportedDestinationsBean.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.

This attribute is not dynamically configurable.

Parameters:
unitOfOrderRouting -
Throws:
IllegalArgumentException
See Also:
SAFImportedDestinationsBean.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