Package javax.jms
Annotation Interface JMSConnectionFactoryDefinition
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
- See Also:
-
Required Element Summary
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionFully-qualified name of the JMS connection factory implementation class.Client id to use for connection.Description of this JMS connection factory.Fully qualified name of the JMS connection factory interface.int
Maximum number of connections that should be concurrently allocated for a connection pool.int
Minimum number of connections that should be concurrently allocated for a connection pool.Password to use for connection authentication.String[]
JMS connection factory property.Resource adapter name.boolean
Set tofalse
if connections should not participate in transactions.User name to use for connection authentication.
-
Element Details
-
name
String nameJNDI name of the JMS connection factory being defined.
-
-
-
description
String descriptionDescription of this JMS connection factory.- Default:
- ""
-
interfaceName
String interfaceNameFully qualified name of the JMS connection factory interface. Permitted values arejavax.jms.ConnectionFactory
orjavax.jms.QueueConnectionFactory
orjavax.jms.TopicConnectionFactory
. If not specified thenjavax.jms.ConnectionFactory
will be used.- Default:
- "javax.jms.ConnectionFactory"
-
className
String classNameFully-qualified name of the JMS connection factory implementation class. Ignored if a resource adapter is used.- Default:
- ""
-
resourceAdapter
String resourceAdapterResource 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.- Default:
- ""
-
user
String userUser name to use for connection authentication.- Default:
- ""
-
password
String passwordPassword to use for connection authentication.- Default:
- ""
-
clientId
String clientIdClient id to use for connection.- Default:
- ""
-
properties
String[] propertiesJMS 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.
- Default:
- {}
-
transactional
boolean transactionalSet tofalse
if connections should not participate in transactions.Default is to enlist in a transaction when one is active or becomes active.
- Default:
- true
-
maxPoolSize
int maxPoolSizeMaximum number of connections that should be concurrently allocated for a connection pool.Default is vendor-specific.
- Default:
- -1
-
minPoolSize
int minPoolSizeMinimum number of connections that should be concurrently allocated for a connection pool.Default is vendor-specific.
- Default:
- -1
-