Oracle GlassFish(tm) Server Message Queue
5.0

javax.jms
Annotation Type JMSDestinationDefinition


@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface JMSDestinationDefinition

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.

See Also:
javax.annotation.Resource

Required Element Summary
 java.lang.String className
          JMS destination implementation class name which implements: javax.jms.Queue or javax.jms.Topic
 java.lang.String name
          JNDI name of the destination resource being defined.
 
Optional Element Summary
 java.lang.String description
          Description of this JMS Destination.
 java.lang.String destinationName
          Name of the queue or topic.
 java.lang.String[] properties
          JMS destination property.
 java.lang.String resourceAdapterName
          Resource adapter name.
 

Element Detail

name

public abstract java.lang.String name
JNDI name of the destination resource being defined.


className

public abstract java.lang.String className
JMS destination implementation class name which implements: javax.jms.Queue or javax.jms.Topic

description

public abstract java.lang.String description
Description of this JMS Destination.

Default:
""

resourceAdapterName

public abstract java.lang.String resourceAdapterName
Resource adapter name.

Default:
""

destinationName

public abstract java.lang.String destinationName
Name of the queue or topic.

Default:
""

properties

public abstract java.lang.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.

Default:
{}

Oracle GlassFish(tm) Server Message Queue
5.0

Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.