org.ow2.util.ee.metadata.ejbjar.api
Interface IEjbJarMethodMetadata<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, ICommonMethodMetadata<C,M,F>, IEjbAccessTimeout, IEjbEJB, IEJBInterceptors, IEjbSchedule, IHandlerChain, IInterceptorExcludeDefaultInterceptors, ILock, IMethodMetadata<C,M,F>, IPersistenceContext, IPersistenceUnit, ISharedMetadata, ITransactionAttribute, IWebMethod, IWebServiceRef, Serializable

public interface IEjbJarMethodMetadata<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 ICommonMethodMetadata<C,M,F>, ITransactionAttribute, IEJBInterceptors, ILock, IEjbAccessTimeout, IEjbSchedule, IWebMethod, IAnnotationSecurityRolesAllowed, IAnnotationSecurityPermitAll, IInterceptorExcludeDefaultInterceptors

Interface of the Method Metadata for EJB.

Author:

Gael Lalire

Method Summary

IJInterceptors	getAnnotationInterceptors()
List<? extends IJClassInterceptor>	getGlobalEasyBeansInterceptors()
javax.ejb.Remove	getJRemove()
String	getMethodName()
List<String>	getRolesAllowed()
TransactionAttributeLevel	getTransactionAttributeLevel()
javax.ejb.TransactionAttributeType	getTransactionAttributeType()
Map<InterceptorType,List<? extends IJClassInterceptor>>	getUserEasyBeansInterceptors()
boolean	hasDenyAll()
boolean	hasPermitAll()
boolean	isAfterBegin()
boolean	isAfterCompletion()
boolean	isAroundInvoke()
boolean	isBeforeCompletion()
boolean	isBusinessMethod()
boolean	isExcludedClassInterceptors()
boolean	isExcludedDefaultInterceptors()
boolean	isLifeCycleMethod()
boolean	isPostActivate()
boolean	isPrePassivate()
boolean	isTimeout()
void	setAfterBegin() Sets true if method is an afterBegin method.
void	setAfterCompletion() Sets true if method is an AfterCompletion method.
void	setAnnotationsInterceptors(IJInterceptors annotationInterceptors) Sets the object representing the @javax.interceptor.Interceptors annotation.
void	setAroundInvoke(boolean aroundInvoke) Sets true if method has @javax.interceptor.AroundInvoke.
void	setBeforeCompletion() Sets true if method is an beforeCompletion method.
void	setBusinessMethod(boolean flag) This method is a business method.
void	setDenyAll(boolean denyAll) This method has DenyAll annotation.
void	setExcludeClassInterceptors(boolean excludeClassInterceptors) Flag this method as a method which exclude user interceptors.
void	setExcludeDefaultInterceptors(boolean excludeDefaultInterceptors) Flag this class as a class which exclude default interceptors.
void	setGlobalEasyBeansInterceptors(List<? extends IJClassInterceptor> globalEasyBeansInterceptors) Sets the list of global interceptors that enhancers will use.
void	setPermitAll(boolean permitAll) This method has PermitAll annotation.
void	setPostActivate(boolean postActivate) Sets true if method has @PostActivate.
void	setPrePassivate(boolean prePassivate) Sets true if method has @PrePassivate.
void	setRemove(javax.ejb.Remove remove) Sets @Remove attribute.
void	setRolesAllowed(List<String> rolesAllowed) Set the list of roles allowed on this class/method.
void	setTimeout(boolean timeout) Sets true if method has @Timeout.
void	setTransactionAttributeLevel(TransactionAttributeLevel transactionAttributeLevel) Sets Transaction Attribute Level.
void	setTransactionAttributeType(javax.ejb.TransactionAttributeType transactionAttributeType) Sets Transaction Attribute Type.
void	setUserInterceptors(Map<InterceptorType,List<? extends IJClassInterceptor>> userInterceptors) Sets the list of user interceptors that enhancers will use. These interceptors are defined in bean class.

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

isPostConstruct, isPreDestroy, setPostConstruct, setPreDestroy

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.scan.api.metadata.IMethodMetadata

getClassMetadata, getJMethod, setClassMetadata, setJMethod

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

getLockType, setLockType

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.IEjbSchedule

addJavaxEjbSchedule, getJavaxEjbSchedules, setJavaxEjbSchedules

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

getJavaxJwsWebMethod, setJavaxJwsWebMethod

Method Detail

getMethodName

String getMethodName()

Returns:

name of the method

getTransactionAttributeType

javax.ejb.TransactionAttributeType getTransactionAttributeType()

Specified by:

getTransactionAttributeType in interface ITransactionAttribute

Returns:

transaction Attribute type.

See Also:

TransactionAttributeType

setTransactionAttributeLevel

void setTransactionAttributeLevel(TransactionAttributeLevel transactionAttributeLevel)

Sets Transaction Attribute Level.

Parameters:

transactionAttributeLevel - the level of transaction.

getTransactionAttributeLevel

TransactionAttributeLevel getTransactionAttributeLevel()

Returns:

transaction Attribute Level.

setTransactionAttributeType

void setTransactionAttributeType(javax.ejb.TransactionAttributeType transactionAttributeType)

Sets Transaction Attribute Type.

Specified by:

setTransactionAttributeType in interface ITransactionAttribute

Parameters:

transactionAttributeType - the type of transaction.

See Also:

TransactionAttributeType

isBusinessMethod

boolean isBusinessMethod()

Returns:

true if the method is a business method.

setBusinessMethod

void setBusinessMethod(boolean flag)

This method is a business method.

Parameters:

flag - true/false if method is a business method.

isLifeCycleMethod

boolean isLifeCycleMethod()

Returns:

true if the method is a lifecycle method.

getJRemove

javax.ejb.Remove getJRemove()

Returns:

remove attributes @Remove attributes

setRemove

void setRemove(javax.ejb.Remove remove)

Sets @Remove attribute.

Parameters:

remove - contains the attribute with retainIfException.

isPostActivate

boolean isPostActivate()

Returns:

true if method has @PostActivate

setPostActivate

void setPostActivate(boolean postActivate)

Sets true if method has @PostActivate.

Parameters:

postActivate - true/false.

isPrePassivate

boolean isPrePassivate()

Returns:

true if method has @PrePassivate.

setPrePassivate

void setPrePassivate(boolean prePassivate)

Sets true if method has @PrePassivate.

Parameters:

prePassivate - true/false.

isTimeout

boolean isTimeout()

Returns:

true if method has @Timeout.

setTimeout

void setTimeout(boolean timeout)

Sets true if method has @Timeout.

Parameters:

timeout - true/false.

isAroundInvoke

boolean isAroundInvoke()

Returns:

true if method has @javax.interceptor.AroundInvoke.

setAroundInvoke

void setAroundInvoke(boolean aroundInvoke)

Sets true if method has @javax.interceptor.AroundInvoke.

Parameters:

aroundInvoke - true/false

isExcludedClassInterceptors

boolean isExcludedClassInterceptors()

Returns:

true if this method won't use user interceptors.

setExcludeClassInterceptors

void setExcludeClassInterceptors(boolean excludeClassInterceptors)

Flag this method as a method which exclude user interceptors.

Parameters:

excludeClassInterceptors - true if this method is a method which exclude user interceptors.

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

getUserEasyBeansInterceptors

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

Returns:

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

setUserInterceptors

void setUserInterceptors(Map<InterceptorType,List<? extends IJClassInterceptor>> userInterceptors)

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

Parameters:

userInterceptors - list of interceptors that enhancer will use.

getGlobalEasyBeansInterceptors

List<? extends IJClassInterceptor> getGlobalEasyBeansInterceptors()

Returns:

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

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.

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 method 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.

setDenyAll

void setDenyAll(boolean denyAll)

This method has DenyAll annotation.

Parameters:

denyAll - the boolean value.

hasDenyAll

boolean hasDenyAll()

Returns:

true if DenyAll 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.

isAfterBegin

boolean isAfterBegin()

Returns:

true if method is an afterBegin method.

setAfterBegin

void setAfterBegin()

Sets true if method is an afterBegin method.

isAfterCompletion

boolean isAfterCompletion()

Returns:

true if method is an AfterCompletion method.

setAfterCompletion

void setAfterCompletion()

Sets true if method is an AfterCompletion method.

isBeforeCompletion

boolean isBeforeCompletion()

Returns:

true if method is an beforeCompletion method.

setBeforeCompletion

void setBeforeCompletion()

Sets true if method is an beforeCompletion method.