Package com.sun.enterprise.deployment
Class MessageDestinationReferenceDescriptor
- java.lang.Object
-
- java.util.Observable
-
- org.glassfish.deployment.common.DynamicAttributesDescriptor
-
- org.glassfish.deployment.common.Descriptor
-
- com.sun.enterprise.deployment.EnvironmentProperty
-
- com.sun.enterprise.deployment.MessageDestinationReferenceDescriptor
-
- All Implemented Interfaces:
InjectionCapable
,ApplicationParam
,MessageDestinationReference
,MessageDestinationReferencer
,NamedInformation
,ContextParameter
,EnvironmentEntry
,InitializationParameter
,NameValuePair
,WebDescriptor
,Serializable
public class MessageDestinationReferenceDescriptor extends EnvironmentProperty implements MessageDestinationReference
An object representing the use of a message destination in a J2EE component.- Author:
- Kenneth Saks
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
CONSUMES
static String
CONSUMES_PRODUCES
static String
PRODUCES
-
Fields inherited from class com.sun.enterprise.deployment.EnvironmentProperty
lookupName, mappedName
-
Fields inherited from class org.glassfish.deployment.common.Descriptor
DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED
-
Fields inherited from interface com.sun.enterprise.deployment.types.MessageDestinationReference
CONSUMES_AND_PRODUCES
-
-
Constructor Summary
Constructors Constructor Description MessageDestinationReferenceDescriptor()
Constructs a reference in the extrernal state.MessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor other)
copy constructorMessageDestinationReferenceDescriptor(String name, String desc)
Construct an message destination reference with the given name and descriptor of the reference.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object object)
Returns true if the argument is an environment property of the same name, false else.String
getDestinationType()
String
getInjectResourceType()
This is the class name of the type of resource that is to be injected.String
getJndiName()
EjbMessageBeanDescriptor
getMessageBeanOwner()
Get the descriptor for the message-driven bean owner.MessageDestinationDescriptor
getMessageDestination()
String
getMessageDestinationLinkName()
Gets the link name of the reference.MessageDestinationReferenceDescriptor
getMessageDestinationRefOwner()
Get the descriptor for the message destination reference owner.BundleDescriptor
getReferringBundleDescriptor()
Get the referring bundle, i.e.String
getUsage()
int
hashCode()
The hashCode of an environment property is the same as that of the name String.boolean
isConflict(MessageDestinationReferenceDescriptor other)
boolean
isLinkedToMessageDestination()
boolean
ownedByMessageBean()
True if the owner is a message-driven bean.boolean
ownedByMessageDestinationRef()
True if the owner is a message destination reference.void
print(StringBuilder toStringBuilder)
returns a formatted string representing me.MessageDestinationDescriptor
resolveLinkName()
Try to resolve the current link name value to a MessageDestination object.void
setDestinationType(String type)
void
setInjectResourceType(String resourceType)
void
setJndiName(String physicalDestinationName)
void
setMessageDestination(MessageDestinationDescriptor newMsgDest)
void
setMessageDestinationLinkName(String linkName)
Sets the name of the message destination to which I refer.MessageDestinationDescriptor
setMessageDestinationLinkName(String linkName, boolean resolveLink)
Sets the name of the message destination to which I refer.void
setReferringBundleDescriptor(BundleDescriptor referringBundle)
Set the referring bundle, i.e.void
setUsage(String destUsage)
-
Methods inherited from class com.sun.enterprise.deployment.EnvironmentProperty
addInjectionTarget, getComponentEnvName, getInjectionTargets, getLookupName, getMappedName, getResolvedValue, getResolvedValueObject, getType, getValue, getValueObject, getValueType, hasAValue, hasInjectionTargetFromXml, hasLookupName, isConflict, isConflictResourceGroup, isInjectable, isSetValueCalled, printInjectableResourceInfo, setLookupName, setMappedName, setType, setValue
-
Methods inherited from class org.glassfish.deployment.common.Descriptor
addDescriptorExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDescriptorExtension, getDescriptorExtensions, getDisplayName, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getName, getPrefixMapping, getSmallIconUri, isBoundsChecking, setBoundsChecking, setDescription, setDisplayName, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setName, setSmallIconUri, visit
-
Methods inherited from class org.glassfish.deployment.common.DynamicAttributesDescriptor
addExtraAttribute, getExtraAttribute, getExtraAttributes, removeExtraAttribute, toString
-
Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.sun.enterprise.deployment.types.MessageDestinationReference
getType, setType
-
Methods inherited from interface com.sun.enterprise.deployment.types.NamedInformation
getDescription, getName, setDescription, setName
-
Methods inherited from interface com.sun.enterprise.deployment.web.NameValuePair
getDescription, getName, setDescription, setName
-
Methods inherited from interface com.sun.enterprise.deployment.web.WebDescriptor
getDescription, getLargeIconUri, getName, getSmallIconUri, setDescription, setLargeIconUri, setName, setSmallIconUri
-
-
-
-
Field Detail
-
CONSUMES
public static final String CONSUMES
- See Also:
- Constant Field Values
-
PRODUCES
public static final String PRODUCES
- See Also:
- Constant Field Values
-
CONSUMES_PRODUCES
public static final String CONSUMES_PRODUCES
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MessageDestinationReferenceDescriptor
public MessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor other)
copy constructor
-
MessageDestinationReferenceDescriptor
public MessageDestinationReferenceDescriptor(String name, String desc)
Construct an message destination reference with the given name and descriptor of the reference.- Parameters:
name
- the message-destination-ref name as used in the referencing componentoptional
- description
-
MessageDestinationReferenceDescriptor
public MessageDestinationReferenceDescriptor()
Constructs a reference in the extrernal state.
-
-
Method Detail
-
getUsage
public String getUsage()
- Specified by:
getUsage
in interfaceMessageDestinationReference
- Returns:
- the usage type of the message destination reference (Consumes, Produces, ConsumesProduces)
-
setUsage
public void setUsage(String destUsage)
- Specified by:
setUsage
in interfaceMessageDestinationReference
- Parameters:
usage
- the usage type of the message destination reference (Consumes, Produces, ConsumesProduces)
-
getDestinationType
public String getDestinationType()
-
setDestinationType
public void setDestinationType(String type)
-
getJndiName
public String getJndiName()
-
setJndiName
public void setJndiName(String physicalDestinationName)
-
getInjectResourceType
public String getInjectResourceType()
Description copied from interface:InjectionCapable
This is the class name of the type of resource that is to be injected.- Specified by:
getInjectResourceType
in interfaceInjectionCapable
- Overrides:
getInjectResourceType
in classEnvironmentProperty
-
setInjectResourceType
public void setInjectResourceType(String resourceType)
- Specified by:
setInjectResourceType
in interfaceInjectionCapable
- Overrides:
setInjectResourceType
in classEnvironmentProperty
-
setReferringBundleDescriptor
public void setReferringBundleDescriptor(BundleDescriptor referringBundle)
Set the referring bundle, i.e. the bundle within which this message destination reference is declared.- Specified by:
setReferringBundleDescriptor
in interfaceMessageDestinationReference
-
getReferringBundleDescriptor
public BundleDescriptor getReferringBundleDescriptor()
Get the referring bundle, i.e. the bundle within which this message destination reference is declared.- Specified by:
getReferringBundleDescriptor
in interfaceMessageDestinationReference
-
isLinkedToMessageDestination
public boolean isLinkedToMessageDestination()
- Specified by:
isLinkedToMessageDestination
in interfaceMessageDestinationReferencer
- Returns:
- true if this referencer is linked to a message destination and false otherwise.
-
getMessageDestinationLinkName
public String getMessageDestinationLinkName()
Description copied from interface:MessageDestinationReferencer
Gets the link name of the reference. Points to the associated message destination within the J2EE application. Can be NULL if link is not set.- Specified by:
getMessageDestinationLinkName
in interfaceMessageDestinationReferencer
- Returns:
- the name of the message destination to which I refer
-
setMessageDestinationLinkName
public void setMessageDestinationLinkName(String linkName)
Sets the name of the message destination to which I refer.- Specified by:
setMessageDestinationLinkName
in interfaceMessageDestinationReferencer
-
setMessageDestinationLinkName
public MessageDestinationDescriptor setMessageDestinationLinkName(String linkName, boolean resolveLink)
Description copied from interface:MessageDestinationReferencer
Sets the name of the message destination to which I refer.- Specified by:
setMessageDestinationLinkName
in interfaceMessageDestinationReferencer
resolveLink
- if true, *try* to resolve link to the target message destination.- Returns:
- MessageDestination to which link was resolved, or null if link name resolution failed.
-
resolveLinkName
public MessageDestinationDescriptor resolveLinkName()
Description copied from interface:MessageDestinationReferencer
Try to resolve the current link name value to a MessageDestination object.- Specified by:
resolveLinkName
in interfaceMessageDestinationReferencer
- Returns:
- MessageDestination to which link was resolved, or null if link name resolution failed.
-
ownedByMessageDestinationRef
public boolean ownedByMessageDestinationRef()
Description copied from interface:MessageDestinationReferencer
True if the owner is a message destination reference.- Specified by:
ownedByMessageDestinationRef
in interfaceMessageDestinationReferencer
-
getMessageDestinationRefOwner
public MessageDestinationReferenceDescriptor getMessageDestinationRefOwner()
Get the descriptor for the message destination reference owner.- Specified by:
getMessageDestinationRefOwner
in interfaceMessageDestinationReferencer
-
ownedByMessageBean
public boolean ownedByMessageBean()
True if the owner is a message-driven bean.- Specified by:
ownedByMessageBean
in interfaceMessageDestinationReferencer
-
getMessageBeanOwner
public EjbMessageBeanDescriptor getMessageBeanOwner()
Get the descriptor for the message-driven bean owner.- Specified by:
getMessageBeanOwner
in interfaceMessageDestinationReferencer
-
getMessageDestination
public MessageDestinationDescriptor getMessageDestination()
- Specified by:
getMessageDestination
in interfaceMessageDestinationReferencer
- Returns:
- the message destination to which I refer. Can be NULL.
-
setMessageDestination
public void setMessageDestination(MessageDestinationDescriptor newMsgDest)
- Specified by:
setMessageDestination
in interfaceMessageDestinationReferencer
- Parameters:
messageDestiation
- the message destination to which I refer.
-
print
public void print(StringBuilder toStringBuilder)
returns a formatted string representing me.- Overrides:
print
in classEnvironmentProperty
-
isConflict
public boolean isConflict(MessageDestinationReferenceDescriptor other)
-
equals
public boolean equals(Object object)
Description copied from class:EnvironmentProperty
Returns true if the argument is an environment property of the same name, false else.- Overrides:
equals
in classEnvironmentProperty
-
hashCode
public int hashCode()
Description copied from class:EnvironmentProperty
The hashCode of an environment property is the same as that of the name String.- Overrides:
hashCode
in classEnvironmentProperty
-
-