Top Description Methods
javax.jms

public @Interface JMSDestinationDefinition

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target
An application may use this annotation to specify a JMS 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
Version
JMS 2.0
See Also
javax.annotation.Resource

Method Summary

Modifier and TypeMethod and Description
public String
className()

Fully-qualified name of the JMS destination implementation class.

public String
description()

Description of this JMS destination.

public String
destinationName()

Name of the queue or topic.

public String
interfaceName()

Fully qualified name of the JMS destination interface.

public String
name()

JNDI name of the destination resource being defined.

public String[]
properties()

JMS destination property.

public String
resourceAdapter()

Resource adapter name.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

classNameback to summary
public 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

descriptionback to summary
public String description()

Description of this JMS destination.

destinationNameback to summary
public String destinationName()

Name of the queue or topic.

interfaceNameback to summary
public String interfaceName()

Fully qualified name of the JMS destination interface. Permitted values are javax.jms.Queue or javax.jms.Topic.

nameback to summary
public String name()

JNDI name of the destination resource being defined.

propertiesback to summary
public String[] properties()

JMS 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.

resourceAdapterback to summary
public 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.