javax.jms.JMSConnectionFactoryDefinition Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
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
* ConnectionFactory} 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 {@code ConnectionFactory} 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 ConnectionFactory} resource may be referenced by a
* component in the same way as any other {@code ConnectionFactory} resource,
* for example by using the {@code lookup} element of the {@code Resource}
* annotation.
*
* @version JMS 2.0
* @since JMS 2.0
*
* @see javax.annotation.Resource
*/
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface JMSConnectionFactoryDefinition {
/**
* Description of this JMS connection factory.
*/
String description() default "";
/**
* JNDI name of the JMS connection factory being defined.
*/
String name();
/**
* Fully qualified name of the JMS connection factory interface.
* Permitted values are
* {@code javax.jms.ConnectionFactory} or
* {@code javax.jms.QueueConnectionFactory} or
* {@code javax.jms.TopicConnectionFactory}.
* If not specified then {@code javax.jms.ConnectionFactory} will be used.
*/
String interfaceName() default "javax.jms.ConnectionFactory";
/**
* Fully-qualified name of the JMS connection factory implementation class.
* Ignored if a resource adapter is used.
*/
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 "";
/**
* User name to use for connection authentication.
*/
String user() default "";
/**
* Password to use for connection authentication.
*/
String password() default "";
/**
* Client id to use for connection.
*/
String clientId() default "";
/**
* JMS connection factory 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 {};
/**
* Set to {@code false} if connections should not participate in
* transactions.
*
* Default is to enlist in a transaction when one is active or becomes
* active.
*/
boolean transactional() default true;
/**
* Maximum number of connections that should be concurrently allocated for a
* connection pool.
*
* Default is vendor-specific.
*/
int maxPoolSize() default -1;
/**
* Minimum number of connections that should be concurrently allocated for a
* connection pool.
*
* Default is vendor-specific.
*/
int minPoolSize() default -1;
}