JMSConnectionFactoryBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.

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


    ClientParams

    The client parameters for this connection factory.

    Several parameters that govern JMS server behavior with regard to a client are configured using a client parameters bean. For example, the client Id when using a connection factory.

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

    DefaultDeliveryParams

    The default delivery parameters for this connection factory.

    If a client does not specify certain parameters then the values that those parameters will take can be controlled with a default delivery parameters bean.

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

    FlowControlParams

    The flow control parameters for this connection factory.

    Many clients producing messages can cause the server to fall behind in processing messages. The flow control parameters can help by slowing down production of messages. Using flow control can help the overall throughput of the system.

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

    LoadBalancingParams

    The load balancing parameters for this connection factory.

    Multiple clients may use this connection factory. The load balancing parameters allow those client to choose how they wish to distribute the work to the configured servers.

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

    SecurityParams

    The security parameters for this connection factory.

    Some clients may wish to customize the security information associated with them. They can use the security parameters bean to do so.

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

    TransactionParams

    The transactional parameters for this connection factory.

    The transaction parameters bean controls how transactions are handled from clients who connect using this factory.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeTransactionParamsBean
    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.

    JNDIName

    The global JNDI name used to look up a connection factory within a clustered JNDI namespace.

    In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name setting.

    If not specified, then the connection factory is not bound into a clustered JNDI namespace.

    For more information, see:

           
    Privileges Read/Write
    Typejava.lang.String

    LocalJNDIName

    The local JNDI name used to look up the connection factory within the JNDI namespace of the server where the connection factory is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.

    If not specified, then the connection factory is not bound into the local JNDI namespace.

           
    Privileges Read/Write
    Typejava.lang.String

    Name

           
    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


    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.