jboss_2_4.dtd

《J2EE企业级应用开发》一书的配套源代码

<?xml version='1.0' encoding='UTF-8' ?>

<!--
This is the XML DTD for the JBoss 2.4 EJB deployment descriptor.
The DOCTYPE is:
  <!DOCTYPE jboss PUBLIC
      "-//JBoss//DTD JBOSS 2.4//EN"
      "http://www.jboss.org/j2ee/dtd/jboss_2_4.dtd">

$Id: jboss_2_4.dtd,v 1.9 2001/11/09 23:11:21 slaboure Exp $
$Revision: 1.9 $

Overview of the architecture of jboss.xml

<jboss>

  <enforce-ejb-restrictions />
  <security-domain />
  <unauthenticated-principal />

  <enterprise-beans>

    <entity>
      <ejb-name />
      <jndi-name />
      <resource-ref>
        <res-ref-name />
        <resource-name />
      </resource-ref>
      <clustered />
    </entity>

    <session>
      <ejb-name />
      <jndi-name />
      <resource-ref>
        <res-ref-name />
        <resource-name />
      </resource-ref>
      <clustered />
    </session>

  </enterprise-beans>

  <resource-managers>

    <resource-manager>
      <res-name />
      <res-jndi-name />
    </resource-manager>

    <resource-manager>
      <res-name />
      <res-url />
    </resource-manager>

  </resource-managers>

  <container-configurations>

    <container-configuration>
      <container-name />
      <container-invoker />
      <container-interceptors />
      <instance-pool />
      <instance-cache />
      <persistence-manager />
      <transaction-manager />
      <locking-policy />
      <container-invoker-conf />
      <container-cache-conf />
      <container-pool-conf />
      <commit-option />
      <optiond-refresh-rate />
      <security-domain/>
    </container-configuration>

  </container-configurations>

</jboss>
-->
<!--
The jboss element is the root element of the jboss.xml file. It
contains all the information used by jboss but not described in the
ejb-jar.xml file. All of it is optional.

1- the application assembler can define custom container configurations
for the beans. Standard configurations are provided in standardjboss.xml
2- the deployer can override the jndi names under which the beans are
deployed
3- the deployer can specify runtime jndi names for resource managers.

-->
<!ELEMENT jboss (enforce-ejb-restrictions? , security-domain? , unauthenticated-principal? , enterprise-beans? , resource-managers? , container-configurations?)>

<!--
  The enforce-ejb-restrictions element tells the container to enforce ejb1.1 restrictions
  It must be one of the following :
     <enforce-ejb-restrictions>true</enforce-ejb-restrictions>
     <enforce-ejb-restrictions>false</enforce-ejb-restrictions>

  Used in: jboss
  -->
<!ELEMENT enforce-ejb-restrictions (#PCDATA)>

<!-- The security-domain element specifies the JNDI name of the security
manager that implements the EJBSecurityManager and RealmMapping for
the domain. When specified at the jboss level it specifies the security
domain for all j2ee components in the deployment unit.
One can override the global security-domain at the container
level using the security-domain element at the container-configuration
level.

  Used in: jboss, container-configuration
-->
<!ELEMENT security-domain (#PCDATA)>

<!-- The unauthenticated-principal element specifies the name of the principal
that will be returned by the EJBContext.getCallerPrincipal() method if there
is no authenticated user. This Principal has no roles or privaledges to call
any other beans.
-->
<!ELEMENT unauthenticated-principal (#PCDATA)>

<!--
  The enterprise-beans element contains additional information about
  the beans. These informations, such as jndi names, resource managers and
  container configurations, are specific to jboss and not described in
  ejb-jar.xml.

  jboss will provide a standard behaviour if no enterprise-beans element
  is found, see container-configurations, jndi-name and resource-managers
  for defaults.

  Used in: jboss
  -->
<!ELEMENT enterprise-beans (session | entity | message-driven)+>

<!--
    The entity element holds information specific to jboss and not declared
    in ejb-jar.xml about an entity bean, such as jndi name, container
    configuration, and resource managers. (see tags for details)
    The bean should already be declared in ejb-jar.xml, with the same
    ejb-name.

    Used in: enterprise-beans
    -->
<!ELEMENT entity (ejb-name , jndi-name? , configuration-name? , security-proxy? , ejb-ref* , resource-ref* , resource-env-ref* , clustered? , cluster-config? )>

<!--
    The session element holds information specific to jboss and not declared
    in ejb-jar.xml about a session bean, such as jndi name, container
    configuration, and resource managers. (see tags for details)
    The bean should already be declared in ejb-jar.xml, with the same
    ejb-name.

    Used in: enterprise-beans
    -->
<!ELEMENT session (ejb-name , jndi-name? , configuration-name? , security-proxy? , ejb-ref* , resource-ref* , resource-env-ref* , clustered? , cluster-config? )>

<!--
    The message-driven element holds information specific to jboss and not declared
    in ejb-jar.xml about a message-driven bean, such as container
    configuration and resources.
    The bean should already be declared in ejb-jar.xml, with the same
    ejb-name.

    Used in: enterprise-beans
    -->
<!ELEMENT message-driven (ejb-name , destination-jndi-name , configuration-name? , security-proxy? , ejb-ref* , resource-ref* , resource-env-ref*)>

<!--
      The ejb-name element gives the name of the bean, it must correspond to
      an ejb-name element in ejb-jar.xml

      Used in: entity, session, and message-driven
      -->
<!ELEMENT ejb-name (#PCDATA)>

<!--
      The jndi-name element gives the actual jndi name under which the bean will
      be deployed. It is provided by the deployer. If not, jboss will assume
      "jndi-name" = "ejb-name"

      Used in: entity and session
      -->
<!ELEMENT jndi-name (#PCDATA)>

<!--
      The configuration-name element gives the name of the container
      configuration for this bean. It must match one of the container-name
      tags in the container-configurations section, or one of the standard
      configurations. If none is provided, jboss will automatically use the
      right standard configuration, see container-configurations.

      Used in: entity, session, and message-driven
      -->
<!ELEMENT configuration-name (#PCDATA)>

<!ELEMENT destination-jndi-name (#PCDATA)>

<!-- The security-proxy gives the class name of the security proxy implementation.
	This may be an instance of org.jboss.security.SecurityProxy, or an
	just an object that implements methods in the home or remote interface
	of an EJB without implementating any common interface.

      Used in: entity, session, and message-driven
-->
<!ELEMENT security-proxy (#PCDATA)>

<!--
      The ejb-ref element is used to give the jndi-name of an external
      ejb reference. In the case of an external ejb reference, you don't
      provide a ejb-link element in ejb-jar.xml, but you provide a jndi-name
      in jboss.xml

      Used in: entity, session, and message-driven
      -->
<!ELEMENT ejb-ref (ejb-ref-name , jndi-name)>

<!--
        The ejb-ref-name element is the name of the ejb reference as given in
        ejb-jar.xml.

        Used in: ejb-ref
        -->
<!ELEMENT ejb-ref-name (#PCDATA)>

<!--
        The jndi-name element gives the deployed name of the reference. The
        general form is
           <jndi-name>t3://otherserver/application/beanB</jndi-name>

        Used in: ejb-ref

	(It's commented out here because it appears above and you
         can't declare an element more than once per DTD)
        -->
<!--    <!ELEMENT jndi-name (#PCDATA)> -->
<!--
      The resource-env-ref element gives a mapping between the "code name"
      of a env resource (res-ref-name, provided by the Bean Developper) and
      its deployed JNDI name.

      Used in: session, entity, message-driven
      -->
<!ELEMENT resource-env-ref (resource-env-ref-name , jndi-name)>

<!--
        The resource-env-ref-name element gives the "code name" of a resource. It is
        provided by the Bean Developper. See resource-managers for the actual

        Used in: resource-env-ref
        -->
<!ELEMENT resource-env-ref-name (#PCDATA)>

<!--
      The clustered element indicates if this bean will run in a cluster of JBoss instances.
      It is provided by the deployer. If not, jboss will assume clustered = False
      Possible values: "True", "False" (default)

      Used in: entity and session
      -->
<!ELEMENT clustered (#PCDATA)>

<!--
      The cluster-config element allows to specify cluster specific settings.
      WARNING: session-state-manager-jndi-name is only for SFSB.

      Used in: session, entity
      -->
<!ELEMENT cluster-config (partition-name? , home-load-balance-policy? , bean-load-balance-policy? , session-state-manager-jndi-name? )>

<!--
      The partition-name element indicates the name of the HAPartition to be used
      by the container to exchange clustering information. This is a name and *not*
      a JNDI name. Given name will be prefixed by "/HASessionState/" by the container to get
      the actual JNDI name of the HAPartition. If not, jboss will assume partition-name = "DefaultPartition".

      Used in: entity and session (in clustered-config element)
      -->
<!ELEMENT partition-name (#PCDATA)>

<!--
      The home-load-balance-policy element indicates the java class name to be used
      to load balance calls in the home proxy.
      If not, jboss will assume home-load-balance-policy = "org.jboss.ha.framework.interfaces.RoundRobin".

      Used in: entity and session (in clustered-config element)
      -->
<!ELEMENT home-load-balance-policy (#PCDATA)>

<!--
      The bean-load-balance-policy element indicates the java class name to be used
      to load balance calls in the bean proxy.
      If not, jboss will assume :
       - for EB and SFSB : bean-load-balance-policy = "org.jboss.ha.framework.interfaces.RoundRobin"
       - for SLSB        : bean-load-balance-policy = "org.jboss.ha.framework.interfaces.RoundRobin"

      Used in: entity and session (in clustered-config element)
      -->
<!ELEMENT bean-load-balance-policy (#PCDATA)>

<!--
      The session-state-manager-jndi-name element indicates the name of the HASessionState to be used
      by the container as a backend for state session management in the cluster.
      This *is* a JNDI name (not like the partition-name element).
      If not, jboss will assume partition-name = "/HASessionState/Default".

      Used in: session (in clustered-config element)
      -->
<!ELEMENT session-state-manager-jndi-name (#PCDATA)>

<!--
        The jndi-name element gives the deployed name of the reference. The
        general form is
           <jndi-name>t3://otherserver/application/beanB</jndi-name>

        Used in: ejb-ref

	(It's commented out here because it appears above and you
         can't declare an element more than once per DTD)
        -->
<!--    <!ELEMENT jndi-name (#PCDATA)> -->
<!--
      The resource-ref element gives a mapping between the "code name"
      of a resource (res-ref-name, provided by the Bean Developper) and
      its "xml name" (resource-name, provided by the Application Assembler).
      If no resource-ref is provided, jboss will assume that
      "xml-name" = "code name"

      See resource-managers.

      Used in: entity, session, and message-driven
      -->
<!ELEMENT resource-ref (res-ref-name , (resource-name | jndi-name | res-url))>

<!--
        The res-ref-name element gives the "code name" of a resource. It is
        provided by the Bean Developper. See resource-managers for the actual
        configuration of the resource.

        Used in: resource-ref
        -->
<!ELEMENT res-ref-name (#PCDATA)>

<!--
        The resource-name element gives the "xml name" of the resource. It is
        provided by the Application Assembler. See resource-managers for the
        actual configuration of the resource.

        Used in: resource-ref
        -->
<!ELEMENT resource-name (#PCDATA)>

<!--
  The resource-managers element is used to declare resource managers.

  A resource has 3 names:
  - the "code name" is the name used in the code of the bean, supplied by
    the Bean Developper in the resource-ref section of the ejb-jar.xml file

  - the "xml name" is an intermediary name used by the Application Assembler
    to identify resources in the XML file.

  - the "runtime jndi name" is the actual jndi-name or url of the deployed
    resource, it is supplied by the Deployer.

  The mapping between the "code name" and the "xml name" is given
  in the resource-ref section for the bean. If not, jboss will assume that
  "xml name" = "code name".

  The mapping between the "xml name" and the "runtime jndi name" is given in
  a resource-manager section. If not, and if the datasource is of type
  javax.sql.DataSource, jboss will look for a javax.sql.DataSource in the jndi
  tree.

  Used in: jboss
  -->
<!ELEMENT resource-managers (resource-manager*)>

<!--
    The resource-manager element is used to provide a mapping between the
    "xml name" of a resource (res-name) and its "runtime jndi name"
    (res-jndi-name or res-url according to the type of the resource).
    If it is not provided, and if the type of the resource is
    javax.sql.DataSource, jboss will look for a javax.sql.DataSource in the
    jndi tree.

    See resource-managers.

    Used in: resource-managers
    -->
<!ELEMENT resource-manager (res-name , (res-jndi-name | res-url))>

<!--
      The res-name element gives the "xml name" of a resource, it is provided
      by the Application Assembler. See resource-managers.

      Used in: resource-manager
      -->
<!ELEMENT res-name (#PCDATA)>

<!--
      The res-jndi-name element is the "deployed jndi name" of a resource, it
      is provided by the Deployer. See resource-managers.

      Used in: resource-manager
      -->
<!ELEMENT res-jndi-name (#PCDATA)>

<!--
      The res-url element is the "runtime jndi name" as a url of the resource.
      It is provided by the Deployer. See resource-managers.

      Used in: resource-manager
      -->
<!ELEMENT res-url (#PCDATA)>

<!--
  The container-configurations element declares the different possible
  container configurations that the beans can use. standardjboss.xml
  provides 4 standard configurations with the following container-names:
   - Standard CMP EntityBean
   - Standard BMP EntityBean
   - Standard Stateless SessionBean
   - Standard Stateful SessionBean

  These standard configurations will automatically be used if no custom