Dependencies can be used between Services and Entities, they won't need any stereotype assigned to them. These dependencies are used to produce entity references (from an entity or service) within the base classes (i.e. DaoBase and ServiceBase), or to produce service references (from another service) within the ServiceBase classes. Entity business operations can be set to classifier scope instead of the usual instance scope. By doing so they will be generated into the corresponding DAO for that entity instead of the entity implementation class. Entity query operations (i.e. finders) can be denoted by setting the query flag on the modeled operation to true (they do not require any stereotypes) and setting it's scope to classifier. Actors represent roles within your model. To designate that a role has access to a given service you must draw a dependency from an Actor to the <<Service>>. To designate the role has access to to a given operation, you must draw a dependency from an Actor to the operation.

AndroMDA EJB3 Cartridge Profile

This profile contains all elements that can be applied on the model used as the MDA transformation process. These elements are specific to the AndroMDA EJB3 Cartridge component.

Stereotypes
Stereotypes are the names you sometimes see appear in UML diagrams, they typically look like <<MyStereotype>> and can be applied on any type of UML model element.
Tagged Values
Sometimes it happens you want to add information to the model but there is no clean way of doing it. In those cases you may want to resort to tagged values, but these cases should be considered with caution. A tagged value is something extra, something optional, and the application should run fine without them.

Entity(Back to Stereotypes)
Applied on: class
Produces a POJO EJB entity.
MappedSuperclass(Back to Stereotypes)
Applied on: class
Produces a POJO class annotated as a mapped/embeddable super class. This can only be assigned to the root class in a hierarchy.
Service(Back to Stereotypes)
Applied on: class
Produces a Session EJB facade for the POJO EJB entities.
MessageDriven(Back to Stereotypes)
Applied on: class
Produces a JMS Message Driven EJB facade that received messages.
Enumeration(Back to Stereotypes)
Applied on: class
This stereotype will instruct to define an enumeration class variable of type enum introduced in JDK 1.5. That way it is possible for Entities to use this enumeration type for their attributes. Deprecated: Use UML Enumeration instead of UML Class.
Version(Back to Stereotypes)
Applied on: Entity attribute
Identifies an attribute as an version property (optimistic lock value) of an entity. Used to ensure integrity when reattaching and for overall optimistic concurrency control. Only one attribute per entity class is allowed to have the Version stereotype. The following types are supported:
  • int
  • Integer
  • short
  • Short
  • long
  • Long
  • Timestamp
Transient(Back to Stereotypes)
Applied on: Entity attribute
Identifies an entity attribute as a transient attribute which is non persistent.
PersistenceContext(Back to Stereotypes)
Applied on: class
Identifies a persistence context used to express a dependency on an EntityManager persistence context.
Identifier(Back to Stereotypes)
Applied on: Entity attribute
Identifies an attribute as an identifier (primary key).
CreateMethod(Back to Stereotypes)
Applied on: Entity operation and Session operation
Used to tag an EJB create method NOTE: However POJO constructors are used in EJB3
EntityRef(Back to Stereotypes)
Applied on: A dependency going into an Entity
Used to reference an entity from another entity or service.
ServiceRef(Back to Stereotypes)
Applied on: A dependency going into a Service
Used to reference a service from an entity or another service.
ResourceRef(Back to Stereotypes)
Applied on: A dependency going into a class having a stereotype of UserTransaction or DataSource, out of a Service.
Used to reference a resource, like a DataSource from a service bean.
UserTransaction(Back to Stereotypes)
Applied on: class
Used to inject a javax.transaction.UserTransaction resource.
DataSource(Back to Stereotypes)
Applied on: class
Used to inject a javax.sql.DataSource resource.
Interceptor(Back to Stereotypes)
Applied on: class
Defines a custom made interceptor for the business methods of the session bean and message driven bean.
Listener(Back to Stereotypes)
Applied on: class
Defines a callback listener class for the entity, session and message driven beans. The corresponding entity, session or message driven beans are annotated to indicate the listener class.
RunAs(Back to Stereotypes)
Applied on: Dependency
Represents a dependency from an actor that is identified to apply a run-as identity to the bean when making calls. It does not affect the identity of the method callers.
ValueRef(Back to Stereotypes)
Applied on: A dependency going into a ValueObject and out of an Entity
Used to generate an association between an entity and a value object class. Found attributes inside the entity as well as the value object are used to get automatically filled out. The entity will provide the helper method, also for saving a value object to an existing entity. NOTE: This should not be used any longer with EJB3 as there are no value object.
EnvEntry(Back to Stereotypes)
Applied on: Attribute
Used to specify an environment entry which is defined in the ejb-jar.xml descriptor and can be injected in a bean.
Timeout(Back to Stereotypes)
Applied on: Service Operation
Specifies whether the session bean operation as a Timer Service timeout callback method.
FirstResult(Back to Stereotypes)
Applied on: Entity Finder Method Parameter
Specifies the finder method parameter result type to specify the starting index.
MaxResult(Back to Stereotypes)
Applied on: Entity Finder Method Parameter
Specifies the finder method parameter result type to specify the max or limit.
PostConstruct(Back to Stereotypes)
Applied on: Session and Message-Driven Bean Operation
Specifies that the associated operation is a lifecycle callback handler and will be invoked when the bean is first created, after any dependency injection is required.
PreDestroy(Back to Stereotypes)
Applied on: Session and Message-Driven Bean Operation
Specifies that the associated operation is a lifecycle callback handler and will be invoked when the bean is removed from the pool or destroyed. For stateful session beans, this occurs before the @Remove annotated method is invoked.
PostActivate(Back to Stereotypes)
Applied on: Stateful Session Bean Operation
Specifies that the associated operation is a lifecycle callback handler for a stateful session bean and will be invoked when the bean instance has just been reactivated.
PrePassivate(Back to Stereotypes)
Applied on: Stateful Session Bean Operation
Specifies that the associated operation is a lifecycle callback handler for a stateful session bean and will be invoked when container is ready to passivate the instance.
PrePersist(Back to Stereotypes)
Applied on: Entity Bean Operation
Specifies that the associated operation is a lifecycle callback handler for an entity bean and will be invoked before the entity is created in the database and will cascade to all associated cascadeable entities.
PostPersist(Back to Stereotypes)
Applied on: Entity Bean Operation
Specifies that the associated operation is a lifecycle callback handler for an entity bean and will be invoked after the entity is created in the database and will cascade to all associated cascadeable entities.
PreRemove(Back to Stereotypes)
Applied on: Entity Bean Operation
Specifies that the associated operation is a lifecycle callback handler for an entity bean and will be invoked before the entity is deleted from the database and will cascade to all associated cascadeable entities.
PostRemove(Back to Stereotypes)
Applied on: Entity Bean Operation
Specifies that the associated operation is a lifecycle callback handler for an entity bean and will be invoked after the entity is deleted from the database and will cascade to all associated cascadeable entities.
PreUpdate(Back to Stereotypes)
Applied on: Entity Bean Operation
Specifies that the associated operation is a lifecycle callback handler for an entity bean and will be invoked right before the database is updated.
PostUpdate(Back to Stereotypes)
Applied on: Entity Bean Operation
Specifies that the associated operation is a lifecycle callback handler for an entity bean and will be invoked immediately after the database has been updated.
PostLoad(Back to Stereotypes)
Applied on: Entity Bean Operation
Specifies that the associated operation is a lifecycle callback handler for an entity bean and will be invoked right after the data has been loaded from the database and associated with the entity.
WebService(Back to Stereotypes)
Applied on: class
Exposes ALL methods of the session bean as a web service.
WebServiceOperation(Back to Stereotypes)
Applied on: Service operation
This is used in conjunction with the <<Service>> stereotype. Adds the method to the list of allowed methods which will be exposed as a web service. You MUST place this stereotype on an operation if you want it exposed as a web service (unless you add the <<WebService>> stereotype to your class).
Seam(Back to Stereotypes)
Applied on: Entity, Session and Java Beans
Indicates this bean is a Seam component object. This must be set before anything else is modeled on the class.
Startup(Back to Stereotypes)
Applied on: Entity, Session and Java Beans
Specifies that a session scope component is started immediately at session creation time, unless dependencies are specified.
In(Back to Stereotypes)
Applied on: Session and Java Bean Attribute
Indicates a Seam component attribute which is to be injected from a context variable at the beginning of each component method invocation.
Out(Back to Stereotypes)
Applied on: Session and Java Bean Attribute
Indicates a Seam component attribute which is to be outjected to a context variable at the end of each component method invocation.
Unwrap(Back to Stereotypes)
Applied on: Session and Java Bean Attribute
Specifies that the object returned by the annotated getter method is the thing that is injected instead of the component instance itself.
Factory(Back to Stereotypes)
Applied on: Session and Java Bean Operations
When this stereotype is used on an operation which return void that operation will be used to initialize the value of the named context variable, when the context variable has no value. When it is used on an operation that returns a value then Seam should use that value to initialize the value of the named context variable, when the context variable has no value. The context variable is specified by tagged value andromda_seam_bijection_factory_value. If the method is a getter method, default to the JavaBeans property name. If no scope is explicitly specified by tagged value andromda_seam_bijection_factory_scope, the scope of the component with the @Factory method is used (unless the component is stateless, in which case the EVENT context is used).
Logger(Back to Stereotypes)
Applied on: Session and Java Bean Attribute
Specifies that a component field is to be injected with an instance of org.jboss.seam.log.Log.
RequestParameter(Back to Stereotypes)
Applied on: Session and Java Bean Attribute
Specifies that a component attribute is to be injected with the value of a request parameter. Basic type conversions are performed automatically.
Create(Back to Stereotypes)
Applied on: Session and Java Bean Operation
Indicates that the method is a Seam component lifecycle operation and should be called when an instance of the component is instantiated by Seam.
Destroy(Back to Stereotypes)
Applied on: Session and Java Bean Operation
Indicates that the method is a Seam component lifecycle operation and should be called when the context ends and its context variables are destroyed. All SFSB components must define a Destroy method to guarantee destruction of the SFSB when the context ends.
Begin(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Specifies that a long-running conversation begins when this method returns a non-null outcome without exception.
End(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Specifies that a long-running conversation ends when this method returns a non-null outcome without exception.
BeginTask(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Specifies that a long-running conversation ends when this method returns a non-null outcome without exception.
StartTask(Back to Stereotypes)
Applied on: Session and Java Bean Operations
"Starts" a jBPM task. Specifies that a long-running conversation begins when this method returns a non-null outcome without exception. This conversation is associated with the jBPM task specified in the named request parameter. Within the context of this conversation, a business process context is also defined, for the business process instance of the task instance. The jBPM TaskInstance will be available in a request context variable named taskInstance. The jPBM ProcessInstance will be available in a request context variable named processInstance. (Of course, these objects are available for injection via @In.)
EndTask(Back to Stereotypes)
Applied on: Session and Java Bean Operations
"Ends" a jBPM task. Specifies that a long-running conversation ends when this method returns a non-null outcome, and that the current task is complete. Triggers a jBPM transition. The actual transition triggered will be the default transition unless the application has called Transition.setName() on the built-in component named transition.
CreateProcess(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Creates a new jBPM process instance when the method returns a non-null outcome without exception. The ProcessInstance object will be available in a context variable named processInstance.
ResumeProcess(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Re-enters the scope of an existing jBPM process instance when the method returns a non-null outcome without exception. The ProcessInstance object will be available in a context variable named processInstance.
Transactional(Back to Stereotypes)
Applied on: Session and Java Beans and Operations
Specifies that a JavaBean component should have a similar transactional behavior to the default behavior of a session bean component. i.e. method invocations should take place in a transaction, and if no transaction exists when the method is called, a transaction will be started just for that method. This annotation may be applied at either class or method level.
Rollback(Back to Stereotypes)
Applied on: Session and Java Bean Operations
If the outcome of the method matches any of the listed outcomes, or if no outcomes are listed, set the transaction to rollback only when the method completes.
Valid(Back to Stereotypes)
Applied on: Session and Java Bean Attribute
Specifies that the Hibernate Validator should validate this and related component attributes before an action listener Seam component method is invoked.
Validator(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Specifies that the validator should validate all Seam components marked with @Valid annotation before the method is invoked. Use of tagged values for outcome when validation fails and for refreshing entities when validation fails is provided.
WebRemote(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Indicates that the annotated method may be called from client-side JavaScript. The exclude property is optional and allows objects to be excluded from the result's object graph.
Interceptor(Back to Stereotypes)
Applied on: Interceptor classes
This stereotype appear on Seam interceptor classes. Please refer to the documentation for the EJB 3.0 specification for information about the annotations required for EJB interceptor definition.
Asynchronous(Back to Stereotypes)
Applied on: Session and Java Bean Operations
Specifies that the method call is processed asynchronously.
Duration(Back to Stereotypes)
Applied on: Session and Java Bean Operation Parameters
Specifies that a parameter of the asynchronous call is the duration before the call is processed (or first processed for recurring calls).
Expiration(Back to Stereotypes)
Applied on: Session and Java Bean Operation Parameters
Specifies that a parameter of the asynchronous call is the datetime at which the call is processed (or first processed for recurring calls).
IntervalDuration(Back to Stereotypes)
Applied on: Session and Java Bean Operation Parameters
Specifies that an asynchronous method call recurs, and that the annotated parameter is duration between recurrences.
DataModel(Back to Stereotypes)
Applied on: Session and Java Bean Attributes
Exposes an attribute of type List, Map, Set or Object[] as a JSF DataModel into the scope of the owning component (or the EVENT scope if the owning component is STATELESS). In the case of Map, each row of the DataModel is a Map.Entry.
DataModelSelection(Back to Stereotypes)
Applied on: Session and Java Bean Attributes
Injects the selected value from the JSF DataModel (this is the element of the underlying collection, or the map value).
DataModelSelectionIndex(Back to Stereotypes)
Applied on: Session and Java Bean Attributes
Exposes the selection index of the JSF DataModel as an attribute of the component (this is the row number of the underlying collection, or the map key).
andromda_persistence_optional(Back to Tagged Values)
Applied on: Entity attribute
Defines the attribute non-null relationship annotations. If set to false, then a non-null relationship must always exist.
Allowed values for this element:
  • true (default)
  • false
andromda_persistence_inheritance(Back to Tagged Values)
Applied on: <<Entity>>
Used to override the default entity inheritance strategy defined by the entityInheritanceStrategy namespace property.
    Permitted values are:
  • SINGLE_TABLE - table per hierarchy.
  • TABLE_PER_CLASS - table per class in hierarchy.
  • JOINED - Table per class.

The tagged value of andromda_persistence_inheritance is set on the base/root class. All subclasses must then follow the same strategy. The default strategy is defined by the entityInheritanceStrategy namespace property.

Allowed values for this element:
  • SINGLE_TABLE
  • TABLE_PER_CLASS
  • JOINED
andromda_persistence_discriminator_type(Back to Tagged Values)
Applied on: <<Entity>>
Used to override the default entity inheritance discriminator type defined by the entityDiscriminatorType namespace property.
    Permitted values are:
  • STRING
  • CHAR
  • INTEGER

The tagged value of andromda_persistence_discriminator_type is set once on the base/root class to indicate the type of the column used for the discriminator. The default discriminator type is defined by the entityDiscriminatorType namespace property.

Allowed values for this element:
  • STRING
  • CHAR
  • INTEGER
andromda_persistence_discriminator_value(Back to Tagged Values)
Applied on: <<Entity>>
Used at the class level of an entity and is optional. This is the value that indicates that the row is an entity of the annotated entity type. It should be specified for each class in the hierarchy.
andromda_persistence_discriminator_column_name (Back to Tagged Values)
Applied on: <<Entity>>
Used at the class level of an entity and is optional. This value indicates the name of the column to be used for the discriminator. If not specified for the SINGLE_TABLE or JOINED inheritance mapping strategies, then default to TYPE.
andromda_persistence_discriminator_column_definition (Back to Tagged Values)
Applied on: <<Entity>>
Used at the class level of an entity and is optional. This value indicates the SQL fragment used when generating the DDL for the discriminator column.
andromda_persistence_discriminator_column_length (Back to Tagged Values)
Applied on: <<Entity>>
Used at the class level of an entity and is optional. This value indicates the column length for the String-based discriminator types. It is ignored for the other discriminator types.
andromda_persistence_temporal_type (Back to Tagged Values)
Applied on: Entity Attribute or Entity Finder Method Parameter
The temporal type tagged value specified on the attributes of type java.util.Date or java.util.Calendar or on finder method parameter specifying, whether to expect one of the following types Date, Time or Timestamp.
Allowed values for this element:
  • DATE (default)
  • TIME
  • TIMESTAMP
  • NONE
andromda_hibernate_type (Back to Tagged Values)
Applied on: Entity Attribute
The overridden type indicating the overridden type specified on attributes or finder method arguments, to generate @org.hibernate.annotations.Type annotations. Generally used for Boolean types in legacy databases, i.e yes_no, true_false. Could be: The name of a Hibernate basic type: integer, string, character, date, timestamp, float, binary, serializable, object, blob etc.; The name of a Java class with a default basic type: int, float, char, java.lang.String, java.util.Date, java.lang.Integer, java.sql.Clob etc.; The name of a serializable Java class; The class name of a custom type: com.illflow.type.MyCustomType etc.
andromda_persistence_fetch_type (Back to Tagged Values)
Applied on: Association End or Entity Attribute
Denotes whether or not to hint to the EJB3 container that the EJB relationship/property should be lazily or eagerly loaded. By default, the loading persistence is EAGER for attributes and relationships of type OneToOne and ManyToOne. Relationships with OneToMany and ManyToMany syntax are LAZY loaded. You don't need to set anything to accept these default settings.
Allowed values for this element:
  • LAZY
  • EAGER
andromda_persistence_cascade_type (Back to Tagged Values)
Applied on: Association End
Specifies the override value for the default cascade setting for this relationship.
Allowed values for this element:
  • ALL
  • PERSIST
  • MERGE
  • REMOVE
  • REFRESH
andromda_hibernate_cascade(Back to Tagged Values)
Applied on: Association ends between <<Entity>> classes
Place a user defined Hibernate specific cascade value at an association end. Hibernate extensions must be enabled.
andromda_persistence_enumeration_type (Back to Tagged Values)
Applied on: Entity Attribute
Specifies the enumeration type for the persistent property or field.
Allowed values for this element:
  • ORDINAL (default)
  • STRING
andromda_persistence_generator_type (Back to Tagged Values)
Applied on: Entity Attribute
Specifies the primary key generation strategy associated with an entity bean attribute identifier.
Allowed values for this element:
  • AUTO (default)
  • SEQUENCE
  • IDENTITY
  • TABLE
  • GENERIC
  • NONE
andromda_persistence_generator_name (Back to Tagged Values)
Applied on: Entity Attribute
Defines a unique name which is referenced by one or more classes to be the generator for an entity bean.
andromda_persistence_generator_genericStrategy (Back to Tagged Values)
Applied on: Entity Attribute
Defines either a predefined Hibernate strategy or a fully qualified class name for use in id generation using persistence layer extensions.
andromda_persistence_generator_source_name (Back to Tagged Values)
Applied on: Entity Attribute
Specifies either the table name that stores the generated ids or the sequence name which is the name of the database sequence object used to get the ids.
andromda_persistence_generator_pkcolumn_value (Back to Tagged Values)
Applied on: Entity Attribute
The primary key value in the generator table that identifies the generated value from other values in the table.
andromda_persistence_generator_initial_value (Back to Tagged Values)
Applied on: Entity Attribute
Specifies the initial starting sequence for id generation for an entity PK generator.
andromda_persistence_generator_allocation_size (Back to Tagged Values)
Applied on: Entity Attribute
Specifies the amount to increment by when allocating an id number from the generator.
andromda_persistence_column_definition (Back to Tagged Values)
Applied on: Entity Attribute
Specifies the SQL to create the DDL for the column or entity property.
andromda_persistence_column_precision (Back to Tagged Values)
Applied on: Entity Attribute
Specifies the precision value for a decimal column.
andromda_persistence_column_scale (Back to Tagged Values)
Applied on: Entity Attribute
Specifies the scale to use for a decimal column.
andromda_persistence_column_nullable (Back to Tagged Values)
Applied on: Entity Attribute
Specifies whether the underlying column for the entity attribute may be NULL.
Allowed values for this element:
  • true
  • false
andromda_persistence_column_insert(Back to Tagged Values)
Applied on: <<Entity>> Attribute
Specifies whether a mapped column should be included in SQL INSERT statements. Setting to false allows the column to be initialized using other mechanisms such as a value defaulted by the database. Defaults to true.
Allowed values for this element:
  • true (default)
  • false
andromda_persistence_column_update(Back to Tagged Values)
Applied on: <<Entity>> Attribute
Specifies whether a mapped column should be included in SQL UPDATE statements. Setting to false allows the column to be updated using other mechanisms such as a value defaulted by the database. Defaults to true.
Allowed values for this element:
  • true (default)
  • false
andromda_persistence_orderBy (Back to Tagged Values)
Applied on: Association End
Specifies the column name(s) that will be used for sorting the returned collection, with ASC or DESC optional. Without a value, the primary key is assumed.
andromda_persistence_associationEnd_primary (Back to Tagged Values)
Applied on: Association End
Specifies the side of a bidirectional navigable association which owns the relationship. For persistence, only one side can be the owner, determining the mappedBy annotation. The side with the Aggregation or Composition relationship will always be the owner. Otherwise, if not tagged, the M side of the 1:M relationship will be the owner. If bidirectional 1:1 or M:M, the side with the longer name will be the owner.
andromda_persistence_collection_type(Back to Tagged Values)
Applied on: Association ends between <<Entity>> classes
Used to define the mapping for EJB3 collections. This value overrides the namespace property.
Allowed values for this element:
  • set
  • map
  • list
  • bag
andromda_persistence_collection_index(Back to Tagged Values)
Applied on: Association ends between <<Entity>> classes
Column containing the collection index, overrides the associationEndCollectionIndexName
Allowed values for this element:
  • A property of this entity
andromda_persistence_collection_index_type(Back to Tagged Values)
Applied on: Association ends between <<Entity>> classes
The type of the column containing the collection index, overrides the associationEndCollectionIndexType
Allowed values for this element:
  • A property of this entity
andromda_persistence_lob_type(Back to Tagged Values)
Applied on: Entity Attribute of Type datatype::Clob or datatype::Blob
Override the entity attribute type where the property is defined as either a large binary or character type via datatype::Clob or datatype::Blob respectively. BLOB fields represent Byte[] or Serializable types. CLOB fields represent char[], Character[] or String types. Make sure to define the fully qualified type name for the tagged value.
andromda_service_type (Back to Tagged Values)
Applied on: <<Service>>
Used at the class level of a service bean to override the default session bean type which is determined by the existence of instance variables.
Allowed values for this element:
  • Stateless
  • Stateful
andromda_service_persistence_context_unit_name (Back to Tagged Values)
Applied on: <<Service>>
Used at the class level of a service bean or a class with stereotype PersistenceContext to determine the persistence context unit name.
andromda_service_persistence_context_unit_type (Back to Tagged Values)
Applied on: <<Service>>
Used at the class level of a service bean or a class with stereotype PersistenceContext to determine the persistence context type. This can be set to extend the transaction on a Stateful session bean for it's EntityManager.
Allowed values for this element:
  • EXTENDED
  • TRANSACTION
andromda_service_persistence_context_datasource (Back to Tagged Values)
Applied on: Class with <<Service>>
Used at the class level of a service bean or a class with stereotype PersistenceContext to determine the persistence context datasource JNDI name. If you don't have a scoped classloader for your application, all persistence contexts defined in your system's global context are made available to all applications.
andromda_service_persistence_flush_mode (Back to Tagged Values)
Applied on: Service operation
Used on session bean operations to set the flush mode that determines when the changes to the changes to the database are applied in a transaction.
Allowed values for this element:
  • AUTO (default)
  • COMMIT
  • NEVER
andromda_service_jndi_remote (Back to Tagged Values)
Applied on: <<Service>>
Used on a session bean to manually specify the JNDI name the remote interface is bound to.
andromda_service_jndi_local (Back to Tagged Values)
Applied on: <<Service>>
Used on a session bean to manually specify the JNDI name the local interface is bound to.
andromda_ejb_transaction_management (Back to Tagged Values)
Applied on: Service and Message-Driven Beans
Specifies the transaction demarcation strategy for session and message-driven beans. By default, this does not need to be set for CONTAINER managed transaction demarcation.
Allowed values for this element:
  • CONTAINER (default)
  • BEAN
andromda_service_security_permitAll (Back to Tagged Values)
Applied on: Service and service operation
Specifies whether to permit all roles to execute the operations in the bean. This can be set on the session bean or on individual operations. If set on the session bean, all operations will inherit this behavior. The permit all tagged value will override the roles allowed. If both are set, only the permit all tagged value is rendered.
Allowed values for this element:
  • true
  • false
andromda_service_security_denyAll (Back to Tagged Values)
Applied on: Service and service operation
Specifies whether to deny all roles to execute the operations in the bean. This can be set on the session bean or on individual operations. If set on the session bean, all operations will inherit this behavior. The deny all tagged value will override the roles allowed. If both are set, only the deny all tagged value is rendered.
Allowed values for this element:
  • true
  • false
andromda_service_security_realm (Back to Tagged Values)
Applied on: Service
Specifies the security domain for role based authorization. JBoss uses the security realm to match allowed roles.
andromda_service_interceptor_excludeDefault(Back to Tagged Values)
Applied on: Service Operation
Determines whether to exclude the invocation of the default interceptors for the applied business method.
Allowed values for this element:
  • true
  • false
andromda_service_interceptor_excludeClass(Back to Tagged Values)
Applied on: Service Operation
Determines whether to exclude the invocation of the class interceptors for the applied business method.
Allowed values for this element:
  • true
  • false
andromda_service_interceptor_default(Back to Tagged Values)
Applied on: Interceptor Class
Defines the modeled interceptor as a default interceptor for all business methods of all session and message driven beans within this deployment.
Allowed values for this element:
  • true
  • false
andromda_ejb_automaticKey(Back to Tagged Values)
Applied on: Entity attribute
Can be used in class level of an entity. If you set this to true, the class will use an automatic key generation for the defined primary key. Please note: This is currently only available in BEA Weblogic and can not be used with combined primary keys.
andromda_ejb_noSyntheticCreateMethod(Back to Tagged Values)
Applied on: Entity
Used on an Entity bean to decide whether to allow synthetic (auto generated) create/constructors.
andromda_ejb_query(Back to Tagged Values)
Applied on: An Entity operation marked as a query .
Defines a hibernate query expression. Note that it's encouraged to model your query body as an OCL constraint (instead of using this tagged value).
andromda_ejb_viewType(Back to Tagged Values)
Applied on: Service or Service operation
Defines the view type for a Session EJB at the class level or at the operation level for each Session method.
Allowed values for this element:
  • remote (default)
  • local
  • both
andromda_ejb_transaction_type(Back to Tagged Values)
Applied on: Service operation or Entity attribute
Defines a transaction type for a method in the Session EJB or for entity EJB POJO accessor method.
Allowed values for this element:
  • NotSupported
  • Supports
  • Required
  • RequiresNew
  • Mandatory
  • Never
andromda_persistence_table(Back to Tagged Values)
Applied on: Entity or a many-to-many association.
Defines the relational table name for entity persistence.
andromda_persistence_column(Back to Tagged Values)
Applied on: Entity attribute
Represents the column name for entity persistence.
andromda_persistence_column_length(Back to Tagged Values)
Applied on: Entity attribute
Represents the column length for entity persistence.
andromda_ejb_mdb_acknowledge_mode(Back to Tagged Values)
Applied on: Message Driven Bean
Represents the acknowledge mode for the JMS message driven bean. Only needs to be specified if DUPS_OK_ACKNOWLEDGE mode is required. The default mode is AUTO_ACKNOWLEDGE.
Allowed values for this element:
  • AUTO_ACKNOWLEDGE (default)
  • DUPS_OK_ACKNOWLEDGE
andromda_ejb_mdb_destination(Back to Tagged Values)
Applied on: Message Driven Bean
Represents the destination queue or topic name this JMS message driven bean is associated with.
andromda_ejb_mdb_destination_type(Back to Tagged Values)
Applied on: Message Driven Bean
Represents the destination type of the JMS message driven bean. If not specified, it is assumed to be a Queue.
Allowed values for this element:
  • javax.jms.Queue (default)
  • javax.jms.Topic
andromda_ejb_mdb_selector(Back to Tagged Values)
Applied on: Message Driven Bean
Represents the JMS message selector logic used when determining the messages that a JMS message driven bean is to receive.
andromda_ejb_mdb_subscription_durability(Back to Tagged Values)
Applied on: Message Driven Bean
Represents the JMS message driven bean subscription durability mode. Queues are always durable. The durability only needs to be specified on topics. By default, topics are non-durable.
andromda_ejb_mdb_pool_size_min(Back to Tagged Values)
Applied on: Message Driven
Defines the bean's minimum pool size. Must be an integer and greater than 0, otherwise will not be set.
andromda_ejb_mdb_pool_size_max(Back to Tagged Values)
Applied on: Message Driven
Defines the bean's maximum pool size. Can be used to define singleton message driven beans. Must be an integer and greater than 0, otherwise will not be set.
andromda_persistence_entity_cache(Back to Tagged Values)
Applied on: Entities
Defines the cache strategy the entity.
Allowed values for this element:
  • NONE
  • NONSTRICT_READ_WRITE
  • READ_ONLY
  • READ_WRITE
  • TRANSACTIONAL
andromda_persistence_association_cache(Back to Tagged Values)
Applied on: Association End Between Entities
Defines the cache strategy for relationship association collection.
Allowed values for this element:
  • NONE
  • NONSTRICT_READ_WRITE
  • READ_ONLY
  • READ_WRITE
  • TRANSACTIONAL
andromda_ejb_query_useCache(Back to Tagged Values)
Applied on: Query Operations
Used to override the default option that enables/disable query cache.
Allowed values for this element:
  • true
  • false
andromda_webservice_parameter_style(Back to Tagged Values)
Applied on: Service and WebService
Specifies the method parameters represent the entire message body or are elements wrapped inside a top-level element named after the webservice operation.
Allowed values for this element:
  • wrapped
  • bare
andromda_webservice_operation_oneway(Back to Tagged Values)
Applied on: WebService Operation
Specifies the method has only an input message and no output. A oneway method returns the thread of control to the calling application prior to executing the actual business method. Do not model on operations that have a return value or holder parameters or declare any checked exceptions.
Allowed values for this element:
  • true
  • false
andromda_webservice_operation_name(Back to Tagged Values)
Applied on: Service and WebService
Specifies the web service method name.
andromda_webservice_operation_result_name(Back to Tagged Values)
Applied on: Service and WebService
Specifies the web service method result name.
andromda_seam_component_name(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Override the default Seam component object name.
andromda_seam_component_scope(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
The JBoss Seam component scope type. The default for stateless session beans is STATELESS. The default for entity beans and stateful session beans is CONVERSATION.
Allowed values for this element:
  • EVENT
  • PAGE
  • CONVERSATION
  • SESSION
  • BUSINESS_PROCESS
  • APPLICATION
  • STATELESS
andromda_seam_component_role_name(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Allows a Seam component to be bound to multiple contexts variables. The @Name/@Scope annotations define a "default role". Each @Role annotation defines an additional role. This tagged value specifies the context variable name.
andromda_seam_component_role_scope(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
The context variable scope. When no scope is explicitly specified, the default depends upon the component type, as above. Note! If multiple roles are specified then the list of scopes must be in the same order as the role names.
Allowed values for this element:
  • EVENT
  • PAGE
  • CONVERSATION
  • SESSION
  • BUSINESS_PROCESS
  • APPLICATION
  • STATELESS
andromda_seam_component_intercept(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Determines when Seam interceptors are active. When no interception type is explicitly specified, the default depends upon the component type. For entity beans, the default is NEVER. For session beans, message driven beans and JavaBeans, the default is ALWAYS.
Allowed values for this element:
  • ALWAYS
  • AFTER_RESTORE_VIEW
  • AFTER_UPDATE_MODEL_VALUES
  • INVOKE_APPLICATION
  • NEVER
andromda_seam_component_jndiname(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Specifies the JNDI name that Seam will use to look up the EJB component. If no JNDI name is explicitly specified, Seam will use the JNDI pattern specified by org.jboss.seam.core.init.jndiPattern.
andromda_seam_component_conversional_ifnotbegunoutcome(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that a conversation scope component is conversational, meaning that no method of the component can be called unless a long-running conversation started by this component is active (unless the method would begin a new long-running conversation).
andromda_seam_component_startup_depends(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Specifies that the named components must be started first, if they are installed.
andromda_seam_component_synchronized_timeout(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Specifies that a component is accessed concurrently by multiple clients, and that Seam should serialize requests. If a request is not able to obtain its lock on the component in the given timeout period, an exception will be raised.
andromda_seam_component_readonly(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Specifies that a JavaBean component or component method does not require state replication at the end of the invocation.
andromda_seam_bijection_in_create(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
Specifies that Seam should instantiate the component with the same name as the context variable if the context variable is undefined (null) in all contexts. Default to false.
andromda_seam_bijection_in_value(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
Specifies the name of the context variable. Default to the name of the component attribute. Alternatively, specifies a JSF EL expression, surrounded by #{...}.
andromda_seam_bijection_out_value(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
Specifies the name of the context variable explicitly, instead of using the annotated instance variable name.
andromda_seam_bijection_out_scope(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
Specifies that a component attribute that is not a Seam component type is to be outjected to a specific scope at the end of the invocation. Alternatively, if no scope is explicitly specified, the scope of the component with the @Out attribute is used (or the EVENT scope if the component is stateless).
Allowed values for this element:
  • EVENT
  • PAGE
  • CONVERSATION
  • SESSION
  • BUSINESS_PROCESS
  • APPLICATION
  • STATELESS
andromda_seam_bijection_factory_value(Back to Tagged Values)
Applied on: Session and Java Bean Operations
Specifies the name of the context variable. If the method is a getter method, default to the JavaBeans property name.
andromda_seam_bijection_factory_scope(Back to Tagged Values)
Applied on: Session and Java Bean Operations
Specifies the scope that Seam should bind the returned value to. Only meaningful for factory methods which return a value.
Allowed values for this element:
  • EVENT
  • PAGE
  • CONVERSATION
  • SESSION
  • BUSINESS_PROCESS
  • APPLICATION
  • STATELESS
andromda_seam_bijection_logger_value(Back to Tagged Values)
Applied on: Entity, Session and Java Beans
Specifies the name of the log category. Default to the name of the component class.
andromda_seam_bijection_requestparameter_value(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies the name of the request parameter. Default to the name of the component attribute.
andromda_seam_lifecycle_observer_event(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that the method should be called when a component-driven event of the specified type occurs.
andromda_seam_conversation_begin_ifoutcome(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that a long-running conversation begins when this action listener method returns with one of the given outcomes. Example: @Begin(ifOutcome={"success", "continue"})
andromda_seam_conversation_begin_join(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that if a long-running conversation is already in progress, the conversation context is simply propagated.
andromda_seam_conversation_begin_nested(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that if a long-running conversation is already in progress, a new nested conversation context begins. The nested conversation will end when the next @End is encountered, and the outer conversation will resume. It is perfectly legal for multiple nested conversations to exist concurrently in the same outer conversation.
andromda_seam_conversation_begin_flushmode(Back to Tagged Values)
Applied on: Session and Java Beans
Specify the flush mode of any Seam-managed persistence contexts. flushMode=FlushModeType.MANUAL supports the use of atomic conversations where all write operations are queued in the conversation context until an explicit call to flush() (which usually occurs at the end of the conversation).
andromda_seam_conversation_begin_pageflow(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies a jBPM process definition name that defines the pageflow for this conversation.
andromda_seam_conversation_end_ifoutcome(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that a long-running conversation ends when this action listener method returns with one of the given outcomes.
andromda_seam_conversation_end_beforeredirect(Back to Tagged Values)
Applied on: Session and Java Beans
By default, the conversation will not actually be destroyed until after any redirect has occurred. Setting beforeRedirect=true specifies that the conversation should be destroyed at the end of the current request, and that the redirect will be processed in a new temporary conversation context.
andromda_seam_conversation_end_evenifexception(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that a long-running conversation ends when this action listener method throws one of the specified classes of exception.
andromda_seam_conversation_starttask_taskidparameter(Back to Tagged Values)
Applied on: Session and Java Beans
The name of a request parameter which holds the id of the task. Default to "taskId", which is also the default used by the Seam taskList JSF component.
andromda_seam_conversation_starttask_flushmode(Back to Tagged Values)
Applied on: Session and Java Beans
Set the flush mode of any Seam-managed Hibernate sessions or JPA persistence contexts that are created during this conversation.
andromda_seam_conversation_begintask_taskidparameter(Back to Tagged Values)
Applied on: Session and Java Beans
The name of a request parameter which holds the id of the task. Default to "taskId", which is also the default used by the Seam taskList JSF component.
andromda_seam_conversation_begintask_flushmode(Back to Tagged Values)
Applied on: Session and Java Beans
Set the flush mode of any Seam-managed Hibernate sessions or JPA persistence contexts that are created during this conversation.
andromda_seam_conversation_endtask_transition_name(Back to Tagged Values)
Applied on: Session and Java Beans
Triggers the given jBPM transition.
andromda_seam_conversation_endtask_ifoutcome(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies the JSF outcome or outcomes that result in the end of the task.
andromda_seam_conversation_endtask_beforeredirect(Back to Tagged Values)
Applied on: Session and Java Beans
By default, the conversation will not actually be destroyed until after any redirect has occurred. Setting beforeRedirect=true specifies that the conversation should be destroyed at the end of the current request, and that the redirect will be processed in a new temporary conversation context.
andromda_seam_conversation_createprocess_definition(Back to Tagged Values)
Applied on: Session and Java Beans
The name of the jBPM process definition deployed via org.jboss.seam.core.jbpm.processDefinitions.
andromda_seam_conversation_resumeprocess_processIdParameter(Back to Tagged Values)
Applied on: Session and Java Beans
The name a request parameter holding the process id. Default to "processId".
andromda_seam_transaction_rollback_ifoutcome(Back to Tagged Values)
Applied on: Session and Java Beans
The JSF outcomes that cause a transaction rollback (no outcomes is interpreted to mean any outcome).
andromda_seam_validation_outcome(Back to Tagged Values)
Applied on: Session and Java Bean Operation
Returns the JSF outcome when validation fails.
andromda_seam_validation_refreshEntities(Back to Tagged Values)
Applied on: Session and Java Bean Operation
Specifies whether invalid entities in the managed state should be refreshed from the database when validation fails.
andromda_seam_webremote_exclude(Back to Tagged Values)
Applied on: Session and Java Bean Operation
Excludes objects from the WebRemote call result's object graph (see the Remoting chapter for more details).
andromda_seam_interceptor_stateless(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that this interceptor is stateless and Seam may optimize replication.
andromda_seam_interceptor_type(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that this interceptor is a "client-side" interceptor that is called before the EJB container.
andromda_seam_interceptor_around(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that this interceptor is positioned higher in the stack than the given interceptors.
andromda_seam_interceptor_within(Back to Tagged Values)
Applied on: Session and Java Beans
Specifies that this interceptor is positioned deeper in the stack than the given interceptors.
andromda_seam_data_datamodel_value(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
Name of the conversation context variable. Default to the attribute name.
andromda_seam_data_datamodel_scope(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
If scope=ScopeType.PAGE is explicitly specified, the DataModel will be kept in the PAGE context.
Allowed values for this element:
  • EVENT
  • PAGE
  • CONVERSATION
  • SESSION
  • BUSINESS_PROCESS
  • APPLICATION
  • STATELESS
andromda_seam_data_datamodelselection_value(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
Name of the conversation context variable. Not needed if there is exactly one @DataModel in the component.
andromda_seam_data_datamodelselectionindex_value(Back to Tagged Values)
Applied on: Session and Java Bean Attributes
Name of the conversation context variable. Not needed if there is exactly one @DataModel in the component.
andromda_seam_data_databinderclass(Back to Tagged Values)
Applied on: Java Interfaces
This meta-annotation make it possible to implement similar functionality to @DataModel and @DataModelSelection for other data structures apart from lists. The class name of the DataModelBinder class
andromda_seam_data_dataselectorclass(Back to Tagged Values)
Applied on: Java Interfaces
This meta-annotation make it possible to implement similar functionality to @DataModel and @DataModelSelection for other data structures apart from lists. The DataModelSelector class.