Oracle GlassFish(tm) Server Message Queue
5.0

javax.jms
Annotation Type JMSConnectionFactoryDefinition


@Target(value=TYPE)
@Retention(value=RUNTIME)
public @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.

See Also:
javax.annotation.Resource

Required Element Summary
 java.lang.String className
          JMS connection factory implementation class name which implements: javax.jms.ConnectionFactory or javax.jms.QueueConnectionFactory or javax.jms.TopicConnectionFactory
 java.lang.String name
          JNDI name of the JMS connection factory being defined.
 
Optional Element Summary
 java.lang.String clientId
          Client id to use for connection.
 java.lang.String description
          Description of this JMS connection factory.
 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.
 java.lang.String password
          Password to use for connection authentication.
 java.lang.String[] properties
          JMS connection factory property.
 java.lang.String resourceAdapterName
          Resource adapter name.
 boolean transactional
          Set to false if connections should not participate in transactions.
 java.lang.String user
          User name to use for connection authentication.
 

Element Detail

name

public abstract java.lang.String name
JNDI name of the JMS connection factory being defined.


className

public abstract java.lang.String className
JMS connection factory implementation class name which implements: javax.jms.ConnectionFactory or javax.jms.QueueConnectionFactory or javax.jms.TopicConnectionFactory

description

public abstract java.lang.String description
Description of this JMS connection factory.

Default:
""

resourceAdapterName

public abstract java.lang.String resourceAdapterName
Resource adapter name.

Default:
""

user

public abstract java.lang.String user
User name to use for connection authentication.

Default:
""

password

public abstract java.lang.String password
Password to use for connection authentication.

Default:
""

clientId

public abstract java.lang.String clientId
Client id to use for connection.

Default:
""

properties

public abstract java.lang.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:
{}

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

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

Oracle GlassFish(tm) Server Message Queue
5.0

Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.