com.sun.enterprise.deployment.types
Interface MessageDestinationReferencer

All Known Subinterfaces:

MessageDestinationReference

All Known Implementing Classes:

EjbMessageBeanDescriptor, MessageDestinationReferenceDescriptor, MessageDestinationReferencerImpl

public interface MessageDestinationReferencer

Author:

Kenneth Saks

Method Summary

EjbMessageBeanDescriptor	getMessageBeanOwner() Get the descriptor for the message-driven bean owner.
MessageDestinationDescriptor	getMessageDestination()
java.lang.String	getMessageDestinationLinkName() Gets the link name of the reference.
MessageDestinationReferenceDescriptor	getMessageDestinationRefOwner() Get the descriptor for the message destination reference owner.
boolean	isLinkedToMessageDestination()
boolean	ownedByMessageBean() True if the owner is a message-driven bean.
boolean	ownedByMessageDestinationRef() True if the owner is a message destination reference.
MessageDestinationDescriptor	resolveLinkName() Try to resolve the current link name value to a MessageDestination object.
void	setMessageDestination(MessageDestinationDescriptor destination)
void	setMessageDestinationLinkName(java.lang.String linkName) Sets the link name of the reference.
MessageDestinationDescriptor	setMessageDestinationLinkName(java.lang.String linkName, boolean resolve) Sets the name of the message destination to which I refer.

Method Detail

isLinkedToMessageDestination

boolean isLinkedToMessageDestination()

Returns:

true if this referencer is linked to a message destination and false otherwise.

getMessageDestinationLinkName

java.lang.String getMessageDestinationLinkName()

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.

Returns:

the link name.

setMessageDestinationLinkName

void setMessageDestinationLinkName(java.lang.String linkName)

Sets the link name of the reference. Points to the associated message destination within the J2EE application. Can be NULL if link is not set.

Parameters:

the - link name.

setMessageDestinationLinkName

MessageDestinationDescriptor setMessageDestinationLinkName(java.lang.String linkName,
                                                           boolean resolve)

Sets the name of the message destination to which I refer.

Parameters:

resolve - 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

MessageDestinationDescriptor resolveLinkName()

Try to resolve the current link name value to a MessageDestination object.

Returns:

MessageDestination to which link was resolved, or null if link name resolution failed.

getMessageDestination

MessageDestinationDescriptor getMessageDestination()

Returns:

the message destination object to which this message destination ref is linked. Can be NULL.

setMessageDestination

void setMessageDestination(MessageDestinationDescriptor destination)

Parameters:

destination - set the message destination object to which this message destination ref is linked. Can be NULL.

ownedByMessageDestinationRef

boolean ownedByMessageDestinationRef()

True if the owner is a message destination reference.

getMessageDestinationRefOwner

MessageDestinationReferenceDescriptor getMessageDestinationRefOwner()

Get the descriptor for the message destination reference owner.

ownedByMessageBean

boolean ownedByMessageBean()

True if the owner is a message-driven bean.

getMessageBeanOwner

EjbMessageBeanDescriptor getMessageBeanOwner()

Get the descriptor for the message-driven bean owner.