org.apache.openejb.jee
Class MessageDestinationRef
java.lang.Object
org.apache.openejb.jee.MessageDestinationRef
- All Implemented Interfaces:
- Injectable, JndiReference, Keyable<String>
public class MessageDestinationRef
- extends 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
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
description
protected List<Text> description
messageDestinationRefName
protected String messageDestinationRefName
messageDestinationType
protected String messageDestinationType
messageDestinationUsage
protected MessageDestinationUsage messageDestinationUsage
messageDestinationLink
protected String messageDestinationLink
mappedName
protected String mappedName
injectionTarget
protected List<InjectionTarget> injectionTarget
id
protected String id
MessageDestinationRef
public MessageDestinationRef()
getName
public String getName()
- Specified by:
getName
in interface JndiReference
getKey
public String getKey()
- Description copied from interface:
Keyable
- Gets the immutable key for this object.
- Specified by:
getKey
in interface Keyable<String>
- Returns:
- gets the immutable key for this object
getType
public String getType()
- Specified by:
getType
in interface JndiReference
setName
public void setName(String name)
- Specified by:
setName
in interface JndiReference
setType
public void setType(String type)
- Specified by:
setType
in interface JndiReference
getDescription
public List<Text> getDescription()
getMessageDestinationRefName
public String getMessageDestinationRefName()
setMessageDestinationRefName
public void setMessageDestinationRefName(String value)
getMessageDestinationType
public String getMessageDestinationType()
setMessageDestinationType
public void setMessageDestinationType(String value)
getMessageDestinationUsage
public MessageDestinationUsage getMessageDestinationUsage()
setMessageDestinationUsage
public void setMessageDestinationUsage(MessageDestinationUsage 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)
getMappedName
public String getMappedName()
- Specified by:
getMappedName
in interface JndiReference
setMappedName
public void setMappedName(String value)
- Specified by:
setMappedName
in interface JndiReference
getInjectionTarget
public List<InjectionTarget> getInjectionTarget()
- Specified by:
getInjectionTarget
in interface Injectable
getId
public String getId()
setId
public void setId(String value)
Copyright © 1999-2013 The Apache OpenEJB development community. All Rights Reserved.