User: stark
Date: 01/01/29 22:56:50
Modified: documentation jboss.dtd
Log:
Updated the documentation version to include the container interceptor
config elements.
Revision Changes Path
1.4 +167 -175 newsite/documentation/jboss.dtd
Index: jboss.dtd
===================================================================
RCS file: /products/cvs/ejboss/newsite/documentation/jboss.dtd,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- jboss.dtd 2001/01/21 08:47:08 1.3
+++ jboss.dtd 2001/01/30 06:56:50 1.4
@@ -1,3 +1,5 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+
<!--
Overview of the architecture of jboss.xml
@@ -27,7 +29,6 @@
</enterprise-beans>
-
<resource-managers>
<resource-manager>
@@ -42,12 +43,12 @@
</resource-managers>
-
<container-configurations>
<container-configuration>
<container-name />
<container-invoker />
+ <container-interceptors />
<instance-pool />
<instance-cache />
<persistence-manager />
@@ -62,13 +63,8 @@
</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
@@ -81,10 +77,9 @@
3- the deployer can specify runtime jndi names for resource managers.
-->
-<!ELEMENT jboss (secure?, enterprise-beans?, resource-managers?,
-container-configurations?)>
+<!ELEMENT jboss (secure? , 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>
@@ -92,10 +87,9 @@
Used in: jboss
-->
- <!ELEMENT secure (#PCDATA)>
+<!ELEMENT secure (#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
@@ -107,10 +101,9 @@
Used in: jboss
-->
- <!ELEMENT enterprise-beans (session | entity)+>
-
-
- <!--
+<!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)
@@ -119,11 +112,9 @@
Used in: enterprise-beans
-->
- <!ELEMENT entity (ejb-name, jndi-name?, configuration-name?,
- ejb-ref*, resource-ref*)>
-
-
- <!--
+<!ELEMENT entity (ejb-name , jndi-name? , configuration-name? , 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)
@@ -132,30 +123,26 @@
Used in: enterprise-beans
-->
- <!ELEMENT session (ejb-name, jndi-name?, configuration-name?,
- ejb-ref*, resource-ref*)>
-
-
- <!--
+<!ELEMENT session (ejb-name , jndi-name? , configuration-name? , 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)>
-
-
- <!--
+<!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)>
-
-
- <!--
+<!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
@@ -164,10 +151,9 @@
Used in: entity and session
-->
- <!ELEMENT configuration-name (#PCDATA)>
-
-
- <!--
+<!ELEMENT configuration-name (#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
@@ -175,19 +161,17 @@
Used in: entity, session
-->
- <!ELEMENT ejb-ref (ejb-ref-name, jndi-name)>
-
-
- <!--
+<!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)>
+<!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>
@@ -198,9 +182,7 @@
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).
@@ -211,30 +193,27 @@
Used in: session, entity
-->
- <!ELEMENT resource-ref (res-ref-name, resource-name)>
-
-
- <!--
+<!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)>
-
-
- <!--
+<!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)>
+<!ELEMENT resource-name (#PCDATA)>
-
- <!--
+<!--
The resource-managers element is used to declare resource managers.
A resource has 3 names:
@@ -258,10 +237,9 @@
Used in: jboss
-->
- <!ELEMENT resource-managers (resource-manager*)>
-
-
- <!--
+<!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).
@@ -273,42 +251,39 @@
Used in: resource-managers
-->
- <!ELEMENT resource-manager (res-name, (res-jndi-name | res-url))>
+<!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>
-
- <!--
+<!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)>
-
-
- <!--
+<!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)>
-
-
- <!--
+<!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)>
-
-
- <!--
+<!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:
@@ -324,10 +299,9 @@
Used in: jboss
-->
- <!ELEMENT container-configurations (container-configuration*)>
-
-
- <!--
+<!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
@@ -335,40 +309,36 @@
Used in: container-configurations
-->
- <!ELEMENT container-configuration (container-name, call-logging,
- container-invoker, instance-pool?, instance-cache?, persistence-manager?,
- transaction-manager?, container-invoker-conf?, container-cache-conf?,
- container-pool-conf?, commit-option?, role-mapping-manager?,
- authentication-module?)>
+<!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>
-
-
- <!--
+<!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)>
-
-
- <!--
+<!ELEMENT container-name (#PCDATA)>
+
+<!--
The call-logging element tells if the container must log every method
invocation for this bean or not. Its value must be trus or false.
Used in: container-configuration
-->
- <!ELEMENT call-logging (#PCDATA)>
-
-
- <!--
+<!ELEMENT call-logging (#PCDATA)>
+
+<!--
The container-invoker element gives the class name of the container
invoker jboss must use for in this configuration. This class must
implement the org.jboss.ejb.ContainerInvoker interface. The default is
@@ -378,10 +348,44 @@
Used in: container-configuration
-->
- <!ELEMENT container-invoker (#PCDATA)>
-
-
- <!--
+<!ELEMENT container-invoker (#PCDATA)>
+
+<!-- The container-interceptors element gives the chain of Interceptors
+(instances of org.jboss.ejb.Interceptor) that are associated with the container.
+The declared order of the interceptor elements corresponds to the order of the
+interceptor chain.
+
+Used in: container-configuration
+-->
+<!ELEMENT container-interceptors (interceptor+)>
+
+<!-- The interceptor element specifies an instance of org.jboss.ejb.Interceptor
+that is to be added to the container interceptor stack.
+
+Used in: container-interceptors
+-->
+<!ELEMENT interceptor (#PCDATA)>
+
+<!-- The transaction attribute is used to indicate what type of container its
+interceptor applies to. It is an enumerated value that can take on one of: Bean,
+Container or Both. A value of Bean indicates that the interceptor should only be
+added to a container for bean-managed transaction.
+A value of Container indicates that the interceptor should only be added to a
+container for container-managed transactions.
+A value of Both indicates that the interceptor should be added to all
+containers. This is the default value if the transaction attribute is not
+explictlygiven.
+-->
+<!ATTLIST interceptor transaction (Bean | Container | Both ) "Both">
+
+<!-- The metricsEnabled attributes is used to indicate if the interceptor
+should only be included when the org.jboss.ejb.ContainerFactory metricsEnabled
+flag is set to true. The allowed values are true and false with false being the
+default if metricsEnabled is not explicitly given.
+-->
+<!ATTLIST interceptor metricsEnabled (true | false ) "false">
+
+<!--
The instance-pool element gives the class name of the instance pool
jboss must use for in this configuration. This class must implement
the org.jboss.ejb.InstancePool interface. The defaults are:
@@ -392,10 +396,9 @@
Used in: container-configuration
-->
- <!ELEMENT instance-pool (#PCDATA)>
-
-
- <!--
+<!ELEMENT instance-pool (#PCDATA)>
+
+<!--
The instance-cache element gives the class name of the instance cache
jboss must use for in this configuration. This class must implement
the org.jboss.ejb.InstanceCache interface. The defaults are:
@@ -406,10 +409,9 @@
Used in: container-configuration
-->
- <!ELEMENT instance-cache (#PCDATA)>
-
-
- <!--
+<!ELEMENT instance-cache (#PCDATA)>
+
+<!--
The persistence-manager element gives the class name of the persistence
manager / persistence store jboss must use for in this configuration.
This class must implement:
@@ -423,10 +425,9 @@
Used in: container-configuration
-->
- <!ELEMENT persistence-manager (#PCDATA)>
-
-
- <!--
+<!ELEMENT persistence-manager (#PCDATA)>
+
+<!--
The transaction-manager element gives the class name of the transaction
manager jboss must use for in this configuration. This class must implement
the javax.transaction.TransactionManager interface. The default is
@@ -434,10 +435,9 @@
Used in: container-configuration
-->
- <!ELEMENT transaction-manager (#PCDATA)>
-
-
- <!--
+<!ELEMENT transaction-manager (#PCDATA)>
+
+<!--
The container-invoker-conf element holds configuration data for the
container invoker.
jboss does not read directly the subtree for this element: instead,
@@ -449,10 +449,9 @@
Used in: container-configuration
-->
- <!ELEMENT container-invoker-conf (Optimized, RMIObjectPort)>
-
+<!ELEMENT container-invoker-conf (Optimized , RMIObjectPort)>
- <!--
+<!--
This element is only valid if the container invoker is
JRMPContainerInvoker.
@@ -462,10 +461,9 @@
Used in: container-invoker-conf for JRMPContainerInvoker
-->
- <!ELEMENT Optimized (#PCDATA)>
+<!ELEMENT Optimized (#PCDATA)>
-
- <!--
+<!--
The RMIObjectPort element indicates what port the RMI objects
created by this container should listen on. Any number of objects
in the same VM can use the same port. However, objects in
@@ -481,10 +479,9 @@
Used in: container-invoker-conf for JRMPContainerInvoker
-->
- <!ELEMENT RMIObjectPort (#PCDATA)>
-
-
- <!--
+<!ELEMENT RMIObjectPort (#PCDATA)>
+
+<!--
The container-cache-conf element holds dynamic configuration data
for the instance cache.
jboss does not read directly the subtree for this element: instead,
@@ -497,71 +494,68 @@
Used in: container-configuration
-->
- <!ELEMENT container-cache-conf (cache-policy?, cache-policy-conf?)>
+<!ELEMENT container-cache-conf (cache-policy? , cache-policy-conf?)>
- <!--
+<!--
The implementation class for the cache policy, which controls
when instances will be passivated, etc.
Used in: container-cache-conf
-->
- <!ELEMENT cache-policy (#PCDATA)>
+<!ELEMENT cache-policy (#PCDATA)>
- <!--
+<!--
The configuration settings for the selected cache policy. This
is currently only valid for the LRU cache.
Used in: container-cache-conf (when cache-policy is the LRU cache)
-->
- <!ELEMENT cache-policy-conf (min-capacity, max-capacity,
- overager-period,resizer-period,max-bean-age,max-cache-miss-period,
- min-cache-miss-period,cache-load-factor)>
+<!ELEMENT cache-policy-conf (min-capacity , max-capacity , overager-period ,
resizer-period , max-bean-age , max-cache-miss-period , min-cache-miss-period ,
cache-load-factor)>
- <!--
+<!--
The minimum capacity of this cache
-->
- <!ELEMENT min-capacity (#PCDATA)>
+<!ELEMENT min-capacity (#PCDATA)>
- <!--
+<!--
The maximum capacity of this cache
-->
- <!ELEMENT max-capacity (#PCDATA)>
+<!ELEMENT max-capacity (#PCDATA)>
- <!--
+<!--
The period of the overager's runs
-->
- <!ELEMENT overager-period (#PCDATA)>
+<!ELEMENT overager-period (#PCDATA)>
- <!--
+<!--
The period of the resizer's runs
-->
- <!ELEMENT resizer-period (#PCDATA)>
+<!ELEMENT resizer-period (#PCDATA)>
- <!--
+<!--
The age after which a bean is automatically passivated
-->
- <!ELEMENT max-bean-age (#PCDATA)>
+<!ELEMENT max-bean-age (#PCDATA)>
- <!--
+<!--
Shrink cache capacity if there is a cache miss every or more
this member's value
-->
- <!ELEMENT max-cache-miss-period (#PCDATA)>
+<!ELEMENT max-cache-miss-period (#PCDATA)>
- <!--
+<!--
Enlarge cache capacity if there is a cache miss every or less
this member's value
-->
- <!ELEMENT min-cache-miss-period (#PCDATA)>
+<!ELEMENT min-cache-miss-period (#PCDATA)>
- <!--
+<!--
The resizer will always try to keep the cache capacity so that
the cache is this member's value loaded of cached objects
-->
- <!ELEMENT cache-load-factor (#PCDATA)>
-
-
- <!--
+<!ELEMENT cache-load-factor (#PCDATA)>
+
+<!--
The container-pool-conf element holds configuration data for the
instance pool.
jboss does not read directly the subtree for this element: instead,
@@ -574,10 +568,9 @@
Used in: container-configuration
-->
- <!ELEMENT container-pool-conf (MaximumSize, MinimumSize)>
-
-
- <!--
+<!ELEMENT container-pool-conf (MaximumSize , MinimumSize)>
+
+<!--
This element is only valid if the instance pool is a subclass of
AbstractInstancePool.
@@ -586,10 +579,9 @@
Used in: container-pool-conf for AbstractInstancePool subclasses
-->
- <!ELEMENT MaximumSize (#PCDATA)>
-
-
- <!--
+<!ELEMENT MaximumSize (#PCDATA)>
+
+<!--
This element is only valid if the instance pool is a subclass of
AbstractInstancePool.
@@ -598,10 +590,9 @@
Used in: container-pool-conf for AbstractInstancePool subclasses
-->
- <!ELEMENT MinimumSize (#PCDATA)>
-
+<!ELEMENT MinimumSize (#PCDATA)>
- <!--
+<!--
This option is only used for entity container configurations.
The commit-option element tells the container which option to use for
transactions.
@@ -618,22 +609,23 @@
Used in: container-configuration
-->
- <!ELEMENT commit-option (#PCDATA)>
+<!ELEMENT commit-option (#PCDATA)>
- <!--
+<!--
The role-mapping-manager element specifies the JNDI name of the
org.jboss.security.RealmMapping implementation that is to be used by the
container SecurityInterceptor.
Used in: container-configuration
-->
- <!ELEMENT role-mapping-manager (#PCDATA)>
+<!ELEMENT role-mapping-manager (#PCDATA)>
- <!--
+<!--
The authentication-module element specifies the JNDI name of the
org.jboss.security.EJBSecurityManager implementation that is to be used
by the container SecurityInterceptor.
Used in: container-configuration
-->
- <!ELEMENT authentication-module (#PCDATA)>
+<!ELEMENT authentication-module (#PCDATA)>
+
