com.sun.enterprise.deployment
Class EjbMessageBeanDescriptor

java.lang.Object
  java.util.Observable
      com.sun.enterprise.deployment.DynamicAttributesDescriptor
          com.sun.enterprise.deployment.Descriptor
              com.sun.enterprise.deployment.EjbAbstractDescriptor
                  com.sun.enterprise.deployment.EjbDescriptor
                      com.sun.enterprise.deployment.EjbMessageBeanDescriptor

All Implemented Interfaces:

JndiNameEnvironment, NamedDescriptor, EjbReferenceContainer, MessageDestinationReferenceContainer, MessageDestinationReferencer, ResourceEnvReferenceContainer, ResourceReferenceContainer, ServiceReferenceContainer, WritableJndiNameEnvironment, java.io.Serializable

public final class EjbMessageBeanDescriptor
extends EjbDescriptor
implements MessageDestinationReferencer

Objects of this kind represent the deployment information describing a single message driven Ejb.

See Also:

Serialized Form

Field Summary

static java.lang.String

TYPE The Session type String.

Fields inherited from class com.sun.enterprise.deployment.EjbDescriptor

BEAN_TRANSACTION_TYPE, CONTAINER_TRANSACTION_TYPE, DISTRIBUTED_TRANSACTION_SCOPE, isDistributedTxScope, LOCAL_TRANSACTION_SCOPE, runAsIdentity, securityIdentityDescription, transactionType, usesCallerIdentity, usesDefaultTransaction

Fields inherited from class com.sun.enterprise.deployment.Descriptor

DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED

Constructor Summary

EjbMessageBeanDescriptor()
Default constructor.

EjbMessageBeanDescriptor(EjbMessageBeanDescriptor other)
The copy constructor.

Method Summary

ActivationConfigDescriptor	getActivationConfigDescriptor()
java.util.Set	getActivationConfigProperties()
java.lang.String	getActivationConfigValue(java.lang.String name)
java.lang.String	getConnectionFactoryName()
java.lang.String	getDestinationType()
java.lang.String	getDurableSubscriptionName()
int	getJmsAcknowledgeMode()
java.lang.String	getJmsAcknowledgeModeAsString()
java.lang.String	getJmsMessageSelector()
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.
java.lang.reflect.Method[]	getMessageListenerInterfaceMethods(java.lang.ClassLoader classLoader) This returns the message listener onMessage method from the *message listener interface* itself, as opposed to the method from the ejb class that implements it.
java.lang.String	getMessageListenerType()
java.util.Vector	getMethods(java.lang.ClassLoader classLoader) Return the ejb method objects, i.e.
java.util.Vector	getPossibleTransactionAttributes() Returns the set of transaction attributes that can be assigned to methods of this ejb when in CMT mode.
java.lang.String	getResourceAdapterMid()
ActivationConfigDescriptor	getRuntimeActivationConfigDescriptor()
java.util.Set	getRuntimeActivationConfigProperties()
java.lang.String	getRuntimeActivationConfigValue(java.lang.String name)
java.util.Set	getSecurityBusinessMethodDescriptors() Returns the full set of security business method descriptors I have.
protected java.util.Collection	getTransactionMethods(java.lang.ClassLoader classLoader)
java.util.Set	getTxBusinessMethodDescriptors() Returns the full set of transactional business method descriptors I have.
java.lang.String	getType() Returns the type of this bean - always "Message-driven".
boolean	hasConnectionFactory()
boolean	hasDestinationType()
boolean	hasDurableSubscription()
boolean	hasJmsMessageSelector()
boolean	hasMessageDestinationLinkName()
boolean	hasQueueDest()
boolean	hasResourceAdapterMid()
boolean	hasTopicDest()
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(java.lang.StringBuffer toStringBuffer) Returns a formatted String of the attributes of this object.
void	putActivationConfigProperty(EnvironmentProperty prop)
void	putRuntimeActivationConfigProperty(EnvironmentProperty prop)
void	removeActivationConfigProperty(EnvironmentProperty prop)
void	removeActivationConfigPropertyByName(java.lang.String name)
void	removeRuntimeActivationConfigProperty(EnvironmentProperty prop)
void	removeRuntimeActivationConfigPropertyByName(java.lang.String name)
MessageDestinationDescriptor	resolveLinkName() Try to resolve the current link name value to a MessageDestination object.
void	setActivationConfigDescriptor(ActivationConfigDescriptor desc)
void	setConnectionFactoryName(java.lang.String connectionFactory) Connection factory is optional.
void	setContainerTransactionFor(MethodDescriptor methodDescriptor, ContainerTransaction containerTransaction) Sets the container transaction for the given method descriptor.
void	setDestinationType(java.lang.String destType)
void	setDurableSubscriptionName(java.lang.String durableSubscriptionName)
void	setHasDurableSubscription(boolean durable)
void	setHasQueueDest()
void	setHasTopicDest()
void	setJmsAcknowledgeMode(int acknowledgeMode)
void	setJmsAcknowledgeMode(java.lang.String acknowledgeMode)
void	setJmsMessageSelector(java.lang.String selector)
void	setMessageDestination(MessageDestinationDescriptor newMsgDest)
void	setMessageDestinationLinkName(java.lang.String linkName) Sets the name of the message destination to which I refer.
MessageDestinationDescriptor	setMessageDestinationLinkName(java.lang.String linkName, boolean resolveLink) Sets the name of the message destination to which I refer.
void	setMessageListenerType(java.lang.String messagingType)
void	setResourceAdapterMid(java.lang.String resourceAdapterMid) resource-adapter-mid is optional.
void	setRuntimeActivationConfigDescriptor(ActivationConfigDescriptor desc)
void	setSubscriptionDurability(java.lang.String subscription)
void	setTransactionType(java.lang.String transactionType) Sets the transaction type for this bean.
void	setType(java.lang.String type) Sets my type

Methods inherited from class com.sun.enterprise.deployment.EjbDescriptor

addAllInterfaceMethodsIn, addAroundInvokeDescriptor, addAroundTimeoutDescriptor, addDataSourceDefinitionDescriptor, addEjbDescriptor, addEjbReferenceDescriptor, addEntityManagerFactoryReferenceDescriptor, addEntityManagerReferenceDescriptor, addEnvironmentProperty, addFrameworkInterceptor, addInterceptorClass, addIORConfigurationDescriptor, addJmsDestinationReferenceDescriptor, addMessageDestinationReferenceDescriptor, addMethodLevelChain, addPermissionedMethod, addPostConstructDescriptor, addPreDestroyDescriptor, addResourceReferenceDescriptor, addRoleReference, addScheduledTimerDescriptor, addScheduledTimerDescriptorFromDD, addServiceReferenceDescriptor, allMechanismsRequireSSL, appendToInterceptorChain, applyDefaultClassToLifecycleMethods, applyInterceptors, getAllEjbReferencers, getApplication, getAroundInvokeDescriptorByClass, getAroundInvokeDescriptors, getAroundInvokeInterceptors, getAroundTimeoutDescriptorByClass, getAroundTimeoutDescriptors, getAroundTimeoutInterceptors, getBusinessMethodDescriptorFor, getCallbackInterceptors, getClientBusinessMethodDescriptors, getContainerTransaction, getContainerTransactionFor, getDataSourceDefinitionDescriptors, getEjbBundleDescriptor, getEjbClassName, getEjbImplClassName, getEJBLocalObjectImplClassName, getEJBObjectImplClassName, getEjbReference, getEjbReferenceDescriptors, getEjbTimeoutMethod, getEntityManagerFactoryReferenceByName, getEntityManagerFactoryReferenceDescriptors, getEntityManagerReferenceByName, getEntityManagerReferenceDescriptors, getEnvironmentProperties, getEnvironmentPropertyByName, getExcludedMethodDescriptors, getFieldDescriptors, getFields, getFrameworkInterceptors, getIASEjbExtraDescriptors, getInjectableResourcesByClass, getInjectionInfoByClass, getInterceptorChain, getInterceptorClasses, getInterceptorClassNames, getIORConfigurationDescriptors, getJmsDestinationReferenceByName, getJmsDestinationReferenceDescriptors, getLocalHomeImplClassName, getMessageDestinationReferenceByName, getMessageDestinationReferenceDescriptors, getMethodContainerTransactions, getMethodDescriptors, getMethodInterceptorsMap, getMethodPermissionsFor, getMethodPermissionsFromDD, getMethods, getOptionalLocalBusinessMethods, getPermissionedMethodsByPermission, getPermissionedRoles, getPostConstructDescriptorByClass, getPostConstructDescriptors, getPreDestroyDescriptorByClass, getPreDestroyDescriptors, getRemoteHomeImplClassName, getResourceReferenceByName, getResourceReferenceDescriptors, getResourceReferenceDescriptors, getRoleReferenceByName, getRoleReferences, getRunAsIdentity, getScheduledTimerDescriptors, getSecurityIdentityDescription, getServiceReferenceByName, getServiceReferenceDescriptors, getStyledPermissionedMethodsByPermission, getTransactionMethodDescriptors, getTransactionType, getUncheckedMethodDescriptors, getUniqueId, getUsesCallerIdentity, hasAroundInvokeMethod, hasAroundTimeoutMethod, hasInterceptorClass, hasPostConstructMethod, hasPreDestroyMethod, hasResolvedResourceReferences, hasScheduledTimerMethodFromDD, isDistributedTransactionScope, isTimedObject, isUsesDefaultTransaction, notifyNewModule, removeDataSourceDefinitionDescriptor, removeEjbReferenceDescriptor, removeEjbReferencer, removeEnvironmentProperty, removeJmsDestinationReferenceDescriptor, removeMessageDestinationReferenceDescriptor, removePermissionedMethod, removeResourceReferenceDescriptor, removeRoleReference, removeServiceReferenceDescriptor, setDistributedTransactionScope, setEjbBundleDescriptor, setEjbClassName, setEJBLocalObjectImplClassName, setEJBObjectImplClassName, setEjbTimeoutMethod, setLocalHomeImplClassName, setMethodContainerTransactions, setRemoteHomeImplClassName, setRunAsIdentity, setSecurityIdentityDescription, setUniqueId, setUsesCallerIdentity, setUsesDefaultTransaction, visit, visit

Methods inherited from class com.sun.enterprise.deployment.EjbAbstractDescriptor

addLocalBusinessClassName, addNoInterfaceLocalBeanClass, addRemoteBusinessClassName, getHomeClassName, getJndiName, getLocalBusinessClassNames, getLocalClassName, getLocalHomeClassName, getMappedName, getNoInterfaceLocalBeanClasses, getRemoteBusinessClassNames, getRemoteClassName, getWebServiceEndpointInterfaceName, hasWebServiceEndpointInterface, isLocalBean, isLocalBusinessInterfacesSupported, isLocalInterfacesSupported, isRemoteBusinessInterfacesSupported, isRemoteInterfacesSupported, setHomeClassName, setJndiName, setLocalBean, setLocalClassName, setLocalHomeClassName, setMappedName, setRemoteClassName, setWebServiceEndpointInterfaceName

Methods inherited from class com.sun.enterprise.deployment.Descriptor

addDeploymentExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, 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

Methods inherited from class com.sun.enterprise.deployment.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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sun.enterprise.deployment.NamedDescriptor

getName

Field Detail

TYPE

public static final java.lang.String TYPE

The Session type String.

See Also:

Constant Field Values

Constructor Detail

EjbMessageBeanDescriptor

public EjbMessageBeanDescriptor()

Default constructor.

EjbMessageBeanDescriptor

public EjbMessageBeanDescriptor(EjbMessageBeanDescriptor other)

The copy constructor.

Method Detail

getType

public java.lang.String getType()

Returns the type of this bean - always "Message-driven".

Specified by:

getType in class EjbAbstractDescriptor

setContainerTransactionFor

public void setContainerTransactionFor(MethodDescriptor methodDescriptor,
                                       ContainerTransaction containerTransaction)

Description copied from class: EjbDescriptor

Sets the container transaction for the given method descriptor. Throws an Illegal argument if this ejb has transaction type BEAN_TRANSACTION_TYPE.

Overrides:

setContainerTransactionFor in class EjbDescriptor

setType

public void setType(java.lang.String type)

Sets my type

Specified by:

setType in class EjbAbstractDescriptor

setMessageListenerType

public void setMessageListenerType(java.lang.String messagingType)

getMessageListenerType

public java.lang.String getMessageListenerType()

getTxBusinessMethodDescriptors

public java.util.Set getTxBusinessMethodDescriptors()

Description copied from class: EjbDescriptor

Returns the full set of transactional business method descriptors I have.

Overrides:

getTxBusinessMethodDescriptors in class EjbDescriptor

getSecurityBusinessMethodDescriptors

public java.util.Set getSecurityBusinessMethodDescriptors()

Description copied from class: EjbDescriptor

Returns the full set of security business method descriptors I have.

Overrides:

getSecurityBusinessMethodDescriptors in class EjbDescriptor

getMessageListenerInterfaceMethods

public java.lang.reflect.Method[] getMessageListenerInterfaceMethods(java.lang.ClassLoader classLoader)
                                                              throws java.lang.NoSuchMethodException

This returns the message listener onMessage method from the *message listener interface* itself, as opposed to the method from the ejb class that implements it.

Throws:

java.lang.NoSuchMethodException

getPossibleTransactionAttributes

public java.util.Vector getPossibleTransactionAttributes()

Description copied from class: EjbDescriptor

Returns the set of transaction attributes that can be assigned to methods of this ejb when in CMT mode. Elements are of type ContainerTransaction

Overrides:

getPossibleTransactionAttributes in class EjbDescriptor

hasMessageDestinationLinkName

public boolean hasMessageDestinationLinkName()

isLinkedToMessageDestination

public boolean isLinkedToMessageDestination()

Specified by:

isLinkedToMessageDestination in interface MessageDestinationReferencer

Returns:

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

getMessageDestinationLinkName

public java.lang.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 interface MessageDestinationReferencer

Returns:

the name of the message destination to which I refer

setMessageDestinationLinkName

public void setMessageDestinationLinkName(java.lang.String linkName)

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

Specified by:

setMessageDestinationLinkName in interface MessageDestinationReferencer

setMessageDestinationLinkName

public MessageDestinationDescriptor setMessageDestinationLinkName(java.lang.String linkName,
                                                                  boolean resolveLink)

Description copied from interface: MessageDestinationReferencer

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

Specified by:

setMessageDestinationLinkName in interface MessageDestinationReferencer

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 interface MessageDestinationReferencer

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 interface MessageDestinationReferencer

getMessageDestinationRefOwner

public MessageDestinationReferenceDescriptor getMessageDestinationRefOwner()

Description copied from interface: MessageDestinationReferencer

Get the descriptor for the message destination reference owner.

Specified by:

getMessageDestinationRefOwner in interface MessageDestinationReferencer

ownedByMessageBean

public boolean ownedByMessageBean()

True if the owner is a message-driven bean.

Specified by:

ownedByMessageBean in interface MessageDestinationReferencer

getMessageBeanOwner

public EjbMessageBeanDescriptor getMessageBeanOwner()

Get the descriptor for the message-driven bean owner.

Specified by:

getMessageBeanOwner in interface MessageDestinationReferencer

getMessageDestination

public MessageDestinationDescriptor getMessageDestination()

Specified by:

getMessageDestination in interface MessageDestinationReferencer

Returns:

the message destination to which I refer. Can be NULL.

setMessageDestination

public void setMessageDestination(MessageDestinationDescriptor newMsgDest)

Specified by:

setMessageDestination in interface MessageDestinationReferencer

Parameters:

newMsgDest - the message destination to which I refer.

getActivationConfigProperties

public java.util.Set getActivationConfigProperties()

Returns:

Set of EnvironmentProperty elements.

getActivationConfigValue

public java.lang.String getActivationConfigValue(java.lang.String name)

putActivationConfigProperty

public void putActivationConfigProperty(EnvironmentProperty prop)

removeActivationConfigProperty

public void removeActivationConfigProperty(EnvironmentProperty prop)

removeActivationConfigPropertyByName

public void removeActivationConfigPropertyByName(java.lang.String name)

getRuntimeActivationConfigProperties

public java.util.Set getRuntimeActivationConfigProperties()

Returns:

Set of EnvironmentProperty elements.

getRuntimeActivationConfigValue

public java.lang.String getRuntimeActivationConfigValue(java.lang.String name)

putRuntimeActivationConfigProperty

public void putRuntimeActivationConfigProperty(EnvironmentProperty prop)

removeRuntimeActivationConfigProperty

public void removeRuntimeActivationConfigProperty(EnvironmentProperty prop)

removeRuntimeActivationConfigPropertyByName

public void removeRuntimeActivationConfigPropertyByName(java.lang.String name)

hasQueueDest

public boolean hasQueueDest()

hasTopicDest

public boolean hasTopicDest()

hasDestinationType

public boolean hasDestinationType()

getDestinationType

public java.lang.String getDestinationType()

setDestinationType

public void setDestinationType(java.lang.String destType)

hasDurableSubscription

public boolean hasDurableSubscription()

setHasDurableSubscription

public void setHasDurableSubscription(boolean durable)

setHasQueueDest

public void setHasQueueDest()

setHasTopicDest

public void setHasTopicDest()

setSubscriptionDurability

public void setSubscriptionDurability(java.lang.String subscription)

hasJmsMessageSelector

public boolean hasJmsMessageSelector()

setJmsMessageSelector

public void setJmsMessageSelector(java.lang.String selector)

getJmsMessageSelector

public java.lang.String getJmsMessageSelector()

getJmsAcknowledgeMode

public int getJmsAcknowledgeMode()

getJmsAcknowledgeModeAsString

public java.lang.String getJmsAcknowledgeModeAsString()

setJmsAcknowledgeMode

public void setJmsAcknowledgeMode(int acknowledgeMode)

setJmsAcknowledgeMode

public void setJmsAcknowledgeMode(java.lang.String acknowledgeMode)

getDurableSubscriptionName

public java.lang.String getDurableSubscriptionName()

setDurableSubscriptionName

public void setDurableSubscriptionName(java.lang.String durableSubscriptionName)

getConnectionFactoryName

public java.lang.String getConnectionFactoryName()

setConnectionFactoryName

public void setConnectionFactoryName(java.lang.String connectionFactory)

Connection factory is optional. If set to null, hasConnectionFactory will return false.

hasConnectionFactory

public boolean hasConnectionFactory()

getResourceAdapterMid

public java.lang.String getResourceAdapterMid()

setResourceAdapterMid

public void setResourceAdapterMid(java.lang.String resourceAdapterMid)

resource-adapter-mid is optional. It is set when a resource adapter is responsible for delivering messages to the message-driven bean. If not set, hasResourceAdapterMid will return false.

hasResourceAdapterMid

public boolean hasResourceAdapterMid()

getMethods

public java.util.Vector getMethods(java.lang.ClassLoader classLoader)

Description copied from class: EjbDescriptor

Return the ejb method objects, i.e. the methods on the home and remote interfaces.

Overrides:

getMethods in class EjbDescriptor

getTransactionMethods

protected java.util.Collection getTransactionMethods(java.lang.ClassLoader classLoader)

Overrides:

getTransactionMethods in class EjbDescriptor

Returns:

a collection of MethodDescriptor for methods which may have a assigned security attribute.

setTransactionType

public void setTransactionType(java.lang.String transactionType)

Sets the transaction type for this bean. Must be either BEAN_TRANSACTION_TYPE or CONTAINER_TRANSACTION_TYPE.

Specified by:

setTransactionType in class EjbDescriptor

setActivationConfigDescriptor

public void setActivationConfigDescriptor(ActivationConfigDescriptor desc)

getActivationConfigDescriptor

public ActivationConfigDescriptor getActivationConfigDescriptor()

setRuntimeActivationConfigDescriptor

public void setRuntimeActivationConfigDescriptor(ActivationConfigDescriptor desc)

getRuntimeActivationConfigDescriptor

public ActivationConfigDescriptor getRuntimeActivationConfigDescriptor()

print

public void print(java.lang.StringBuffer toStringBuffer)

Returns a formatted String of the attributes of this object.

Overrides:

print in class EjbDescriptor