jakarta.jms

Annotation Type JMSConnectionFactoryDefinition

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Repeatable(value=JMSConnectionFactoryDefinitions.class)
public @interface JMSConnectionFactoryDefinition

An application may use this annotation to specify a Jakarta Messaging ConnectionFactory resource that it requires in its operational environment. This provides information that can be used at the application's deployment to provision the required resource and allows an application to be deployed into a Jakarta EE environment with more minimal administrative configuration.

The ConnectionFactory resource may be configured by setting the annotation elements for commonly used properties. Additional properties may be specified using the properties element. Once defined, a ConnectionFactory resource may be referenced by a component in the same way as any other ConnectionFactory resource, for example by using the lookup element of the Resource annotation.

Since:

JMS 2.0

Version:

Jakarta Messaging 2.0

See Also:

Resource

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name JNDI name of the Jakarta Messaging connection factory being defined.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	className Fully-qualified name of the Jakarta Messaging connection factory implementation class.
java.lang.String	clientId Client id to use for connection.
java.lang.String	description Description of this Jakarta Messaging connection factory.
java.lang.String	interfaceName Fully qualified name of the Jakarta Messaging connection factory interface.
int	maxPoolSize Maximum number of connections that should be concurrently allocated for a connection pool.
int	minPoolSize Minimum number of connections that should be concurrently allocated for a connection pool.
java.lang.String	password Password to use for connection authentication.
java.lang.String[]	properties Jakarta Messaging connection factory property.
java.lang.String	resourceAdapter Resource adapter name.
boolean	transactional Set to false if connections should not participate in transactions.
java.lang.String	user User name to use for connection authentication.

Element Detail

name

public abstract java.lang.String name

JNDI name of the Jakarta Messaging connection factory being defined.

Returns:

The JNDI name of the Jakarta Messaging connection factory being defined.

description

public abstract java.lang.String description

Description of this Jakarta Messaging connection factory.

Returns:

The description of this Jakarta Messaging connection factory.

Default:

""

interfaceName

public abstract java.lang.String interfaceName

Fully qualified name of the Jakarta Messaging connection factory interface. Permitted values are jakarta.jms.ConnectionFactory or jakarta.jms.QueueConnectionFactory or jakarta.jms.TopicConnectionFactory. If not specified then jakarta.jms.ConnectionFactory will be used.

Returns:

The fully qualified name of the Jakarta Messaging connection factory interface.

Default:

"jakarta.jms.ConnectionFactory"

className

public abstract java.lang.String className

Fully-qualified name of the Jakarta Messaging connection factory implementation class. Ignored if a resource adapter is used.

Returns:

The fully-qualified name of the Jakarta Messaging connection factory implementation class.

Default:

""

resourceAdapter

public abstract java.lang.String resourceAdapter

Resource adapter name. If not specified then the application server will define the default behaviour, which may or may not involve the use of a resource adapter.

Returns:

The resource adapter name.

Default:

""

user

public abstract java.lang.String user

User name to use for connection authentication.

Returns:

The user name to use for connection authentication.

Default:

""

password

public abstract java.lang.String password

Password to use for connection authentication.

Returns:

The password to use for connection authentication.

Default:

""

clientId

public abstract java.lang.String clientId

Client id to use for connection.

Returns:

The client id to use for connection.

Default:

""

properties

public abstract java.lang.String[] properties

Jakarta Messaging connection factory property. This may be a vendor-specific property or a less commonly used ConnectionFactory property.

Properties are specified using the format: propertyName=propertyValue with one property per array element.

Returns:

The Jakarta Messaging connection factory property.

Default:

{}

transactional

public abstract boolean transactional

Set to false if connections should not participate in transactions.

Default is to enlist in a transaction when one is active or becomes active.

Returns:

Whether connections should participate in transactions.

Default:

true

maxPoolSize

public abstract int maxPoolSize

Maximum number of connections that should be concurrently allocated for a connection pool.

Default is vendor-specific.

Returns:

The maximum number of connections that should be concurrently allocated for a connection pool.

Default:

-1

minPoolSize

public abstract int minPoolSize

Minimum number of connections that should be concurrently allocated for a connection pool.

Default is vendor-specific.

Returns:

The minimum number of connections that should be concurrently allocated for a connection pool.

Default:

-1