ForeignJMSServerMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class represents a JNDI provider that is outside the WebLogic JMS server. It is a parent element of the ForeignJMSConnectionFactory and ForeignJMSDestination MBeans. It contains information that allows WebLogic Server to reach the remote JNDI provider. This way, a number of connection factory and destination objects can be defined on one JNDI directory.

Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

   
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.ForeignJMSServerMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:


    Related MBeans

    This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


    ConnectionFactories

    The remote connection factories.

               
    Lookup OperationlookupForeignJMSConnectionFactory(String name)

    Returns a javax.management.ObjectName for the instance of ForeignJMSConnectionFactoryMBean named name.

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

    Destinations

    The remote destinations.

    Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

               
    Lookup OperationlookupForeignJMSDestination(String name)

    Returns a javax.management.ObjectName for the instance of ForeignJMSDestinationMBean named name.

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

    ForeignJMSConnectionFactories

    Get all the Members

    Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

               
    Factory MethodscreateForeignJMSConnectionFactory (java.lang.String )

    destroyForeignJMSConnectionFactory (ForeignJMSConnectionFactoryMBean )

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupForeignJMSConnectionFactory(String name)

    Returns a javax.management.ObjectName for the instance of ForeignJMSConnectionFactoryMBean named name.

    Privileges Read only
    TypeForeignJMSConnectionFactoryMBean[]
    Relationship type: Containment.

    ForeignJMSDestinations

    Get all the Members

    Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

               
    Factory MethodscreateForeignJMSDestination (java.lang.String )

    destroyForeignJMSDestination (ForeignJMSDestinationMBean )

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupForeignJMSDestination(String name)

    Returns a javax.management.ObjectName for the instance of ForeignJMSDestinationMBean named name.

    Privileges Read only
    TypeForeignJMSDestinationMBean[]
    Relationship type: Containment.

    Targets

    You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

           
    Privileges Read/Write
    TypeTargetMBean[]
    Relationship type: Reference.


    Attributes

    This section describes the following attributes:


    CachingDisabled

    Private property that disables caching in proxies.

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

    ConnectionURL

    The URL that WebLogic Server will use to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is being used. For WebLogic JMS, leave this field blank if you are referencing WebLogic JMS objects within the same cluster. This value corresponds to the standard JNDI property, java.naming.provider.url.

    Note: If this value is not specified, look-ups will be performed on the JNDI server within the WebLogic Server instance where this connection factory is deployed.

           
    Privileges Read/Write
    Typejava.lang.String

    DeploymentOrder

    A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

    For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

    Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

           
    Privileges Read/Write
    Typeint
    Default Value1000
    Minimum value0
    Maximum value2147483647

    InitialContextFactory

    The name of the class that must be instantiated to access the JNDI provider. This class name depends on the JNDI provider and the vendor that are being used. This value corresponds to the standard JNDI property, java.naming.factory.initial.

    Note: This value defaults to weblogic.jndi.WLInitialContextFactory, which is the correct value for WebLogic Server.

           
    Privileges Read/Write
    Typejava.lang.String
    Default Valueweblogic.jndi.WLInitialContextFactory

    JNDIProperties

    Any additional properties that must be set for the JNDI provider. These properties will be passed directly to the constructor for the JNDI provider's InitialContext class.

    Note: This value must be filled in using a name=value<return>name=value format.

           
    Privileges Read/Write
    Typejava.util.Properties

    JNDIPropertiesCredential

    The encrypted value of the value set via java.naming.security.credentials property of the JNDIProperties attribute. set via setJNDIPropertiesCredential ,

    For more information, see:

           
    Privileges Read/Write
    Typejava.lang.String
    Encryptedtrue

    JNDIPropertiesCredentialEncrypted

    The encrypted value of the value set via java.naming.security.credentials property of the JNDIProperties attribute. set via setJNDIPropertiesCredentialEncrypted ,

    For more information, see:

           
    Privileges Read/Write
    Typebyte[]
    Encryptedtrue

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

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

    Name

    The user-specified name of this MBean instance.

    This name is included as one of the key properties in the MBean's javax.management.ObjectName:
    Name=user-specified-name

           
    Privileges Read/Write
    Typejava.lang.String

    Notes

    Optional information that you can include to describe this configuration.

    WebLogic Sever saves this note in the domain's configuration file (config.xml) 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

    ObjectName

    Returns the ObjectName under which this MBean is registered in the MBean server.

    Deprecated.

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

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Registered

    Returns false if the the MBean represented by this object has been unregistered.

    Deprecated.

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

    Type

    Returns the type of the MBean.

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


    Operations

    This section describes the following operations:


    addConnectionFactory

    Adds a destination.

    Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

       
    Operation Name"addConnectionFactory"
    ParametersObject [] {  factory }

    where:

    • factory is an object of type weblogic.management.configuration.ForeignJMSConnectionFactoryMBean that specifies:

      The feature to be added to the ConnectionFactory attribute

    SignatureString [] { "weblogic.management.configuration.ForeignJMSConnectionFactoryMBean" }
    Returns boolean

    addDestination

    Adds a destination.

    Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

       
    Operation Name"addDestination"
    ParametersObject [] {  destination }

    where:

    • destination is an object of type weblogic.management.configuration.ForeignJMSDestinationMBean that specifies:

      The feature to be added to the Destination attribute

    SignatureString [] { "weblogic.management.configuration.ForeignJMSDestinationMBean" }
    Returns boolean

    addTarget

    You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

       
    Operation Name"addTarget"
    ParametersObject [] {  target }

    where:

    • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

      The feature to be added to the Target attribute

    SignatureString [] { "weblogic.management.configuration.TargetMBean" }
    Returns boolean
    Exceptions
    • javax.management.InvalidAttributeValueException
    • weblogic.management.DistributedManagementException

    freezeCurrentValue

    If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

    Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

    Note:

    To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

    This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

    Deprecated. 9.0.0.0

       
    Operation Name"freezeCurrentValue"
    ParametersObject [] {  attributeName }

    where:

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

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • javax.management.AttributeNotFoundException
    • javax.management.MBeanException

    isSet

    Returns true if the specified attribute has been set explicitly in this MBean instance.

       
    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

    removeConnectionFactory

    Removes a destination.

    Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

       
    Operation Name"removeConnectionFactory"
    ParametersObject [] {  factory }

    where:

    • factory is an object of type weblogic.management.configuration.ForeignJMSConnectionFactoryMBean that specifies:

      factory

    SignatureString [] { "weblogic.management.configuration.ForeignJMSConnectionFactoryMBean" }
    Returns boolean

    removeDestination

    Removes a destination.

    Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.

       
    Operation Name"removeDestination"
    ParametersObject [] {  destination }

    where:

    • destination is an object of type weblogic.management.configuration.ForeignJMSDestinationMBean that specifies:

      destination

    SignatureString [] { "weblogic.management.configuration.ForeignJMSDestinationMBean" }
    Returns boolean

    removeTarget

    Removes the value of the addTarget attribute.

    For more information, see:

       
    Operation Name"removeTarget"
    ParametersObject [] {  target }

    where:

    • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

      target

    SignatureString [] { "weblogic.management.configuration.TargetMBean" }
    Returns boolean
    Exceptions
    • javax.management.InvalidAttributeValueException
    • weblogic.management.DistributedManagementException

    restoreDefaultValue

    If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

    Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

    This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

    Deprecated. 9.0.0.0

       
    Operation Name"restoreDefaultValue"
    ParametersObject [] {  attributeName }

    where:

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

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • javax.management.AttributeNotFoundException

    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