|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface SessionBeanType<T>
This interface defines the contract for the session-beanType xsd type
Original Documentation:
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.
| Method Summary | |
|---|---|
AroundInvokeType<SessionBeanType<T>> |
aroundInvoke()
Returns the around-invoke element |
EjbLocalRefType<SessionBeanType<T>> |
ejbLocalRef()
Returns the ejb-local-ref element |
EjbRefType<SessionBeanType<T>> |
ejbRef()
Returns the ejb-ref element |
EnvEntryType<SessionBeanType<T>> |
envEntry()
Returns the env-entry element |
java.util.List<AroundInvokeType<SessionBeanType<T>>> |
getAroundInvokeList()
Returns all around-invoke elements |
java.util.List<java.lang.String> |
getBusinessLocalList()
Returns all business-local elements |
java.util.List<java.lang.String> |
getBusinessRemoteList()
Returns all business-remote elements |
java.util.List<java.lang.String> |
getDescriptionList()
Returns all description elements |
java.util.List<java.lang.String> |
getDisplayNameList()
Returns all display-name elements |
java.lang.String |
getEjbClass()
Returns the ejb-class element |
java.util.List<EjbLocalRefType<SessionBeanType<T>>> |
getEjbLocalRefList()
Returns all ejb-local-ref elements |
java.lang.String |
getEjbName()
Returns the ejb-name element |
java.util.List<EjbRefType<SessionBeanType<T>>> |
getEjbRefList()
Returns all ejb-ref elements |
java.util.List<EnvEntryType<SessionBeanType<T>>> |
getEnvEntryList()
Returns all env-entry elements |
java.lang.String |
getHome()
Returns the home element |
java.util.List<IconType<SessionBeanType<T>>> |
getIconList()
Returns all icon elements |
java.util.List<InitMethodType<SessionBeanType<T>>> |
getInitMethodList()
Returns all init-method elements |
java.lang.String |
getLocal()
Returns the local element |
java.lang.String |
getLocalHome()
Returns the local-home element |
java.lang.String |
getMappedName()
Returns the mapped-name element |
java.util.List<MessageDestinationRefType<SessionBeanType<T>>> |
getMessageDestinationRefList()
Returns all message-destination-ref elements |
java.util.List<PersistenceContextRefType<SessionBeanType<T>>> |
getPersistenceContextRefList()
Returns all persistence-context-ref elements |
java.util.List<PersistenceUnitRefType<SessionBeanType<T>>> |
getPersistenceUnitRefList()
Returns all persistence-unit-ref elements |
java.util.List<LifecycleCallbackType<SessionBeanType<T>>> |
getPostActivateList()
Returns all post-activate elements |
java.util.List<LifecycleCallbackType<SessionBeanType<T>>> |
getPostConstructList()
Returns all post-construct elements |
java.util.List<LifecycleCallbackType<SessionBeanType<T>>> |
getPreDestroyList()
Returns all pre-destroy elements |
java.util.List<LifecycleCallbackType<SessionBeanType<T>>> |
getPrePassivateList()
Returns all pre-passivate elements |
java.lang.String |
getRemote()
Returns the remote element |
java.util.List<RemoveMethodType<SessionBeanType<T>>> |
getRemoveMethodList()
Returns all remove-method elements |
java.util.List<ResourceEnvRefType<SessionBeanType<T>>> |
getResourceEnvRefList()
Returns all resource-env-ref elements |
java.util.List<ResourceRefType<SessionBeanType<T>>> |
getResourceRefList()
Returns all resource-ref elements |
java.util.List<SecurityRoleRefType<SessionBeanType<T>>> |
getSecurityRoleRefList()
Returns all security-role-ref elements |
java.lang.String |
getServiceEndpoint()
Returns the service-endpoint element |
java.util.List<ServiceRefType<SessionBeanType<T>>> |
getServiceRefList()
Returns all service-ref elements |
SessionTypeType |
getSessionType()
Returns the session-type element |
java.lang.String |
getSessionTypeAsString()
Returns the session-type element |
TransactionTypeType |
getTransactionType()
Returns the transaction-type element |
java.lang.String |
getTransactionTypeAsString()
Returns the transaction-type element |
IconType<SessionBeanType<T>> |
icon()
Returns the icon element |
InitMethodType<SessionBeanType<T>> |
initMethod()
Returns the init-method element |
MessageDestinationRefType<SessionBeanType<T>> |
messageDestinationRef()
Returns the message-destination-ref element |
PersistenceContextRefType<SessionBeanType<T>> |
persistenceContextRef()
Returns the persistence-context-ref element |
PersistenceUnitRefType<SessionBeanType<T>> |
persistenceUnitRef()
Returns the persistence-unit-ref element |
LifecycleCallbackType<SessionBeanType<T>> |
postActivate()
Returns the post-activate element |
LifecycleCallbackType<SessionBeanType<T>> |
postConstruct()
Returns the post-construct element |
LifecycleCallbackType<SessionBeanType<T>> |
preDestroy()
Returns the pre-destroy element |
LifecycleCallbackType<SessionBeanType<T>> |
prePassivate()
Returns the pre-passivate element |
SessionBeanType<T> |
removeAllAroundInvoke()
Removes all around-invoke elements |
SessionBeanType<T> |
removeAllBusinessLocal()
Removes the business-local element |
SessionBeanType<T> |
removeAllBusinessRemote()
Removes the business-remote element |
SessionBeanType<T> |
removeAllDescription()
Removes the description element |
SessionBeanType<T> |
removeAllDisplayName()
Removes the display-name element |
SessionBeanType<T> |
removeAllEjbLocalRef()
Removes all ejb-local-ref elements |
SessionBeanType<T> |
removeAllEjbRef()
Removes all ejb-ref elements |
SessionBeanType<T> |
removeAllEnvEntry()
Removes all env-entry elements |
SessionBeanType<T> |
removeAllIcon()
Removes all icon elements |
SessionBeanType<T> |
removeAllInitMethod()
Removes all init-method elements |
SessionBeanType<T> |
removeAllMessageDestinationRef()
Removes all message-destination-ref elements |
SessionBeanType<T> |
removeAllPersistenceContextRef()
Removes all persistence-context-ref elements |
SessionBeanType<T> |
removeAllPersistenceUnitRef()
Removes all persistence-unit-ref elements |
SessionBeanType<T> |
removeAllPostActivate()
Removes all post-activate elements |
SessionBeanType<T> |
removeAllPostConstruct()
Removes all post-construct elements |
SessionBeanType<T> |
removeAllPreDestroy()
Removes all pre-destroy elements |
SessionBeanType<T> |
removeAllPrePassivate()
Removes all pre-passivate elements |
SessionBeanType<T> |
removeAllRemoveMethod()
Removes all remove-method elements |
SessionBeanType<T> |
removeAllResourceEnvRef()
Removes all resource-env-ref elements |
SessionBeanType<T> |
removeAllResourceRef()
Removes all resource-ref elements |
SessionBeanType<T> |
removeAllSecurityRoleRef()
Removes all security-role-ref elements |
SessionBeanType<T> |
removeAllServiceRef()
Removes all service-ref elements |
SessionBeanType<T> |
removeEjbClass()
Removes the ejb-class element |
SessionBeanType<T> |
removeEjbName()
Removes the ejb-name element |
SessionBeanType<T> |
removeHome()
Removes the home element |
SessionBeanType<T> |
removeLocal()
Removes the local element |
SessionBeanType<T> |
removeLocalHome()
Removes the local-home element |
SessionBeanType<T> |
removeMappedName()
Removes the mapped-name element |
RemoveMethodType<SessionBeanType<T>> |
removeMethod()
Returns the remove-method element |
SessionBeanType<T> |
removeRemote()
Removes the remote element |
SessionBeanType<T> |
removeSecurityIdentity()
Removes the security-identity element |
SessionBeanType<T> |
removeServiceEndpoint()
Removes the service-endpoint element |
SessionBeanType<T> |
removeTimeoutMethod()
Removes the timeout-method element |
ResourceEnvRefType<SessionBeanType<T>> |
resourceEnvRef()
Returns the resource-env-ref element |
ResourceRefType<SessionBeanType<T>> |
resourceRef()
Returns the resource-ref element |
SecurityIdentityType<SessionBeanType<T>> |
securityIdentity()
If not already created, a new security-identity element will be created and returned. |
SecurityRoleRefType<SessionBeanType<T>> |
securityRoleRef()
Returns the security-role-ref element |
ServiceRefType<SessionBeanType<T>> |
serviceRef()
Returns the service-ref element |
SessionBeanType<T> |
setBusinessLocal(java.lang.String businessLocal)
Creates a new business-local element |
SessionBeanType<T> |
setBusinessLocalList(java.lang.String... values)
Creates for all String objects representing business-local elements,
a new business-local element |
SessionBeanType<T> |
setBusinessRemote(java.lang.String businessRemote)
Creates a new business-remote element |
SessionBeanType<T> |
setBusinessRemoteList(java.lang.String... values)
Creates for all String objects representing business-remote elements,
a new business-remote element |
SessionBeanType<T> |
setDescription(java.lang.String description)
Creates a new description element |
SessionBeanType<T> |
setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements,
a new description element |
SessionBeanType<T> |
setDisplayName(java.lang.String displayName)
Creates a new display-name element |
SessionBeanType<T> |
setDisplayNameList(java.lang.String... values)
Creates for all String objects representing display-name elements,
a new display-name element |
SessionBeanType<T> |
setEjbClass(java.lang.String ejbClass)
If not already created, a new ejb-class element with the given value will be created. |
SessionBeanType<T> |
setEjbName(java.lang.String ejbName)
If not already created, a new ejb-name element with the given value will be created. |
SessionBeanType<T> |
setHome(java.lang.String home)
If not already created, a new home element with the given value will be created. |
SessionBeanType<T> |
setLocal(java.lang.String local)
If not already created, a new local element with the given value will be created. |
SessionBeanType<T> |
setLocalHome(java.lang.String localHome)
If not already created, a new local-home element with the given value will be created. |
SessionBeanType<T> |
setMappedName(java.lang.String mappedName)
If not already created, a new mapped-name element with the given value will be created. |
SessionBeanType<T> |
setRemote(java.lang.String remote)
If not already created, a new remote element with the given value will be created. |
SessionBeanType<T> |
setServiceEndpoint(java.lang.String serviceEndpoint)
If not already created, a new service-endpoint element with the given value will be created. |
SessionBeanType<T> |
setSessionType(SessionTypeType sessionType)
If not already created, a new session-type element with the given value will be created. |
SessionBeanType<T> |
setSessionType(java.lang.String sessionType)
If not already created, a new session-type element with the given value will be created. |
SessionBeanType<T> |
setTransactionType(java.lang.String transactionType)
If not already created, a new transaction-type element with the given value will be created. |
SessionBeanType<T> |
setTransactionType(TransactionTypeType transactionType)
If not already created, a new transaction-type element with the given value will be created. |
NamedMethodType<SessionBeanType<T>> |
timeoutMethod()
If not already created, a new timeout-method element will be created and returned. |
| Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child |
|---|
up |
| Method Detail |
|---|
SessionBeanType<T> setDescription(java.lang.String description)
description element
SessionBeanTypeSessionBeanType<T> setDescriptionList(java.lang.String... values)
description elements,
a new description element
list - of description objects
SessionBeanTypeSessionBeanType<T> removeAllDescription()
description element
SessionBeanTypejava.util.List<java.lang.String> getDescriptionList()
description elements
descriptionSessionBeanType<T> setDisplayName(java.lang.String displayName)
display-name element
SessionBeanTypeSessionBeanType<T> setDisplayNameList(java.lang.String... values)
display-name elements,
a new display-name element
list - of display-name objects
SessionBeanTypeSessionBeanType<T> removeAllDisplayName()
display-name element
SessionBeanTypejava.util.List<java.lang.String> getDisplayNameList()
display-name elements
display-nameSessionBeanType<T> removeAllIcon()
icon elements
SessionBeanTypeIconType<SessionBeanType<T>> icon()
icon element
iconjava.util.List<IconType<SessionBeanType<T>>> getIconList()
icon elements
iconSessionBeanType<T> removeAllEnvEntry()
env-entry elements
SessionBeanTypeEnvEntryType<SessionBeanType<T>> envEntry()
env-entry element
env-entryjava.util.List<EnvEntryType<SessionBeanType<T>>> getEnvEntryList()
env-entry elements
env-entrySessionBeanType<T> removeAllEjbRef()
ejb-ref elements
SessionBeanTypeEjbRefType<SessionBeanType<T>> ejbRef()
ejb-ref element
ejb-refjava.util.List<EjbRefType<SessionBeanType<T>>> getEjbRefList()
ejb-ref elements
ejb-refSessionBeanType<T> removeAllEjbLocalRef()
ejb-local-ref elements
SessionBeanTypeEjbLocalRefType<SessionBeanType<T>> ejbLocalRef()
ejb-local-ref element
ejb-local-refjava.util.List<EjbLocalRefType<SessionBeanType<T>>> getEjbLocalRefList()
ejb-local-ref elements
ejb-local-refSessionBeanType<T> removeAllResourceRef()
resource-ref elements
SessionBeanTypeResourceRefType<SessionBeanType<T>> resourceRef()
resource-ref element
resource-refjava.util.List<ResourceRefType<SessionBeanType<T>>> getResourceRefList()
resource-ref elements
resource-refSessionBeanType<T> removeAllResourceEnvRef()
resource-env-ref elements
SessionBeanTypeResourceEnvRefType<SessionBeanType<T>> resourceEnvRef()
resource-env-ref element
resource-env-refjava.util.List<ResourceEnvRefType<SessionBeanType<T>>> getResourceEnvRefList()
resource-env-ref elements
resource-env-refSessionBeanType<T> removeAllMessageDestinationRef()
message-destination-ref elements
SessionBeanTypeMessageDestinationRefType<SessionBeanType<T>> messageDestinationRef()
message-destination-ref element
message-destination-refjava.util.List<MessageDestinationRefType<SessionBeanType<T>>> getMessageDestinationRefList()
message-destination-ref elements
message-destination-refSessionBeanType<T> removeAllPersistenceContextRef()
persistence-context-ref elements
SessionBeanTypePersistenceContextRefType<SessionBeanType<T>> persistenceContextRef()
persistence-context-ref element
persistence-context-refjava.util.List<PersistenceContextRefType<SessionBeanType<T>>> getPersistenceContextRefList()
persistence-context-ref elements
persistence-context-refSessionBeanType<T> removeAllPersistenceUnitRef()
persistence-unit-ref elements
SessionBeanTypePersistenceUnitRefType<SessionBeanType<T>> persistenceUnitRef()
persistence-unit-ref element
persistence-unit-refjava.util.List<PersistenceUnitRefType<SessionBeanType<T>>> getPersistenceUnitRefList()
persistence-unit-ref elements
persistence-unit-refSessionBeanType<T> removeAllPostConstruct()
post-construct elements
SessionBeanTypeLifecycleCallbackType<SessionBeanType<T>> postConstruct()
post-construct element
post-constructjava.util.List<LifecycleCallbackType<SessionBeanType<T>>> getPostConstructList()
post-construct elements
post-constructSessionBeanType<T> removeAllPreDestroy()
pre-destroy elements
SessionBeanTypeLifecycleCallbackType<SessionBeanType<T>> preDestroy()
pre-destroy element
pre-destroyjava.util.List<LifecycleCallbackType<SessionBeanType<T>>> getPreDestroyList()
pre-destroy elements
pre-destroySessionBeanType<T> removeAllServiceRef()
service-ref elements
SessionBeanTypeServiceRefType<SessionBeanType<T>> serviceRef()
service-ref element
service-refjava.util.List<ServiceRefType<SessionBeanType<T>>> getServiceRefList()
service-ref elements
service-refSessionBeanType<T> setEjbName(java.lang.String ejbName)
ejb-name element with the given value will be created.
Otherwise, the existing ejb-name element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeEjbName()
ejb-name element
SessionBeanTypejava.lang.String getEjbName()
ejb-name element
ejb-nameSessionBeanType<T> setMappedName(java.lang.String mappedName)
mapped-name element with the given value will be created.
Otherwise, the existing mapped-name element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeMappedName()
mapped-name element
SessionBeanTypejava.lang.String getMappedName()
mapped-name element
mapped-nameSessionBeanType<T> setHome(java.lang.String home)
home element with the given value will be created.
Otherwise, the existing home element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeHome()
home element
SessionBeanTypejava.lang.String getHome()
home element
homeSessionBeanType<T> setRemote(java.lang.String remote)
remote element with the given value will be created.
Otherwise, the existing remote element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeRemote()
remote element
SessionBeanTypejava.lang.String getRemote()
remote element
remoteSessionBeanType<T> setLocalHome(java.lang.String localHome)
local-home element with the given value will be created.
Otherwise, the existing local-home element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeLocalHome()
local-home element
SessionBeanTypejava.lang.String getLocalHome()
local-home element
local-homeSessionBeanType<T> setLocal(java.lang.String local)
local element with the given value will be created.
Otherwise, the existing local element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeLocal()
local element
SessionBeanTypejava.lang.String getLocal()
local element
localSessionBeanType<T> setBusinessLocal(java.lang.String businessLocal)
business-local element
SessionBeanTypeSessionBeanType<T> setBusinessLocalList(java.lang.String... values)
business-local elements,
a new business-local element
list - of business-local objects
SessionBeanTypeSessionBeanType<T> removeAllBusinessLocal()
business-local element
SessionBeanTypejava.util.List<java.lang.String> getBusinessLocalList()
business-local elements
business-localSessionBeanType<T> setBusinessRemote(java.lang.String businessRemote)
business-remote element
SessionBeanTypeSessionBeanType<T> setBusinessRemoteList(java.lang.String... values)
business-remote elements,
a new business-remote element
list - of business-remote objects
SessionBeanTypeSessionBeanType<T> removeAllBusinessRemote()
business-remote element
SessionBeanTypejava.util.List<java.lang.String> getBusinessRemoteList()
business-remote elements
business-remoteSessionBeanType<T> setServiceEndpoint(java.lang.String serviceEndpoint)
service-endpoint element with the given value will be created.
Otherwise, the existing service-endpoint element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeServiceEndpoint()
service-endpoint element
SessionBeanTypejava.lang.String getServiceEndpoint()
service-endpoint element
service-endpointSessionBeanType<T> setEjbClass(java.lang.String ejbClass)
ejb-class element with the given value will be created.
Otherwise, the existing ejb-class element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> removeEjbClass()
ejb-class element
SessionBeanTypejava.lang.String getEjbClass()
ejb-class element
ejb-classSessionBeanType<T> setSessionType(SessionTypeType sessionType)
session-type element with the given value will be created.
Otherwise, the existing session-type element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> setSessionType(java.lang.String sessionType)
session-type element with the given value will be created.
Otherwise, the existing session-type element will be updated with the given value.
SessionBeanTypeSessionTypeType getSessionType()
session-type element
session-typejava.lang.String getSessionTypeAsString()
session-type element
session-typeSessionBeanType<T> removeTimeoutMethod()
timeout-method element
SessionBeanTypeNamedMethodType<SessionBeanType<T>> timeoutMethod()
timeout-method element will be created and returned.
Otherwise, the existing timeout-method element will be returned.
timeout-methodSessionBeanType<T> removeAllInitMethod()
init-method elements
SessionBeanTypeInitMethodType<SessionBeanType<T>> initMethod()
init-method element
init-methodjava.util.List<InitMethodType<SessionBeanType<T>>> getInitMethodList()
init-method elements
init-methodSessionBeanType<T> removeAllRemoveMethod()
remove-method elements
SessionBeanTypeRemoveMethodType<SessionBeanType<T>> removeMethod()
remove-method element
remove-methodjava.util.List<RemoveMethodType<SessionBeanType<T>>> getRemoveMethodList()
remove-method elements
remove-methodSessionBeanType<T> setTransactionType(TransactionTypeType transactionType)
transaction-type element with the given value will be created.
Otherwise, the existing transaction-type element will be updated with the given value.
SessionBeanTypeSessionBeanType<T> setTransactionType(java.lang.String transactionType)
transaction-type element with the given value will be created.
Otherwise, the existing transaction-type element will be updated with the given value.
SessionBeanTypeTransactionTypeType getTransactionType()
transaction-type element
transaction-typejava.lang.String getTransactionTypeAsString()
transaction-type element
transaction-typeSessionBeanType<T> removeAllAroundInvoke()
around-invoke elements
SessionBeanTypeAroundInvokeType<SessionBeanType<T>> aroundInvoke()
around-invoke element
around-invokejava.util.List<AroundInvokeType<SessionBeanType<T>>> getAroundInvokeList()
around-invoke elements
around-invokeSessionBeanType<T> removeAllPostActivate()
post-activate elements
SessionBeanTypeLifecycleCallbackType<SessionBeanType<T>> postActivate()
post-activate element
post-activatejava.util.List<LifecycleCallbackType<SessionBeanType<T>>> getPostActivateList()
post-activate elements
post-activateSessionBeanType<T> removeAllPrePassivate()
pre-passivate elements
SessionBeanTypeLifecycleCallbackType<SessionBeanType<T>> prePassivate()
pre-passivate element
pre-passivatejava.util.List<LifecycleCallbackType<SessionBeanType<T>>> getPrePassivateList()
pre-passivate elements
pre-passivateSessionBeanType<T> removeAllSecurityRoleRef()
security-role-ref elements
SessionBeanTypeSecurityRoleRefType<SessionBeanType<T>> securityRoleRef()
security-role-ref element
security-role-refjava.util.List<SecurityRoleRefType<SessionBeanType<T>>> getSecurityRoleRefList()
security-role-ref elements
security-role-refSessionBeanType<T> removeSecurityIdentity()
security-identity element
SessionBeanTypeSecurityIdentityType<SessionBeanType<T>> securityIdentity()
security-identity element will be created and returned.
Otherwise, the existing security-identity element will be returned.
security-identity
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||