MessageDriven

java.lang.Object
- org.apache.openejb.jee.was.v6.common.DescriptionGroup
- - org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup
  - - org.apache.openejb.jee.was.v6.common.JNDIEnvRefsGroup
    - - org.apache.openejb.jee.was.v6.ejb.EnterpriseBean
      - org.apache.openejb.jee.was.v6.ejb.MessageDriven

```
public class MessageDriven
extends EnterpriseBean
```
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 - the message-driven bean's implementation class - an optional declaration of the bean's messaging type - the message-driven bean's transaction management type - 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 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 Java class for MessageDriven complex type. The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="MessageDriven">
   <complexContent>
     <extension base="{ejb.xmi}EnterpriseBean">
       <choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="destination" type="{ejb.xmi}MessageDrivenDestination"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="activationConfig" type="{ejb.xmi}ActivationConfig"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="messageDestination" type="{java.xmi}JavaClass"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="messagingType" type="{java.xmi}JavaClass"/>
         </choice>
       </choice>
       <attribute name="acknowledgeMode" type="{ejb.xmi}AcknowledgeMode" />
       <attribute name="link" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="messageDestination" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="messageSelector" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="messagingType" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="transactionType" type="{ejb.xmi}TransactionType" />
     </extension>
   </complexContent>
 </complexType>
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected AcknowledgeModeEnum`	`acknowledgeMode`
`protected java.util.List<ActivationConfig>`	`activationConfigs`
`protected java.util.List<MessageDrivenDestination>`	`destinations`
`protected java.lang.String`	`link`
`protected java.lang.String`	`messageDestination`
`protected java.util.List<JavaClass>`	`messageDestinations`
`protected java.lang.String`	`messageSelector`
`protected java.lang.String`	`messagingType`
`protected java.util.List<JavaClass>`	`messagingTypes`
`protected TransactionEnum`	`transactionType`

Fields inherited from class org.apache.openejb.jee.was.v6.ejb.EnterpriseBean
ejbClass, ejbClasses, homeInterface, homeInterfaces, localHomeInterface, localHomeInterfaces, localInterface, localInterfaces, name, remoteInterface, remoteInterfaces, securityIdentities, securityRoleRefs

Fields inherited from class org.apache.openejb.jee.was.v6.common.JNDIEnvRefsGroup
ejbLocalRefs, ejbRefs, environmentProperties, messageDestinationRefs, resourceEnvRefs, resourceRefs, serviceRefs

Fields inherited from class org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup
description, displayName, largeIcon, smallIcon

Fields inherited from class org.apache.openejb.jee.was.v6.common.DescriptionGroup
descriptions, displayNames, extensions, href, icons, id, idref, label, type, uuid, version

Constructor Summary

Constructors
Constructor and Description

MessageDriven()

Constructors
Constructor and Description
`MessageDriven()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcknowledgeModeEnum`	`getAcknowledgeMode()` Gets the value of the acknowledgeMode property.
`java.util.List<ActivationConfig>`	`getActivationConfigs()` Gets the value of the activationConfigs property.
`java.util.List<MessageDrivenDestination>`	`getDestinations()` Gets the value of the destinations property.
`java.lang.String`	`getLink()` Gets the value of the link property.
`java.lang.String`	`getMessageDestination()` Gets the value of the messageDestination property.
`java.util.List<JavaClass>`	`getMessageDestinations()` Gets the value of the messageDestinations property.
`java.lang.String`	`getMessageSelector()` Gets the value of the messageSelector property.
`java.lang.String`	`getMessagingType()` Gets the value of the messagingType property.
`java.util.List<JavaClass>`	`getMessagingTypes()` Gets the value of the messagingTypes property.
`TransactionEnum`	`getTransactionType()` Gets the value of the transactionType property.
`void`	`setAcknowledgeMode(AcknowledgeModeEnum value)` Sets the value of the acknowledgeMode property.
`void`	`setLink(java.lang.String value)` Sets the value of the link property.
`void`	`setMessageDestination(java.lang.String value)` Sets the value of the messageDestination property.
`void`	`setMessageSelector(java.lang.String value)` Sets the value of the messageSelector property.
`void`	`setMessagingType(java.lang.String value)` Sets the value of the messagingType property.
`void`	`setTransactionType(TransactionEnum value)` Sets the value of the transactionType property.

Methods inherited from class org.apache.openejb.jee.was.v6.ejb.EnterpriseBean
getEjbClass, getEjbClasses, getHomeInterface, getHomeInterfaces, getLocalHomeInterface, getLocalHomeInterfaces, getLocalInterface, getLocalInterfaces, getName, getRemoteInterface, getRemoteInterfaces, getSecurityIdentities, getSecurityRoleRefs, setEjbClass, setHomeInterface, setLocalHomeInterface, setLocalInterface, setName, setRemoteInterface

Methods inherited from class org.apache.openejb.jee.was.v6.common.JNDIEnvRefsGroup
getEjbLocalRefs, getEjbRefs, getEnvironmentProperties, getMessageDestinationRefs, getResourceEnvRefs, getResourceRefs, getServiceRefs

Methods inherited from class org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDisplayName, setLargeIcon, setSmallIcon

Methods inherited from class org.apache.openejb.jee.was.v6.common.DescriptionGroup
getDescriptions, getDisplayNames, getExtensions, getHref, getIcons, getId, getIdref, getLabel, getType, getUuid, getVersion, setHref, setId, setIdref, setLabel, setType, setUuid, setVersion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - destinations
```
protected java.util.List<MessageDrivenDestination> destinations
```
  - activationConfigs
```
protected java.util.List<ActivationConfig> activationConfigs
```
  - messageDestinations
```
protected java.util.List<JavaClass> messageDestinations
```
  - messagingTypes
```
protected java.util.List<JavaClass> messagingTypes
```
  - acknowledgeMode
```
protected AcknowledgeModeEnum acknowledgeMode
```
  - link
```
protected java.lang.String link
```
  - messageDestination
```
protected java.lang.String messageDestination
```
  - messageSelector
```
protected java.lang.String messageSelector
```
  - messagingType
```
protected java.lang.String messagingType
```
  - transactionType
```
protected TransactionEnum transactionType
```
- Constructor Detail
  - MessageDriven
```
public MessageDriven()
```
- Method Detail
  - getDestinations
```
public java.util.List<MessageDrivenDestination> getDestinations()
```
    Gets the value of the destinations property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the destinations property. For example, to add a new item, do as follows:
```
 getDestinations().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list MessageDrivenDestination
  - getActivationConfigs
```
public java.util.List<ActivationConfig> getActivationConfigs()
```
    Gets the value of the activationConfigs property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the activationConfigs property. For example, to add a new item, do as follows:
```
 getActivationConfigs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ActivationConfig
  - getMessageDestinations
```
public java.util.List<JavaClass> getMessageDestinations()
```
    Gets the value of the messageDestinations property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the messageDestinations property. For example, to add a new item, do as follows:
```
 getMessageDestinations().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list JavaClass
  - getMessagingTypes
```
public java.util.List<JavaClass> getMessagingTypes()
```
    Gets the value of the messagingTypes property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the messagingTypes property. For example, to add a new item, do as follows:
```
 getMessagingTypes().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list JavaClass
  - getAcknowledgeMode
```
public AcknowledgeModeEnum getAcknowledgeMode()
```
    Gets the value of the acknowledgeMode property.
    
    Returns:
    
    possible object is AcknowledgeModeEnum
  - setAcknowledgeMode
```
public void setAcknowledgeMode(AcknowledgeModeEnum value)
```
    Sets the value of the acknowledgeMode property.
    
    Parameters:
    
    value - allowed object is AcknowledgeModeEnum
  - getLink
```
public java.lang.String getLink()
```
    Gets the value of the link property.
    
    Returns:
    
    possible object is String
  - setLink
```
public void setLink(java.lang.String value)
```
    Sets the value of the link property.
    
    Parameters:
    
    value - allowed object is String
  - getMessageDestination
```
public java.lang.String getMessageDestination()
```
    Gets the value of the messageDestination property.
    
    Returns:
    
    possible object is String
  - setMessageDestination
```
public void setMessageDestination(java.lang.String value)
```
    Sets the value of the messageDestination property.
    
    Parameters:
    
    value - allowed object is String
  - getMessageSelector
```
public java.lang.String getMessageSelector()
```
    Gets the value of the messageSelector property.
    
    Returns:
    
    possible object is String
  - setMessageSelector
```
public void setMessageSelector(java.lang.String value)
```
    Sets the value of the messageSelector property.
    
    Parameters:
    
    value - allowed object is String
  - getMessagingType
```
public java.lang.String getMessagingType()
```
    Gets the value of the messagingType property.
    
    Returns:
    
    possible object is String
  - setMessagingType
```
public void setMessagingType(java.lang.String value)
```
    Sets the value of the messagingType property.
    
    Parameters:
    
    value - allowed object is String
  - getTransactionType
```
public TransactionEnum getTransactionType()
```
    Gets the value of the transactionType property.
    
    Returns:
    
    possible object is TransactionEnum
  - setTransactionType
```
public void setTransactionType(TransactionEnum value)
```
    Sets the value of the transactionType property.
    
    Parameters:
    
    value - allowed object is TransactionEnum

Class MessageDriven

Field Summary

Fields inherited from class org.apache.openejb.jee.was.v6.ejb.EnterpriseBean

Fields inherited from class org.apache.openejb.jee.was.v6.common.JNDIEnvRefsGroup

Fields inherited from class org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup

Fields inherited from class org.apache.openejb.jee.was.v6.common.DescriptionGroup

Constructor Summary

Method Summary

Methods inherited from class org.apache.openejb.jee.was.v6.ejb.EnterpriseBean

Methods inherited from class org.apache.openejb.jee.was.v6.common.JNDIEnvRefsGroup

Methods inherited from class org.apache.openejb.jee.was.v6.common.CompatibilityDescriptionGroup

Methods inherited from class org.apache.openejb.jee.was.v6.common.DescriptionGroup

Methods inherited from class java.lang.Object

Field Detail

destinations

activationConfigs

messageDestinations

messagingTypes

acknowledgeMode

link

messageDestination

messageSelector

messagingType

transactionType

Constructor Detail

MessageDriven

Method Detail

getDestinations

getActivationConfigs

getMessageDestinations

getMessagingTypes

getAcknowledgeMode

setAcknowledgeMode

getLink

setLink

getMessageDestination

setMessageDestination

getMessageSelector

setMessageSelector

getMessagingType

setMessagingType

getTransactionType

setTransactionType