org.ow2.util.ee.metadata.ejbjar.api
Interface IEjbJarClassMetadata<E extends org.ow2.util.ee.deploy.api.deployable.EJBDeployable<E>>

Type Parameters:

E - type of deployable

All Superinterfaces:

org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationSecurityPermitAll, org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationSecurityRolesAllowed, org.ow2.util.ee.metadata.common.api.interfaces.IEJBInterceptors, org.ow2.util.ee.metadata.common.api.interfaces.IInterceptorExcludeDefaultInterceptors, org.ow2.util.ee.metadata.common.api.interfaces.ITransactionAttribute

public interface IEjbJarClassMetadata<E extends org.ow2.util.ee.deploy.api.deployable.EJBDeployable<E>>
extends org.ow2.util.ee.metadata.common.api.interfaces.ITransactionAttribute, org.ow2.util.ee.metadata.common.api.interfaces.IEJBInterceptors, org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationSecurityRolesAllowed, org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationSecurityPermitAll, org.ow2.util.ee.metadata.common.api.interfaces.IInterceptorExcludeDefaultInterceptors

IEjbJarClassMetadata.

Author:

Gael Lalire

Method Summary

org.ow2.util.ee.metadata.common.api.struct.IJInterceptors	getAnnotationInterceptors()
javax.ejb.ApplicationException	getApplicationException()
java.lang.String	getClassName()
java.util.List<java.lang.String>	getDeclareRoles()
IEjbJarDeployableMetadata<E>	getEjbJarArchiveMetadata()
java.util.Map<InterceptorType,java.util.List<IJClassInterceptor>>	getExternalUserEasyBeansInterceptors()
java.util.List<IJClassInterceptor>	getGlobalEasyBeansInterceptors()
java.lang.String[]	getInterfaces()
java.util.Map<InterceptorType,java.util.List<IJClassInterceptor>>	getInternalUserEasyBeansInterceptors()
IJMessageDriven	getJMessageDriven()
java.lang.String	getLocalHome()
IJLocal	getLocalInterfaces()
java.lang.String	getRemoteHome()
java.lang.String	getRemoteInterface()
IJRemote	getRemoteInterfaces()
java.util.List<java.lang.String>	getRolesAllowed()
java.lang.String	getRunAs()
java.lang.String	getSuperName()
javax.ejb.TransactionAttributeType	getTransactionAttributeType()
javax.ejb.TransactionManagementType	getTransactionManagementType()
boolean	hasPermitAll()
boolean	isAroundInvokeMethodMetadata()
boolean	isBean()
boolean	isExcludedDefaultInterceptors()
boolean	isInterceptor() Is that this class is an interceptor class ?
boolean	isMdb()
boolean	isOrderedInterceptors()
boolean	isSession()
boolean	isStateful()
boolean	isStateless()
void	setAnnotationsInterceptors(org.ow2.util.ee.metadata.common.api.struct.IJInterceptors annotationInterceptors) Sets the object representing the @javax.interceptor.Interceptors annotation.
void	setApplicationException(javax.ejb.ApplicationException applicationException) Sets the object representing the @ApplicationException annotation.
void	setClassType(ClassType cType) Sets the type of this class.
void	setDeclareRoles(java.util.List<java.lang.String> declareRoles) Sets the list of roles declared on this class.
void	setExcludeDefaultInterceptors(boolean excludeDefaultInterceptors) Flag this class as a class which exclude default interceptors.
void	setExternalUserInterceptors(java.util.Map<InterceptorType,java.util.List<IJClassInterceptor>> externalUserInterceptors) Sets the list of user interceptors that enhancers will use. These interceptors are defined outside the bean class (interceptor classes).
void	setGlobalEasyBeansInterceptors(java.util.List<IJClassInterceptor> globalEasyBeansInterceptors) Sets the list of global interceptors that enhancers will use.
void	setInterfaces(java.lang.String[] array) construct a new JClass.
void	setInternalUserInterceptors(java.util.Map<InterceptorType,java.util.List<IJClassInterceptor>> internalUserInterceptors) Sets the list of user interceptors that enhancers will use. These interceptors are defined in bean class.
void	setJMessageDriven(IJMessageDriven messageDriven) Sets the message driven bean object.
void	setLocalHome(java.lang.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(java.lang.String remoteHome) Sets the @RemoteHome class name.
void	setRemoteInterface(java.lang.String remoteInterface) Set the value of the remote Interface property.
void	setRemoteInterfaces(IJRemote jRemote) Sets the remote interfaces of this class.
void	setRolesAllowed(java.util.List<java.lang.String> rolesAllowed) Set the list of roles allowed on this class/method.
void	setRunAs(java.lang.String runAs) Set the value of the run-as property.
void	setTransactionAttributeType(javax.ejb.TransactionAttributeType transactionAttributeType) Set Transaction Attribute Type.
void	setTransactionManagementType(javax.ejb.TransactionManagementType transactionManagementType) Sets transaction management type.
boolean	wasModified()

Method Detail

getClassName

java.lang.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

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

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

java.lang.String getRemoteHome()

Returns:

the @RemoteHome class name.

setRemoteHome

void setRemoteHome(java.lang.String remoteHome)

Sets the @RemoteHome class name.

Parameters:

remoteHome - the class name.

getLocalHome

java.lang.String getLocalHome()

Returns:

the @LocalHome class name.

setLocalHome

void setLocalHome(java.lang.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

getTransactionAttributeType

javax.ejb.TransactionAttributeType getTransactionAttributeType()

Specified by:

getTransactionAttributeType in interface org.ow2.util.ee.metadata.common.api.interfaces.ITransactionAttribute

Returns:

transaction Attribute type.

See Also:

TransactionAttributeType

setTransactionAttributeType

void setTransactionAttributeType(javax.ejb.TransactionAttributeType transactionAttributeType)

Set Transaction Attribute Type.

Specified by:

setTransactionAttributeType in interface org.ow2.util.ee.metadata.common.api.interfaces.ITransactionAttribute

Parameters:

transactionAttributeType - the type of transaction.

See Also:

TransactionAttributeType

getAnnotationInterceptors

org.ow2.util.ee.metadata.common.api.struct.IJInterceptors getAnnotationInterceptors()

Returns:

object representing list of @javax.interceptor.Interceptors.

setAnnotationsInterceptors

void setAnnotationsInterceptors(org.ow2.util.ee.metadata.common.api.struct.IJInterceptors annotationInterceptors)

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

Specified by:

setAnnotationsInterceptors in interface org.ow2.util.ee.metadata.common.api.interfaces.IEJBInterceptors

Parameters:

annotationInterceptors - list of classes

getApplicationException

javax.ejb.ApplicationException getApplicationException()

Returns:

the @ApplicationException annotation.

setApplicationException

void setApplicationException(javax.ejb.ApplicationException applicationException)

Sets the object representing the @ApplicationException annotation.

Parameters:

applicationException - object representation

isBean

boolean isBean()

Returns:

true if the classs is a Bean

getInterfaces

java.lang.String[] getInterfaces()

Returns:

array of interfaces name.

getSuperName

java.lang.String getSuperName()

Returns:

the super class name.

getEjbJarArchiveMetadata

IEjbJarDeployableMetadata<E> getEjbJarArchiveMetadata()

Returns:

parent metadata object.

getExternalUserEasyBeansInterceptors

java.util.Map<InterceptorType,java.util.List<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(java.util.Map<InterceptorType,java.util.List<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

java.util.Map<InterceptorType,java.util.List<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(java.util.Map<InterceptorType,java.util.List<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

java.util.List<IJClassInterceptor> getGlobalEasyBeansInterceptors()

Returns:

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

setGlobalEasyBeansInterceptors

void setGlobalEasyBeansInterceptors(java.util.List<IJClassInterceptor> globalEasyBeansInterceptors)

Sets the list of global interceptors that enhancers will use.

Parameters:

globalEasyBeansInterceptors - list of interceptors that enhancer will use.

isAroundInvokeMethodMetadata

boolean isAroundInvokeMethodMetadata()

Returns:

the method metadata with annotation @javax.interceptor.AroundInvoke.

isInterceptor

boolean isInterceptor()

Is that this class is an interceptor class ?

Returns:

true if it the case, else false.

wasModified

boolean wasModified()

Returns:

true if the class has been modified.

setModified

void setModified()

Defines that this class has been modified.

setDeclareRoles

void setDeclareRoles(java.util.List<java.lang.String> declareRoles)

Sets the list of roles declared on this class.

Parameters:

declareRoles - the list of roles.

getDeclareRoles

java.util.List<java.lang.String> getDeclareRoles()

Returns:

the list of roles declared on this class.

setRolesAllowed

void setRolesAllowed(java.util.List<java.lang.String> rolesAllowed)

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

Specified by:

setRolesAllowed in interface org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationSecurityRolesAllowed

Parameters:

rolesAllowed - the list of roles.

getRolesAllowed

java.util.List<java.lang.String> getRolesAllowed()

Specified by:

getRolesAllowed in interface org.ow2.util.ee.metadata.common.api.interfaces.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 org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationSecurityPermitAll

Parameters:

permitAll - the boolean value.

hasPermitAll

boolean hasPermitAll()

Specified by:

hasPermitAll in interface org.ow2.util.ee.metadata.common.api.interfaces.IAnnotationSecurityPermitAll

Returns:

true if PermitAll annotation.

setRunAs

void setRunAs(java.lang.String runAs)

Set the value of the run-as property.

Parameters:

runAs - the run-as property.

getRunAs

java.lang.String getRunAs()

Returns:

the name of the security-role of the run-as element.

isExcludedDefaultInterceptors

boolean isExcludedDefaultInterceptors()

Specified by:

isExcludedDefaultInterceptors in interface org.ow2.util.ee.metadata.common.api.interfaces.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 org.ow2.util.ee.metadata.common.api.interfaces.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(java.lang.String remoteInterface)

Set the value of the remote Interface property.

Parameters:

remoteInterface - the remote Interface property.

getRemoteInterface

java.lang.String getRemoteInterface()

Returns:

the name of the remote interface.

setInterfaces

void setInterfaces(java.lang.String[] array)

construct a new JClass.

Parameters:

array - interface list