javax.jms

Annotation Type JMSConnectionFactoryDefinition

@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface JMSConnectionFactoryDefinition

Annotation used to define a Java Message Service (JMS) connection factory and be registered with JNDI. The JMSConnectionFactory may be configured by setting the annotation elements for commonly used JMSConnectionFactory properties. Additional standard and vendor-specific properties may be specified using the properties element. Once defined, a connection factory may be referenced by a component using the lookup element of the Resource annotation.

See Also:

Resource

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	className JMS connection factory implementation class name which implements: javax.jms.ConnectionFactory or javax.jms.QueueConnectionFactory or javax.jms.TopicConnectionFactory
String	name JNDI name of the JMS connection factory being defined.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	clientId Client id to use for connection.
int	connectionTimeout Sets the maximum time in seconds that to wait while attempting to connect to the resource.
String	description Description of this JMS connection factory.
int	initialPoolSize Number of connections that should be created when a connection pool is initialized.
int	maxIdleTime The number of seconds that a physical connection should remain unused in the pool before the connection is closed for a connection pool.
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.
String	password Password to use for connection authentication.
String[]	properties JMS connection factory property.
String	resourceAdapterName Resource adapter name.
boolean	transactional Set to false if connections should not participate in transactions.
String	url Opaque string which defines how to connect to the JMS provider.
String	user User name to use for connection authentication.

Element Detail

name

public abstract String name

JNDI name of the JMS connection factory being defined.

className

public abstract String className

JMS connection factory implementation class name which implements: javax.jms.ConnectionFactory or javax.jms.QueueConnectionFactory or javax.jms.TopicConnectionFactory

description

public abstract String description

Description of this JMS connection factory.

Default:

""

resourceAdapterName

public abstract String resourceAdapterName

Resource adapter name.

Default:

""

user

public abstract String user

User name to use for connection authentication.

Default:

""

password

public abstract String password

Password to use for connection authentication.

Default:

""

clientId

public abstract String clientId

Client id to use for connection.

Default:

""

url

public abstract String url

Opaque string which defines how to connect to the JMS provider. Whether this property is used, and what it should be set to, is defined by the JMS provider

Default:

""

properties

public abstract String[] properties

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

Default:

{}

connectionTimeout

public abstract int connectionTimeout

Sets the maximum time in seconds that to wait while attempting to connect to the resource. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.

Default is vendor-specific.

Default:

0

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.

Default:

true

initialPoolSize

public abstract int initialPoolSize

Number of connections that should be created when a connection pool is initialized.

Default is vendor-specific

Default:

-1

maxPoolSize

public abstract int maxPoolSize

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

Default is vendor-specific.

Default:

-1

minPoolSize

public abstract int minPoolSize

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

Default is vendor-specific.

Default:

-1

maxIdleTime

public abstract int maxIdleTime

The number of seconds that a physical connection should remain unused in the pool before the connection is closed for a connection pool.

Default is vendor-specific

Default:

-1