EE4J 10.0.0 · jakarta.jms.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.

Method Summary

Modifier and Type	Method and Description
public String	Returns: The fully-qualified name of the Jakarta Messaging connection factory implementation class. className() Fully-qualified name of the Jakarta Messaging connection factory implementation class.
public String	Returns: The client id to use for connection. clientId() Client id to use for connection.
public String	Returns: The description of this Jakarta Messaging connection factory. description() Description of this Jakarta Messaging connection factory.
public String	Returns: The fully qualified name of the Jakarta Messaging connection factory interface. interfaceName() Fully qualified name of the Jakarta Messaging connection factory interface.
public int	Returns: The maximum number of connections that should be concurrently allocated for a connection pool. maxPoolSize() Maximum number of connections that should be concurrently allocated for a connection pool.
public int	Returns: The minimum number of connections that should be concurrently allocated for a connection pool. minPoolSize() Minimum number of connections that should be concurrently allocated for a connection pool.
public String	Returns: The JNDI name of the Jakarta Messaging connection factory being defined. name() JNDI name of the Jakarta Messaging connection factory being defined.
public String	Returns: The password to use for connection authentication. password() Password to use for connection authentication.
public String[]	Returns: The Jakarta Messaging connection factory property. properties() Jakarta Messaging connection factory property.
public String	Returns: The resource adapter name. resourceAdapter() Resource adapter name.
public boolean	Returns: Whether connections should participate in transactions. transactional() Set to `false` if connections should not participate in transactions.
public String	Returns: The user name to use for connection authentication. user() User name to use for connection authentication.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

className	back to summary
public String className() Fully-qualified name of the Jakarta Messaging connection factory implementation class. Ignored if a resource adapter is used. Returns:String The fully-qualified name of the Jakarta Messaging connection factory implementation class.

className

back to summary

public String className()

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

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

clientId	back to summary
public String clientId() Client id to use for connection. Returns:String The client id to use for connection.

clientId

back to summary

public String clientId()

Client id to use for connection.

Returns:String: The client id to use for connection.

description	back to summary
public String description() Description of this Jakarta Messaging connection factory. Returns:String The description of this Jakarta Messaging connection factory.

description

back to summary

public String description()

Description of this Jakarta Messaging connection factory.

Returns:String: The description of this Jakarta Messaging connection factory.

interfaceName back to summary

interfaceName	back to summary
public 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:String The fully qualified name of the Jakarta Messaging connection factory interface.

public 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:String: The fully qualified name of the Jakarta Messaging connection factory interface.

maxPoolSize	back to summary
public int maxPoolSize() Maximum number of connections that should be concurrently allocated for a connection pool. Default is vendor-specific. Returns:int The maximum number of connections that should be concurrently allocated for a connection pool.

maxPoolSize

back to summary

public int maxPoolSize()

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

Default is vendor-specific.

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

minPoolSize	back to summary
public int minPoolSize() Minimum number of connections that should be concurrently allocated for a connection pool. Default is vendor-specific. Returns:int The minimum number of connections that should be concurrently allocated for a connection pool.

minPoolSize

back to summary

public int minPoolSize()

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

Default is vendor-specific.

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

name	back to summary
public String name() JNDI name of the Jakarta Messaging connection factory being defined. Returns:String The JNDI name of the Jakarta Messaging connection factory being defined.

name

back to summary

public String name()

JNDI name of the Jakarta Messaging connection factory being defined.

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

password	back to summary
public String password() Password to use for connection authentication. Returns:String The password to use for connection authentication.

password

back to summary

public String password()

Password to use for connection authentication.

Returns:String: The password to use for connection authentication.

properties back to summary

properties	back to summary
public 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:String[] The Jakarta Messaging connection factory property.

public 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:String[]: The Jakarta Messaging connection factory property.

resourceAdapter	back 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. Returns:String The resource adapter name.

resourceAdapter

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

Returns:String: The resource adapter name.

transactional back to summary

transactional	back 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. Returns:boolean Whether connections should participate in transactions.

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.

Returns:boolean: Whether connections should participate in transactions.

user	back to summary
public String user() User name to use for connection authentication. Returns:String The user name to use for connection authentication.

user

back to summary

public String user()

User name to use for connection authentication.

Returns:String: The user name to use for connection authentication.

public @Interface JMSConnectionFactoryDefinition

Method Summary

Method Detail