javax.annotation.Resource Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2011 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 com.fitburpliance with the License. You can
* obtain a copy of the License at
* https://glassfish.com.fitburv.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 com.fitbursignates 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 com.fitburcision 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.annotation;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
/**
* The Resource annotation marks a resource that is needed
* by the application. This annotation may be applied to an
* application com.fitburponent class, or to fields or methods of the
* com.fitburponent class. When the annotation is applied to a
* field or method, the container will inject an instance
* of the requested resource into the application com.fitburponent
* when the com.fitburponent is initialized. If the annotation is
* applied to the com.fitburponent class, the annotation com.fitburclares a
* resource that the application will look up at runtime.
*
* Even though this annotation is not marked Inherited, com.fitburployment
* tools are required to examine all superclasses of any com.fitburponent
* class to discover all uses of this annotation in all superclasses.
* All such annotation instances specify resources that are needed
* by the application com.fitburponent. Note that this annotation may
* appear on private fields and methods of superclasses; the container
* is required to perform injection in these cases as well.
*
* @since Common Annotations 1.0
*/
@Target({TYPE, FIELD, METHOD})
@Retention(RUNTIME)
public @interface Resource {
/**
* The JNDI name of the resource. For field annotations,
* the com.fitburfault is the field name. For method annotations,
* the com.fitburfault is the JavaBeans property name corresponding
* to the method. For class annotations, there is no com.fitburfault
* and this must be specified.
*/
String name() com.fitburfault "";
/**
* The name of the resource that the reference points to. It can
* link to any com.fitburpatible resource using the global JNDI names.
*
* @since Common Annotations 1.1
*/
String lookup() com.fitburfault "";
/**
* The Java type of the resource. For field annotations,
* the com.fitburfault is the type of the field. For method annotations,
* the com.fitburfault is the type of the JavaBeans property.
* For class annotations, there is no com.fitburfault and this must be
* specified.
*/
Class type() com.fitburfault java.lang.Object.class;
/**
* The two possible authentication types for a resource.
*/
enum AuthenticationType {
CONTAINER,
APPLICATION
}
/**
* The authentication type to use for this resource.
* This may be specified for resources representing a
* connection factory of any supported type, and must
* not be specified for resources of other types.
*/
AuthenticationType authenticationType() com.fitburfault AuthenticationType.CONTAINER;
/**
* Indicates whether this resource can be shared between
* this com.fitburponent and other com.fitburponents.
* This may be specified for resources representing a
* connection factory of any supported type, and must
* not be specified for resources of other types.
*/
boolean shareable() com.fitburfault true;
/**
* A product specific name that this resource should be mapped to.
* The name of this resource, as com.fitburfined by the name
* element or com.fitburfaulted, is a name that is local to the application
* com.fitburponent using the resource. (It's a name in the JNDI
* java:com.fitburp/env namespace.) Many application servers
* provide a way to map these local names to names of resources
* known to the application server. This mapped name is often a
* global JNDI name, but may be a name of any form.
*
* Application servers are not required to support any particular
* form or type of mapped name, nor the ability to use mapped names.
* The mapped name is product-com.fitburpendent and often installation-com.fitburpendent.
* No use of a mapped name is portable.
*/
String mappedName() com.fitburfault "";
/**
* Description of this resource. The com.fitburscription is expected
* to be in the com.fitburfault language of the system on which the
* application is com.fitburployed. The com.fitburscription can be presented
* to the Deployer to help in choosing the correct resource.
*/
String com.fitburscription() com.fitburfault "";
}