Package org.jboss.as.ejb3.component.session

Class SessionBeanComponentDescription

java.lang.Object

org.jboss.as.ee.component.ComponentDescription

org.jboss.as.ejb3.component.EJBComponentDescription

org.jboss.as.ejb3.component.session.SessionBeanComponentDescription

All Implemented Interfaces:

ResourceInjectionTarget

Direct Known Subclasses:

SingletonComponentDescription, StatefulComponentDescription, StatelessComponentDescription

public abstract class SessionBeanComponentDescription
extends EJBComponentDescription

Author:

Jaikiran Pai, Richard Opalka

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionBeanComponentDescription.SessionBeanType

Constructor Summary

Constructors

Constructor	Description
SessionBeanComponentDescription(String componentName, String componentClassName, EjbJarDescription ejbJarDescription, org.jboss.as.server.deployment.DeploymentUnit deploymentUnit, org.jboss.metadata.ejb.spec.SessionBeanMetaData descriptorData)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
void	addAsynchronousClass(String viewName)	Add a bean class or superclass that has been marked asynchronous
void	addAsynchronousMethod(org.jboss.invocation.proxy.MethodIdentifier methodIdentifier)	Add an asynchronous method.
protected void	addCurrentInvocationContextFactory()	Setup the current invocation context interceptor, which will be used during the post-construct lifecycle of the component instance
protected void	addCurrentInvocationContextFactory(ViewDescription view)	Setup the current invocation context interceptor, which will be used during the invocation on the view (methods)
void	addLocalBusinessInterfaceViews(String... classNames)
void	addLocalBusinessInterfaceViews(Collection<String> classNames)
void	addNoInterfaceView()
void	addRemoteBusinessInterfaceViews(Collection<String> classNames)
protected static void	addTxManagementInterceptorForView(ViewDescription view)	Sets up the transaction management interceptor for all methods of the passed view.
EJBViewDescription	addWebserviceEndpointView()
Set<String>	getAsynchronousClasses()
Set<org.jboss.invocation.proxy.MethodIdentifier>	getAsynchronousMethods()
Map<String,AccessTimeoutDetails>	getBeanLevelAccessTimeout()	Returns the AccessTimeout applicable for the bean.
Map<String,jakarta.ejb.LockType>	getBeanLevelLockType()	Returns the LockType applicable for the bean.
jakarta.ejb.ConcurrencyManagementType	getConcurrencyManagementType()	Returns the concurrency management type for this bean.
org.jboss.metadata.ejb.spec.SessionBeanMetaData	getDescriptorData()
String	getMappedName()	Returns the mapped-name of this bean
Map<org.jboss.invocation.proxy.MethodIdentifier,AccessTimeoutDetails>	getMethodApplicableAccessTimeouts()
Map<org.jboss.invocation.proxy.MethodIdentifier,jakarta.ejb.LockType>	getMethodApplicableLockTypes()
protected abstract ViewConfigurator	getSessionBeanObjectViewConfigurator()
abstract SessionBeanComponentDescription.SessionBeanType	getSessionBeanType()	Returns the type of the session bean
boolean	hasNoInterfaceView()
boolean	isSession()
boolean	isSingleton()
boolean	isStateful()
boolean	isStateless()
void	setAccessTimeout(AccessTimeoutDetails accessTimeout, org.jboss.invocation.proxy.MethodIdentifier method)	Sets the AccessTimeout for the specific bean method
void	setBeanLevelAccessTimeout(String className, AccessTimeoutDetails accessTimeout)	Sets the AccessTimeout applicable for the bean.
void	setBeanLevelLockType(String className, jakarta.ejb.LockType locktype)	Sets the LockType applicable for the bean.
void	setConcurrencyManagementType(jakarta.ejb.ConcurrencyManagementType concurrencyManagementType)
void	setLockType(jakarta.ejb.LockType lockType, org.jboss.invocation.proxy.MethodIdentifier method)	Sets the LockType for the specific bean method
void	setMappedName(String mappedName)	Sets the mapped-name for this bean
protected void	setupViewInterceptors(EJBViewDescription view)

Methods inherited from class org.jboss.as.ejb3.component.EJBComponentDescription

addDeclaredRoles, addEjbLocalObjectView, addEjbObjectView, addEJBSuspendHandlerDependency, addLocalHome, addRemoteHome, addRemoteTransactionsDependency, addScheduleMethod, addTransactionManagerDependencies, excludeClassLevelContainerInterceptors, excludeDefaultContainerInterceptors, getAllContainerInterceptors, getAnnotationMethodPermissions, getClassLevelContainerInterceptors, getDeclaredRoles, getDefaultContainerInterceptors, getDefinedSecurityDomain, getDescriptorMethodPermissions, getEJBClassName, getEjbHomeView, getEjbLocalHomeView, getEjbLocalView, getEJBName, getEjbRemoteView, getElytronInterceptorFactories, getMethodLevelContainerInterceptors, getResolvedSecurityDomain, getRunAs, getRunAsPrincipal, getScheduleMethods, getSecurityDomainServiceName, getSecurityRoleLinks, getSecurityRoles, getServerInterceptorCache, getShutDownInterceptorFactory, getTimeoutMethod, getTimerMethods, getTimerServiceResource, getTransactionAttributes, getTransactionManagementType, getTransactionTimeouts, hasBeanLevelSecurityMetadata, isEntity, isExcludeClassLevelContainerInterceptors, isExcludeDefaultContainerInterceptors, isExcludeDefaultContainerInterceptors, isExposedViaIiop, isMessageDriven, isMissingMethodPermissionsDeniedAccess, isOutflowSecurityDomainsConfigured, isSecurityRequired, linkSecurityRoles, registerView, registerView, requiresJacc, requiresLegacyCompliantPrincipalPropagation, setClassLevelContainerInterceptors, setDeclaredRoles, setDefaultContainerInterceptors, setDefaultSecurityDomain, setDefinedSecurityDomain, setExcludeDefaultContainerInterceptors, setExposedViaIiop, setLegacyCompliantPrincipalPropagation, setMethodContainerInterceptors, setMissingMethodPermissionsDenyAccess, setOutflowSecurityDomainsConfigured, setRequiresJacc, setRunAs, setRunAsPrincipal, setSecurityDomainServiceName, setSecurityRequired, setSecurityRoles, setServerInterceptorCache, setTimeoutMethod, setTimerServiceResource, setTransactionManagementType, setupClientViewInterceptors, setupRemoteView, setupSecurityInterceptors, toString

Methods inherited from class org.jboss.as.ee.component.ComponentDescription

addClassInterceptor, addDependency, addInterceptorMethodOverride, addMethodInterceptor, addResourceInjection, createConfiguration, excludeClassInterceptors, excludeDefaultInterceptors, getAllInterceptors, getApplicationName, getBeanDeploymentArchiveId, getBindingConfigurations, getClassInterceptor, getClassInterceptors, getComponentClassName, getComponentName, getConfigurators, getContextServiceName, getCreateServiceName, getDefaultInterceptors, getDependencies, getDeploymentDescriptorEnvironment, getMethodInterceptors, getModuleDescription, getModuleName, getNamingMode, getResourceInjections, getServiceName, getStartServiceName, getViews, isCDIInterceptorEnabled, isExcludeClassInterceptors, isExcludeDefaultInterceptors, isExcludeDefaultInterceptors, isIgnoreLifecycleInterceptors, isIntercepted, isOptional, isPassivationApplicable, isTimerServiceApplicable, isTimerServiceRequired, mergeInterceptorConfig, setBeanDeploymentArchiveId, setClassInterceptors, setContextServiceName, setDefaultInterceptors, setDeploymentDescriptorEnvironment, setExcludeDefaultInterceptors, setIgnoreLifecycleInterceptors, setMethodInterceptors, setNamingMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionBeanComponentDescription

public SessionBeanComponentDescription(String componentName,
                                       String componentClassName,
                                       EjbJarDescription ejbJarDescription,
                                       org.jboss.as.server.deployment.DeploymentUnit deploymentUnit,
                                       org.jboss.metadata.ejb.spec.SessionBeanMetaData descriptorData)

Construct a new instance.

Parameters:

componentName - the component name

componentClassName - the component instance class name

ejbJarDescription - the module description

Method Detail

addLocalBusinessInterfaceViews

public void addLocalBusinessInterfaceViews(Collection<String> classNames)

addLocalBusinessInterfaceViews

public void addLocalBusinessInterfaceViews(String... classNames)

addNoInterfaceView

public void addNoInterfaceView()

addWebserviceEndpointView

public EJBViewDescription addWebserviceEndpointView()

addRemoteBusinessInterfaceViews

public void addRemoteBusinessInterfaceViews(Collection<String> classNames)

hasNoInterfaceView

public boolean hasNoInterfaceView()

setBeanLevelLockType

public void setBeanLevelLockType(String className,
                                 jakarta.ejb.LockType locktype)

Sets the LockType applicable for the bean.

Parameters:

className - The class that has the annotation

locktype - The lock type applicable for the bean

getBeanLevelLockType

public Map<String,jakarta.ejb.LockType> getBeanLevelLockType()

Returns the LockType applicable for the bean.

Returns:

setLockType

public void setLockType(jakarta.ejb.LockType lockType,
                        org.jboss.invocation.proxy.MethodIdentifier method)

Sets the LockType for the specific bean method

Parameters:

lockType - The applicable lock type for the method

method - The method

getMethodApplicableLockTypes

public Map<org.jboss.invocation.proxy.MethodIdentifier,jakarta.ejb.LockType> getMethodApplicableLockTypes()

getBeanLevelAccessTimeout

public Map<String,AccessTimeoutDetails> getBeanLevelAccessTimeout()

Returns the AccessTimeout applicable for the bean.

Returns:

setBeanLevelAccessTimeout

public void setBeanLevelAccessTimeout(String className,
                                      AccessTimeoutDetails accessTimeout)

Sets the AccessTimeout applicable for the bean.

Parameters:

accessTimeout - The access timeout applicable for the class

setAccessTimeout

public void setAccessTimeout(AccessTimeoutDetails accessTimeout,
                             org.jboss.invocation.proxy.MethodIdentifier method)

Sets the AccessTimeout for the specific bean method

Parameters:

accessTimeout - The applicable access timeout for the method

method - The method

getMethodApplicableAccessTimeouts

public Map<org.jboss.invocation.proxy.MethodIdentifier,AccessTimeoutDetails> getMethodApplicableAccessTimeouts()

getConcurrencyManagementType

public jakarta.ejb.ConcurrencyManagementType getConcurrencyManagementType()

Returns the concurrency management type for this bean.

This method returns null if the concurrency management type hasn't explicitly been set on this SessionBeanComponentDescription

Returns:

setConcurrencyManagementType

public void setConcurrencyManagementType(jakarta.ejb.ConcurrencyManagementType concurrencyManagementType)

getMappedName

public String getMappedName()

Returns the mapped-name of this bean

Returns:

setMappedName

public void setMappedName(String mappedName)

Sets the mapped-name for this bean

Parameters:

mappedName -

addAsynchronousMethod

public void addAsynchronousMethod(org.jboss.invocation.proxy.MethodIdentifier methodIdentifier)

Add an asynchronous method.

Parameters:

methodIdentifier - The identifier for an async method

getAsynchronousMethods

public Set<org.jboss.invocation.proxy.MethodIdentifier> getAsynchronousMethods()

Returns:

The identifier of all async methods

addAsynchronousClass

public void addAsynchronousClass(String viewName)

Add a bean class or superclass that has been marked asynchronous

Parameters:

viewName - The view name

getAsynchronousClasses

public Set<String> getAsynchronousClasses()

Returns:

The class name of all asynchronous classes

getSessionBeanType

public abstract SessionBeanComponentDescription.SessionBeanType getSessionBeanType()

Returns the type of the session bean

Returns:

setupViewInterceptors

protected void setupViewInterceptors(EJBViewDescription view)

Overrides:

setupViewInterceptors in class EJBComponentDescription

getSessionBeanObjectViewConfigurator

protected abstract ViewConfigurator getSessionBeanObjectViewConfigurator()

addTxManagementInterceptorForView

protected static void addTxManagementInterceptorForView(ViewDescription view)

Sets up the transaction management interceptor for all methods of the passed view.

Parameters:

view - The EJB bean view

addCurrentInvocationContextFactory

protected void addCurrentInvocationContextFactory()

Description copied from class: EJBComponentDescription

Setup the current invocation context interceptor, which will be used during the post-construct lifecycle of the component instance

Specified by:

addCurrentInvocationContextFactory in class EJBComponentDescription

addCurrentInvocationContextFactory

protected void addCurrentInvocationContextFactory(ViewDescription view)

Description copied from class: EJBComponentDescription

Setup the current invocation context interceptor, which will be used during the invocation on the view (methods)

Specified by:

addCurrentInvocationContextFactory in class EJBComponentDescription

Parameters:

view - The view for which the interceptor has to be setup

isSession

public boolean isSession()

Overrides:

isSession in class EJBComponentDescription

isSingleton

public boolean isSingleton()

Overrides:

isSingleton in class EJBComponentDescription

isStateful

public boolean isStateful()

Overrides:

isStateful in class EJBComponentDescription

isStateless

public boolean isStateless()

Overrides:

isStateless in class EJBComponentDescription

getDescriptorData

public org.jboss.metadata.ejb.spec.SessionBeanMetaData getDescriptorData()

Overrides:

getDescriptorData in class EJBComponentDescription