org.apache.openejb.jee
Class MessageDrivenBean

java.lang.Object
  org.apache.openejb.jee.MessageDrivenBean

All Implemented Interfaces:

EnterpriseBean, Invokable, JndiConsumer, Lifecycle, TimerConsumer

public class MessageDrivenBean
extends Object
implements EnterpriseBean, TimerConsumer, Invokable

ejb-jar_3_1.xsd

Java class for message-driven-beanType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="message-driven-beanType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="ejb-name" type="{http://java.sun.com/xml/ns/javaee}ejb-nameType"/>
         <element name="mapped-name" type="{http://java.sun.com/xml/ns/javaee}xsdStringType" minOccurs="0"/>
         <element name="ejb-class" type="{http://java.sun.com/xml/ns/javaee}ejb-classType" minOccurs="0"/>
         <element name="messaging-type" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType" minOccurs="0"/>
         <element name="timeout-method" type="{http://java.sun.com/xml/ns/javaee}named-methodType" minOccurs="0"/>
         <element name="timer" type="{http://java.sun.com/xml/ns/javaee}timerType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="transaction-type" type="{http://java.sun.com/xml/ns/javaee}transaction-typeType" minOccurs="0"/>
         <element name="message-destination-type" type="{http://java.sun.com/xml/ns/javaee}message-destination-typeType" minOccurs="0"/>
         <element name="message-destination-link" type="{http://java.sun.com/xml/ns/javaee}message-destination-linkType" minOccurs="0"/>
         <element name="activation-config" type="{http://java.sun.com/xml/ns/javaee}activation-configType" minOccurs="0"/>
         <element name="around-invoke" type="{http://java.sun.com/xml/ns/javaee}around-invokeType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="around-timeout" type="{http://java.sun.com/xml/ns/javaee}around-timeoutType" maxOccurs="unbounded" minOccurs="0"/>
         <group ref="{http://java.sun.com/xml/ns/javaee}jndiEnvironmentRefsGroup"/>
         <element name="security-role-ref" type="{http://java.sun.com/xml/ns/javaee}security-role-refType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="security-identity" type="{http://java.sun.com/xml/ns/javaee}security-identityType" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected ActivationConfig	activationConfig
protected List<AroundInvoke>	aroundInvoke
protected List<AroundTimeout>	aroundTimeout
protected KeyedCollection<String,DataSource>	dataSource
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 List<SecurityRoleRef>	securityRoleRef
protected KeyedCollection<String,ServiceRef>	serviceRef
protected NamedMethod	timeoutMethod
protected List<Timer>	timer
protected TransactionType	transactionType

Constructor Summary

MessageDrivenBean()

MessageDrivenBean(Class ejbClass)

MessageDrivenBean(String ejbName)

MessageDrivenBean(String ejbName, Class ejbClass)

MessageDrivenBean(String ejbName, String ejbClass)

Method Summary

void	addAroundInvoke(String method)
void	addAroundTimeout(String method)
void	addPostConstruct(String method)
void	addPreDestroy(String method)
String	getAcknowledgeMode()
ActivationConfig	getActivationConfig()
List<AroundInvoke>	getAroundInvoke()
List<AroundTimeout>	getAroundTimeout()
Collection<DataSource>	getDataSource()
Map<String,DataSource>	getDataSourceMap()
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()
List<SecurityRoleRef>	getSecurityRoleRef()
Collection<ServiceRef>	getServiceRef()
Map<String,ServiceRef>	getServiceRefMap()
NamedMethod	getTimeoutMethod()
List<Timer>	getTimer()
String	getTimerConsumerName()
TransactionType	getTransactionType()
void	setAcknowledgeMode(String acknowledgeMode)
void	setActivationConfig(ActivationConfig value)
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	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(Class value)
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

timer

protected List<Timer> timer

transactionType

protected TransactionType transactionType

messageDestinationType

protected String messageDestinationType

messageDestinationLink

protected String messageDestinationLink

activationConfig

protected ActivationConfig activationConfig

aroundInvoke

protected List<AroundInvoke> aroundInvoke

aroundTimeout

protected List<AroundTimeout> aroundTimeout

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

dataSource

protected KeyedCollection<String,DataSource> dataSource

postConstruct

protected List<LifecycleCallback> postConstruct

preDestroy

protected List<LifecycleCallback> preDestroy

securityRoleRef

protected List<SecurityRoleRef> securityRoleRef

securityIdentity

protected SecurityIdentity securityIdentity

id

protected String id

Constructor Detail

MessageDrivenBean

public MessageDrivenBean()

MessageDrivenBean

public MessageDrivenBean(String ejbName)

MessageDrivenBean

public MessageDrivenBean(String ejbName,
                         String ejbClass)

MessageDrivenBean

public MessageDrivenBean(Class ejbClass)

MessageDrivenBean

public MessageDrivenBean(String ejbName,
                         Class ejbClass)

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

setEjbClass

public void setEjbClass(Class value)

Specified by:

setEjbClass in interface EnterpriseBean

getMessagingType

public String getMessagingType()

setMessagingType

public void setMessagingType(String value)

setMessagingType

public void setMessagingType(Class value)

getTimeoutMethod

public NamedMethod getTimeoutMethod()

Specified by:

getTimeoutMethod in interface TimerConsumer

setTimeoutMethod

public void setTimeoutMethod(NamedMethod value)

Specified by:

setTimeoutMethod in interface TimerConsumer

getTimer

public List<Timer> getTimer()

Specified by:

getTimer 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 Invokable

addAroundInvoke

public void addAroundInvoke(String method)

Specified by:

addAroundInvoke in interface Invokable

getAroundTimeout

public List<AroundTimeout> getAroundTimeout()

Specified by:

getAroundTimeout in interface Invokable

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

getDataSource

public Collection<DataSource> getDataSource()

Specified by:

getDataSource in interface JndiConsumer

getDataSourceMap

public Map<String,DataSource> getDataSourceMap()

Specified by:

getDataSourceMap 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

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

getId

public String getId()

Specified by:

getId in interface EnterpriseBean

setId

public void setId(String value)

Specified by:

setId in interface EnterpriseBean

addAroundTimeout

public void addAroundTimeout(String method)

Specified by:

addAroundTimeout in interface Invokable

getTimerConsumerName

public String getTimerConsumerName()

Specified by:

getTimerConsumerName in interface TimerConsumer