Top Description Methods
jakarta.jms

public @Interface JMSDestinationDefinition

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
@Repeatable:JMSDestinationDefinitions
Imports
java.lang.annotation.ElementType, .Repeatable, .Retention, .RetentionPolicy, .Target

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
Version
Jakarta Messaging 2.0
See Also
jakarta.annotation.Resource

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The fully-qualified name of the Jakarta Messaging destination implementation class.
className
()

Fully-qualified name of the Jakarta Messaging destination implementation class.

public String

Returns:

The description of this Jakarta Messaging destination.
description
()

Description of this Jakarta Messaging destination.

public String

Returns:

The name of the queue or topic.
destinationName
()

Name of the queue or topic.

public String

Returns:

The fully qualified name of the Jakarta Messaging destination interface.
interfaceName
()

Fully qualified name of the Jakarta Messaging destination interface.

public String

Returns:

The JNDI name of the destination resource being defined.
name
()

JNDI name of the destination resource being defined.

public String[]

Returns:

The Jakarta Messaging destination properties.
properties
()

Jakarta Messaging destination property.

public String

Returns:

The resource adapter name.
resourceAdapter
()

Resource adapter name.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

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

The fully-qualified name of the Jakarta Messaging destination implementation class.

descriptionback to summary
public String description()

Description of this Jakarta Messaging destination.

Returns:String

The description of this Jakarta Messaging destination.

destinationNameback to summary
public String destinationName()

Name of the queue or topic.

Returns:String

The name of the queue or topic.

interfaceNameback to summary
public String interfaceName()

Fully qualified name of the Jakarta Messaging destination interface. Permitted values are jakarta.jms.Queue or jakarta.jms.Topic.

Returns:String

The fully qualified name of the Jakarta Messaging destination interface.

nameback to summary
public String name()

JNDI name of the destination resource being defined.

Returns:String

The JNDI name of the destination resource being defined.

propertiesback to summary
public 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:String[]

The Jakarta Messaging destination properties.

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.

Returns:String

The resource adapter name.