javax.jms.JMSDestinationDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ow2-jms-2.0-spec Show documentation
The Java Message Service (JMS) API, version 2.0
The newest version!
/**
 * Copyright 2013 ScalAgent Distributed Technologies
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  ---------------------------------------------------------------------
 *  $Id: JMSDestinationDefinition.java 6347 2013-03-13 08:52:02Z tachker $
 *  ---------------------------------------------------------------------
 */
package javax.jms;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * An application may use this annotation to specify a JMS {@code  Destination}
 * resource that it requires in its running environment. This furnish
 * 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 {@code Destination} resource may be configured by setting the annotation
 * elements for commonly used properties. Additional properties may be specified
 * using the {@code properties} element. Once defined, a {@code Destination}
 * resource may be referenced by a component in the same way as any other
 * {@code Destination} resource, for example by using the {@code lookup} element
 * of the {@code Resource} annotation.
 * 
 * @see javax.annotation.Resource
 * 
 * @version JMS 2.0
 * @since JMS 2.0
 * 
 */
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface JMSDestinationDefinition {

  /**
   * Description of this JMS destination.
   */
  String description() default "";

  /**
   * JNDI name of the destination resource being defined.
   */
  String name();

  /**
   * Fully qualified name of the JMS destination interface. Permitted values are
   * {@code javax.jms.Queue} or {@code javax.jms.Topic}.
   */
  String interfaceName();

  /**
   * 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
   */
  String className() default "";

  /**
   * 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.
   */
  String resourceAdapter() default "";

  /**
   * Name of the queue or topic.
   */
  String destinationName() default "";

  /**
   * JMS destination property. This may be a vendor-specific property or a less
   * commonly used {@code ConnectionFactory} property.
   * 
   * Properties are specified using the format:
   * propertyName=propertyValue with one property per array element.
   */
  String[] properties() default {};
}