weblogic.j2ee.descriptor.wl
Interface JMSConnectionFactoryBean

All Superinterfaces:

NamedEntityBean, SettableBean, TargetableBean

public interface JMSConnectionFactoryBean
extends TargetableBean

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

Access limited to the following security roles:

Deployer

getName

String getName()

Description copied from interface: NamedEntityBean

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.

Specified by:

getName in interface NamedEntityBean

Returns:

The name of this entity

setName

void setName(String name)

Description copied from interface: NamedEntityBean

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.

Specified by:

setName in interface NamedEntityBean

Parameters:

name - The name to use for this entity

This method can NOT set a null value.

getJNDIName

String getJNDIName()

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.

Returns:

The jNDIName value

See Also:

JMSConnectionFactoryBean.getLocalJNDIName()

setJNDIName

void setJNDIName(String jndiName)
                 throws IllegalArgumentException

Sets the value of the JNDIName attributed.

Parameters:

jndiName -

Throws:

IllegalArgumentException

See Also:

JMSConnectionFactoryBean.getJNDIName()

getLocalJNDIName

String getLocalJNDIName()

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.

setLocalJNDIName

void setLocalJNDIName(String localJndiName)
                      throws IllegalArgumentException

Sets the value of the LocalJNDIName attributed.

Parameters:

localJndiName -

Throws:

IllegalArgumentException

See Also:

JMSConnectionFactoryBean.getLocalJNDIName()

getDefaultDeliveryParams

DefaultDeliveryParamsBean getDefaultDeliveryParams()

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.

Returns:

The default delivery parameter bean associated with this connection factory

getClientParams

ClientParamsBean getClientParams()

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.

Returns:

The client parameter bean associated with this connection factory

getTransactionParams

TransactionParamsBean getTransactionParams()

The transactional parameters for this connection factory.

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

Returns:

The transaction parameter bean associated with this connection factory

getFlowControlParams

FlowControlParamsBean getFlowControlParams()

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.

Returns:

The flow-control parameter bean associated with this connection factory

getLoadBalancingParams

LoadBalancingParamsBean getLoadBalancingParams()

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.

Returns:

The load-balancing parameter bean associated with this connection factory

getSecurityParams

SecurityParamsBean getSecurityParams()

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.

Returns:

The security parameter bean associated with this connection factory