-
@Target(TYPE) @Retention(RUNTIME) @Repeatable(JMSConnectionFactoryDefinitions.class) public @interface JMSConnectionFactoryDefinition
An application may use this annotation to specify a Jakarta MessagingConnectionFactory
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 theproperties
element. Once defined, aConnectionFactory
resource may be referenced by a component in the same way as any otherConnectionFactory
resource, for example by using thelookup
element of theResource
annotation.- Since:
- JMS 2.0
- Version:
- Jakarta Messaging 2.0
- See Also:
Resource
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
className
Fully-qualified name of the Jakarta Messaging connection factory implementation class.String
clientId
Client id to use for connection.String
description
Description of this Jakarta Messaging connection factory.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.String
password
Password to use for connection authentication.String[]
properties
Jakarta Messaging connection factory property.String
resourceAdapter
Resource adapter name.boolean
transactional
Set tofalse
if connections should not participate in transactions.String
user
User name to use for connection authentication.
-
-
-
Element Detail
-
name
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
String description
Description of this Jakarta Messaging connection factory.- Returns:
- The description of this Jakarta Messaging connection factory.
- Default:
- ""
-
-
-
interfaceName
String interfaceName
Fully qualified name of the Jakarta Messaging connection factory interface. Permitted values arejakarta.jms.ConnectionFactory
orjakarta.jms.QueueConnectionFactory
orjakarta.jms.TopicConnectionFactory
. If not specified thenjakarta.jms.ConnectionFactory
will be used.- Returns:
- The fully qualified name of the Jakarta Messaging connection factory interface.
- Default:
- "jakarta.jms.ConnectionFactory"
-
-
-
className
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
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
String user
User name to use for connection authentication.- Returns:
- The user name to use for connection authentication.
- Default:
- ""
-
-
-
password
String password
Password to use for connection authentication.- Returns:
- The password to use for connection authentication.
- Default:
- ""
-
-
-
clientId
String clientId
Client id to use for connection.- Returns:
- The client id to use for connection.
- Default:
- ""
-
-
-
properties
String[] properties
Jakarta Messaging connection factory property. This may be a vendor-specific property or a less commonly usedConnectionFactory
property.Properties are specified using the format: propertyName=propertyValue with one property per array element.
- Returns:
- The Jakarta Messaging connection factory property.
- Default:
- {}
-
-