Top Description Methods
javax.jms

public @Interface JMSConnectionFactoryDefinition

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target
An application may use this annotation to specify a JMS 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 Java 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
JMS 2.0
See Also
javax.annotation.Resource

Method Summary

Modifier and TypeMethod and Description
public String
className()

Fully-qualified name of the JMS connection factory implementation class.

public String
clientId()

Client id to use for connection.

public String
description()

Description of this JMS connection factory.

public String
interfaceName()

Fully qualified name of the JMS connection factory interface.

public int
maxPoolSize()

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

public int
minPoolSize()

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

public String
name()

JNDI name of the JMS connection factory being defined.

public String
password()

Password to use for connection authentication.

public String[]
properties()

JMS connection factory property.

public String
resourceAdapter()

Resource adapter name.

public boolean
transactional()

Set to false if connections should not participate in transactions.

public String
user()

User name to use for connection authentication.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

classNameback to summary
public String className()

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

clientIdback to summary
public String clientId()

Client id to use for connection.

descriptionback to summary
public String description()

Description of this JMS connection factory.

interfaceNameback to summary
public String interfaceName()

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

maxPoolSizeback to summary
public int maxPoolSize()

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

Default is vendor-specific.

minPoolSizeback to summary
public int minPoolSize()

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

Default is vendor-specific.

nameback to summary
public String name()

JNDI name of the JMS connection factory being defined.

passwordback to summary
public String password()

Password to use for connection authentication.

propertiesback to summary
public 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.

resourceAdapterback to summary
public 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.

transactionalback to summary
public 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.

userback to summary
public String user()

User name to use for connection authentication.