| <orion-ejb-jar deployment-time="0ab135e4" deployment-version="x.x.x"> | ||||||||
|
An orion-ejb-jar.xml file contains the deploy-time info for an ejb-jar. It is located in ORION_HOME/application-deployments/deploymentName/jarname(.jar)/orion-ejb-jar.xml after deployment and META-INF/orion-ejb-jar.xml below the ejb-jar root if bundled with the application or if no deployment-directory is specified in server.xml. If using deployment-directory (which is the default) the bundled version will be copied to the deployment location if and only if no file exists at that location. It is used to specify initial (first time) deployment properties. After each deployment the deployment file is reformatted/augmented/altered by the server to add any new/missing info to it.
deployment-time - The time (long millis in hex) of the last deployment, if not matching the last editing date the jar will be redeployed. (internal server value, do not edit) deployment-version - The version of Orion this jar was deployed with, if it's not matching the current version then it will be redeployed. (internal server value, do not edit) |
||||||||
| <enterprise-beans> | ||||||||
|
The beans in this ejb-jar.
|
||||||||
| <session-deployment ...> | ||||||||
|
Deployment info for a session bean.
cache-timeout - How long to keep stateless sessions cached in the pool. Only applies to stateless session beans, the default is 60, legal values are positive integer values or 'never'. call-timeout - The time (long millis in hex) to wait for an EJB if it is busy (before throwing a RemoteException, treating it as a deadlock). 0 equals "forever" and is the deafault. copy-by-value - Whether or not to copy (clone) all the incoming/outgoing parameters in EJB calls. Set this to 'false' if you're certain your application doesnt assume copy-by-value semantics for a speed-up. The default is 'true'. iiop-accessable - Whether or not to expose this bean via IIOP. The default is false. The bean will be exposed as iiop://[nameserverhost]/[applicationname]/[location]. Exposing requires the orb tag to be specified in server.xml. location - The JNDI-name this bean will be bound to. max-tx-retries - The number of times to retry a transaction that was rolled back due to system-level failures. The default is 3. name - The name of the bean, this matches the name of a bean in the assembly descriptor (ejb-jar.xml). persistence-filename - Path to file where sessions are stored across restarts. timeout - Inactivity timeout in seconds. If the value is zero or negative timeouts will be disabled. wrapper - Name of the Orion wrapper class for this bean. (internal server attribute, do not edit) |
||||||||
| <env-entry-mapping name="theName">deploymentValue</env-entry-mapping> | ||||||||
|
Overrides the value of an env-entry in the assembly descriptor. It is used to keep the .ear (assembly) clean from deployment-specific values. The body is the value.
name - The name of the context-param. |
||||||||
| <ejb-ref-mapping location="ejb/Payroll" name="ejb/Payroll" /> | ||||||||
|
The ejb-ref element is used for the declaration of a reference to another enterprise bean's home. The ejb-ref-mapping ties this to a JNDI-location when deploying.
location - The JNDI location to look up the EJB home from. name - The ejb-ref's name. Matches the name of an ejb-ref in ejb-jar.xml. |
||||||||
| <resource-ref-mapping location="jdbc/TheDS" name="jdbc/TheDSVar"> | ||||||||
|
The resource-ref element is used for the declaration of a reference to an external resource such as a datasource, JMS queue, mail session or similar. The resource-ref-mapping ties this to a JNDI-location when deploying.
location - The JNDI location to look up the resource factory from. name - The resource-ref's name. Matches the name of an resource-ref in ejb-jar.xml. |
||||||||
| <lookup-context location="foreign/resource/location"> | ||||||||
|
The specification of an optional javax.naming.Context implementation used for retrieving the resource. This is useful when hooking up with 3rd party modules, such as a 3rd party JMS server for instance. Either use the context implementation supplied by the resource vendor or if none exists write an implementation which in turn negotiates with the vendor software.
location - The name looked for in the foreign context when retrieving the resource. |
||||||||
| <context-attribute name="name" value="value" /> | ||||||||
|
An attribute sent to the context. The only mandatory attribute in JNDI is the 'java.naming.factory.initial' which is the classname of the context factory implementation.
name - The name of the attribute. value - The value of the attribute. |
||||||||
| <timer-service data-source="jdbc/MyEJBDS" id-field-name="info" info-field-name="info" table="MyTimer" timeout-field-name="timeout" timeout-interval-field-name="timeout-interval"> | ||||||||
|
The beans in this ejb-jar.
data-source - The name of the data-source used to persist the timers. id-field-name - The database field name for id primary key of the timer. info-field-name - The database field name for the timer serialized optional info data. table - The name of the table in the database used to persist the timers. timeout-field-name - The database field name for the timer timeout data. timeout-interval-field-name - The database field name for the timer timeout interval data. |
||||||||
| <cmp-field-mapping ejb-reference-home="MyOtherEntity" name="myField" persistence-name="myField" persistence-type="integer|char (255)|..."> | ||||||||
|
Deployment info for a container-managed persistence field. If no subtags defining different behaviour is specified the field is persisted thru serialization or native handling of "recognized" primitive types.
ejb-reference-home - The JNDI-location of the fields remote EJB-home if the field is an entity EJBObject or an EJBHome. name - The name of the field. persistence-name - The name of the field in the database table. persistence-type - The database type (valid values varies from database to database) of the field. |
||||||||
| <fields> | ||||||||
|
Specifies the configuration of a field-based (java class field) mapping persistence for this field. The fields that are to be persisted have to be public, non-static, non-final and the type of the containing object has to have an empty constructor.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <properties> | ||||||||
|
Specifies the configuration of a property-based (bean properties) mapping persistence for this field. The properties have to adhere to the usual JavaBeans specification and the type of the containing object has to have an empty constructor (also per the beans spec).
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <entity-ref home="ejb/TheEJB"> | ||||||||
|
Specified the configuration for persisting an entity reference via it's primary key. The child-tag of this tag is the specification of how to persist the primary key.
home - JNDI location of the EJBHome to get lookup the beans at. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <list-mapping table="MyEntity_listVariable"> | ||||||||
|
Specifies a relational mapping of a List type. A List is a sequential (where order/index is important) Collection of items. The field containing the mapping must be of type java.util.List or the legacy types java.util.Vector or Type[].
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <collection-mapping table="MyEntity_collectionVariable"> | ||||||||
|
Specifies a relational mapping of a Collection type. A Collection consists of n unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Collection.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <set-mapping table="MyEntity_setVariable"> | ||||||||
|
Specifies a relational mapping of a Set type. A Set consists of n unique unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Set.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-mapping table="MyEntity_mapVariable"> | ||||||||
|
Specifies a relational mapping of a Map type. A Map consists of n unique keys and their mapping to values. The field containing the mapping must be of type java.util.Map or the legacy types java.util.Hashtable or java.util.Properties.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-key-mapping type="null"> | ||||||||
|
Specifies a mapping of the map key. Map keys are always immutable.
type - The fully qualified classname of the type of the value. Examples are com.acme.Product, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <field-persistence-manager class="my.FieldPersistenceManager"> | ||||||||
|
A field persistence manager is a custom persistence handler for a CMP-field. See the API documentation for details.
class - The class implementing the custom persistence manager. |
||||||||
| <property name="theName" value="theValue" /> | ||||||||
|
A configuration property.
name - The property name value - The property value |
||||||||
| <entity-deployment ...> | ||||||||
|
Deployment info for an entity bean.
call-timeout - The time (long millis in hex) to wait for an EJB if it is bussy (before throwing a RemoteException, treating it as a deadlock). 0 equals "forever" and is the deafault. clustering-schema - The schema used for clustering propagation. The default implies no specific clustering support (each node is configured to read and lock the database upon operations). asynchronous-cache is for non-TX crucial, rarely updated entities where you want to maintain the entity cache capability on each node (server) in the cluster, improving performance. copy-by-value - Whether or not to copy (clone) all the incoming/outgoing parameters in EJB calls. Set this to 'false' if you're certain your application doesnt assume copy-by-value semantics for a speed-up. The default is 'true'. data-source - The name of the data-source used if using container-managed persistence. exclusive-write-access - Whether or not the EJB-server has exclusive write (update) access to the database backend. If it does it will speed up common bean operations and enable better caching. The default is true. iiop-accessable - Whether or not to expose this bean via IIOP. The default is false. The bean will be exposed as iiop://[nameserverhost]/[applicationname]/[location]. Exposing requires the orb tag to be specified in server.xml. instance-cache-timeout - The amount of time in seconds that an entity is to be kept in the instance (assigned to an identity) state, specifying 'never' retains the entities forever. The default is 60. isolation - Specifies the isolation-level for database actions. The valid values are 'serializable', 'uncommitted', 'committed', 'repeatable_read'. location - The JNDI-name this bean will be bound to. max-instances - The number of maximum instances to be kept instantiated or pooled. The default is infinite. max-tx-retries - The number of times to retry a transaction that was rolled back due to system-level failures. The default is 0, ie no retries. name - The name of the bean, this matches the name of a bean in the assembly descriptor (ejb-jar.xml). pool-cache-timeout - The amount of time in seconds that an entity is to be kept in the "pooled" (unassigned) state, specifying 'never' retains the entities forever. The default is 60. table - The name of the table in the database if using container-managed persistence. validity-timeout - The maximum amount of time (in millis) that an entity is valid in the cache (before being reloaded). Useful for loosely coupled environments where rare updates from legacy systems occur. This attribute is only valid when exclusive-write-access="true" (the default). wrapper - Name of the Orion wrapper class for this bean. (internal server attribute, do not edit) |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping ejb-reference-home="MyOtherEntity" name="myField" persistence-name="myField" persistence-type="integer|char (255)|..."> | ||||||||
|
Deployment info for a container-managed persistence field. If no subtags defining different behaviour is specified the field is persisted thru serialization or native handling of "recognized" primitive types.
ejb-reference-home - The JNDI-location of the fields remote EJB-home if the field is an entity EJBObject or an EJBHome. name - The name of the field. persistence-name - The name of the field in the database table. persistence-type - The database type (valid values varies from database to database) of the field. |
||||||||
| <fields> | ||||||||
|
Specifies the configuration of a field-based (java class field) mapping persistence for this field. The fields that are to be persisted have to be public, non-static, non-final and the type of the containing object has to have an empty constructor.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <properties> | ||||||||
|
Specifies the configuration of a property-based (bean properties) mapping persistence for this field. The properties have to adhere to the usual JavaBeans specification and the type of the containing object has to have an empty constructor (also per the beans spec).
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <entity-ref home="ejb/TheEJB"> | ||||||||
|
Specified the configuration for persisting an entity reference via it's primary key. The child-tag of this tag is the specification of how to persist the primary key.
home - JNDI location of the EJBHome to get lookup the beans at. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <list-mapping table="MyEntity_listVariable"> | ||||||||
|
Specifies a relational mapping of a List type. A List is a sequential (where order/index is important) Collection of items. The field containing the mapping must be of type java.util.List or the legacy types java.util.Vector or Type[].
table - The name of the table in the database. |
||||||||
| <primkey-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <collection-mapping table="MyEntity_collectionVariable"> | ||||||||
|
Specifies a relational mapping of a Collection type. A Collection consists of n unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Collection.
table - The name of the table in the database. |
||||||||
| <primkey-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <set-mapping table="MyEntity_setVariable"> | ||||||||
|
Specifies a relational mapping of a Set type. A Set consists of n unique unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Set.
table - The name of the table in the database. |
||||||||
| <primkey-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-mapping table="MyEntity_mapVariable"> | ||||||||
|
Specifies a relational mapping of a Map type. A Map consists of n unique keys and their mapping to values. The field containing the mapping must be of type java.util.Map or the legacy types java.util.Hashtable or java.util.Properties.
table - The name of the table in the database. |
||||||||
| <primkey-mapping .../> | ||||||||
| <map-key-mapping type="null"> | ||||||||
|
Specifies a mapping of the map key. Map keys are always immutable.
type - The fully qualified classname of the type of the value. Examples are com.acme.Product, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <field-persistence-manager class="my.FieldPersistenceManager"> | ||||||||
|
A field persistence manager is a custom persistence handler for a CMP-field. See the API documentation for details.
class - The class implementing the custom persistence manager. |
||||||||
| <property name="theName" value="theValue" /> | ||||||||
|
A configuration property.
name - The property name value - The property value |
||||||||
| <cmp-field-mapping ejb-reference-home="MyOtherEntity" name="myField" persistence-name="myField" persistence-type="integer|char (255)|..."> | ||||||||
|
Deployment info for a container-managed persistence field. If no subtags defining different behaviour is specified the field is persisted thru serialization or native handling of "recognized" primitive types.
ejb-reference-home - The JNDI-location of the fields remote EJB-home if the field is an entity EJBObject or an EJBHome. name - The name of the field. persistence-name - The name of the field in the database table. persistence-type - The database type (valid values varies from database to database) of the field. |
||||||||
| <fields> | ||||||||
|
Specifies the configuration of a field-based (java class field) mapping persistence for this field. The fields that are to be persisted have to be public, non-static, non-final and the type of the containing object has to have an empty constructor.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <properties> | ||||||||
|
Specifies the configuration of a property-based (bean properties) mapping persistence for this field. The properties have to adhere to the usual JavaBeans specification and the type of the containing object has to have an empty constructor (also per the beans spec).
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <entity-ref home="ejb/TheEJB"> | ||||||||
|
Specified the configuration for persisting an entity reference via it's primary key. The child-tag of this tag is the specification of how to persist the primary key.
home - JNDI location of the EJBHome to get lookup the beans at. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <list-mapping table="MyEntity_listVariable"> | ||||||||
|
Specifies a relational mapping of a List type. A List is a sequential (where order/index is important) Collection of items. The field containing the mapping must be of type java.util.List or the legacy types java.util.Vector or Type[].
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <collection-mapping table="MyEntity_collectionVariable"> | ||||||||
|
Specifies a relational mapping of a Collection type. A Collection consists of n unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Collection.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <set-mapping table="MyEntity_setVariable"> | ||||||||
|
Specifies a relational mapping of a Set type. A Set consists of n unique unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Set.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-mapping table="MyEntity_mapVariable"> | ||||||||
|
Specifies a relational mapping of a Map type. A Map consists of n unique keys and their mapping to values. The field containing the mapping must be of type java.util.Map or the legacy types java.util.Hashtable or java.util.Properties.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-key-mapping type="null"> | ||||||||
|
Specifies a mapping of the map key. Map keys are always immutable.
type - The fully qualified classname of the type of the value. Examples are com.acme.Product, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <field-persistence-manager class="my.FieldPersistenceManager"> | ||||||||
|
A field persistence manager is a custom persistence handler for a CMP-field. See the API documentation for details.
class - The class implementing the custom persistence manager. |
||||||||
| <property name="theName" value="theValue" /> | ||||||||
|
A configuration property.
name - The property name value - The property value |
||||||||
| <finder-method partial="true|false" query="$1 = $myField AND $myOtherField > 5" sql-query="$1 = $myField AND $myOtherField > 5"> | ||||||||
|
The definition of a container-managed finder method. This defines the selection criteria in a findByXXX() method in the bean's home.
partial - Whether or not the specified query is a partial one. A partial query is the 'where' clause or the 'order' (if it starts with order) clause of the SQL query. Queries are partial by default. If partial="false" is specified then the full query is to be entered as value for the query attribute and you need to make sure that the query produces a result-set containing all of the CMP fields. This is useful when doing advances queries involving table joins and similar. query - Deprecated. Either use EJB-QL (recommended) or the sql-query attribute if overriding or using EJB 1.1. sql-query - The query part of an SQL statement, overriding the EJB-QL default specified for this finder. This is the section following the WHERE keyword in the statement. Special tokens are $number which denotes an method argument number and $name which denotes a cmp-field name. For instance the query for "findByAge(int age)" would be (assuming the cmp-field is named 'age'): "$1 = $age". |
||||||||
| <method> | ||||||||
|
<pre> 1. <method> <ejb-name>EJBNAME</ejb-name> <method-name>*</method-name> </method> This style is used to refer to all the methods of the specified enterprise bean's home and remote interfaces. 2. <method> <ejb-name>EJBNAME</ejb-name> <method-name>METHOD</method-name> </method>> This style is used to refer to the specified method of the specified enterprise bean. If there are multiple methods with the same overloaded name, the element of this style refers to all the methods with the overloaded name. 3. <method> <ejb-name>EJBNAME</ejb-name> <method-name>METHOD</method-name> <method-params> <method-param>PARAM-1</method-param> <method-param>PARAM-2</method-param> ... <method-param>PARAM-n</method-param> </method-params> <method> This style is used to refer to a single method within a set of methods with an overloaded name. PARAM-1 through PARAM-n are the fully-qualified Java types of the method's input parameters (if the method has no input arguments, the method-params element contains no method-param elements). Arrays are specified by the array element's type, followed by one or more pair of square brackets (e.g. int[][]). </pre>
|
||||||||
| <description>A short description</description> | ||||||||
|
A short description.
|
||||||||
| <ejb-name>EmployeeService</ejb-name> | ||||||||
|
The ejb-name element specifies an enterprise bean's name. This name is assigned by the ejb-jar file producer to name the enterprise bean in the ejb-jar file's deployment descriptor. The name must be unique among the names of the enterprise beans in the same ejb-jar file. The enterprise bean code does not depend on the name; therefore the name can be changed during the application-assembly process without breaking the enterprise bean's function. There is no architected relationship between the ejb-name in the deployment descriptor and the JNDI name that the Deployer will assign to the enterprise bean's home. The name must conform to the lexical rules for an NMTOKEN.
|
||||||||
| <method-intf>Home/Remote</method-intf> | ||||||||
|
The method-intf element allows a method element to differentiate between the methods with the same name and signature that are defined in both the remote and home interfaces. The method-intf element must be one of the following: Home or Remote.
|
||||||||
| <method-name>nameOfMethod</method-name> | ||||||||
|
The method-name element contains a name of an enterprise bean method, or the asterisk (*) character. The asterisk is used when the element denotes all the methods of an enterprise bean's remote and home interfaces.
|
||||||||
| <method-params> | ||||||||
|
The method-params element contains a list of the fully-qualified Java type names of the method parameters.
|
||||||||
| <method-param>int[]</method-param> | ||||||||
|
The method-param element contains the fully-qualified Java type name of a method parameter.
|
||||||||
| <env-entry-mapping name="theName">deploymentValue</env-entry-mapping> | ||||||||
|
Overrides the value of an env-entry in the assembly descriptor. It is used to keep the .ear (assembly) clean from deployment-specific values. The body is the value.
name - The name of the context-param. |
||||||||
| <ejb-ref-mapping location="ejb/Payroll" name="ejb/Payroll" /> | ||||||||
|
The ejb-ref element is used for the declaration of a reference to another enterprise bean's home. The ejb-ref-mapping ties this to a JNDI-location when deploying.
location - The JNDI location to look up the EJB home from. name - The ejb-ref's name. Matches the name of an ejb-ref in ejb-jar.xml. |
||||||||
| <resource-ref-mapping location="jdbc/TheDS" name="jdbc/TheDSVar"> | ||||||||
|
The resource-ref element is used for the declaration of a reference to an external resource such as a datasource, JMS queue, mail session or similar. The resource-ref-mapping ties this to a JNDI-location when deploying.
location - The JNDI location to look up the resource factory from. name - The resource-ref's name. Matches the name of an resource-ref in ejb-jar.xml. |
||||||||
| <lookup-context location="foreign/resource/location"> | ||||||||
|
The specification of an optional javax.naming.Context implementation used for retrieving the resource. This is useful when hooking up with 3rd party modules, such as a 3rd party JMS server for instance. Either use the context implementation supplied by the resource vendor or if none exists write an implementation which in turn negotiates with the vendor software.
location - The name looked for in the foreign context when retrieving the resource. |
||||||||
| <context-attribute name="name" value="value" /> | ||||||||
|
An attribute sent to the context. The only mandatory attribute in JNDI is the 'java.naming.factory.initial' which is the classname of the context factory implementation.
name - The name of the attribute. value - The value of the attribute. |
||||||||
| <timer-service data-source="jdbc/MyEJBDS" id-field-name="info" info-field-name="info" table="MyTimer" timeout-field-name="timeout" timeout-interval-field-name="timeout-interval"> | ||||||||
|
The beans in this ejb-jar.
data-source - The name of the data-source used to persist the timers. id-field-name - The database field name for id primary key of the timer. info-field-name - The database field name for the timer serialized optional info data. table - The name of the table in the database used to persist the timers. timeout-field-name - The database field name for the timer timeout data. timeout-interval-field-name - The database field name for the timer timeout interval data. |
||||||||
| <cmp-field-mapping ejb-reference-home="MyOtherEntity" name="myField" persistence-name="myField" persistence-type="integer|char (255)|..."> | ||||||||
|
Deployment info for a container-managed persistence field. If no subtags defining different behaviour is specified the field is persisted thru serialization or native handling of "recognized" primitive types.
ejb-reference-home - The JNDI-location of the fields remote EJB-home if the field is an entity EJBObject or an EJBHome. name - The name of the field. persistence-name - The name of the field in the database table. persistence-type - The database type (valid values varies from database to database) of the field. |
||||||||
| <fields> | ||||||||
|
Specifies the configuration of a field-based (java class field) mapping persistence for this field. The fields that are to be persisted have to be public, non-static, non-final and the type of the containing object has to have an empty constructor.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <properties> | ||||||||
|
Specifies the configuration of a property-based (bean properties) mapping persistence for this field. The properties have to adhere to the usual JavaBeans specification and the type of the containing object has to have an empty constructor (also per the beans spec).
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <entity-ref home="ejb/TheEJB"> | ||||||||
|
Specified the configuration for persisting an entity reference via it's primary key. The child-tag of this tag is the specification of how to persist the primary key.
home - JNDI location of the EJBHome to get lookup the beans at. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <list-mapping table="MyEntity_listVariable"> | ||||||||
|
Specifies a relational mapping of a List type. A List is a sequential (where order/index is important) Collection of items. The field containing the mapping must be of type java.util.List or the legacy types java.util.Vector or Type[].
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <collection-mapping table="MyEntity_collectionVariable"> | ||||||||
|
Specifies a relational mapping of a Collection type. A Collection consists of n unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Collection.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <set-mapping table="MyEntity_setVariable"> | ||||||||
|
Specifies a relational mapping of a Set type. A Set consists of n unique unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Set.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-mapping table="MyEntity_mapVariable"> | ||||||||
|
Specifies a relational mapping of a Map type. A Map consists of n unique keys and their mapping to values. The field containing the mapping must be of type java.util.Map or the legacy types java.util.Hashtable or java.util.Properties.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-key-mapping type="null"> | ||||||||
|
Specifies a mapping of the map key. Map keys are always immutable.
type - The fully qualified classname of the type of the value. Examples are com.acme.Product, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <field-persistence-manager class="my.FieldPersistenceManager"> | ||||||||
|
A field persistence manager is a custom persistence handler for a CMP-field. See the API documentation for details.
class - The class implementing the custom persistence manager. |
||||||||
| <property name="theName" value="theValue" /> | ||||||||
|
A configuration property.
name - The property name value - The property value |
||||||||
| <message-driven-deployment cache-timeout="60|never" connection-factory-location="jms/MyQueueConnection" destination-location="jms/MyQueue" max-instances="50" min-instances="5" name="MyMessageDriven"> | ||||||||
|
Deployment info for a session bean.
cache-timeout - The number of seconds before a cached instance can be timed out. Can be set to 'never' to never time out or to 0 (zero) to never cache. The default is 60. connection-factory-location - The JNDI location of the connection factory to use. destination-location - The JNDI location of the destination (queue/topic) to use. max-instances - The maximum number of bean instances to instantiate. The default is -1, which implies an infinite number. min-instances - The minimum number of bean instances to instantiate. The set amount will be instantiated at startup, and there will always be at least the set amount of instances active. The default is 0 (none). name - The name of the bean, this matches the name of a bean in the assembly descriptor (ejb-jar.xml). |
||||||||
| <env-entry-mapping name="theName">deploymentValue</env-entry-mapping> | ||||||||
|
Overrides the value of an env-entry in the assembly descriptor. It is used to keep the .ear (assembly) clean from deployment-specific values. The body is the value.
name - The name of the context-param. |
||||||||
| <ejb-ref-mapping location="ejb/Payroll" name="ejb/Payroll" /> | ||||||||
|
The ejb-ref element is used for the declaration of a reference to another enterprise bean's home. The ejb-ref-mapping ties this to a JNDI-location when deploying.
location - The JNDI location to look up the EJB home from. name - The ejb-ref's name. Matches the name of an ejb-ref in ejb-jar.xml. |
||||||||
| <resource-ref-mapping location="jdbc/TheDS" name="jdbc/TheDSVar"> | ||||||||
|
The resource-ref element is used for the declaration of a reference to an external resource such as a datasource, JMS queue, mail session or similar. The resource-ref-mapping ties this to a JNDI-location when deploying.
location - The JNDI location to look up the resource factory from. name - The resource-ref's name. Matches the name of an resource-ref in ejb-jar.xml. |
||||||||
| <lookup-context location="foreign/resource/location"> | ||||||||
|
The specification of an optional javax.naming.Context implementation used for retrieving the resource. This is useful when hooking up with 3rd party modules, such as a 3rd party JMS server for instance. Either use the context implementation supplied by the resource vendor or if none exists write an implementation which in turn negotiates with the vendor software.
location - The name looked for in the foreign context when retrieving the resource. |
||||||||
| <context-attribute name="name" value="value" /> | ||||||||
|
An attribute sent to the context. The only mandatory attribute in JNDI is the 'java.naming.factory.initial' which is the classname of the context factory implementation.
name - The name of the attribute. value - The value of the attribute. |
||||||||
| <timer-service data-source="jdbc/MyEJBDS" id-field-name="info" info-field-name="info" table="MyTimer" timeout-field-name="timeout" timeout-interval-field-name="timeout-interval"> | ||||||||
|
The beans in this ejb-jar.
data-source - The name of the data-source used to persist the timers. id-field-name - The database field name for id primary key of the timer. info-field-name - The database field name for the timer serialized optional info data. table - The name of the table in the database used to persist the timers. timeout-field-name - The database field name for the timer timeout data. timeout-interval-field-name - The database field name for the timer timeout interval data. |
||||||||
| <cmp-field-mapping ejb-reference-home="MyOtherEntity" name="myField" persistence-name="myField" persistence-type="integer|char (255)|..."> | ||||||||
|
Deployment info for a container-managed persistence field. If no subtags defining different behaviour is specified the field is persisted thru serialization or native handling of "recognized" primitive types.
ejb-reference-home - The JNDI-location of the fields remote EJB-home if the field is an entity EJBObject or an EJBHome. name - The name of the field. persistence-name - The name of the field in the database table. persistence-type - The database type (valid values varies from database to database) of the field. |
||||||||
| <fields> | ||||||||
|
Specifies the configuration of a field-based (java class field) mapping persistence for this field. The fields that are to be persisted have to be public, non-static, non-final and the type of the containing object has to have an empty constructor.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <properties> | ||||||||
|
Specifies the configuration of a property-based (bean properties) mapping persistence for this field. The properties have to adhere to the usual JavaBeans specification and the type of the containing object has to have an empty constructor (also per the beans spec).
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <entity-ref home="ejb/TheEJB"> | ||||||||
|
Specified the configuration for persisting an entity reference via it's primary key. The child-tag of this tag is the specification of how to persist the primary key.
home - JNDI location of the EJBHome to get lookup the beans at. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <list-mapping table="MyEntity_listVariable"> | ||||||||
|
Specifies a relational mapping of a List type. A List is a sequential (where order/index is important) Collection of items. The field containing the mapping must be of type java.util.List or the legacy types java.util.Vector or Type[].
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <collection-mapping table="MyEntity_collectionVariable"> | ||||||||
|
Specifies a relational mapping of a Collection type. A Collection consists of n unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Collection.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <set-mapping table="MyEntity_setVariable"> | ||||||||
|
Specifies a relational mapping of a Set type. A Set consists of n unique unordered items (order isnt specified and not relevant). The field containing the mapping must be of type java.util.Set.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-mapping table="MyEntity_mapVariable"> | ||||||||
|
Specifies a relational mapping of a Map type. A Map consists of n unique keys and their mapping to values. The field containing the mapping must be of type java.util.Map or the legacy types java.util.Hashtable or java.util.Properties.
table - The name of the table in the database. |
||||||||
| <primkey-mapping> | ||||||||
|
Specifies a mapping of the primary key part of a set of fields.
|
||||||||
| <cmp-field-mapping .../> | ||||||||
| <map-key-mapping type="null"> | ||||||||
|
Specifies a mapping of the map key. Map keys are always immutable.
type - The fully qualified classname of the type of the value. Examples are com.acme.Product, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <value-mapping immutable="true|false" type="the.package.Type"> | ||||||||
|
Specified a mapping of the primary key part of a set of fields.
immutable - Whether or not the value can be trusted to be immutable once added to the Collection/Map. Setting this to true will optimize database operations extensively. The default value is "true" for set-mapping and map-mappings and "false" for collection-mapping and list-mapping. type - The fully qualified classname of the type of the value. Examples are com.acme.OrderEntry, java.lang.String etc. |
||||||||
| <cmp-field-mapping .../> | ||||||||
| <field-persistence-manager class="my.FieldPersistenceManager"> | ||||||||
|
A field persistence manager is a custom persistence handler for a CMP-field. See the API documentation for details.
class - The class implementing the custom persistence manager. |
||||||||
| <property name="theName" value="theValue" /> | ||||||||
|
A configuration property.
name - The property name value - The property value |
||||||||
| <assembly-descriptor> | ||||||||
|
The mapping of the assembly descriptor elements.
|
||||||||
| <security-role-mapping impliesAll="true|false" name="theRole"> | ||||||||
|
The runtime mapping (to groups and users) of a role. Maps to a security-role of the same name in the assembly descriptor.
impliesAll - Whether or not this mapping implies all users. The default is false. name - The name of the role |
||||||||
| <group name="theGroup" /> | ||||||||
|
A group that this security-role-mapping implies. Ie all the members of the specified group are included in this role.
name - The name of the group. |
||||||||
| <user name="theUser" /> | ||||||||
|
A user that this security-role-mapping implies.
name - The name of the user. |
||||||||
| <default-method-access> | ||||||||
|
The default method-access policy for methods not tied to a method-permission.
|
||||||||
| <security-role-mapping impliesAll="true|false" name="theRole"> | ||||||||
|
The runtime mapping (to groups and users) of a role. Maps to a security-role of the same name in the assembly descriptor.
impliesAll - Whether or not this mapping implies all users. The default is false. name - The name of the role |
||||||||
| <group name="theGroup" /> | ||||||||
|
A group that this security-role-mapping implies. Ie all the members of the specified group are included in this role.
name - The name of the group. |
||||||||
| <user name="theUser" /> | ||||||||
|
A user that this security-role-mapping implies.
name - The name of the user. |
||||||||