From: Scott M S. <st...@us...> - 2003-04-30 17:47:40
|
User: starksm Date: 03/04/30 10:47:33 Modified: src/resources/org/jboss/metadata Tag: Branch_3_2 jboss_3_2.dtd Log: Add the strictMaximumSize and strictTimeout elements to the container-pool-conf content model Revision Changes Path No revision No revision 1.1.2.11 +101 -83 jboss/src/resources/org/jboss/metadata/jboss_3_2.dtd Index: jboss_3_2.dtd =================================================================== RCS file: /cvsroot/jboss/jboss/src/resources/org/jboss/metadata/jboss_3_2.dtd,v retrieving revision 1.1.2.10 retrieving revision 1.1.2.11 diff -u -r1.1.2.10 -r1.1.2.11 --- jboss_3_2.dtd 30 Apr 2003 16:15:07 -0000 1.1.2.10 +++ jboss_3_2.dtd 30 Apr 2003 17:47:32 -0000 1.1.2.11 @@ -7,8 +7,8 @@ "-//JBoss//DTD JBOSS 3.2//EN" "http://www.jboss.org/j2ee/dtd/jboss_3_2.dtd"> -$Id: jboss_3_2.dtd,v 1.1.2.10 2003/04/30 16:15:07 starksm Exp $ -$Revision: 1.1.2.10 $ +$Id: jboss_3_2.dtd,v 1.1.2.11 2003/04/30 17:47:32 starksm Exp $ +$Revision: 1.1.2.11 $ Overview of the architecture of jboss.xml @@ -24,7 +24,7 @@ <ejb-name /> <jndi-name /> <local-jndi-name /> - <read-only> + <read-only> <configuration-name> <security-proxy> <ejb-ref> @@ -110,7 +110,7 @@ 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 @@ -165,7 +165,7 @@ --> <!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 @@ -178,7 +178,7 @@ --> <!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 @@ -202,7 +202,7 @@ <!-- The org.jboss.ejb.EJBProxyFactory implementation class --> <!ELEMENT proxy-factory (#PCDATA)> -<!-- The proxy-factory-config defines the client-interceptors stack +<!-- The proxy-factory-config defines the client-interceptors stack and other configuration options to use for the various EJB proxies. --> <!ELEMENT proxy-factory-config (client-interceptors? , web-class-loader? , @@ -340,7 +340,7 @@ 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 , @@ -351,29 +351,29 @@ <!-- 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 when used in the entity, session and - message-driven elements. If it is not provided jboss will assume - "jndi-name" = "ejb-name" - - When used in the ejb-ref, resource-ref, resource-env-ref elements - this specifies the jndi name to which the reference should link. - - Used in: entity, session and message-driven - ejb-ref, resource-ref, resource-env-ref +<!-- + The jndi-name element gives the actual jndi name under which + the bean will be deployed when used in the entity, session and + message-driven elements. If it is not provided jboss will assume + "jndi-name" = "ejb-name" + + When used in the ejb-ref, resource-ref, resource-env-ref elements + this specifies the jndi name to which the reference should link. + + Used in: entity, session and message-driven + ejb-ref, resource-ref, resource-env-ref --> <!ELEMENT jndi-name (#PCDATA)> -<!-- +<!-- The JNDI name under with the local home interface should be bound - - Used in: entity and session + + Used in: entity and session --> <!ELEMENT local-jndi-name (#PCDATA)> @@ -394,7 +394,7 @@ tags in the container-configurations section, or one of the standard configurations. If no element is provided, jboss will automatically use the right standard configuration, see container-configurations. - + Note: unlike earlier releases, this element may not be specified as an empty element to achieve the same effect as not specifying the element. @@ -431,7 +431,7 @@ 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)> @@ -439,7 +439,7 @@ <!-- 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)> @@ -448,7 +448,7 @@ The resource-env-ref element gives a mapping between the "code name" of a env resource (res-ref-name, provided by the Bean Developer) and its deployed JNDI name. - + Used in: session, entity, message-driven --> <!ELEMENT resource-env-ref (resource-env-ref-name , jndi-name)> @@ -456,7 +456,7 @@ <!-- The resource-env-ref-name element gives the "code name" of a resource. It is provided by the Bean Developer. - + Used in: resource-env-ref --> <!ELEMENT resource-env-ref-name (#PCDATA)> @@ -489,7 +489,7 @@ 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)> @@ -497,7 +497,7 @@ <!-- The cluster-config element allows to specify cluster specific settings. WARNING: session-state-manager-jndi-name is only for SFSB. - + Used in: session, entity, container-configuration --> <!ELEMENT cluster-config (partition-name? , home-load-balance-policy? , @@ -508,7 +508,7 @@ 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)> @@ -517,7 +517,7 @@ 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)> @@ -528,7 +528,7 @@ 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)> @@ -541,29 +541,29 @@ NOTE: This value will *only* be applied if the correct cache plugin and interceptor(s) are defined in the container configuration. Possible values: "False", "True" (default) - + Used in: entity (only commit-option A and D will invalidate their cache) --> <!ELEMENT cache-invalidation (#PCDATA)> <!-- The cache-invalidation-config element allows to specify cache invalidation specific settings. - + Used in: entity --> <!ELEMENT cache-invalidation-config (invalidation-group-name? , invalidation-manager-name?)> <!-- - The invalidation-group-name element indicates the name of a group in which all + The invalidation-group-name element indicates the name of a group in which all invalidation messages are exchanged i.e. all beans sharing a given invalidation-group-name should share the same PK semantic. By default, invalidation-group-name equals to the EJB name. Thus, when using cache invalidation accross a cluster, it is not necessary to specify a name as all beans will have the same name - accross the cluster. Nevertheless, if you deploy, on the same node, the same EJB, once with + accross the cluster. Nevertheless, if you deploy, on the same node, the same EJB, once with commit-option C (RW access) and once in commit-option A (RO) and want the RW EJB to invalidate entries of RO EJB, each one will obviously have its own EJB name. Consequently, you can assign a common invalidation-group-name to both EJBs so that they share their cache invalidation messages. - + Used in: entity (in cache-invalidation-config element) --> <!ELEMENT invalidation-group-name (#PCDATA)> @@ -571,7 +571,7 @@ <!-- The invalidation-manager-name references the InvalidationManager MBean to be used. By Default, the default InvalidationManager is used. - + Used in: entity (in cache-invalidation-config element) --> <!ELEMENT invalidation-manager-name (#PCDATA)> @@ -581,7 +581,7 @@ 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)> @@ -592,9 +592,9 @@ 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))> @@ -603,7 +603,7 @@ The res-ref-name element gives the "code name" of a resource. It is provided by the Bean Developer. See resource-managers for the actual configuration of the resource. - + Used in: resource-ref --> <!ELEMENT res-ref-name (#PCDATA)> @@ -612,33 +612,33 @@ 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 Developer 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*)> @@ -650,9 +650,9 @@ 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))> @@ -660,7 +660,7 @@ <!-- 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)> @@ -668,7 +668,7 @@ <!-- 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)> @@ -676,7 +676,7 @@ <!-- 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)> @@ -701,12 +701,12 @@ - Clustered BMP EntityBean - IIOP BMP EntityBean - Standard message Driven Bean - + The 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*)> @@ -716,7 +716,7 @@ 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?, @@ -740,7 +740,7 @@ <!-- 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)> @@ -782,12 +782,12 @@ (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 client-interceptors defines the home and bean client side interceptor chain Used in: proxy-factory-config @@ -814,7 +814,7 @@ --> <!ELEMENT bean (interceptor+)> -<!-- +<!-- The list-entity element gives the chain of interceptors (instances of org.jboss.proxy.Interceptor) that are associated with the remote proxy and operate in the client VM. The declared order of the interceptor @@ -845,7 +845,7 @@ --> <!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 @@ -861,7 +861,7 @@ - org.jboss.ejb.plugins.StatelessSessionInstancePool for stateless session beans. - no pool is used for stateful session beans - + Used in: container-configuration --> <!ELEMENT instance-pool (#PCDATA)> @@ -874,7 +874,7 @@ - org.jboss.ejb.plugins.NoPassivationStatefulSessionInstanceCache for stateful session beans. - no cache is used for stateless session beans - + Used in: container-configuration --> <!ELEMENT instance-cache (#PCDATA)> @@ -890,7 +890,7 @@ - org.jboss.ejb.StatefulSessionPersistenceManager for stateless session beans. - no persistence-manager is used for stateless session beans - + Used in: container-configuration --> <!ELEMENT persistence-manager (#PCDATA)> @@ -900,7 +900,7 @@ implementation JBoss must use for in this configuration. This class must implement the org.jboss.ejb.BeanLock interface. The default is org.jboss.ejb.plugins.lock.QueuedPessimisticEJBLock. - + Used in: container-configuration --> <!ELEMENT locking-policy (#PCDATA)> @@ -921,7 +921,7 @@ jboss does not read directly the subtree for this element: instead, it is passed to the instance cache instance (if it implements org.jboss.metadata.XmlLoadable) for it to load its parameters. - + Used in: container-configuration --> <!ELEMENT container-cache-conf (cache-policy? , cache-policy-conf?)> @@ -929,7 +929,7 @@ <!-- The implementation class for the cache policy, which controls when instances will be passivated, etc. - + Used in: container-cache-conf --> <!ELEMENT cache-policy (#PCDATA)> @@ -1009,45 +1009,63 @@ jboss does not read directly the subtree for this element: instead, it is passed to the instance pool instance (if it implements org.jboss.metadata.XmlLoadable) for it to load its parameters. - + The default instance pools, EntityInstancePool and StatelessSessionInstancePool, both accept the following configuration. - + Used in: container-configuration --> -<!ELEMENT container-pool-conf (MinimumSize?, MaximumSize)> +<!ELEMENT container-pool-conf (MinimumSize?, MaximumSize?, + strictMaximumSize?, strictTimeout?)> +<!-- The theoretical minimum size of the pool. Currently unused by JBoss +pools. +--> <!ELEMENT MinimumSize (#PCDATA)> + <!-- - The capacity of the Pool. The pool feeder will feed the pool with new - instances, the pool size being limited by this value. For pools where - reclaim is possible, the pool will also be feed when the instance is - free to be reused. + The capacity of the Pool. For pools where reclaim is possible, the pool will + also be repopulated when the instance is free to be reused. This is not an hard limit, if instances are needed when the pool is at - its MaximumSize, new instances will be created following the demand. - + its MaximumSize, new instances will be created following the demand unless + a strictMaximumSize of true is specified. + Used in: container-pool-conf and invoker-proxy-conf for JMSContainerInvoker --> <!ELEMENT MaximumSize (#PCDATA)> +<!-- A boolean flag indicating if attempts to access the pool will block when +MaximumSize instances are active. The default is false. + + Used in: container-pool-conf +--> +<!ELEMENT strictMaximumSize (#PCDATA)> + +<!-- The time in milliseconds to wait for the strictMaximumSize semaphore. The +default is Long.MAX_VALUE or essentially enternity. + + Used in: container-pool-conf +--> +<!ELEMENT strictTimeout (#PCDATA)> + <!-- This option is only used for entity container configurations. - + The commit-option element tells the container which option to use for transactions. Its value must be A, B C, or D. - + - option A: the entiry instance has exclusive access to the database. The instance stays ready after a transaction. - option B: the entity instance does not have exclusive access to the database. The state is loaded before the next transaction. - option C: same as B, except the container does not keep the instance after commit: a passivate is immediately performed after the commit. - + - option D: a lazy update. default is every 30 secs. can be updated with <optiond-refresh-rate> - + See ejb1.1 specification for details (p118). - + Used in: container-configuration --> <!ELEMENT commit-option (#PCDATA)> |