org.apache.openejb.jee
Class MessageDrivenBean

java.lang.Object
  extended by org.apache.openejb.jee.MessageDrivenBean
All Implemented Interfaces:
EnterpriseBean, JndiConsumer, Lifecycle, TimerConsumer

public class MessageDrivenBean
extends Object
implements EnterpriseBean, TimerConsumer

The message-driven element declares a message-driven 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 descriptor - an optional mapped-name element that can be used to provide vendor-specific deployment information such as the physical jndi-name of destination from which this message-driven bean should consume. This element is not required to be supported by all implementations. Any use of this element is non-portable. - the message-driven bean's implementation class - an optional declaration of the bean's messaging type - an optional declaration of the bean's timeout method. - the optional message-driven bean's transaction management type. If it is not defined, it is defaulted to Container. - an optional declaration of the bean's message-destination-type - an optional declaration of the bean's message-destination-link - an optional declaration of the message-driven bean's activation configuration properties - an optional list of the message-driven 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 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


Field Summary
protected  ActivationConfig activationConfig
           
protected  List<AroundInvoke> aroundInvoke
           
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  LocalCollection<Icon> icon
           
protected  String id
           
protected  String mappedName
           
protected  String messageDestinationLink
           
protected  KeyedCollection<String,MessageDestinationRef> messageDestinationRef
           
protected  String messageDestinationType
           
protected  String messagingType
           
protected  KeyedCollection<String,PersistenceContextRef> persistenceContextRef
           
protected  KeyedCollection<String,PersistenceUnitRef> persistenceUnitRef
           
protected  List<LifecycleCallback> postConstruct
           
protected  List<LifecycleCallback> preDestroy
           
protected  KeyedCollection<String,ResourceEnvRef> resourceEnvRef
           
protected  KeyedCollection<String,ResourceRef> resourceRef
           
protected  SecurityIdentity securityIdentity
           
protected  KeyedCollection<String,ServiceRef> serviceRef
           
protected  NamedMethod timeoutMethod
           
protected  TransactionType transactionType
           
 
Constructor Summary
MessageDrivenBean()
           
MessageDrivenBean(String ejbName)
           
 
Method Summary
 void addAroundInvoke(String method)
           
 void addPostConstruct(String method)
           
 void addPreDestroy(String method)
           
 String getAcknowledgeMode()
           
 ActivationConfig getActivationConfig()
           
 List<AroundInvoke> getAroundInvoke()
           
 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()
           
 Icon getIcon()
           
 Map<String,Icon> getIconMap()
           
 Collection<Icon> getIcons()
           
 String getId()
           
 String getJndiConsumerName()
           
 String getMappedName()
           
 String getMessageDestinationLink()
          The Assembler sets the value to reflect the flow of messages between producers and consumers in the application.
 Collection<MessageDestinationRef> getMessageDestinationRef()
           
 Map<String,MessageDestinationRef> getMessageDestinationRefMap()
           
 String getMessageDestinationType()
           
 MessageDrivenDestination getMessageDrivenDestination()
           
 String getMessageSelector()
           
 String getMessagingType()
           
 Collection<PersistenceContextRef> getPersistenceContextRef()
           
 Map<String,PersistenceContextRef> getPersistenceContextRefMap()
           
 Collection<PersistenceUnitRef> getPersistenceUnitRef()
           
 Map<String,PersistenceUnitRef> getPersistenceUnitRefMap()
           
 List<LifecycleCallback> getPostConstruct()
           
 List<LifecycleCallback> getPreDestroy()
           
 Collection<ResourceEnvRef> getResourceEnvRef()
           
 Map<String,ResourceEnvRef> getResourceEnvRefMap()
           
 Collection<ResourceRef> getResourceRef()
           
 Map<String,ResourceRef> getResourceRefMap()
           
 SecurityIdentity getSecurityIdentity()
           
 Collection<ServiceRef> getServiceRef()
           
 Map<String,ServiceRef> getServiceRefMap()
           
 NamedMethod getTimeoutMethod()
           
 TransactionType getTransactionType()
           
 void setAcknowledgeMode(String acknowledgeMode)
           
 void setActivationConfig(ActivationConfig value)
           
 void setDescriptions(Text[] text)
           
 void setDisplayNames(Text[] text)
           
 void setEjbClass(String value)
           
 void setEjbName(String value)
          The ejb-nameType specifies an enterprise bean's name.
 void setId(String value)
           
 void setMappedName(String value)
           
 void setMessageDestinationLink(String value)
           
 void setMessageDestinationType(String value)
           
 void setMessageDrivenDestination(MessageDrivenDestination value)
           
 void setMessageSelector(String messageSelector)
           
 void setMessagingType(String value)
           
 void setSecurityIdentity(SecurityIdentity 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

ejbClass

protected String ejbClass

messagingType

protected String messagingType

timeoutMethod

protected NamedMethod timeoutMethod

transactionType

protected TransactionType transactionType

messageDestinationType

protected String messageDestinationType

messageDestinationLink

protected String messageDestinationLink

activationConfig

protected ActivationConfig activationConfig

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

securityIdentity

protected SecurityIdentity securityIdentity

id

protected String id
Constructor Detail

MessageDrivenBean

public MessageDrivenBean()

MessageDrivenBean

public MessageDrivenBean(String ejbName)
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

getEjbClass

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

setEjbClass

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

getMessagingType

public String getMessagingType()

setMessagingType

public void setMessagingType(String value)

getTimeoutMethod

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

setTimeoutMethod

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

getMessageDrivenDestination

public MessageDrivenDestination getMessageDrivenDestination()

setMessageDrivenDestination

public void setMessageDrivenDestination(MessageDrivenDestination value)

getMessageSelector

public String getMessageSelector()

setMessageSelector

public void setMessageSelector(String messageSelector)

getAcknowledgeMode

public String getAcknowledgeMode()

setAcknowledgeMode

public void setAcknowledgeMode(String acknowledgeMode)

getTransactionType

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

setTransactionType

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

getMessageDestinationType

public String getMessageDestinationType()

setMessageDestinationType

public void setMessageDestinationType(String value)

getMessageDestinationLink

public String getMessageDestinationLink()
The Assembler sets the value to reflect the flow of messages between producers and consumers in the application.

The value must be the message-destination-name of a message destination in the same Deployment File or in another Deployment File in the same Java EE application unit.

Alternatively, the value may be composed of a path name specifying a Deployment File containing the referenced message destination with the message-destination-name of the destination appended and separated from the path name by "#". The path name is relative to the Deployment File containing Deployment Component that is referencing the message destination. This allows multiple message destinations with the same name to be uniquely identified.


setMessageDestinationLink

public void setMessageDestinationLink(String value)

getActivationConfig

public ActivationConfig getActivationConfig()

setActivationConfig

public void setActivationConfig(ActivationConfig 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

getSecurityIdentity

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

setSecurityIdentity

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

getId

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

setId

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


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