org.andromda.cartridges.ejb3.metafacades

Interface EJB3MessageDrivenFacade

All Superinterfaces:

ClassifierFacade, GeneralizableElementFacade, ModelElementFacade, Service

All Known Implementing Classes:

EJB3MessageDrivenFacadeLogic, EJB3MessageDrivenFacadeLogicImpl

public interface EJB3MessageDrivenFacade
extends Service

Represents a message driven EJB. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAcknowledgeMode() Returns the acknowledge mode for this JMS message driven bean.
String	getAttributesAsList(Collection attributes, boolean includeTypes, boolean includeNames) Returns the comma separated list of attributes. This method can be used to generate argument lists for constructors and method calls.
Collection	getConstants(boolean follow) Gets all constants for this message driven EJB.
String	getDestination() Returns the destination queue or topic JNDI name this message driven bean is associated with.
String	getDestinationType() Returns the destination type of the message driven bean.
String	getDurableSubscriptionId() This returns a subscription name which is only required for durable subscriptions.
Collection	getEnvironmentEntries(boolean follow) Gets all env-entries for the specified session EJB.
String	getFullyQualifiedMessageDrivenImplementationName() Returns the fully qualified message driven bean implementation name.
String	getFullyQualifiedMessageDrivenListenerName() Returns the fully qualified message driven bean listener name.
String	getFullyQualifiedMessageDrivenName() Returns the fully qualified message driven bean name.
String	getFullyQualifiedMessageDrivenTestName() Returns the fully qualified message driven test class name
Collection	getInterceptorReferences() Returns the Collection of target elements from the message-driven bean class where the target class has a stereotype of Interceptor.
int	getMaximumPoolSize() Returns the MDB maximum pool size.
String	getMessageDrivenImplementationName() Returns the message driven bean implementation name.
String	getMessageDrivenListenerName() Returns the message driven bean callback listener name.
String	getMessageDrivenName() Returns message driven bean name.
String	getMessageDrivenTestName() Returns the message driven bean test class name
String	getMessageSelector() Returns the JMS message selector used when determining the messages a message driven bean is to receive.
int	getMinimumPoolSize() Returns the MDB minimum pool size.
String	getRunAs() Returns the run-as identity for the message driven bean which is used to establish the identity the bean will use when making calls.
String	getSubscriptionDurability() If the message driven bean is associated with a topic, then this will return the subscription durability.
String	getTestPackageName() Returns the message driven test package name.
String	getTransactionManagement() Returns the transaction demarcation strategy for this bean.
String	getTransactionType() Gets the transaction type for this message driven bean.
boolean	isDestinationTypeQueue() Returns true if the destination type if a javax.jms.Queue.
boolean	isDestinationTypeTopic() Returns true if the destination type is a javax.jms.Topic.
boolean	isEJB3MessageDrivenFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isExcludeDefaultInterceptors() Determines whether to exclude the invocation of the default interceptors for all business method in the bean.
boolean	isListenerEnabled() Returns true if this message driven bean has the stereotype Listener.
boolean	isSubscriptionDurable() Returns true if the topic subscription durability setting is Durable.
boolean	isSubscriptionNonDurable() Returns true if the subscription durability setting is NonDurable.
boolean	isTransactionManagementBean() Returns true if the transaction demarcation strategy is bean managedfor this bean.

Methods inherited from interface org.andromda.metafacades.uml.Service

getAllEntityReferences, getAllMessagingDestinations, getAllRoles, getAllServiceReferences, getEntityReferences, getMessagingDestinations, getRoles, getServiceReferences, isServiceMetaType

Methods inherited from interface org.andromda.metafacades.uml.ClassifierFacade

findAttribute, getAbstractions, getAllAssociatedClasses, getAllProperties, getAllRequiredConstructorParameters, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getFullyQualifiedArrayName, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

Methods inherited from interface org.andromda.metafacades.uml.GeneralizableElementFacade

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isEJB3MessageDrivenFacadeMetaType

boolean isEJB3MessageDrivenFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAcknowledgeMode

String getAcknowledgeMode()

Returns the acknowledge mode for this JMS message driven bean. This is automatically handled by the container. EJB 3.0 spec states: For container managed transaction demarcation, message acknowledgment is automatically handled as part of transaction commit. If bean-managed transaction demarcation is used, the message receipt cannot be part of the bean-managed transaction, therefore the receipt is acknowledged by the container. If this property is not specified, AUTO_ACKNOWLEDGE semantics is assumed. Possible values are AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE.

Returns:

String

getAttributesAsList

String getAttributesAsList(Collection attributes,
                         boolean includeTypes,
                         boolean includeNames)

Returns the comma separated list of attributes.

This method can be used to generate argument lists for constructors and method calls.

Parameters:

attributes - Collection

includeTypes - boolean

includeNames - boolean

Returns:

String

getConstants

Collection getConstants(boolean follow)

Gets all constants for this message driven EJB. Constants are defined as static read-only attributes which do NOT have the <> stereotype. If 'follow' is true, then the inheritance hierarchy will be followed and we'll retrieve all constants from any super types as well.

Parameters:

follow - boolean

Returns:

Collection

getDestination

String getDestination()

Returns the destination queue or topic JNDI name this message driven bean is associated with.

Returns:

String

getDestinationType

String getDestinationType()

Returns the destination type of the message driven bean. Possible values are javax.jms.Queue or javax.jms.Topic. Queues ensure that messages are not missed, even if the EJB server is not running. Same applis to durable topic subscriptions.

Returns:

String

getDurableSubscriptionId

String getDurableSubscriptionId()

This returns a subscription name which is only required for durable subscriptions.

Returns:

String

getEnvironmentEntries

Collection getEnvironmentEntries(boolean follow)

Gets all env-entries for the specified session EJB. Env-entries are stored as static attributes on the entity and stereotyped as <>. If 'follow' is true, then the inheritance hierarchy will be followed and we'll retrieve all env-entries from any super types as well.

Parameters:

follow - boolean

Returns:

Collection

getFullyQualifiedMessageDrivenImplementationName

String getFullyQualifiedMessageDrivenImplementationName()

Returns the fully qualified message driven bean implementation name.

Returns:

String

getFullyQualifiedMessageDrivenListenerName

String getFullyQualifiedMessageDrivenListenerName()

Returns the fully qualified message driven bean listener name.

Returns:

String

getFullyQualifiedMessageDrivenName

String getFullyQualifiedMessageDrivenName()

Returns the fully qualified message driven bean name.

Returns:

String

getFullyQualifiedMessageDrivenTestName

String getFullyQualifiedMessageDrivenTestName()

Returns the fully qualified message driven test class name

Returns:

String

getInterceptorReferences

Collection getInterceptorReferences()

Returns the Collection of target elements from the message-driven bean class where the target class has a stereotype of Interceptor.

Returns:

Collection

getMaximumPoolSize

int getMaximumPoolSize()

Returns the MDB maximum pool size.

Returns:

int

getMessageDrivenImplementationName

String getMessageDrivenImplementationName()

Returns the message driven bean implementation name.

Returns:

String

getMessageDrivenListenerName

String getMessageDrivenListenerName()

Returns the message driven bean callback listener name.

Returns:

String

getMessageDrivenName

String getMessageDrivenName()

Returns message driven bean name.

Returns:

String

getMessageDrivenTestName

String getMessageDrivenTestName()

Returns the message driven bean test class name

Returns:

String

getMessageSelector

String getMessageSelector()

Returns the JMS message selector used when determining the messages a message driven bean is to receive.

Returns:

String

getMinimumPoolSize

int getMinimumPoolSize()

Returns the MDB minimum pool size.

Returns:

int

getRunAs

String getRunAs()

Returns the run-as identity for the message driven bean which is used to establish the identity the bean will use when making calls. It does not affect the identity of the callers.

Returns:

String

getSubscriptionDurability

String getSubscriptionDurability()

If the message driven bean is associated with a topic, then this will return the subscription durability. Possible values are Durable or NonDurable. By default, if a topic subscription is not specified, the non-durable subscription is assumed. Durable topic subscriptions ensure that messages are not missed, even if the EJB server is not running.

Returns:

String

getTestPackageName

String getTestPackageName()

Returns the message driven test package name. This simply appends .test to the existing class package.

Returns:

String

getTransactionManagement

String getTransactionManagement()

Returns the transaction demarcation strategy for this bean. Typically, this will return BEAN for non default CONTAINER managed beans. Unless specified, this will return null indicating CONTAINER transaction demarcation.

Returns:

String

getTransactionType

String getTransactionType()

Gets the transaction type for this message driven bean. For container managed demarcation, either the REQUIRED or NOT_SUPPORTED transaction attributes must be used on a message driven bean.

Returns:

String

isDestinationTypeQueue

boolean isDestinationTypeQueue()

Returns true if the destination type if a javax.jms.Queue.

Returns:

boolean

isDestinationTypeTopic

boolean isDestinationTypeTopic()

Returns true if the destination type is a javax.jms.Topic.

Returns:

boolean

isExcludeDefaultInterceptors

boolean isExcludeDefaultInterceptors()

Determines whether to exclude the invocation of the default interceptors for all business method in the bean.

Returns:

boolean

isListenerEnabled

boolean isListenerEnabled()

Returns true if this message driven bean has the stereotype Listener. False otherwise.

Returns:

boolean

isSubscriptionDurable

boolean isSubscriptionDurable()

Returns true if the topic subscription durability setting is Durable.

Returns:

boolean

isSubscriptionNonDurable

boolean isSubscriptionNonDurable()

Returns true if the subscription durability setting is NonDurable.

Returns:

boolean

isTransactionManagementBean

boolean isTransactionManagementBean()

Returns true if the transaction demarcation strategy is bean managedfor this bean.

Returns:

boolean