-
@Target(TYPE) @Retention(RUNTIME) @Repeatable(JMSDestinationDefinitions.class) public @interface JMSDestinationDefinition
An application may use this annotation to specify a Jakarta MessagingDestination
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:
- Jakarta Messaging 2.0
- See Also:
Resource
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description String
interfaceName
Fully qualified name of the Jakarta Messaging destination interface.String
name
JNDI name of the destination resource being defined.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
className
Fully-qualified name of the Jakarta Messaging destination implementation class.String
description
Description of this Jakarta Messaging destination.String
destinationName
Name of the queue or topic.String[]
properties
Jakarta Messaging destination property.String
resourceAdapter
Resource adapter name.
-
-
-
Element Detail
-
name
String name
JNDI name of the destination resource being defined.- Returns:
- The JNDI name of the destination resource being defined.
-
-
-
interfaceName
String interfaceName
Fully qualified name of the Jakarta Messaging destination interface. Permitted values arejakarta.jms.Queue
orjakarta.jms.Topic
.- Returns:
- The fully qualified name of the Jakarta Messaging destination interface.
-
-
-
description
String description
Description of this Jakarta Messaging destination.- Returns:
- The description of this Jakarta Messaging destination.
- Default:
- ""
-
-
-
className
String className
Fully-qualified name of the Jakarta Messaging destination implementation class. Ignored if a resource adapter is used unless the resource adapter defines more than one Jakarta Messaging destination implementation class for the specified interface.- Returns:
- The fully-qualified name of the Jakarta Messaging destination 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:
- ""
-
-
-
destinationName
String destinationName
Name of the queue or topic.- Returns:
- The name of the queue or topic.
- Default:
- ""
-
-
-
properties
String[] properties
Jakarta Messaging destination property. This may be a vendor-specific property or a less commonly used destination property.Properties are specified using the format: propertyName=propertyValue with one property per array element.
- Returns:
- The Jakarta Messaging destination properties.
- Default:
- {}
-
-