jboss.dtd

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

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

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

Overview of the architecture of jboss.xml

<jboss>

  <secure />
  <security-domain />

  <enterprise-beans>

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

    <session>
      <ejb-name />
      <jndi-name />
      <resource-ref>
        <res-ref-name />
        <resource-name />
      </resource-ref>
    </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 />
      <container-invoker-conf />
      <container-cache-conf />
      <container-pool-conf />
      <commit-option />
      <role-mapping-manager/>
      <authentication-module/>
    </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 (secure? , security-domain?, enterprise-beans? , resource-managers? , container-configurations?)>

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

  Used in: jboss
  -->
<!ELEMENT secure (#PCDATA)>

<!-- The security-domain element allows one to specify a module wide
security manager domain. It specifies the JNDI name of the security
manager that implements the EJBSecurityManager and RealmMapping for
the domain. One can still override these interfaces at the container
level using the authentication-module and role-mapping-manager elements.
-->
<!ELEMENT security-domain (#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)+>

<!--
    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? , home-invoker? , bean-invoker? , configuration-name? , security-proxy?, ejb-ref* , resource-ref*)>

<!--
    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? , home-invoker? , bean-invoker? , configuration-name?, security-proxy?, ejb-ref* , resource-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 and session
      -->
<!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 home-invoker and bean-invoker elements defines the Invoker MBean to use
      for Home Proxies and Bean Proxies.

      Used in: entity and session
      -->
<!ELEMENT home-invoker (#PCDATA)>
<!ELEMENT bean-invoker (#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 and session
      -->
<!ELEMENT configuration-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 and session
-->
<!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
      -->
<!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-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: session, entity
      -->
<!ELEMENT resource-ref (res-ref-name , resource-name)>

<!--
        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-class attribute is used to indicate which implementation
    class should be used for the specified resource manager.
    -->
<!ATTLIST resource-manager res-class CDATA  #REQUIRED>

<!--
      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
  configuration is specified.

  The application assembler can define advanced custom configurations here.

  Used in: jboss
  -->
<!ELEMENT container-configurations (container-configuration*)>

<!--
    The container-configuration element describes a configuration for the
    container.
    The different plugins to use are declared here, as well as their
    configurations. The configuration-class attribute is no longer used.

    Used in: container-configurations
    -->
<!ELEMENT container-configuration (container-name, call-logging, container-invoker,
container-interceptors?, instance-pool?, instance-cache? , persistence-manager? ,
transaction-manager? , container-invoker-conf? , container-cache-conf? , container-pool-conf?,
commit-option? , (role-mapping-manager, authentication-module?)?)>

<!--
    The configuration-class attribute is used to indicate the
    implementation class that will be loaded for this configuration.
    This usually indicates what type of bean the configuration
    applies to.
    -->
<!ATTLIST container-configuration configuration-class CDATA  #IMPLIED>

<!--
      The container-name element gives the name of the configuration being
      defined. Beans may refer to this name in their configuration-name tag.

      Used in: container-configuration
      -->
<!ELEMENT container-name (#PCDATA)>