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 roles The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:

  • Deployer
   
Fully Qualified Interface Name If 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 No factory methods. Instances of this MBean are created automatically.

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.

 

ClientParams

Gets the client parameters for this connection factory

Several parameters concerning how the JMS server should behave with regard to their clients can be configured with the client parameters bean. For example, the client-id a client should have when using this connection factory can be configured with a client parameter bean.

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

 

DefaultDeliveryParams

Gets 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    
Type DefaultDeliveryParamsBean
Relationship type: Containment.

 

FlowControlParams

Gets 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    
Type FlowControlParamsBean
Relationship type: Containment.

 

LoadBalancingParams

Gets 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    
Type LoadBalancingParamsBean
Relationship type: Containment.

 

SecurityParams

Gets 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    
Type SecurityParamsBean
Relationship type: Containment.

 

TransactionParams

Gets 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    
Type TransactionParamsBean
Relationship type: Containment.

Attributes

This section describes the following attributes:

 

DefaultTargetingEnabled

Whether this JMS resource defaults to the parent module's targeting or uses the 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    
Type boolean

 

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    
Type java.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    
Type java.lang.String

 

Name of

   
Privileges Read/Write    
Type java.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    
Type java.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    
Type java.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"    
    Parameters Object [] {  propertyName }

    where:

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

      property to check

    Signature String [] { "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"    
    Parameters Object [] {  propertyName }

    where:

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

      property to restore

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • java.lang.IllegalArgumentException
      UnsupportedOperationException if called on a runtime implementation.