SAFImportedDestinationsBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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.

       
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.j2ee.descriptor.wl.SAFImportedDestinationsBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:

    Related MBeans

    This section describes attributes that provide access to other MBeans.

    MessageLoggingParams

    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.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeMessageLoggingParamsBean
    Relationship type: Containment.

    SAFErrorHandling

    Specifies the error handling configuration used for the imported destinations.

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

           
    Privileges Read/Write
    TypeSAFErrorHandlingBean
    Relationship type: Reference.
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    SAFQueues

    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.

               
    Factory MethodscreateSAFQueue (java.lang.String name)

    destroySAFQueue (SAFQueueBean safQueue)

    Factory methods do not return objects.

    See Using factory methods.
    Lookup OperationlookupSAFQueue(String name)

    Returns a javax.management.ObjectName for the instance of SAFQueueBean named name.
    Privileges Read only
    TypeSAFQueueBean[]
    Relationship type: Containment.

    SAFRemoteContext

    Specifies the remote context used for the imported destinations.

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

           
    Privileges Read/Write
    TypeSAFRemoteContextBean
    Relationship type: Reference.

    SAFTopics

    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.

               
    Factory MethodscreateSAFTopic (java.lang.String name)

    destroySAFTopic (SAFTopicBean safTopic)

    Factory methods do not return objects.

    See Using factory methods.
    Lookup OperationlookupSAFTopic(String name)

    Returns a javax.management.ObjectName for the instance of SAFTopicBean named name.
    Privileges Read only
    TypeSAFTopicBean[]
    Relationship type: Containment.

    Attributes

    This section describes the following attributes:

    DefaultTargetingEnabled

    Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.

    When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.

           
    Privileges Read/Write
    Typeboolean

    Id

    Return the unique identifier of this bean instance.

           
    Privileges Read only
    Typelong
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    JNDIPrefix

    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.

           
    Privileges Read/Write
    Typejava.lang.String

    Name

    The name of this entity, represented in XML as an attribute.

    Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.

    This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.

           
    Privileges Read/Write
    Typejava.lang.String

    Notes

    Optional information that you can include to describe this named JMS descriptor bean.

    JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

    Note:

    If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

           
    Privileges Read/Write
    Typejava.lang.String

    SubDeploymentName

    Gets the name of the sub-deployment to use when targeting this entity

    Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.

           
    Privileges Read/Write
    Typejava.lang.String

    TimeToLiveDefault

    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.

           
    Privileges Read/Write
    Typelong
    Default Value3600000
    Minimum value-1

    UnitOfOrderRouting

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

           
    Privileges Read/Write
    Typejava.lang.String
    Default ValueHash
    Legal Values
    • Hash
    • PathService

    UseSAFTimeToLiveDefault

    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.

           
    Privileges Read/Write
    Typeboolean

    Operations

    This section describes the following operations:

      isSet

      Return true if the given property has been explicitly set in this bean.

         
      Operation Name"isSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to check
      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if propertyName is not a recognized property

      unSet

      Restore the given property to its default value.

         
      Operation Name"unSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to restore
      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • java.lang.IllegalArgumentException
        UnsupportedOperationException if called on a runtime implementation.