Complete List of Metadata Annotations By Function

http://docs.oracle.com/cd/E23943_01/web.1111/e13720/annotations.htm#i1426084

A EJB 3.0 Metadata Annotations Reference

The following topics provide reference information about the EJB 3.0 metadata annotations:
•Overview of EJB 3.0 Annotations

•Annotations for Stateless, Stateful, and Message-Driven Beans

•Annotations Used to Configure Interceptors

•Annotations Used to Interact With Entity Beans

•Standard JDK Annotations Used By EJB 3.0

•Standard Security-Related JDK Annotations Used by EJB 3.0

•WebLogic Annotations



The new EJB 3.0 programming model uses the JDK 5.0 metadata annotations feature (described at http://java.sun.com/developer/technicalArticles/releases/j2se15)

Complete List of Metadata Annotations By Function

Appendix A, "EJB 3.0 Metadata Annotations Reference," provides full reference information about the EJB 3.0 metadata annotations in alphabetical order. The tables in this section group the annotations based on what task they perform.


Annotations to Specify the Bean Type

The following summarize the annotations used to specify the bean type.


Table 5-1 Annotations to Specify the Bean Type

Annotation

Description

@javax.ejb.Stateless
Specifies that the bean class is a stateless session bean. For more information, see javax.ejb.Stateless.

@javax.ejb.Stateful
Specifies that the bean class is a stateful session bean. For more information, see javax.ejb.Stateful.

@javax.ejb.Init
Specifies the correspondence of a stateful session bean class method with a create<METHOD> method for an adapted EJB 2.1 EJBHome and/or EJBLocalHome client view. For more information, see javax.ejb.Init.

@javax.ejb.Remove
Specifies a remove method of a stateful session bean. For more information, see javax.ejb.Remove.

@javax.ejb.MessageDriven
Specifies that the bean class is a message-driven bean. For more information, see javax.ejb.MessageDriven.

@javax.ejb.ActivationConfigProperty
Specifies properties used to configure a message-driven bean in its operational environment. For more information, see javax.ejb.ActivationConfigProperty.


Annotations to Specify the Local or Remote Interfaces
The following summarize the annotations used to specify the local or remote interfaces.
Table 5-2 Annotations to Specify the Local or Remote Interfaces

Annotation
Description

@javax.ejb.Local
Specifies a local interface of the bean. For more information, see javax.ejb.Local.

@javax.ejb.Remote
Specifies a remote interface of the bean. For more information, see javax.ejb.Remote.


Annotations to Support EJB 2.X Client View

The following summarize the annotations used to support EJB 2.x client view.
Table 5-3 Annotations to Support EJB 2.X Client View

Annotation

Description
@javax.ejb.LocalHome
Specifies a local home interface of the bean. For more information, see javax.ejb.LocalHome.

@javax.ejb.RemoteHome
Specifies a remote home interface of the bean. For more information, see javax.ejb.RemoteHome.

Annotations to Invoke a 3.0 Entity Bean
The following summarize the annotations used to invoke a 30 entity bean.

Table 5-4 Annotations to Invoke a 3.0 Entity Bean


Annotation

Description

@javax.persistence.PersistenceContext
Specifies a dependency on an EntityManager persistence context. For more information, see javax.persistence.PersistenceContext.

@javax.persistence.PersistenceContexts
Specifies one or more PersistenceContext annotations. For more information, see javax.persistence.PersistenceContexts.

@javax.persistence.PersistenceUnit
Specifies a dependency on an EntityManagerFactory. For more information, see javax.persistence.PersistenceUnit.

@javax.persistence.PersistenceUnits
Specifies one or more PersistenceUnit annotations. For more information, see javax.persistence.PersistenceUnits.


Transaction-Related Annotations

The following summarize the annotations used for transactions.

Table 5-5 Transaction-Related Annotations

Annotation

Description

@javax.ejb.TransactionManagement
Specifies the transaction management demarcation type (container- or bean-managed). For more information, see javax.ejb.TransactionManagement.



@javax.ejb.TransactionAttribute
Specifies whether a business method is invoked within the context of a transaction. For more information, see javax.ejb.TransactionManagement.


Annotations to Specify Interceptors
The following summarize the annotations used to specify interceptors.

Table 5-6 Annotations to Specify Interceptors

Annotation
Description

@javax.interceptor.Interceptors
Specifies the list of interceptor classes associated with a bean class or method. For more information, see javax.interceptor.Interceptors.


@javax.interceptor.AroundInvoke
Specifies an interceptor method. For more information, see javax.interceptor.AroundInvoke.



@javax.interceptor.ExcludeClassInterceptors
Specifies that, when the annotated method is invoked, the class-level interceptors should not invoke. For more information, see javax.interceptor.ExcludeClassInterceptors.

@javax.interceptor.ExcludeDefaultInterceptors
Specifies that, when the annotated method is invoked, the default interceptors should not invoke. For more information, see javax.interceptor.ExcludeDefaultInterceptors.


Annotations to Specify Life Cycle Callbacks

The following summarize the annotations used to specify life cycle callbacks.

Table 5-7 Annotations to Specify Life Cycle Callbacks
Annotation

Description

@javax.ejb.PostActivate
Designates a method to receive a callback after a stateful session bean has been activated. For more information, see javax.ejb.PostActivate.

@javax.ejb.PrePassivate
Designates a method to receive a callback before a stateful session bean is passivated. For more information, see javax.ejb.PrePassivate.



@javax.annotation.PostConstruct
Specifies the method that needs to be executed after dependency injection is done to perform any initialization. For more information, see javax.annotation.PostConstruct.



@javax.annotation.PreDestroy
Specifies a method to be a callback notification to signal that the instance is in the process of being removed by the container. For more information, see javax.annotation.PreDestroy.


Security-Related Annotations
The following metadata annotations are not specific to EJB 3.0, but rather, are general security-related annotations in the javax.annotation.security package.


Table 5-8 Security-Related Annotations
Annotation
Description

@javax.annotation.security.DeclareRoles
Specifies the references to security roles in the bean class. For more information, see javax.annotation.security.DeclareRoles.

@javax.annotation.security.RolesAllowed
Specifies the list of security roles that are allowed to invoke the bean's business methods. For more information, see javax.annotation.security.RolesAllowed.



@javax.annotation.security.PermitAll
Specifies that all security roles are allowed to invoke the method. For more information, see javax.annotation.security.PermitAll.

@javax.annotation.security.DenyAll
Specifies that no security roles are allowed to invoke the method. For more information, see javax.annotation.security.DenyAll.


@javax.annotation.security.RunAs
Specifies the security role which the method is run as. For more information, see javax.annotation.security.RunAs.

Context Dependency Annotations
The following summarize the annotations used for context dependency.


Table 5-9 Context Dependency Annotations

Annotation
Description

@javax.ejb.EJB
Specifies a dependency to an EJB business interface or home interface. For more information, see javax.ejb.EJB.

@javax.ejb.EJBs
Specifies one or more @EJB annotations. For more information, see javax.ejb.EJBs.

@javax.annotation.Resource
Specifies a dependency on an external resource in the bean's environment. For more information, see javax.annotation.Resource.

@javax.annotation.Resources
Specifies one or more @Resource annotations. For more information, see javax.annotation.Resources.


Timeout and Exceptions Annotations
The following summarize the annotations used for timeout and exceptions.

Table 5-10 Timeout and Exception Annotations
Annotation

Description
@javax.ejb.Timeout
Specifies the timeout method of the bean class. For more information, see javax.ejb.Timeout.

@javax.ejb.ApplicationException
Specifies that an exception is an application exception and should be reported to the client directly. For more information, see javax.ejb.ApplicationException.