org.apache.openejb.jee
Class SessionBean

java.lang.Object
  extended by org.apache.openejb.jee.SessionBean
All Implemented Interfaces:
EnterpriseBean, JndiConsumer, Lifecycle, RemoteBean, Session, TimerConsumer
Direct Known Subclasses:
ManagedBean, SingletonBean, StatefulBean, StatelessBean

public class SessionBean
extends Object
implements RemoteBean, Session, TimerConsumer

The session-beanType declares an session bean. The declaration consists of:

- an optional description - an optional display name - an optional icon element that contains a small and a large icon file name - a name assigned to the enterprise bean in the deployment description - an optional mapped-name element that can be used to provide vendor-specific deployment information such as the physical jndi-name of the session bean's remote home/business interface. This element is not required to be supported by all implementations. Any use of this element is non-portable. - the names of all the remote or local business interfaces, if any - the names of the session bean's remote home and remote interfaces, if any - the names of the session bean's local home and local interfaces, if any - the name of the session bean's web service endpoint interface, if any - the session bean's implementation class - the session bean's state management type - an optional declaration of the session bean's timeout method. - the optional session bean's transaction management type. If it is not present, it is defaulted to Container. - an optional list of the session bean class and/or superclass around-invoke methods. - an optional declaration of the bean's environment entries - an optional declaration of the bean's EJB references - an optional declaration of the bean's local EJB references - an optional declaration of the bean's web service references - an optional declaration of the security role references - an optional declaration of the security identity to be used for the execution of the bean's methods - an optional declaration of the bean's resource manager connection factory references - an optional declaration of the bean's resource environment references. - an optional declaration of the bean's message destination references

The elements that are optional are "optional" in the sense that they are omitted when if lists represented by them are empty.

Either both the local-home and the local elements or both the home and the remote elements must be specified for the session bean.

The service-endpoint element may only be specified if the bean is a stateless session bean.


Field Summary
protected  List<AroundInvoke> aroundInvoke
           
protected  LinkedHashSet<String> businessLocal
           
protected  LinkedHashSet<String> businessRemote
           
protected  ConcurrencyType concurrencyType
           
protected  List<String> dependsOn
           
protected  TextMap description
           
protected  TextMap displayName
           
protected  String ejbClass
           
protected  KeyedCollection<String,EjbLocalRef> ejbLocalRef
           
protected  String ejbName
           
protected  KeyedCollection<String,EjbRef> ejbRef
           
protected  KeyedCollection<String,EnvEntry> envEntry
           
protected  String home
           
protected  LocalCollection<Icon> icon
           
protected  String id
           
protected  List<InitMethod> initMethod
           
protected  Boolean loadOnStartup
           
protected  String local
           
protected  EmptyType localBean
           
protected  String localHome
           
protected  String mappedName
           
protected  KeyedCollection<String,MessageDestinationRef> messageDestinationRef
           
protected  KeyedCollection<String,PersistenceContextRef> persistenceContextRef
           
protected  KeyedCollection<String,PersistenceUnitRef> persistenceUnitRef
           
protected  List<LifecycleCallback> postActivate
           
protected  List<LifecycleCallback> postConstruct
           
protected  List<LifecycleCallback> preDestroy
           
protected  List<LifecycleCallback> prePassivate
           
protected  String remote
           
protected  List<RemoveMethod> removeMethod
           
protected  KeyedCollection<String,ResourceEnvRef> resourceEnvRef
           
protected  KeyedCollection<String,ResourceRef> resourceRef
           
protected  SecurityIdentity securityIdentity
           
protected  List<SecurityRoleRef> securityRoleRef
           
protected  String serviceEndpoint
           
protected  KeyedCollection<String,ServiceRef> serviceRef
           
protected  SessionType sessionType
           
protected  NamedMethod timeoutMethod
           
protected  TransactionType transactionType
           
 
Constructor Summary
SessionBean()
           
SessionBean(String ejbName, String ejbClass, SessionType sessionType)
           
 
Method Summary
 void addAroundInvoke(String method)
           
 void addBusinessLocal(Class businessLocal)
           
 void addBusinessLocal(String businessLocal)
           
 void addBusinessRemote(Class businessRemote)
           
 void addBusinessRemote(String businessRemote)
           
 void addPostActivate(String method)
           
 void addPostConstruct(String method)
           
 void addPreDestroy(String method)
           
 void addPrePassivate(String method)
           
 List<AroundInvoke> getAroundInvoke()
           
 Collection<String> getBusinessLocal()
           
 Collection<String> getBusinessRemote()
           
 ConcurrencyType getConcurrencyType()
           
 List<String> getDependsOn()
           
 String getDescription()
           
 Text[] getDescriptions()
           
 String getDisplayName()
           
 Text[] getDisplayNames()
           
 String getEjbClass()
           
 Collection<EjbLocalRef> getEjbLocalRef()
           
 Map<String,EjbLocalRef> getEjbLocalRefMap()
           
 String getEjbName()
           
 Collection<EjbRef> getEjbRef()
           
 Map<String,EjbRef> getEjbRefMap()
           
 Collection<EnvEntry> getEnvEntry()
           
 Map<String,EnvEntry> getEnvEntryMap()
           
 String getHome()
           
 Icon getIcon()
           
 Map<String,Icon> getIconMap()
           
 Collection<Icon> getIcons()
           
 String getId()
           
 List<InitMethod> getInitMethod()
           
 String getJndiConsumerName()
           
 boolean getLoadOnStartup()
           
 String getLocal()
           
 EmptyType getLocalBean()
           
 String getLocalHome()
           
 String getMappedName()
           
 Collection<MessageDestinationRef> getMessageDestinationRef()
           
 Map<String,MessageDestinationRef> getMessageDestinationRefMap()
           
 Collection<PersistenceContextRef> getPersistenceContextRef()
           
 Map<String,PersistenceContextRef> getPersistenceContextRefMap()
           
 Collection<PersistenceUnitRef> getPersistenceUnitRef()
           
 Map<String,PersistenceUnitRef> getPersistenceUnitRefMap()
           
 List<LifecycleCallback> getPostActivate()
           
 List<LifecycleCallback> getPostConstruct()
           
 List<LifecycleCallback> getPreDestroy()
           
 List<LifecycleCallback> getPrePassivate()
           
 String getRemote()
           
 List<RemoveMethod> getRemoveMethod()
           
 Collection<ResourceEnvRef> getResourceEnvRef()
           
 Map<String,ResourceEnvRef> getResourceEnvRefMap()
           
 Collection<ResourceRef> getResourceRef()
           
 Map<String,ResourceRef> getResourceRefMap()
           
 SecurityIdentity getSecurityIdentity()
           
 List<SecurityRoleRef> getSecurityRoleRef()
           
 String getServiceEndpoint()
           
 Collection<ServiceRef> getServiceRef()
           
 Map<String,ServiceRef> getServiceRefMap()
           
 SessionType getSessionType()
           
 NamedMethod getTimeoutMethod()
           
 TransactionType getTransactionType()
           
 boolean hasLoadOnStartup()
           
 void setConcurrencyType(ConcurrencyType value)
           
 void setDependsOn(List<String> ejbNames)
           
 void setDependsOn(String... ejbNames)
           
 void setDescriptions(Text[] text)
           
 void setDisplayNames(Text[] text)
           
 void setEjbClass(Class value)
           
 void setEjbClass(String value)
           
 void setEjbName(String value)
          The ejb-nameType specifies an enterprise bean's name.
 void setHome(String value)
           
 void setHomeAndLocal(Class<?> localHome, Class<?> local)
           
 void setHomeAndLocal(String localHome, String local)
           
 void setHomeAndRemote(Class<?> home, Class<?> remote)
           
 void setHomeAndRemote(String home, String remote)
           
 void setId(String value)
           
 void setLoadOnStartup(boolean loadOnStartup)
           
 void setLocal(String value)
           
 void setLocalBean(EmptyType localBean)
           
 void setLocalHome(String value)
           
 void setMappedName(String value)
           
 void setRemote(String value)
           
 void setSecurityIdentity(SecurityIdentity value)
           
 void setServiceEndpoint(String value)
           
 void setSessionType(SessionType value)
           
 void setTimeoutMethod(NamedMethod value)
           
 void setTransactionType(TransactionType value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected TextMap description

displayName

protected TextMap displayName

icon

protected LocalCollection<Icon> icon

ejbName

protected String ejbName

mappedName

protected String mappedName

home

protected String home

remote

protected String remote

localHome

protected String localHome

local

protected String local

businessLocal

protected LinkedHashSet<String> businessLocal

businessRemote

protected LinkedHashSet<String> businessRemote

localBean

protected EmptyType localBean

serviceEndpoint

protected String serviceEndpoint

ejbClass

protected String ejbClass

sessionType

protected SessionType sessionType

timeoutMethod

protected NamedMethod timeoutMethod

initMethod

protected List<InitMethod> initMethod

removeMethod

protected List<RemoveMethod> removeMethod

transactionType

protected TransactionType transactionType

concurrencyType

protected ConcurrencyType concurrencyType

aroundInvoke

protected List<AroundInvoke> aroundInvoke

envEntry

protected KeyedCollection<String,EnvEntry> envEntry

ejbRef

protected KeyedCollection<String,EjbRef> ejbRef

ejbLocalRef

protected KeyedCollection<String,EjbLocalRef> ejbLocalRef

serviceRef

protected KeyedCollection<String,ServiceRef> serviceRef

resourceRef

protected KeyedCollection<String,ResourceRef> resourceRef

resourceEnvRef

protected KeyedCollection<String,ResourceEnvRef> resourceEnvRef

messageDestinationRef

protected KeyedCollection<String,MessageDestinationRef> messageDestinationRef

persistenceContextRef

protected KeyedCollection<String,PersistenceContextRef> persistenceContextRef

persistenceUnitRef

protected KeyedCollection<String,PersistenceUnitRef> persistenceUnitRef

postConstruct

protected List<LifecycleCallback> postConstruct

preDestroy

protected List<LifecycleCallback> preDestroy

postActivate

protected List<LifecycleCallback> postActivate

prePassivate

protected List<LifecycleCallback> prePassivate

securityRoleRef

protected List<SecurityRoleRef> securityRoleRef

securityIdentity

protected SecurityIdentity securityIdentity

loadOnStartup

protected Boolean loadOnStartup

dependsOn

protected List<String> dependsOn

id

protected String id
Constructor Detail

SessionBean

public SessionBean()

SessionBean

public SessionBean(String ejbName,
                   String ejbClass,
                   SessionType sessionType)
Method Detail

getJndiConsumerName

public String getJndiConsumerName()
Specified by:
getJndiConsumerName in interface JndiConsumer

getDescriptions

public Text[] getDescriptions()

setDescriptions

public void setDescriptions(Text[] text)

getDescription

public String getDescription()

getDisplayNames

public Text[] getDisplayNames()

setDisplayNames

public void setDisplayNames(Text[] text)

getDisplayName

public String getDisplayName()

getIcons

public Collection<Icon> getIcons()

getIconMap

public Map<String,Icon> getIconMap()

getIcon

public Icon getIcon()

getEjbName

public String getEjbName()
Specified by:
getEjbName in interface EnterpriseBean

setEjbName

public void setEjbName(String value)
The ejb-nameType specifies an enterprise bean's name. It is used by ejb-name elements. This name is assigned by the ejb-jar file producer to name the enterprise bean in the ejb-jar file's deployment descriptor. The name must be unique among the names of the enterprise beans in the same ejb-jar file.

There is no architected relationship between the used ejb-name in the deployment descriptor and the JNDI name that the Deployer will assign to the enterprise bean's home.

The name for an entity bean must conform to the lexical rules for an NMTOKEN.

Example:

EmployeeService

Specified by:
setEjbName in interface EnterpriseBean

getMappedName

public String getMappedName()
Specified by:
getMappedName in interface EnterpriseBean

setMappedName

public void setMappedName(String value)
Specified by:
setMappedName in interface EnterpriseBean

getHome

public String getHome()
Specified by:
getHome in interface RemoteBean

setHome

public void setHome(String value)
Specified by:
setHome in interface RemoteBean

getRemote

public String getRemote()
Specified by:
getRemote in interface RemoteBean

setRemote

public void setRemote(String value)
Specified by:
setRemote in interface RemoteBean

setHomeAndRemote

public void setHomeAndRemote(String home,
                             String remote)

setHomeAndRemote

public void setHomeAndRemote(Class<?> home,
                             Class<?> remote)

setHomeAndLocal

public void setHomeAndLocal(String localHome,
                            String local)

setHomeAndLocal

public void setHomeAndLocal(Class<?> localHome,
                            Class<?> local)

getLocalHome

public String getLocalHome()
Specified by:
getLocalHome in interface RemoteBean

setLocalHome

public void setLocalHome(String value)
Specified by:
setLocalHome in interface RemoteBean

getLocal

public String getLocal()
Specified by:
getLocal in interface RemoteBean

setLocal

public void setLocal(String value)
Specified by:
setLocal in interface RemoteBean

getBusinessLocal

public Collection<String> getBusinessLocal()
Specified by:
getBusinessLocal in interface RemoteBean

addBusinessLocal

public void addBusinessLocal(String businessLocal)

addBusinessLocal

public void addBusinessLocal(Class businessLocal)

getBusinessRemote

public Collection<String> getBusinessRemote()
Specified by:
getBusinessRemote in interface RemoteBean

addBusinessRemote

public void addBusinessRemote(String businessRemote)

addBusinessRemote

public void addBusinessRemote(Class businessRemote)

getLocalBean

public EmptyType getLocalBean()

setLocalBean

public void setLocalBean(EmptyType localBean)

getServiceEndpoint

public String getServiceEndpoint()

setServiceEndpoint

public void setServiceEndpoint(String value)

getEjbClass

public String getEjbClass()
Specified by:
getEjbClass in interface EnterpriseBean

setEjbClass

public void setEjbClass(String value)
Specified by:
setEjbClass in interface EnterpriseBean

setEjbClass

public void setEjbClass(Class value)
Specified by:
setEjbClass in interface EnterpriseBean

getSessionType

public SessionType getSessionType()

setSessionType

public void setSessionType(SessionType value)

getTimeoutMethod

public NamedMethod getTimeoutMethod()
Specified by:
getTimeoutMethod in interface TimerConsumer

setTimeoutMethod

public void setTimeoutMethod(NamedMethod value)
Specified by:
setTimeoutMethod in interface TimerConsumer

getInitMethod

public List<InitMethod> getInitMethod()
Specified by:
getInitMethod in interface Session

getRemoveMethod

public List<RemoveMethod> getRemoveMethod()
Specified by:
getRemoveMethod in interface Session

getTransactionType

public TransactionType getTransactionType()
Specified by:
getTransactionType in interface EnterpriseBean

getConcurrencyType

public ConcurrencyType getConcurrencyType()

setTransactionType

public void setTransactionType(TransactionType value)
Specified by:
setTransactionType in interface EnterpriseBean

setConcurrencyType

public void setConcurrencyType(ConcurrencyType value)

getAroundInvoke

public List<AroundInvoke> getAroundInvoke()
Specified by:
getAroundInvoke in interface Lifecycle

addAroundInvoke

public void addAroundInvoke(String method)
Specified by:
addAroundInvoke in interface Lifecycle

getEnvEntry

public Collection<EnvEntry> getEnvEntry()
Specified by:
getEnvEntry in interface JndiConsumer

getEnvEntryMap

public Map<String,EnvEntry> getEnvEntryMap()
Specified by:
getEnvEntryMap in interface JndiConsumer

getEjbRef

public Collection<EjbRef> getEjbRef()
Specified by:
getEjbRef in interface JndiConsumer

getEjbRefMap

public Map<String,EjbRef> getEjbRefMap()
Specified by:
getEjbRefMap in interface JndiConsumer

getEjbLocalRef

public Collection<EjbLocalRef> getEjbLocalRef()
Specified by:
getEjbLocalRef in interface JndiConsumer

getEjbLocalRefMap

public Map<String,EjbLocalRef> getEjbLocalRefMap()
Specified by:
getEjbLocalRefMap in interface JndiConsumer

getServiceRef

public Collection<ServiceRef> getServiceRef()
Specified by:
getServiceRef in interface JndiConsumer

getServiceRefMap

public Map<String,ServiceRef> getServiceRefMap()
Specified by:
getServiceRefMap in interface JndiConsumer

getResourceRef

public Collection<ResourceRef> getResourceRef()
Specified by:
getResourceRef in interface JndiConsumer

getResourceRefMap

public Map<String,ResourceRef> getResourceRefMap()
Specified by:
getResourceRefMap in interface JndiConsumer

getResourceEnvRef

public Collection<ResourceEnvRef> getResourceEnvRef()
Specified by:
getResourceEnvRef in interface JndiConsumer

getResourceEnvRefMap

public Map<String,ResourceEnvRef> getResourceEnvRefMap()
Specified by:
getResourceEnvRefMap in interface JndiConsumer

getMessageDestinationRef

public Collection<MessageDestinationRef> getMessageDestinationRef()
Specified by:
getMessageDestinationRef in interface JndiConsumer

getMessageDestinationRefMap

public Map<String,MessageDestinationRef> getMessageDestinationRefMap()
Specified by:
getMessageDestinationRefMap in interface JndiConsumer

getPersistenceContextRef

public Collection<PersistenceContextRef> getPersistenceContextRef()
Specified by:
getPersistenceContextRef in interface JndiConsumer

getPersistenceContextRefMap

public Map<String,PersistenceContextRef> getPersistenceContextRefMap()
Specified by:
getPersistenceContextRefMap in interface JndiConsumer

getPersistenceUnitRef

public Collection<PersistenceUnitRef> getPersistenceUnitRef()
Specified by:
getPersistenceUnitRef in interface JndiConsumer

getPersistenceUnitRefMap

public Map<String,PersistenceUnitRef> getPersistenceUnitRefMap()
Specified by:
getPersistenceUnitRefMap in interface JndiConsumer

getPostConstruct

public List<LifecycleCallback> getPostConstruct()
Specified by:
getPostConstruct in interface Lifecycle

addPostConstruct

public void addPostConstruct(String method)
Specified by:
addPostConstruct in interface Lifecycle

getPreDestroy

public List<LifecycleCallback> getPreDestroy()
Specified by:
getPreDestroy in interface Lifecycle

addPreDestroy

public void addPreDestroy(String method)
Specified by:
addPreDestroy in interface Lifecycle

getPostActivate

public List<LifecycleCallback> getPostActivate()
Specified by:
getPostActivate in interface Session

addPostActivate

public void addPostActivate(String method)
Specified by:
addPostActivate in interface Session

getPrePassivate

public List<LifecycleCallback> getPrePassivate()
Specified by:
getPrePassivate in interface Session

addPrePassivate

public void addPrePassivate(String method)
Specified by:
addPrePassivate in interface Session

getSecurityRoleRef

public List<SecurityRoleRef> getSecurityRoleRef()
Specified by:
getSecurityRoleRef in interface EnterpriseBean

getSecurityIdentity

public SecurityIdentity getSecurityIdentity()
Specified by:
getSecurityIdentity in interface EnterpriseBean

setSecurityIdentity

public void setSecurityIdentity(SecurityIdentity value)
Specified by:
setSecurityIdentity in interface EnterpriseBean

getDependsOn

public List<String> getDependsOn()

setDependsOn

public void setDependsOn(String... ejbNames)

setDependsOn

public void setDependsOn(List<String> ejbNames)

hasLoadOnStartup

public boolean hasLoadOnStartup()

getLoadOnStartup

public boolean getLoadOnStartup()

setLoadOnStartup

public void setLoadOnStartup(boolean loadOnStartup)

getId

public String getId()
Specified by:
getId in interface EnterpriseBean

setId

public void setId(String value)
Specified by:
setId in interface EnterpriseBean


Copyright © 1999-2013 The Apache OpenEJB development community. All Rights Reserved.