org.ow2.util.ee.metadata.ejbjar.api
Interface IEjbJarClassMetadata<E extends EJBDeployable<E>,D extends IEjbJarDeployableMetadata<E,D,C,M,F>,C extends IEjbJarClassMetadata<E,D,C,M,F>,M extends IEjbJarMethodMetadata<E,D,C,M,F>,F extends IEjbJarFieldMetadata<E,D,C,M,F>>

Type Parameters:

E - an implementation of EJBDeployable

D - an implementation of IEjbJarDeployableMetadata

C - an implementation of IEjbJarClassMetadata

M - an implementation of IEjbJarMethodMetadata

F - an implementation of IEjbJarFieldMetadata

All Superinterfaces:

IAnnotationResource, IAnnotationSecurityPermitAll, IAnnotationSecurityRolesAllowed, IClassMetadata<C,M,F>, ICommonClassMetadata<C,M,F>, IEjbAccessTimeout, IEjbEJB, IEJBInterceptors, IEjbStatefulTimeout, IEnvEntryAccess, IHandlerChain, IInterceptorExcludeDefaultInterceptors, ILock, IPersistenceContext, IPersistenceUnit, ISharedMetadata, ITransactionAttribute, IWebService, IWebServiceRef, IWebservicesCommonClassMetadata<C,M,F>, Serializable

public interface IEjbJarClassMetadata<E extends EJBDeployable<E>,D extends IEjbJarDeployableMetadata<E,D,C,M,F>,C extends IEjbJarClassMetadata<E,D,C,M,F>,M extends IEjbJarMethodMetadata<E,D,C,M,F>,F extends IEjbJarFieldMetadata<E,D,C,M,F>>
extends ITransactionAttribute, ILock, IEJBInterceptors, IAnnotationSecurityRolesAllowed, IAnnotationSecurityPermitAll, IInterceptorExcludeDefaultInterceptors, IWebservicesCommonClassMetadata<C,M,F>, IEnvEntryAccess, IEjbAccessTimeout, IEjbStatefulTimeout, Serializable

IEjbJarClassMetadata.

Author:

Gael Lalire

Method Summary

IJInterceptors	getAnnotationInterceptors()
IApplicationException	getApplicationException()
String	getClassName()
IConcurrencyManagementType	getConcurrencyManagementType()
List<String>	getDeclareRoles()
IDependsOn	getDependsOn()
D	getEjbJarDeployableMetadata()
Map<InterceptorType,List<? extends IJClassInterceptor>>	getExternalUserEasyBeansInterceptors()
List<? extends IJClassInterceptor>	getGlobalEasyBeansInterceptors()
String[]	getInterfaces()
Map<InterceptorType,List<? extends IJClassInterceptor>>	getInternalUserEasyBeansInterceptors()
IJCommonBean	getJCommonBean()
IJMessageDriven	getJMessageDriven()
IJSingleton	getJSingleton()
IJStateful	getJStateful()
IJStateless	getJStateless()
String	getLinkedBean()
C	getLinkedClassMetadata(String className) Get a classmetadata linked from this one.
String	getLocalHome()
IJLocal	getLocalInterfaces()
String	getRemoteHome()
String	getRemoteInterface()
IJRemote	getRemoteInterfaces()
List<String>	getRolesAllowed()
List<ISecurityRoleRef>	getSecurityRoleRefList() Gets the list of <security-role-ref> elements.
String	getSuperName()
javax.ejb.TransactionAttributeType	getTransactionAttributeType()
javax.ejb.TransactionManagementType	getTransactionManagementType()
boolean	hasPermitAll()
boolean	hasSessionSynchronization()
boolean	isBean()
boolean	isExcludedDefaultInterceptors()
boolean	isLocalBean()
boolean	isMdb()
boolean	isOrderedInterceptors()
boolean	isSession()
boolean	isSingleton()
boolean	isStartup()
boolean	isStateful()
boolean	isStateless()
void	setAnnotationsInterceptors(IJInterceptors annotationInterceptors) Sets the object representing the @javax.interceptor.Interceptors annotation.
void	setApplicationException(IApplicationException applicationException) Sets the object representing the @ApplicationException annotation.
void	setClassType(ClassType cType) Sets the type of this class.
void	setConcurrencyManagementType(IConcurrencyManagementType concurrencyManagementType) Sets concurrency management type.
void	setDeclareRoles(List<String> declareRoles) Sets the list of roles declared on this class.
void	setDependsOn(IDependsOn dependsOn) Sets the object representing the @ javax.ejb.DependsOn annotation.
void	setEjbJarArchiveMetadata(D ejbJarArchiveMetadata) Set the deployable metadata.
void	setExcludeDefaultInterceptors(boolean excludeDefaultInterceptors) Flag this class as a class which exclude default interceptors.
void	setExternalUserInterceptors(Map<InterceptorType,List<? extends IJClassInterceptor>> externalUserInterceptors) Sets the list of user interceptors that enhancers will use. These interceptors are defined outside the bean class (interceptor classes).
void	setGlobalEasyBeansInterceptors(List<? extends IJClassInterceptor> globalEasyBeansInterceptors) Sets the list of global interceptors that enhancers will use.
void	setInterfaces(String[] array) construct a new JClass.
void	setInternalUserInterceptors(Map<InterceptorType,List<? extends IJClassInterceptor>> internalUserInterceptors) Sets the list of user interceptors that enhancers will use. These interceptors are defined in bean class.
void	setJCommonBean(IJCommonBean commonBean) Sets the attributes for a Stateless/Stateful/MDB.
void	setJMessageDriven(IJMessageDriven messageDriven) Sets the message driven bean object.
void	setJSingleton(IJSingleton jSingleton) Sets the attributes for a Singleton.
void	setJStateful(IJStateful jStateful) Sets the attributes for a Stateful.
void	setJStateless(IJStateless jStateless) Sets the attributes for a Stateless.
void	setLinkedBean(String linkedBeanName) This class is linked to the given bean.
void	setLocalBean(boolean isLocalBean) Defines if the bean is a local bean or not.
void	setLocalHome(String localHome) Sets the @LocalHome class name.
void	setLocalInterfaces(IJLocal jLocal) Sets the local interfaces of this class.
void	setModified() Defines that this class has been modified.
void	setOrderedInterceptors(boolean orderedInterceptors) Sets flag to true if interceptors are ordered.
void	setPermitAll(boolean permitAll) This class has PermitAll annotation.
void	setRemoteHome(String remoteHome) Sets the @RemoteHome class name.
void	setRemoteInterface(String remoteInterface) Set the value of the remote Interface property.
void	setRemoteInterfaces(IJRemote jRemote) Sets the remote interfaces of this class.
void	setRolesAllowed(List<String> rolesAllowed) Set the list of roles allowed on this class/method.
void	setSecurityRoleRefList(List<ISecurityRoleRef> securityRoleRefList) Sets the list of <security-role-ref> element.
void	setSessionSynchronization() This bean is linked to a session synchronization and then should report TX lifecycle to the callbacks.
void	setStartup(boolean startup) This class needs eager initialization.
void	setTransactionAttributeType(javax.ejb.TransactionAttributeType transactionAttributeType) Set Transaction Attribute Type.
void	setTransactionManagementType(javax.ejb.TransactionManagementType transactionManagementType) Sets transaction management type.
boolean	wasModified()

Methods inherited from interface org.ow2.util.ee.metadata.ejbjar.api.ILock

getLockType, setLockType

Methods inherited from interface org.ow2.util.ee.metadata.common.api.ICommonClassMetadata

getJAnnotationResources, getJAnnotationSqlDataSourceDefinitions, getJavaxPersistencePersistenceContexts, getJavaxPersistencePersistenceUnits, getJaxwsWebServiceRefs, getJEjbEJBs, getManagedBeanName, getRunAs, isManagedBean, setJAnnotationResources, setJAnnotationSqlDataSourceDefinitions, setJavaxPersistencePersistenceContexts, setJavaxPersistencePersistenceUnits, setJaxwsWebServiceRefs, setJEjbEJBs, setManagedBeanName, setRunAs

Methods inherited from interface org.ow2.util.scan.api.metadata.IClassMetadata

addStandardFieldMetadata, addStandardMethodMetadata, getJClass, getStandardFieldMetadata, getStandardFieldMetadataCollection, getStandardMethodMetadata, getStandardMethodMetadataCollection, searchStandardFieldMetadata, searchStandardMethodMetadata, setJClass

Methods inherited from interface org.ow2.util.ee.metadata.common.api.interfaces.IEjbEJB

getJEjbEJB, setJEjbEJB

Methods inherited from interface org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationResource

getJAnnotationResource, setJAnnotationResource

Methods inherited from interface org.ow2.util.ee.metadata.common.api.interfaces.IPersistenceContext

getJavaxPersistenceContext, isPersistenceContext, setJavaxPersistenceContext

Methods inherited from interface org.ow2.util.ee.metadata.common.api.interfaces.IPersistenceUnit

getJavaxPersistenceUnit, isPersistenceUnit, setJavaxPersistenceUnit

Methods inherited from interface org.ow2.util.ee.metadata.common.api.interfaces.IWebServiceRef

getJaxwsWebServiceRef, setJaxwsWebServiceRef

Methods inherited from interface org.ow2.util.ee.metadata.common.api.interfaces.IHandlerChain

getJwsHandlerChain, setJwsHandlerChain

Methods inherited from interface org.ow2.util.ee.metadata.ws.api.interfaces.IWebService

getWebServiceMarker, setWebServiceMarker

Methods inherited from interface org.ow2.util.ee.metadata.common.api.interfaces.IEnvEntryAccess

getEnvEntryCollection, setEnvEntryCollection

Methods inherited from interface org.ow2.util.ee.metadata.ejbjar.api.interfaces.IEjbAccessTimeout

getJavaxEjbAccessTimeout, setJavaxEjbAccessTimeout

Methods inherited from interface org.ow2.util.ee.metadata.ejbjar.api.interfaces.IEjbStatefulTimeout

getJavaxEjbStatefulTimeout, setJavaxEjbStatefulTimeout

Method Detail

getClassName

String getClassName()

Returns:

name of the bean (associated to this metadata).

setLocalInterfaces

void setLocalInterfaces(IJLocal jLocal)

Sets the local interfaces of this class.

Parameters:

jLocal - list of interfaces.

setRemoteInterfaces

void setRemoteInterfaces(IJRemote jRemote)

Sets the remote interfaces of this class.

Parameters:

jRemote - list of interfaces.

getLocalInterfaces

IJLocal getLocalInterfaces()

Returns:

the local interfaces of this class.

getRemoteInterfaces

IJRemote getRemoteInterfaces()

Returns:

the remote interfaces of this class.

isStateless

boolean isStateless()

Returns:

true if the class is a stateless class

isSingleton

boolean isSingleton()

Returns:

true if the class is a singleton class

isStateful

boolean isStateful()

Returns:

true if the class is a stateful class

isSession

boolean isSession()

Returns:

true if the class is a session bean class

isMdb

boolean isMdb()

Returns:

true if the class is an MDB class

isLocalBean

boolean isLocalBean()

Returns:

true if the class is a local bean.

setLocalBean

void setLocalBean(boolean isLocalBean)

Defines if the bean is a local bean or not.

Parameters:

isLocalBean - true if the bean is a local bean (and expose a no-interface local view)

setClassType

void setClassType(ClassType cType)

Sets the type of this class.

Parameters:

cType - a type from enum class ClassType.

See Also:

org.ow2.easybeans.deployment.annotations.ClassType

getJMessageDriven

IJMessageDriven getJMessageDriven()

Returns:

Message driven attribute.

setJMessageDriven

void setJMessageDriven(IJMessageDriven messageDriven)

Sets the message driven bean object.

Parameters:

messageDriven - attributes of message driven bean.

getRemoteHome

String getRemoteHome()

Returns:

the @RemoteHome class name.

setRemoteHome

void setRemoteHome(String remoteHome)

Sets the @RemoteHome class name.

Parameters:

remoteHome - the class name.

getLocalHome

String getLocalHome()

Returns:

the @LocalHome class name.

setLocalHome

void setLocalHome(String localHome)

Sets the @LocalHome class name.

Parameters:

localHome - the class name.

getTransactionManagementType

javax.ejb.TransactionManagementType getTransactionManagementType()

Returns:

transaction management type from @see TransactionManagementType.

setTransactionManagementType

void setTransactionManagementType(javax.ejb.TransactionManagementType transactionManagementType)

Sets transaction management type.

Parameters:

transactionManagementType - value. (BEAN, CONTAINER)

See Also:

TransactionManagementType

getConcurrencyManagementType

IConcurrencyManagementType getConcurrencyManagementType()

Returns:

transaction management type from

See Also:

javax.ejb.ConcurrencyManagementType.

setConcurrencyManagementType

void setConcurrencyManagementType(IConcurrencyManagementType concurrencyManagementType)

Sets concurrency management type.

Parameters:

concurrencyManagementType - value. BEAN,CONCURRENCY_NOT_ALLOWED, CONTAINER

See Also:

javax.ejb.ConcurrencyManagementType

getTransactionAttributeType

javax.ejb.TransactionAttributeType getTransactionAttributeType()

Specified by:

getTransactionAttributeType in interface ITransactionAttribute

Returns:

transaction Attribute type.

See Also:

TransactionAttributeType

setTransactionAttributeType

void setTransactionAttributeType(javax.ejb.TransactionAttributeType transactionAttributeType)

Set Transaction Attribute Type.

Specified by:

setTransactionAttributeType in interface ITransactionAttribute

Parameters:

transactionAttributeType - the type of transaction.

See Also:

TransactionAttributeType

getAnnotationInterceptors

IJInterceptors getAnnotationInterceptors()

Returns:

object representing list of @javax.interceptor.Interceptors.

setAnnotationsInterceptors

void setAnnotationsInterceptors(IJInterceptors annotationInterceptors)

Sets the object representing the @javax.interceptor.Interceptors annotation.

Specified by:

setAnnotationsInterceptors in interface IEJBInterceptors

Parameters:

annotationInterceptors - list of classes

getApplicationException

IApplicationException getApplicationException()

Returns:

the @ApplicationException annotation.

setApplicationException

void setApplicationException(IApplicationException applicationException)

Sets the object representing the @ApplicationException annotation.

Parameters:

applicationException - object representation

isBean

boolean isBean()

Returns:

true if the class is a Bean

getInterfaces

String[] getInterfaces()

Returns:

array of interfaces name.

getSuperName

String getSuperName()

Returns:

the super class name.

getExternalUserEasyBeansInterceptors

Map<InterceptorType,List<? extends IJClassInterceptor>> getExternalUserEasyBeansInterceptors()

Returns:

Map<interceptor type <--> List of methods/class corresponding to the interceptor> (interceptor classes) of user interceptors that enhancer will use.

setExternalUserInterceptors

void setExternalUserInterceptors(Map<InterceptorType,List<? extends IJClassInterceptor>> externalUserInterceptors)

Sets the list of user interceptors that enhancers will use.
These interceptors are defined outside the bean class (interceptor classes).

Parameters:

externalUserInterceptors - list of interceptors that enhancer will use.

getInternalUserEasyBeansInterceptors

Map<InterceptorType,List<? extends IJClassInterceptor>> getInternalUserEasyBeansInterceptors()

Returns:

Map<interceptor type <--> List of methods/class corresponding to the interceptor> (bean classes) of user interceptors that enhancer will use.

setInternalUserInterceptors

void setInternalUserInterceptors(Map<InterceptorType,List<? extends IJClassInterceptor>> internalUserInterceptors)

Sets the list of user interceptors that enhancers will use.
These interceptors are defined in bean class.

Parameters:

internalUserInterceptors - list of interceptors that enhancer will use.

getGlobalEasyBeansInterceptors

List<? extends IJClassInterceptor> getGlobalEasyBeansInterceptors()

Returns:

list of global interceptors that enhancer will use. (ie : ENC)

setGlobalEasyBeansInterceptors

void setGlobalEasyBeansInterceptors(List<? extends IJClassInterceptor> globalEasyBeansInterceptors)

Sets the list of global interceptors that enhancers will use.

Parameters:

globalEasyBeansInterceptors - list of interceptors that enhancer will use.

getJCommonBean

IJCommonBean getJCommonBean()

Returns:

the attributes for a Stateless/Stateful/MDB

setJCommonBean

void setJCommonBean(IJCommonBean commonBean)

Sets the attributes for a Stateless/Stateful/MDB.

Parameters:

commonBean - the attributes

getJStateful

IJStateful getJStateful()

Returns:

the attributes for a Stateful

setJStateful

void setJStateful(IJStateful jStateful)

Sets the attributes for a Stateful.

Parameters:

jStateful - the attributes

getJStateless

IJStateless getJStateless()

Returns:

the attributes for a Stateless

setJStateless

void setJStateless(IJStateless jStateless)

Sets the attributes for a Stateless.

Parameters:

jStateless - the attributes

getJSingleton

IJSingleton getJSingleton()

Returns:

the attributes for a Singleton

setJSingleton

void setJSingleton(IJSingleton jSingleton)

Sets the attributes for a Singleton.

Parameters:

jSingleton - the attributes

wasModified

boolean wasModified()

Returns:

true if the class has been modified.

setModified

void setModified()

Defines that this class has been modified.

setDeclareRoles

void setDeclareRoles(List<String> declareRoles)

Sets the list of roles declared on this class.

Parameters:

declareRoles - the list of roles.

getDeclareRoles

List<String> getDeclareRoles()

Returns:

the list of roles declared on this class.

getSecurityRoleRefList

List<ISecurityRoleRef> getSecurityRoleRefList()

Gets the list of <security-role-ref> elements.

Returns:

list of <security-role-ref> elements.

setSecurityRoleRefList

void setSecurityRoleRefList(List<ISecurityRoleRef> securityRoleRefList)

Sets the list of <security-role-ref> element.

Parameters:

securityRoleRefList - the list of <security-role-ref> element

setRolesAllowed

void setRolesAllowed(List<String> rolesAllowed)

Set the list of roles allowed on this class/method.

Specified by:

setRolesAllowed in interface IAnnotationSecurityRolesAllowed

Parameters:

rolesAllowed - the list of roles.

getRolesAllowed

List<String> getRolesAllowed()

Specified by:

getRolesAllowed in interface IAnnotationSecurityRolesAllowed

Returns:

the list of roles allowed on this class/method.

setPermitAll

void setPermitAll(boolean permitAll)

This class has PermitAll annotation.

Specified by:

setPermitAll in interface IAnnotationSecurityPermitAll

Parameters:

permitAll - the boolean value.

hasPermitAll

boolean hasPermitAll()

Specified by:

hasPermitAll in interface IAnnotationSecurityPermitAll

Returns:

true if PermitAll annotation.

isExcludedDefaultInterceptors

boolean isExcludedDefaultInterceptors()

Specified by:

isExcludedDefaultInterceptors in interface IInterceptorExcludeDefaultInterceptors

Returns:

true if this class won't use default interceptors.

setExcludeDefaultInterceptors

void setExcludeDefaultInterceptors(boolean excludeDefaultInterceptors)

Flag this class as a class which exclude default interceptors.

Specified by:

setExcludeDefaultInterceptors in interface IInterceptorExcludeDefaultInterceptors

Parameters:

excludeDefaultInterceptors - true if this class is a class which exclude default interceptors.

isOrderedInterceptors

boolean isOrderedInterceptors()

Returns:

true if the interceptors have been ordered for this class.

setOrderedInterceptors

void setOrderedInterceptors(boolean orderedInterceptors)

Sets flag to true if interceptors are ordered.

Parameters:

orderedInterceptors - boolean with true/false.

setRemoteInterface

void setRemoteInterface(String remoteInterface)

Set the value of the remote Interface property.

Parameters:

remoteInterface - the remote Interface property.

getRemoteInterface

String getRemoteInterface()

Returns:

the name of the remote interface.

setInterfaces

void setInterfaces(String[] array)

construct a new JClass.

Parameters:

array - interface list

getEjbJarDeployableMetadata

D getEjbJarDeployableMetadata()

Returns:

the deployable

setEjbJarArchiveMetadata

void setEjbJarArchiveMetadata(D ejbJarArchiveMetadata)

Set the deployable metadata.

Parameters:

ejbJarArchiveMetadata - the given deployable metadata

getLinkedBean

String getLinkedBean()

Returns:

the name of the bean on which we are linked. This is used for cloned classmetadata that are for the classes.

setLinkedBean

void setLinkedBean(String linkedBeanName)

This class is linked to the given bean.

Parameters:

linkedBeanName - the bean name

getLinkedClassMetadata

C getLinkedClassMetadata(String className)

Get a classmetadata linked from this one.

Parameters:

className - the name of the class that is wanted

Returns:

the class metadata

setStartup

void setStartup(boolean startup)

This class needs eager initialization.

Parameters:

startup - the boolean value.

isStartup

boolean isStartup()

Returns:

true if this class(singleton) needs eager initialization.

getDependsOn

IDependsOn getDependsOn()

Returns:

object representing list of @ javax.interceptor.DependsOn.

setDependsOn

void setDependsOn(IDependsOn dependsOn)

Sets the object representing the @ javax.ejb.DependsOn annotation.

Parameters:

dependsOn - list of beans

setSessionSynchronization

void setSessionSynchronization()

This bean is linked to a session synchronization and then should report TX lifecycle to the callbacks.

hasSessionSynchronization

boolean hasSessionSynchronization()

Returns:

true if the bean is part of a session synchronization