allow-concurrent-calls true false false Requires the server to throw a RemoteException when a stateful session bean instance is currently handling a method call and another (concurrent) method call arrives on the server. stateful-session-descriptor weblogic-ejb-jar.xml The allow-concurrent-calls element specifies whether a stateful session bean instance allows concurrent method calls. By default, allows-concurrent-calls is false. However, when this value is set to true, the EJB container blocks the concurrent method call and allows it to proceed when the previous call has completed. stateful-session-descriptor 7.0 cache-between-transactions true false false Optional element. Valid only for entity EJBs. persistence weblogic-ejb-jar.xml The cache-between-transactions element, formerly the db-is-shared element, specifies whether the EJB container will cache the persistent data of an entity bean across (between) transactions. The cache-between-transactions element applies only to entity beans. When it is set to true, WebLogic Server assumes that EJB data can be modified between transactions and reloads the data at the beginning of each transaction. When set to false, WebLogic Server assumes that it has exclusive access to the EJB data in the persistent store. A Read-Only bean ignores the value of the cache-between-transactions element because WebLogic Server always performs long term caching of Read-Only data. persistence commit-option jboss.xml cache-type NRU LRU NRU stateful-session-cache weblogic-ejb-jar.xml The cache-type element specifies the order in which EJBs are removed from the cache. The values are: - Least recently used (LRU) - Not recently used (NRU) The following example shows the structure of the cache-type element. <stateful-session-cache> <cache-type>NRU</cache-type> </stateful-session-cache> 7.0 client-authentication none supported required iiop-security-descriptor weblogic-ejb-jar.xml The client-authentication element specifies whether the EJB supports or requires client authentication. iiop-security-descriptor 7.0 client-cert-authentication none supported required transport-requirements weblogic-ejb-jar.xml The client-cert-authentication element specifies whether the EJB supports or requires client certificate authentication at the transport level. transport-requirements 7.0 clients-on-same-vm true false false weblogic-enterprise-bean weblogic-ejb-jar.xml The clients-on-same-server attribute determines whether WebLogic Server sends JNDI announcements for this EJB when it is deployed. When this attribute is "false" (the default), a WebLogic Server cluster automatically updates its JNDI tree to indicate the location of this EJB on a particular server. This ensures that all clients can access the EJB, even if the client is not collocated on the same server. You can set clients-on-same-server to "true" when you know that all clients that will access this EJB will do so from the same server on which the bean is deployed. In this case, a WebLogic Server cluster does not send JNDI announcements for this EJB when it is deployed. Because JNDI updates in a cluster utilize multicast traffic, setting clients-on-same-server to "true" can reduce the startup time for very large clusters. The following example enables pass-by-value for EJB methods: <weblogic-enterprise-bean> <ejb-name>AccountBean</ejb-name> ... <clients-on-same-server>true</clients-on-same-server> </weblogic-enterprise-bean> concurrency-strategy Exclusive Database ReadOnly Optimistic Database Optional element. Valid only for entity EJBs. entity-cache weblogic-ejb-jar.xml The concurrency-strategy element specifies how the container should manage concurrent access to an entity bean. Set this element to one of four values: - Exclusive causes WebLogic Server to place an exclusive lock on cached entity EJB instances when the bean is associated with a transaction. Other requests for the EJB instance are block until the transaction completes. This option was the default locking behavior for WebLogic Server versions 3.1 through 5.1. - Database causes WebLogic Server to defer locking requests for an entity EJB to the underlying datastore. With the Database concurrency strategy, WebLogic Server allocates a separate entity bean instance and allows locking and caching to be handled by the database. This is the default option. - ReadOnly used for read-only entity beans. Activates a new instance for each transaction so that requests proceed in parallel. WebLogic Server calls ejbLoad() for ReadOnly beans are based on the read-timeout-seconds parameter. - Optimistic holds no locks in the EJB container or database during a transaction. The EJB container verifies that none of the data updated by a transaction has changed before committing the transaction. If any updated data changed, the EJB container rolls back the transaction. The following entry identifies the AccountBean class as a read-only entity EJB: <weblogic-enterprise-bean> <ejb-name>AccountBean</ejb-name> <entity-descriptor> <entity-cache> <concurrency-strategy>ReadOnly</concurrency-strategy> </entity-cache> </entity-descriptor> </weblogic-enterprise-bean> commit-option jboss.xml 7.0 confidentiality none supported required transport-requirements weblogic-ejb-jar.xml The confidentiality element specifies the transport confidentiality requirements for the EJB. Using the confidentiality element ensures that the data is sent between the client and server in such a way as to prevent other entities from observing the contents. transport-requirements connection-factory-jndi-name valid name weblogic.jms.MessageDrivenBeanConnectionFactory in config.xml message-driven-bean weblogic-ejb-jar.xml The connection-factory-jndi-name element specifies the JNDI name of the JMS ConnectionFactory that the MessageDriven Bean should look up to create its queues and topics. If this element is not specified, the default is the weblogic.jms.MessageDrivenBeanConnectionFactory in config.xml. The following example shows the structure of the connection-factory-jndi-name element: <message-driven-descriptor> <connection-factory-jndi-name>weblogic.jms.MessageDrivenBeanConnectionFactory</connection-factory-jndi-name> </message-driven-descriptor> db-is-shared true false true Optional element. Valid only for entity EJBs. persistence weblogic-ejb-jar.xml The db-is-shared element applies only to entity beans. When it is set to true, WebLogic Server assumes that EJB data can be modified between transactions and reloads the data at the beginning of each transaction. When set to false, WebLogic Server assumes that it has exclusive access to the EJB data in the persistent store. persistence commit-option jboss.xml delay-updates-until-end-of-tx true false true Optional element. Valid only for entity EJBs. persistence weblogic-ejb-jar.xml Set the delay-updates-until-end-of-tx element to true (the default) to update the persistent store of all beans in a transaction at the completion of the transaction. This setting generally improves performance by avoiding unnecessary updates. However, it does not preserve the ordering of database updates within a database transaction. If your datastore uses an isolation level of TRANSACTION_READ_UNCOMMITTED, you may want to allow other database users to view the intermediate results of in-progress transactions. In this case, set delay-updates-until-end-of-tx to false to update the bean's persistent store at the conclusion of each method invoke. Note: Setting delay-updates-until-end-of-tx to false does not cause database updates to be "committed" to the database after each method invoke; they are only sent to the database. Updates are committed or rolled back in the database only at the conclusion of the transaction. The following example shows a delay-updates-until-end-of-tx stanza. <entity-descriptor> <persistence> <delay-updates-until-end-of-tx>false</delay-updates-until-end-of-tx> </persistence> </entity-descriptor> description method weblogic-ejb-jar.xml The description element is used to provide text that describes the parent element. The following example specifies the description element. <dscription> Contains a description of parent element </description> destination-jndi-name Valid JNDI name Required in message-driven-descriptor. message-driven-descriptor weblogic-ejb-jar.xml The destination-jndi-name element specifies the JNDI name used to associate a message-driven bean with an actual JMS Queue or Topic deployed in the WebLogic Server JNDI tree. message-driven-descriptor destination-jndi-name jboss.xml ejb-name Name of an EJB defined in ejb-jar.xml Required element in method stanza. The name must conform to the lexical rules for an NMTOKEN. method weblogic-ejb-jar.xml ejb-name specifies the name of an EJB to which WebLogic Server applies isolation level properties. This name is assigned by the ejb-jar file's deployment descriptor. The name must be unique among the names of the enterprise beans in the same ejb.jar file. The enterprise bean code does not depend on the name; therefore the name can be changed during the application-assembly process without breaking the enterprise bean's function. There is no built-in relationship between the ejb-name in the deployment descriptor and the JNDI name that the deployer will assign to the enterprise bean's home. method ejb-name jboss.xml configuration-name jboss.xml mdb-client-id jboss.xml ejb-reference-description XML stanza Optional element reference-descriptor weblogic-ejb-jar.xml The ejb-reference-description element maps the JNDI name in the WebLogic Server of an EJB that is referenced by the bean in the ejb-reference element. The ejb-reference-description stanza is shown here: <ejb-reference-description> <ejb-ref-name>AdminBean</ejb-ref-name> <jndi-name>payroll.AdminBean</jndi-name> </ejb-reference-description> ejb-ref jboss.xml ejb-ref-name Optional element ejb-reference-description weblogic-ejb-jar.xml The ejb-ref-name element specifies a resource reference name. This element is the reference that the EJB provider places within the ejb-jar.xml deployment file. The ejb-ref-name stanza is shown here: <ejb-reference-description> <ejb-ref-name>AdminBean</ejb-ref-name> <jndi-name>payroll.AdminBean</jndi-name> </ejb-reference-description> ejb-ref-name jboss.xml ejb-local-reference-description Optional element reference-descriptor weblogic-ejb-jar.xml The ejb-local-reference-description element maps the JNDI name of an EJB in theWebLogic Server that is referenced by the bean in the ejb-local-ref element. The following example shows the ejb-local-reference-description element. <ejb-local-reference-description> <ejb-ref-name>AdminBean</ejb-ref-name> <jndi-name>payroll.AdminBean</jndi-name> </ejb-local-reference-description> ejb-ref jboss.xml enable-call-by-reference true false true Optional element weblogic-enterprise-bean weblogic-ejb-jar.xml By default, EJB methods called from within the same server pass arguments by reference. This increases the performance of method invocation because parameters are not copied. If you set enable-call-by-reference to False, parameters to the EJB methods are copied (pass-by-value) in accordance with the EJB 1.1 specification. Pass by value is always necessary when the EJB is called remotely (not from within the server). The following example enables pass-by-value for EJB methods: <weblogic-enterprise-bean> <ejb-name>AccountBean</ejb-name> ... <enable-call-by-reference>false</enable-call-by-reference> </weblogic-enterprise-bean> Optimized jboss.xml 7.0 enable-dynamic-queries true false true Optional element entity-descriptor weblogic-ejb-jar.xml The optional enable-dynamic-queries element must be set to true to enable dynamic queries. Dynamic queries are only available for use with EJB 2.0 CMP beans. The following example enables dynamic queries: <enable-dynamic-queries>True</enable-dynamic-queries> entity-cache XML stanza Optional element. Valid only for entity beans. entity-descriptor weblogic-ejb-jar.xml The entity-cache element defines the following options used to cache entity EJB instances within WebLogic Server: - max-beans-in-cache - idle-timeout-seconds - read-timeout-seconds - concurrency-strategy The entity-cache stanza is shown here: <entity-descriptor> <entity-cache> <max-beans-in-cache>...</max-beans-in-cache> <idle-timeout-seconds>...</idle-timeout-seconds> <read-timeout-seconds>...<read-timeout-seconds> <concurrency-strategy>...</concurrency-strategy> </entity-cache> <persistence>...</persistence> <entity-clustering>...</entity-clustering> </entity-descriptor> read-only jboss.xml max-capacity jboss.xml min-capacity jboss.xml max-bean-age jboss.xml commit-option jboss.xml 7.0 entity-cache-name XML stanza The value you specify for entity-cache-name must match the name assigned to an application level entity cache in the weblogic-application.xml file. entity-cache-ref weblogic-ejb-jar.xml The entity-cache-name element refers to an application level entity cache that the entity bean uses. An application level cache is a cache that may be shared by multiple entity beans in the same application. entity-cache-ref 7.0 entity-cache-ref XML stanza The entity-cache-name element in the entity-cache-ref stanza must contain the name of the application level cache. entity-descriptor weblogic-ejb-jar.xml The entity-cache-ref element refers to an application level entity cache which can cache instances of multiple entity beans that are part of the same application. Application level entity caches are declared in the weblogic-application.xml file. Use the "concurrency-strategy" to define the type of concurrency you want the bean to use. The concurrency-strategy must be compatible with the application level cache's caching strategy. For example, an Exclusive cache only supports beans with a concurrency-strategy of Exclusive. While a MultiVersion cache supports the Database, ReadOnly, and Optimistic concurrency strategies. The entity-cache-ref stanza is shown here: <entity-cache-ref> <entity-cache-name>AllEntityCache</entity-cache-name> <concurrency-strategy>ReadOnly</concurrency-strategy> <estimated-bean-size>20</estimated-bean-size> </entity-cache-ref> entity-clustering XML stanza Optional element. Valid only for entity EJBs in a cluster. entity-descriptor weblogic-ejb-jar.xml The entity-clustering element uses the following options to specify how an entity bean will be replicated in a WebLogic cluster: - home-is-clusterable - home-load-algorithm - home call-router-class-name The following excerpt shows the structure of a entity-clustering stanza: <entity-clustering> <home-is-clusterable>true</home-is-clusterable> <home-load-algorithm>random</home-load-algorithm> <home-call-router-class-name>beanRouter</home-call-router-class-name> </entity-clustering> clustered jboss.xml entity-descriptor XML stanza One entity-descriptor stanza is required for each entity EJB in the .jar. weblogic-enterprise-bean weblogic-ejb-jar.xml The entity-descriptor element specifies the following deployment parameters that are applicable to an entity bean: - pool - entity-cache - persistence - entity-clustering The following example shows the structure of the entity-descriptor stanza: <entity-descriptor> <entity-cache>...</entity-cache> <persistence>...</persistence> <entity-clustering>...</entity-clustering> </entity-descriptor> entity jboss.xml container-configuration jboss.xml 7.0 estimated-bean-size XML stanza entity-descriptor weblogic-ejb-jar.xml The estimated-bean-size element specifies the estimated average size of the instances of an entity bean in bytes. This is the average number of byte of memory that is consumed by each instance. Use the estimated-bean-size element when the application level cache you use to cache beans is also specified in terms of bytes and megabytes. Although you may not know the exact number of bytes consumed by the entity bean instances, specifying a size allows you to give some relative weight to the beans that share a cache at one time. For example, suppose bean A and bean B share a cache, called AB-cache, that has a size of 1000 bytes and the size of A is 10 bytes and the size of B is 20 bytes, then the cache can hold at most 100 instances of A and 50 instances of B. If 100 instances of A are cached, this implies that 0 instances of B are cached. entity-cache-name finders-load-bean true false true Optional element. Valid only for CMP entity EJBs. persistence weblogic-ejb-jar.xml The finders-load-bean element determines whether WebLogic Server loads the EJB into the cache after a call to a finder method returns a reference to the bean. If you set this element to true, WebLogic Server immediately loads the bean into the cache if a reference to a bean is returned by the finder. If you set this element to false, WebLogic Server does not automatically load the bean into the cache until the first method invocation; this behavior is consistent with the EJB 1.1 specification. The following entry specifies that EJBs are loaded into the WebLogic Server cache automatically when a finder method returns a reference to the bean: <entity-descriptor> <persistence> <finders-load-bean>true</finders-load-bean> </persistence> </entity-descriptor> load-group jbosscmp-jdbc.xml query jbosscmp-jdbc.xml home-call-router-class-name Valid router class name. null Optional element. Valid only for entity EJBs, stateful session EJBs, and stateless session EJBs in a cluster. entity-clustering stateful-session-clustering stateless-clustering weblogic-ejb-jar.xml home-call-router-class-name specifies the name of a custom class to use for routing bean method calls. This class must implement weblogic.rmi.extensions.CallRouter(). If specified, an instance of this class is called before each method call. The router class has the opportunity to choose a server to route to based on the method parameters. The class returns either a server name or null, which indicates that the current load algorithm should select the server. entity-clustering stateful-session-clustering home-is-clusterable true false true Optional element. Valid only for entity EJBs and stateful session EJBs in a cluster. entity-clustering stateful-session-clustering weblogic-ejb-jar.xml When home-is-clusterable is true, the EJB can be deployed from multiple WebLogic Servers in a cluster. Calls to the home stub are load-balanced between the servers on which this bean is deployed, and if a server hosting the bean is unreachable, the call automatically fails over to another server hosting the bean. entity-clustering home-load-algorithm round-robin random weight-based Value of weblogic.cluster.defaultLoadAlgorithm Optional element. Valid only for entity EJBs and stateful session EJBs in a cluster. entity-clustering stateful-session-clustering weblogic-ejb-jar.xml home-load-algorithm specifies the algorithm to use for load balancing between replicas of the EJB home. If this element is not defined, WebLogic Server uses the algorithm specified by the server element, weblogic.cluster.defaultLoadAlgorithm. You can define home-load-algorithm as one of the following values: - round-robin: Load balancing is performed in a sequential fashion among the servers hosting the bean. - random: Replicas of the EJB home are deployed randomly among the servers hosting the bean. - weight-based: Replicas of the EJB home are deployed on host servers according to the servers' current workload. entity-clustering stateful-session-clustering 7.0 idempotent-method Clustering must be enabled for the EJB. weblogic-enterprise-bean weblogic-ejb-jar.xml The idempotent-methods element defines list of methods which are written in such a way that repeated calls to the same method with the same arguments has exactly the same effect as a single call. This allows the failover handler to retry a failed call without knowing whether the call actually compiled on the failed server. When you enable idempotent-methods for a method, the EJB stub can automatically recover from any failure as long as it can reach another server hosting the EJB. The methods on stateless session bean homes and read-only entity beans are automatically set to be idempotent. It is not necessary to explicitly specify them as idempotent. The method stanza can contain the elements shown here: <idempotent-method> <method> <description>...</description> <ejb-name>...</ejb-name> <method-intf>...</method-intf> <method-name>...</method-name> <method-params>...</method-params> </method> </idempotent-method> 7.0 identity-assirtion none supported required iiop-security-descriptor weblogic-ejb-jar.xml The identity-assertion element specifies whether the EJB supports or requires identity assertion. iiop-security-descriptor idle-timeout-seconds 1 maxSeconds 600 Optional element. entity-cache stateful-session-cache weblogic-ejb-jar.xml idle-timeout-seconds defines the maximum length of time a stateful EJB should remain in the cache. After this time has elapsed, WebLogic Server removes the bean instance if the number of beans in cache approaches the limit of max-beans-in-cache. The removed bean instances are passivated. The following entry indicates that the stateful session EJB, AccountBean, should become eligible for removal if max-beans-in-cache is reached and the bean has been in cache for 20 minutes: <weblogic-enterprise-bean> <ejb-name>AccountBean</ejb-name> <stateful-session-descriptor> <stateful_session-cache> <max-beans-in-cache>200</max-beans-in-cache> <idle-timeout-seconds>1200</idle-timeout-seconds> </stateful-session-cache> </stateful-session-descriptor> </weblogic-enterprise-bean> max-bean-age jboss.xml 7.0 iiop-security-descriptor weblogic-enterprise-bean stateful-session-cache weblogic-ejb-jar.xml The iiop-security-descriptor element specifies security configuration parameters at the bean-level. These parameters determine the IIOP security information contained in the IOR. The iiop-security-descriptor stanza can contain the elements shown here <iiop-security-descriptor> <transport-requirements>...</transport-requirements> <client-authorization>suppoted<client-authentication> <identity-assertion>supported</identity-assertion> </iiop-security-description> initial-beans-in-free-pool 0 maxBeans 0 Optional element. Valid for stateless session, entity, and message-driven EJBs. pool weblogic-ejb-jar.xml If you specify a value for initial-beans-in-free-pool, you set the initial size of the pool. WebLogic Server populates the free pool with the specified number of bean instances for every bean class at startup. Populating the free pool in this way improves initial response time for the EJB, because initial requests for the bean can be satisfied without generating a new instance. pool initial-context-factory true false weblogic.jndi.WLInitialContextFactory n/a message-driven-descriptor weblogic-ejb-jar.xml The initial-context-factory element specifies the initial contextFactory that the container will use to create its connection factories. If initial-context-factory is not specified, the default will be weblogic.jndi.WLInitialContextFactory. The following example specifies the initial-context-factory element. <message-driven-descriptor> <initial-context-factory>weblogic.jndi.WLInitialContextFactory </initial-context-factory> </message-driven-descriptor> invalidation-target The target ejb-name must be a Read-Only entity EJB and this element can only be specified for an EJB 2.0 container-managed persistence entity EJB. entity-descriptor weblogic-ejb-jar.xml The invalidation-target element specifies a Read-Only entity EJB that should be invalidated when this container-managed persistence entity EJB has been modified. The following entry specifies that the EJB named StockReaderEJB should be invalidated when the EJB has been modified. <invalidation-target> <ejb-name>StockReaderEJB</ejb-name> </invalidation-target> is-modified-method-name Valid entity EJB method name. None Optional element. Valid only for entity EJBs. persistence weblogic-ejb-jar.xml is-modified-method-name specifies amethod thatWebLogic Server calls when the EJB is stored. The specified method must return a boolean value. If no method is specified, WebLogic Server always assumes that the EJB has been modified and always saves it. Providing a method and setting it as appropriate can improve performance for EJB 1.1-compliant beans, and for beans that use bean-managed persistence. However, any errors in the method's return value can cause data inconsistency problems. Note: isModified() is no longer required for 2.0 CMP entity EJBs based on the EJB 2.0 specification. However, it still applies to BMP and 1.1 CMP EJBs. When you deploy EJB 2.0 entity beans with container-managed persistence, WebLogic Server automatically detects which EJB fields have been modified, and writes only those fields to the underlying datastore. The following entry specifies that the EJB method named semidivine will notify WebLogic Server when the EJB has been modified: <entity-descriptor> <persistence> <is-modified-method-name>semidivine</is-modified-method-name> </persistence> </entity-descriptor> isolation-level Serializable ReadCommitted ReadUncommitted RepeatableRead n/a Optional element. transaction-isolation weblogic-ejb-jar.xml isolation-level specifies the isolation level for all of the EJB's database operations. The following are possible values for isolation-level: - TRANSACTION_READ_UNCOMMITTED: The transaction can view uncommitted updates from other transactions. - TRANSACTION_READ_COMMITTED: The transaction can view only committed updates from other transactions. - TRANSACTION_REPEATABLE_READ: Once the transaction reads a subset of data, repeated reads of the same data return the same values, even if other transactions have subsequently modified the data. - TRANSACTION_SERIALIZABLE: Simultaneously executing this transaction multiple times has the same effect as executing the transaction multiple times in a serial fashion. Refer to your database documentation for more information on the implications and support for different isolation levels. transaction-isolation jms-polling-interval-seconds n/a 10 seconds n/a weblogic-enterprise-bean weblogic-ejb-jar.xml The jms-polling-interval-seconds specifies the number of seconds between each attempt to reconnect to the JMS destination. Each message-driven bean listens on an associated JMS destination. If the JMS destination is located on another WebLogic Server instance or a foreign JMS provider, then the JMS destination may become unreachable. In this case, the EJB container automatically attempts to reconnect to the JMS Server. Once the JMS Server is up again, the message-driven bean can again receive messages. The following entry specifies the jms polling intervals for message-driven beans: <jms-polling-interval-seconds>5</jms-polling-interval-seconds> jms-client-id n/a The default client identifier is the ejb-name for this EJB. The jms-client-id is necessary for durable subscriptions to JMS topics. message-driven-descriptor weblogic-ejb-jar.xml The jms-client-id specifies an associated id for the JMS consumers. A message-driven bean with a durable subscription needs an associated client id. If you use a separate connection factory, you can set the client id on the connection factory. In this case, the message-driven bean uses this client id. If the associated connection factory does not have a client id or if you use the default connection factory, then the message-driven bean used the jms-client-id value as its client id. The following entry specifies an associated id for JMS consumers: <jms-client-id>MyClientID</jms-client-id> mdb-client-id jboss.xml jndi-name Valid JNDI name n/a Required in resource-description and ejb-reference-description. resource-description ejb-reference-description weblogic-ejb-jar.xml jndi-name specifies the JNDI name of an actual EJB, resource, or reference available in WebLogic Server. resource-description ejb-reference-description jndi-name jboss.xml local-jndi-name Valid JNDI name n/a Required if the bean has a local home. weblogic-enterprise-bean weblogic-ejb-jar.xml The local-jndi-name element specifies a jndi-name for a bean's local home. If a bean has both a remote and a local home, then it must have two JNDI names; one for each home. The following example specifies the local-jndi-name element. <local-jndi-name>weblogic.jndi.WLInitialContext </local-jndi-name> local-jndi-name jboss.xml lifecycle XML stanza n/a Optional element. entity-descriptor stateful-session-descriptor weblogic-ejb-jar.xml The lifecycle element defines options that affect the lifecycle of stateful and entity EJB instances within WebLogic Server. Currently, the lifecycle element includes only one element: passivation-strategy. The following example shows the specifies the lifecycle element. <entity-descriptor> <lifecycle> <passivation-strategy>...</passivation-strategy> </lifecycle> </entity-descriptor> max-beans-in-cache 1 maxBeans 1000 Optional element. entity-cache stateful-session-cache weblogic-ejb-jar.xml The max-beans-in-cache element specifies the maximum number of objects of this class that are allowed in memory. When max-bean-in-cache is reached, WebLogic Server passivates some EJBs that have not recently been used by a client. max-beans-in-cache also affects when EJBs are removed from the WebLogic Server cache. The following entry enables WebLogic Server to cache a maximum of 200 instances of the AccountBean class: <weblogic-enterprise-bean> <ejb-name>AccountBean</ejb-name> <entity-descriptor> <entity-cache> <max-beans-in-cache>200</max-beans-in-cache> </entity-cache> </entity-descriptor> </weblogic-enterprise-bean> max-capacity jboss.xml max-beans-in-free-pool 0 maxBeans max int Optional element. stateless-session-descriptor message-driven-descriptor weblogic-ejb-jar.xml WebLogic Server maintains a free pool of EJBs for every stateless session bean and message-driven bean class. The max-beans-in-free-pool element defines the size of this pool. By default, max-beans-in-free-pool has no limit; the maximum number of beans in the free pool is limited only by the available memory. pool MaximumSize jboss.xml message-driven-descriptor XML stanza n/a weblogic-enterprise-bean weblogic-ejb-jar.xml The message-driven-descriptor element associates a message-driven bean with a JMS destination in WebLogic Server. This element specifies the following deployment parameters: - pool - destination-jndi-name - initial-context-factory - provider-url - connection-factory-jndi-name The following example shows the structure of the message-driven-descriptor stanza: <message-driven-descriptor> <destination-jndi-name>...</destination-jndi-name> </message-driven-descriptor> message-driven jboss.xml container-configuration jboss.xml method XML stanza n/a Optional element. You can specify more than one method stanza to configure multiple EJB methods. transaction-isolation idempotent-methods weblogic-ejb-jar.xml The method element defines a method or set of methods for an enterprise bean's home or remote interface. The method stanza can contain the elements shown here: <method> <description>...</description> <ejb-name>...</ejb-name> <method-intf>...</method-intf> <method-name>...</method-name> <method-params>...</method-params> </method> method-intf Home Remote n/a Optional element. method weblogic-ejb-jar.xml method-intf specifies the EJB interface to which WebLogic Server applies isolation level properties. Use this element only if you need to differentiate between methods having the same signature in the EJB's home and remote interface. method method-name Name of an EJB defined in ejb-jar.xml | * n/a Required element in method stanza. method weblogic-ejb-jar.xml method-name specifies the name of an individual EJB method to which WebLogic Server applies isolation level properties. Use the asterisk (*) to specify all methods in the EJB's home and remote interfaces. If you specify a method-name, the method must be available in the specified ejb-name. method method-param Fully qualified Java type of a method parameter n/a Required element in method-params. method-params weblogic-ejb-jar.xml The method-param element specifies the fully qualified Java type name of a method parameter. method-params method-params XML stanza n/a Optional element. method weblogic-ejb-jar.xml The method-params stanza contains one or more elements that define the Java type name of each of the method's parameters. The method-params stanza contains one or more method-param elements, as shown here: <method-params> <method-param>java.lang.String</method-param> ... </method-params> passivation-strategy default transaction default Optional element. Valid only for entity EJBs. lifecycle weblogic-ejb-jar.xml The passivation-strategy element determines whether or not WebLogic Server maintains the intermediate state of entity EJBs in its cache. The following entry reverts to WebLogic Server locking and caching behavior: <entity-descriptor> <lifecycle> <passivation-strategy>default</passivation-strategy> </lifecycle> </entity-descriptor> persistence XML stanza n/a Required only for entity EJBs that use container-managed persistence services. entity-descriptor weblogic-ejb-jar.xml The persistence element defines the following options that determine the persistence type, transaction commit behavior, and ejbLoad() and ejbStore() behavior for entity EJBs in WebLogic Server: - is-modified-method-name - delay-updates-until-end-of-tx - finders-load-bean - persistence-type - db-is-shared - persistence-use The following example specifies the persistence element. <entity-descriptor> <persistence> <is-modified-method-name>...</is-modified-method-name> <delay-updates-until-end-of-tx>...</delay-updates-until-end-of-tx> <finders-load-bean>...</finders-load-bean> <persistence-type>...</persistence-type> <db-is-shared>false</db-is-shared> <persistence-use>...</persistence-use> </persistence> </entity-descriptor> commit-option jboss.xml persistence-type XML stanza n/a Required only for entity EJBs that use container-managed persistence services. persistence weblogic-ejb-jar.xml The persistence-type element defines a persistence service that the entity EJB can use. You can define multiple persistence-type stanzas in weblogic-ejb-jar.xml for testing your EJB with multiple persistence services. Only the persistence type defined in persistence-use is actually used during deployment. persistence-type includes several elements that identify the persistence types: - type-identifier - type-version - type-storage The following excerpt shows a sample persistence-type stanza: <persistence> <persistence-type> <type-identifier>WebLogic_CMP_RDBMS</type-identifier> <type-version>5.1.0</type-version> <type-storage>META-INF\weblogic-cmp-rdbms-jar.xml</type-storage> </persistence-type> </persistence> persistence-use XML stanza n/a Required only for entity EJBs that use container-managed persistence services. persistence weblogic-ejb-jar.xml The persistence-use element is similar to persistence-type, but it defines the persistence service actually used during deployment. persistence-use uses the type-identifier and type-version elements defined in a persistence-type to identify the service. To deploy an EJB using the WebLogic Server RDBMS-based persistence service defined in persistence-type, use the following persistence-use stanza: <persistence-use> <type-identifier>WebLogic_CMP_RDBMS</type-identifier> <type-version>5.1.0</type-version> </persistence-use> persistence-store-dir Fully qualified filesystem path n/a Optional element. stateful-session-descriptor weblogic-ejb-jar.xml The persistent-store-dir element specifies a file system directory where WebLogic Server stores the state of passivated stateful session bean instances. stateful-session-descriptor pool XML stanza n/a Optional element. stateless-session-descriptor message-driven-descriptor entity-descriptor weblogic-ejb-jar.xml The pool element configures the behavior of the WebLogic Server free pool for stateless session and message-driven EJBs. The options are: - max-beans-in-free-pool - initial-beans-in-free-pool The pool stanza can contain the elements shown here: <stateless-session-descriptor> <pool> <max-beans-in-free-pool>500</max-beans-in-free-pool> <initial-beans-in-free-pool>250</initial-beans-in-free-pool> </pool> </stateless-session-descriptor> principal-name Valid WebLogic Server principal name n/a At least one principal-name is required in the security-role-assignment stanza. You may define more than one principal-name for each role-name. security-role-assignment weblogic-ejb-jar.xml principal-name specifies the name of an actual WebLogic Server principal to apply to the specified role-name. security-role-assignment provider-url Valid name n/a Used in conjunction with initial-context-factory and connection-factory-jndi-name. message-driven-descriptor weblogic-ejb-jar.xml The provider-url element specifies the URL provider to be used by the InitialContext. Typically, this is the host : port and used in conjunction with initial-context-factory and connection-factory-jndi-name. The following example specifies the provider-url element. <message-driven-descriptor> <provider-url>WeblogicURL:Port</provider-url> </message-driven-descriptor> read-timeout-seconds 0 maxSeconds 600 Optional element. Valid only for entity EJBs. entity-cache weblogic-ejb-jar.xml The read-timeout-seconds element specifies the number of seconds between ejbLoad() calls on a Read-Only entity bean. By default, read-timeout-seconds is set to 600, and WebLogic Server calls ejbLoad() only when the bean is brought into the cache. The following entry causes WebLogic Server to call ejbLoad() for instances of the AccountBean class only when the instance is first brought into the cache: <weblogic-enterprise-bean> <ejb-name>AccountBean</ejb-name> <entity-descriptor> <entity-cache> <read-timeout-seconds>0</read-timeout-seconds> </entity-cache> </entity-descriptor> </weblogic-enterprise-bean> commit-option jboss.xml optiond-refresh-rate jboss.xml reference-descriptor XML stanza n/a Optional element. weblogic-enterprise-bean weblogic-ejb-jar.xml The reference-descriptor element maps references in the ejb-jar.xml file to the JNDI names of actual resource factories and EJBs available in WebLogic Server. The reference-descriptor stanza contains one or more additional stanzas to define resource factory references and EJB references. The following shows the organization of these elements: <reference-descriptor> <resource-description> ... </resource-description> <ejb-reference-description> ... </ejb-reference-description> </reference-descriptor> ejb-ref jboss.xml resource-ref jboss.xml resource-env-ref jboss.xml relationship-descriptor weblogic-ejb-jar.xml Is no longer supported. replication-type InMemory None None Optional element. Valid only for stateful session EJBs in a cluster. weblogic-enterprise-bean weblogic-ejb-jar.xml The replication-type element determines whether WebLogic Server replicates the state of stateful session EJBs across WebLogic Server instances in a cluster. If you select InMemory, the state of the EJB is replicated. If you select None, the state is not replicated. stateful-session-clustering res-env-ref-name A valid resource environment reference name from the ejb-jar.xml file n/a A valid resource environment reference name from the ejb-jar.xml file resource-env-description weblogic-ejb-jar.xml The res-env-ref-name element specifies the name of a resource environment reference. resource-description resource-env-ref-name jboss.xml res-ref-name A valid resource reference name from the ejb-jar.xml file n/a Required element if the EJB specifies resource references in ejb-jar.xml resource-description weblogic-ejb-jar.xml The res-ref-name element specifies the name of a resource factory reference. This is the reference that the EJB provider places within the ejb-jar.xml deployment file. resource-description res-ref-name jboss.xml resource-description XML stanza n/a Optional element. reference-descriptor weblogic-ejb-jar.xml The resource-description element maps a resource reference defined in ejb-jar.xml to the JNDI name of an actual resource available in WebLogic Server. The resource-description stanza can contain additional elements as shown here: <reference-descriptor> <resource-description> <res-ref-name>. . .</res-ref-name> <jndi-name>...</jndi-name> </resource-description> <ejb-reference-description> <ejb-ref-name>. . .</ejb-ref-name> <jndi-name>. . .</jndi-name> </ejb-reference-description> </reference-descriptor> resource-ref jboss.xml resource-env-description XML stanza n/a Optional element. reference-descriptor weblogic-ejb-jar.xml The resource-env-description element maps a resource environment reference defined in ejb-jar.xml to the JNDI name of an actual resource available in WebLogic Server. The resource-env-description stanza can contain additional elements as shown here: <reference-descriptor> <resource-env-description> <res-env-ref-name>. . .</res-env-ref-name> <jndi-name>...</jndi-name> </reference-env-description> </reference-descriptor> resource-env-ref jboss.xml role-name An EJB role name defined in ejb-jar.xml n/a Required element in security-role-assignment. security-role-assignment weblogic-ejb-jar.xml The role-name element identifies an application role name that the EJB provider placed in the ejb-jar.xml deployment file. Subsequent principal-name elements in the stanza map WebLogic Server principals to the specified role-name. security-role-assignment run-as-identity-principal Principal that will be used as the identity as defined in ejb-jar.xml n/a Required element in security-role-assignment. weblogic-enterprise-bean weblogic-ejb-jar.xml The run-as-identity-principal element specifies the principal to be used as the identity for beans that have a security-identity. run-as-specified-identity set in the ejb-jar.xml. The principal named in this element must be one of the principals mapped to the run-as-specified-identity role. The run-as-identity-principal stanza can contain additional elements as shown here: <weblogic-ejb-jar> <weblogic-enterprise-bean> <run-as-identity-principal>Fred</run-as-identity-principal> </weblogic-enterprise-bean> </weblogic-ejb-jar> 7.0 security-permission XML stanza n/a n/a weblogic-ejb-jar weblogic-ejb-jar.xml The security-permission element specifies a security permission The security-permission stanza can contain one or more of the following elements: <security-permission> </security-permission> 7.0 security-permission-spec XML stanza n/a n/a security-permission weblogic-ejb-jar.xml The security-permission-spec element specifies a single security permission based on the Security policy file syntax. The security-permission-spec stanza can contain one or more of the following elements: <security-permission> <security-permission-spec>grant</security-permission-spec> </security-permission> security-role-assignment XML stanza n/a Required element if ejb-jar.xml defines application roles. weblogic-ejb-jar weblogic-ejb-jar.xml The security-role-assignment element maps application roles in the ejb-jar.xml file to the names of security principals available in WebLogic Server. The security-role-assignment stanza can contain one or more of the following elements: <security-role-assignment> <role-name>PayrollAdmin</role-name> <principal-name>Tanya</principal-name> <principal-name>system</principal-name> ... </security-role-assignment> stateful-session-cache XML stanza n/a The stateful-session-cache stanza is optional, and is valid only for stateful session EJBs. stateful-session-descriptor weblogic-ejb-jar.xml The stateful-session-cache element defines the following options used to cache stateful session EJB instances within WebLogic Server. - max-beans-in-cache - idle-timeout-seconds - cache-type The following example shows how to specify the stateful-session-cache element <stateful-session-cache> <max-beans-in-cache>...</max-beans-in-cache> <idle-timeout-seconds>...</idle-timeout-seconds> <read-timeout-seconds>...<read-timeout-seconds> </stateful-session-cache> max-capacity jboss.xml max-bean-age jboss.xml stateful-session-clustering XML stanza n/a Optional element. Valid only for stateful session EJBs in a cluster. stateful-session-descriptor weblogic-ejb-jar.xml The stateful-session-clustering stanza element specifies the following options that determine how WebLogic Server replicates stateful session EJB instances in a cluster: - home-is-clusterable - home-load-algorithm - home-call-router-class-name - replication-type The following excerpt shows the structure of a entity-clustering stanza: <stateful-session-clustering> <home-is-clusterable>true</home-is-clusterable> <home-load-algorithm>random</home-load-algorithm> <home-call-router-class-name>beanRouter</home-call-router-class-name> <replication-type>InMemory</replication-type> </stateful-session-clustering> container-configuration jboss.xml stateful-session-descriptor XML stanza n/a One stateful-session-descriptor stanza is required for each stateful session EJB in the .jar. weblogic-enterprise-bean weblogic-ejb-jar.xml The stateful-session-descriptor element specifies the following deployment parameters that are applicable for stateful session EJBs in WebLogic Server: - stateful-session-cache - persistent-store-dir - stateful-session-clustering - allow-concurrent-calls The following example shows the structure of the stateful-session-descriptor stanza: <stateful-session-descriptor> <stateful-session-cache>...</stateful-session-cache> <persistence>...</persistence> <allow-concurrent-calls>...</allow-concurrent-calls> <persistent-store-dir>/weblogic/myserver</persistent-store-dir> <stateful-session-clustering>...</stateful-session-clustering> </stateful-session-descriptor> session jboss.xml container-configuration jboss.xml stateless-bean-call-router-class-name Valid router class name n/a Optional element. Valid only for stateless session EJBs in a cluster. stateless-clustering weblogic-ejb-jar.xml The stateless-bean-call-router-class-name element specifies the name of a custom class to use for routing bean method calls. This class must implement weblogic.rmi.extensions.CallRouter(). If specified, an instance of this class is called before each method call. The router class has the opportunity to choose a server to route to based on the method parameters. The class returns either a server name or null, which indicates that the current load algorithm should select the server. stateless-clustering stateless-bean-is-clusterable true false true Optional element. Valid only for stateless session EJBs in a cluster. stateless-clustering weblogic-ejb-jar.xml When stateless-bean-is-clusterable is true, the EJB can be deployed from multiple WebLogic Servers in a cluster. Calls to the home stub are load-balanced between the servers on which this bean is deployed, and if a server hosting the bean is unreachable, the call automatically fails over to another server hosting the bean. stateless-clustering stateless-bean-load-algorithm round-robin random weight-based Value of weblogic.cluster.defaultLoadAlgorithm Optional element. Valid only for stateless session EJBs in a cluster. stateless-clustering weblogic-ejb-jar.xml stateless-bean-load-algorithm specifies the algorithm to use for load balancing between replicas of the EJB home. If this property is not defined, WebLogic Server uses the algorithm specified by the server property weblogic.cluster.defaultLoadAlgorithm. You can define stateless-bean-load-algorithm as one of the following values: - round-robin: Load balancing is performed in a sequential fashion among the servers hosting the bean. - random: Replicas of the EJB home are deployed randomly among the servers hosting the bean. - weight-based: Replicas of the EJB home are deployed on host servers according to the servers' current workload. stateless-clustering stateless-bean-methods-are-idempotent true false false Optional element. Valid only for stateless session EJBs in a cluster. stateless-clustering weblogic-ejb-jar.xml You can set this element to either true or false. Set stateless-bean-methods-are-idempotent to "true" only if the bean is written such that repeated calls to the same method with the same arguments has exactly the same effect as a single call. This allows the failover handler to retry a failed call without knowing whether the call actually completed on the failed server. Setting this property to true makes it possible for the bean stub to recover automatically from any failure as long as another server hosting the bean can be reached. stateless-clustering stateless-clustering XML stanza n/a Optional element. Valid only for stateless session EJBs in a cluster. stateless-session-descriptor weblogic-ejb-jar.xml The stateless-clustering element specifies the following options that determine how WebLogic Server replicates stateless session EJB instances in a cluster: - stateless-bean-is-clusterable - stateless-bean-load-algorithm - stateless-bean-call-router-class-name - stateless-bean-methods-are-idempotent The following excerpt shows the structure of a stateless-clustering: <stateless-clustering> <stateless-bean-is-clusterable>true</stateless-bean-is-clusterable> <stateless-bean-load-algorithm>random</stateless-bean-load-algorithm> <stateless-bean-call-router-class-name>beanRouter</stateless-bean-call-router-class-name> <stateless-bean-methods-are-idempotent>true</stateless-bean-methods-are-idempotent> </stateless-clustering> clustered jboss.xml stateless-session-descriptor XML stanza n/a One stateless-session-descriptor element is required for each stateless session EJB in the JAR file. weblogic-enterprise-bean weblogic-ejb-jar.xml The stateless-session-descriptor element defines deployment parameters, such as caching, clustering, and persistence for stateless session EJBs in WebLogic Server. The following example shows the structure of the stateless-session-descriptor stanza: <stateless-session-descriptor> <pool>...</pool> <stateless-clustering>...</stateless-clustering> </stateless-session-descriptor> session jboss.xml container-configuration jboss.xml transaction-descriptor XML stanza n/a Optional element. weblogic-enterprise-bean weblogic-ejb-jar.xml The transaction-descriptor element specifies options that define transaction behavior in WebLogic Server. Currently, this stanza includes only one element: trans-timeout-seconds. The following example shows the structure of the transaction-descriptor stanza: <transaction-descriptor> <trans-timeout-seconds>20</trans-timeout-seconds> <transaction-descriptor> transaction-isolation XML stanza n/a Optional element. weblogic-ejb-jar weblogic-ejb-jar.xml The transaction-isolation element defines method-level transaction isolation settings for an EJB. The transaction-isolation stanza can contain the elements shown here: <transaction-isolation> <isolation-level>Serializable</isolation-level> <method> <description>...</description> <ejb-name>...</ejb-name> <method-intf>...</method-intf> <method-name>...</method-name> <method-params>...</method-params> </method> </transaction-isolation> transport-requirements XML stanza n/a n/a iiop-security-descriptor weblogic-ejb-jar.xml The transport-requirements element provides the transport requirements for the EJB. The transport-requirements stanza can contain the elements shown here: <iiop-security-descriptor> <transport-requirements> <confidentiality>supported</confidentiality> <integrity>supported</integrity> <client-cert-authorization>suppoted</client-cert-authentication> </transport-requirements> </iiop-security-description> trans-timeout-seconds 0 max 30 Optional element. Valid for any type of EJB. transaction-descriptor weblogic-ejb-jar.xml The trans-timeout-seconds element specifies the maximum duration for an EJB's container-initiated transactions. If a transaction lasts longer than trans-timeout-seconds, WebLogic Server rolls back the transaction. transaction-descriptor type-identifier Valid string n/a Required only for entity EJBs that use container-managed persistence services. persistence-type persistence-use weblogic-ejb-jar.xml The type-identifier element contains text that identifies an entity EJB persistence type. WebLogic Server RDBMS-based persistence uses the identifier, WebLogic_CMP_RDBMS. If you use a different persistence vendor, consult the vendor's documentation for information on the correct type-identifier. persistence-type type-storage Valid string n/a Required only for entity EJBs that use container-managed persistence services. persistence-type weblogic-ejb-jar.xml The type-storage element defines the full path of the file that stores data for this persistence type. The path must specify the file's location relative to the top level of the EJB's JAR deployment file or deployment directory. WebLogic Server RDBMS-based persistence generally uses an XML file named weblogic-cmp-rdbms-jar.xml to store persistence data for a bean. This file is stored in the META-INF subdirectory of the JAR file. persistence-type type-version Valid string n/a Required only for entity EJBs that use container-managed persistence services. persistence-type persistence-use weblogic-ejb-jar.xml The type-version element identifies the version of the specified persistence type. Note: If you use WebLogic Server RDBMS-based persistence, the specified version must exactly match the RDBMS persistence version for the WebLogic Server release. Specifying an incorrect version results in the error: weblogic.ejb.persistence.PersistenceSetupException: Error initializing the CMP Persistence Type for your bean: No installed Persistence Type matches the signature of (identifier 'Weblogic_CMP_RDBMS', version 'version_number'). persistence-type weblogic-ejb-jar weblogic-ejb-jar.xml weblogic-ejb-jar is the root element of the weblogic component of the EJB deployment descriptor. weblogic-enterprise-bean weblogic-ejb-jar weblogic-ejb-jar.xml Contains deployment information for a bean. entity jboss.xml session jboss.xml message-driven jboss.xml