-
@Target(value=TYPE) @Retention(value=RUNTIME) public @interface JMSDestinationDefinition
An application may use this annotation to specify a JMSDestination
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
Destination
resource may be configured by setting the annotation elements for commonly used properties. Additional properties may be specified using theproperties
element. Once defined, aDestination
resource may be referenced by a component in the same way as any otherDestination
resource, for example by using thelookup
element of theResource
annotation.- Since:
- JMS 2.0
- Version:
- JMS 2.0
- See Also:
Resource
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description String
interfaceName
Fully qualified name of the JMS destination interface.String
name
JNDI name of the destination resource being defined.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description String
className
Fully-qualified name of the JMS destination implementation class.String
description
Description of this JMS destination.String
destinationName
Name of the queue or topic.String[]
properties
JMS destination property.String
resourceAdapter
Resource adapter name.
-
-
-
Element Detail
-
name
public abstract String name
JNDI name of the destination resource being defined.
-
-
-
interfaceName
public abstract String interfaceName
Fully qualified name of the JMS destination interface. Permitted values arejavax.jms.Queue
orjavax.jms.Topic
.
-
-
-
description
public abstract String description
Description of this JMS destination.- Default:
- ""
-
-
-
className
public abstract String className
Fully-qualified name of the JMS destination implementation class. Ignored if a resource adapter is used unless the resource adapter defines more than one JMS destination implementation class for the specified interface- Default:
- ""
-
-
-
resourceAdapter
public abstract 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.- Default:
- ""
-
-
-
destinationName
public abstract String destinationName
Name of the queue or topic.- Default:
- ""
-
-
-
properties
public abstract String[] properties
JMS destination 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:
- {}
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/jms/jmsdestinationdefinition.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.