org.apache.openejb.jee
Class MessageDestinationRef

java.lang.Object
  extended by org.apache.openejb.jee.MessageDestinationRef
All Implemented Interfaces:
Injectable, JndiReference, Keyable<java.lang.String>

public class MessageDestinationRef
extends java.lang.Object
implements JndiReference

The message-destination-ref element contains a declaration of Deployment Component's reference to a message destination associated with a resource in Deployment Component's environment. It consists of:

- an optional description - the message destination reference name - an optional message destination type - an optional specification as to whether the destination is used for consuming or producing messages, or both. if not specified, "both" is assumed. - an optional link to the message destination - optional injection targets

The message destination type must be supplied unless an injection target is specified, in which case the type of the target is used. If both are specified, the type must be assignment compatible with the type of the injection target.

Examples:

jms/StockQueue javax.jms.Queue Consumes CorporateStocks


Field Summary
protected  java.util.List<Text> description
           
protected  java.lang.String id
           
protected  java.util.List<InjectionTarget> injectionTarget
           
protected  java.lang.String mappedName
           
protected  java.lang.String messageDestinationLink
           
protected  java.lang.String messageDestinationRefName
           
protected  java.lang.String messageDestinationType
           
protected  MessageDestinationUsage messageDestinationUsage
           
 
Constructor Summary
MessageDestinationRef()
           
 
Method Summary
 java.util.List<Text> getDescription()
           
 java.lang.String getId()
           
 java.util.List<InjectionTarget> getInjectionTarget()
           
 java.lang.String getKey()
          Gets the immutable key for this object.
 java.lang.String getMappedName()
           
 java.lang.String getMessageDestinationLink()
          The Assembler sets the value to reflect the flow of messages between producers and consumers in the application.
 java.lang.String getMessageDestinationRefName()
           
 java.lang.String getMessageDestinationType()
           
 MessageDestinationUsage getMessageDestinationUsage()
           
 java.lang.String getName()
           
 java.lang.String getType()
           
 void setId(java.lang.String value)
           
 void setMappedName(java.lang.String value)
           
 void setMessageDestinationLink(java.lang.String value)
           
 void setMessageDestinationRefName(java.lang.String value)
           
 void setMessageDestinationType(java.lang.String value)
           
 void setMessageDestinationUsage(MessageDestinationUsage value)
           
 void setName(java.lang.String name)
           
 void setType(java.lang.String type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected java.util.List<Text> description

messageDestinationRefName

protected java.lang.String messageDestinationRefName

messageDestinationType

protected java.lang.String messageDestinationType

messageDestinationUsage

protected MessageDestinationUsage messageDestinationUsage

messageDestinationLink

protected java.lang.String messageDestinationLink

mappedName

protected java.lang.String mappedName

injectionTarget

protected java.util.List<InjectionTarget> injectionTarget

id

protected java.lang.String id
Constructor Detail

MessageDestinationRef

public MessageDestinationRef()
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface JndiReference

getKey

public java.lang.String getKey()
Description copied from interface: Keyable
Gets the immutable key for this object.

Specified by:
getKey in interface Keyable<java.lang.String>
Returns:
gets the immutable key for this object

getType

public java.lang.String getType()
Specified by:
getType in interface JndiReference

setName

public void setName(java.lang.String name)
Specified by:
setName in interface JndiReference

setType

public void setType(java.lang.String type)
Specified by:
setType in interface JndiReference

getDescription

public java.util.List<Text> getDescription()

getMessageDestinationRefName

public java.lang.String getMessageDestinationRefName()

setMessageDestinationRefName

public void setMessageDestinationRefName(java.lang.String value)

getMessageDestinationType

public java.lang.String getMessageDestinationType()

setMessageDestinationType

public void setMessageDestinationType(java.lang.String value)

getMessageDestinationUsage

public MessageDestinationUsage getMessageDestinationUsage()

setMessageDestinationUsage

public void setMessageDestinationUsage(MessageDestinationUsage value)

getMessageDestinationLink

public java.lang.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(java.lang.String value)

getMappedName

public java.lang.String getMappedName()
Specified by:
getMappedName in interface JndiReference

setMappedName

public void setMappedName(java.lang.String value)
Specified by:
setMappedName in interface JndiReference

getInjectionTarget

public java.util.List<InjectionTarget> getInjectionTarget()
Specified by:
getInjectionTarget in interface Injectable

getId

public java.lang.String getId()

setId

public void setId(java.lang.String value)


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