JMSDestinationDefinition

```
@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface JMSDestinationDefinition
```
An application may use this annotation to specify a Jakarta Messaging Destination 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 the properties element. Once defined, a Destination resource may be referenced by a component in the same way as any other Destination resource, for example by using the lookup element of the Resource annotation.

Since:

JMS 2.0

See Also:

Resource

Required Element Summary

Required Elements
Modifier and Type	Required Element and Description
`java.lang.String`	`interfaceName` Fully qualified name of the Jakarta Messaging destination interface.
`java.lang.String`	`name` JNDI name of the destination resource being defined.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`java.lang.String`	`className` Fully-qualified name of the Jakarta Messaging destination implementation class.
`java.lang.String`	`description` Description of this Jakarta Messaging destination.
`java.lang.String`	`destinationName` Name of the queue or topic.
`java.lang.String[]`	`properties` Jakarta Messaging destination property.
`java.lang.String`	`resourceAdapter` Resource adapter name.

- Element Detail
  - name
```
public abstract java.lang.String name
```
    JNDI name of the destination resource being defined.
    
    Returns:
    
    The JNDI name of the destination resource being defined.
- - interfaceName
```
public abstract java.lang.String interfaceName
```
    Fully qualified name of the Jakarta Messaging destination interface. Permitted values are jakarta.jms.Queue or jakarta.jms.Topic.
    
    Returns:
    
    The fully qualified name of the Jakarta Messaging destination interface.
- - description
```
public abstract java.lang.String description
```
    Description of this Jakarta Messaging destination.
    
    Returns:
    
    The description of this Jakarta Messaging destination.
    
    Default:
    
    ""
- - className
```
public abstract java.lang.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
```
public abstract java.lang.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
```
public abstract java.lang.String destinationName
```
    Name of the queue or topic.
    
    Returns:
    
    The name of the queue or topic.
    
    Default:
    
    ""
- - properties
```
public abstract java.lang.String[] properties
```
    Jakarta Messaging destination 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.
    
    Returns:
    
    The Jakarta Messaging destination properties.
    
    Default:
    
    {}

Annotation Type JMSDestinationDefinition

Required Element Summary

Optional Element Summary

Element Detail

name

interfaceName

description

className

resourceAdapter

destinationName

properties