bind-xml element

The attribute or element name and XML schema must be specified for all XML-dependent fields. The node attribute indicates whether the field maps to an attribute, another tag, or the textual content of this element. Only simple types (primitives, date, string, and so on) can be used for attribute values. In addition, only one field can be specified as the content model in a given object. Table 7-2 describes this element’s members.

cache-type element

This element tells the container how to cache instances of this enterprise bean. Table 7-3 describes the members of this element.

class element

This element describes the mapping between a Java class (enterprise bean implementation) and an SQL table, an XML element, an LDAP entry, or any other engine. To map a class into LDAP, you must specify an identity field.

A class is specified by its fully qualified name; for example, com.my.ejb.Person. If a class extends another class for which a mapping file exists, you should use the extends attribute to include the class being extended. Do not use the extends attribute to describe class inheritance that is not reflected in any mapping.

The class mapping specifies each field in the class that is mapped to a table column. Fields that are not mapped are not stored, read, or otherwise processed. Table 7-4 describes this element’s members.

field element

This element specifies the mapping between a field in an enterprise bean’s and an SQL table column, an XML element or attribute, an LDAP attribute, and so on. Table 7-5 describes its members.

The mapping is specified from the perspective of the bean’s implementation class. The field name is required even if no such field exists in the class in order to support field references. A field is an abstraction of an enterprise bean’s property: It can refer to a property directly (by mapping to a public instance variable that is not static or transient) or indirectly by using accessor methods.

Unless specified otherwise, the persistence manager accesses the field through get methods and set methods, whose names are derived from the field name. For example, for a field called lastName, the accessors String getName() and void setName(String) are used. Collection fields require only a get method, except an array requires both a get and a set method. If the accessors are specified through the get-method and set-method attributes, the persistence manager accesses the field only through those methods. The methods must be public and not static.

If the direct attribute is true, the field is accessed directly. The field must be public, not static, and not transient.

The type attribute indicates the type of the instance variable being mapped or the type of each element in a collection. You can use fully qualified class names or a short name, as Table 7-6 illustrates.

If the field is a collection, you specify the collection type through the collection attribute and the type of each element of the collection through the type attribute. Use the following table to determine the appropriate value for the collection attribute.

The “Default implementation” column indicates the type used when the object holding the collection is null and needs to be instantiated. For hashtable and map collections, the persistence manager adds an object with the put(Object, Object) method: The object added is both the key and the value.

Table 7-5 describes the members of the field element.

key-generator element

This element specifies parameters for the key generator (if needed). For example, to obtain sequential values from the table SEQTAB, use

<key-generator name="SEQUENCE">

    <param name="table" value="SEQTAB">

    <param name="global" value="0">

</key-generator>

<class key-generator="SEQUENCE">

    ...

</class>

If you have to use several key generators of the same type for the same data store, use aliases:

<key-generator name="SEQUENCE" alias="seq1">

    <param name="table" value="SEQTAB">

    <param name="global" value="0">

</key-generator>

<key-generator name="SEQUENCE" alias="seq2">

    <param name="table" value="SEQGLOBAL">

    <param name="global" value="1">

</key-generator>

<class key-generator="seq2">

    ...

</class>

Table 7-8 describes the members of the key-generator element.

Table 7-9 lists the key-generator names supported in the persistence manager.

ldap element

This element contains field mapping information for fields mapped to LDAP resources. Table 7-10 describes its members.

map-to element

This element specifies the mapping between an enterprise bean and an SQL table. Table 7-11 describes the element’s members.

mapping element

This element is the root element of the entire file. It defines a collection of class mappings. Its members are described in Table 7-12.

param element

This element is used to provide named parameters to the containing element. Table 7-13 describes the members of this element.

sql element

This element provides field mapping information that is relevant only for fields mapped to SQL tables. The type can be the proper Java-class type returned by the JDBC driver or the SQL type without precision; for example, "java.math.BigDecimal" or "numeric". However, the type could contain the parameter for the SQL-to-Java type convertors in square brackets; for example, "char[01]" for false=0, true=1 conversion from the boolean Java type to the char SQL type. Table 7-14 describes this element’s members.

config element

The config element provides the configuration for a JDBC data source. Table 7-15 describes its members.

connector element

The connector element specifies a database-connection factory. Table 7-16 describes its members.

dataSource element

The dataSource element contains a specification for a JDBC data source. Table 7-17 describes the members of this element.

domain element

The domain element is the root element of the entire file. Table 7-18 describes the members of this element.

limits element

The limits element provides resource limits for a data source or a connector. Table 7-19 describes its members.

resources element

The resources element is the top-level element of a list of JDBC data sources and JCA connectors. Table 7-20 describes the members of this element.

connection-manager element

This element specifies a connection manager. Table 7-21 describes its members.

connector element

This element defines a connector. Table 7-22 describes its members.

connectors element

This element encloses connectors or connection managers. Table 7-23 describes its members.

container-system element

This element delimits the container configuration section of the deployment configuration file. Table 7-24 describes its members.

containers element

This element encloses containers for the three types of enterprise beans: stateless session beans, stateful session beans, and entity beans. Table 7-25 describes its members.

ejb-ref element

This element defines a reference to a bean so that the bean can be accessed using JNDI calls. Table 7-26 describes its members.

ejb-ref-location element

This element identifies a bean through its name (using its <ejb-deployment-id> member) or through its remote interface and JNDI context ID. Table 7-27 describes its members.

entity-bean element

This element defines an entity session bean. Table 7-28 describes its members.

entity-container element

This element defines an entity-bean container and encloses the definition of entity beans. Table 7-29 describes its members.

env-entry element

This element defines an environment variable and its value (which can be accessed by other beans through JNDI). Table 7-30 describes its members.

facilities element

This element specifies the runtime environment: proxy-generation attributes, remote JNDI contexts, data-store connections, and J2EE services. You should not change the information within <facilities> and </facilities> tags. Table 7-31 describes its members.

jndi-context element

This element defines one external JNDI context to be used by the application. Table 7-32 describes its members.

jndi-enc element

This element encloses naming information so that this bean can be located through JNDI. Table 7-33 describes the members of the jndi-enc element.

intra-vm-server element

This element specifies the dynamic factory proxy to use to create client proxies of the real EJB objects. Table 7-34 describes its member.

managed-connection-factory element

This element defines a managed-connection factory. Table 7-35 describes its members.

method element

This element specifies a home or remote interface method of an enterprise bean. Table 7-36 describes its members.

These are examples of the three possible styles of the method element’s syntax:

• Referring to all the methods (home interfaces and remote interfaces) defined within the <container-system> tag:

  <method>

  <method-name>*</method-name>

  </method>

• Referring to a specific method defined within the <container-system> tag:

  <method>

  <method-name>METHOD</method-name>

  </method>

• Referring to a single method within a set of methods (home interfaces and remote interfaces) with an overloaded name:

  <method>

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

method-params element

This element is used when further identification of a method is needed due to method-name overloading. Table 7-37 describes its members.

method-permission element

This element maps security roles to methods. Table 7-38 describes its members.

method-transaction element

This element specifies how the container manages transaction scopes when delegating a method invocation to an enterprise bean’s implementation class. Table 7-39 describes its members.

openejb element

This is the root tag of the deployment configuration file. Table 7-40 describes its members.

properties element

This element encloses a set of property-value definitions. Table 7-41 describes its members.

property element

This element encloses a property-value definition. Table 7-42 describes its members.

query element

This element can be used to declare a query statement and bind it to a specific finder method. The value can be retrieved using the org.openejb.core.DeploymentInfo.getQuery method. Table 7-43 describes this element’s members.

remote-jndi-contexts element

This element groups external JNDI contexts. Table 7-44 describes its members.

resource element

This element defines a resource. Table 7-45 describes its members.

resource-ref element

This element specifies a reference to an external resource. Table 7-46 describes its members.

This is an example of a <resource-ref> definition using properties:

<resource-ref>

    <res-ref-name>comp/env/jdbc/Employee</res-ref-name>

    <res-type>javax.sql.DataSource</res-type>

    <res-auth>Container</res-auth>

    <properties>

        <property>

            <property-name>url</property-name>

            <property-value>jdbc:odbc:orders</property-value>

        </property>

        <property>

            <property-name>username</property-name>

            <property-value>Admin</property-value>

        </property>

        <property>

            <property-name>password</property-name>

            <property-value></property-value>

        </property>

    </properties>

</resource-ref>

role-mapping element

This element maps a logical security role to a physical security role. Table 7-47 describes its members.

security-role element

This element defines a logical role name. Table 7-48 describes its members.

security-role-ref element

This element specifies a security-role reference. Table 7-49 describes its members

security-service element

This element defines a security service. Table 7-50 describes its members.

services element

This element encloses services used by the container. Table 7-51 describes its members.

stateful-bean element

This element defines a stateful session bean. Table 7-52 describes its members.

stateful-session-container element

This element defines a stateful session bean container and encloses the definitions of stateful session beans. Table 7-53 describes its members.

stateless-bean element

This element defines a stateless session bean. Table 7-54 describes its members.

stateless-session-container element

This element defines a stateless session bean container and encloses the definitions of stateless session beans. Table 7-55 describes its members.

transaction-service element

This element defines a transaction service. Table 7-56 describes its members.