Programming WebLogic Enterprise JavaBeans

weblogic-ejb-jar.xml Deployment Descriptor Reference

The following sections describe the elements in the WebLogic-specific deployment descriptor, weblogic-ejb-jar.xml. In this release of WebLogic Server, weblogic-ejb-jar.xml is XML Schema-based (XSD). In prior releases, weblogic-ejb-jar.xml was Document Type Definition-based (DTD). For backward compatibility, this release of WebLogic Server supports XSD- or DTD-based EJB descriptors. In this release of WebLogic Server, the EJB container still supports all older DTD-based descriptors; you can deploy applications that use DTD-based descriptors in this release of WebLogic Server without modifying the descriptors.

For information on:

2.1 weblogic-ejb-jar.xml File Structure

The WebLogic Server weblogic-ejb-jar.xml deployment descriptor file describes the elements that are unique to WebLogic Server.

The top level elements in the WebLogic Server weblogic-ejb-jar.xml are as follows:

2.1 weblogic-ejb-jar.xml Elements

The following list of the elements in weblogic-ejb-jar.xml includes all elements that are supported in this release of WebLogic Server.

allow-concurrent-calls

Function

Specifies whether a stateful session bean instance allows concurrent method calls. By default, allows-concurrent-calls is False, in accordance with the EJB specification, and WebLogic Server will throw a RemoteException when a stateful session bean instance is currently handling a method call and another (concurrent) method call arrives on the server.

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.

Example

See stateful-session-descriptor .

allow-remove-during-transaction

Function

Specifies that the remove method on a stateful session bean can be invoked within a transaction context.

Example

See stateful-session-descriptor .

cache-between-transactions

Function

Formerly the db-is-shared element, specifies whether the EJB container will cache the persistent data of an entity bean across (between) transactions.

Specify True to enable the EJB container to perform long term caching of the data. Specify False to enable the EJB container to perform short term caching of the data.

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.

See Limiting Database Reads with cache-between-transactions (Long-Term Caching) for more information.

Example

See persistence.

cache-type

Function

Specifies the order in which EJBs are removed from the cache. The values are:

Example

<stateful-session-cache>
     <cache-type>NRU</cache-type>
</stateful-session-cache>

client-authentication

Function

Specifies whether the EJB supports or requires client authentication.

Example

See iiop-security-descriptor.

client-cert-authentication

Function

Specifies whether the EJB supports or requires client certificate authentication at the transport level.

Example

See transport-requirements.

clients-on-same-server

Function

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.

See Optimization for Collocated Objects in Using WebLogic Server Clusters for more information on collocated EJBs.

Example

<weblogic-enterprise-bean>
	<ejb-name>AccountBean</ejb-name>
	...
	<clients-on-same-server>True</clients-on-same-server>
</weblogic-enterprise-bean>

concurrency-strategy

Function

Specifies how the container should manage concurrent access to an entity bean. Set this element to one of four values:

See Choosing a Concurrency Strategy for more information on the Exclusive and Database locking behaviors. See Read-Write versus Read-Only Entity Beans for more information about read-only entity EJBs.

Example

<weblogic-enterprise-bean>
	<ejb-name>AccountBean</ejb-name>
	<entity-descriptor>
		<entity-cache>
			<concurrency-strategy>ReadOnly</concurrency-strategy>
		</entity-cache>
	</entity-descriptor>
</weblogic-enterprise-bean>

confidentiality

Function

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.

Example

See transport-requirements.

connection-factory-jndi-name

Function

Specifies the JNDI name of the JMS Connection Factory that a message-driven EJB looks up to create its queues and topics. See Configuring MDBs for Destinations and How to Set connection-factory-jndi-name.

Example

<message-driven-descriptor>
     <connection-factory-jndi-name>
     java:comp/env/jms/MyConnectionFactory
     </connection-factory-jndi-name>
</message-driven-descriptor>

connection-factory-resource-link

Function

Maps to a resource within a JMS module defined in ejb-jar.xml to an actual JMS Module Reference in WebLogic Server.

create-as-principal-name

Function

Introduced in WebLogic Server 8.1 SP01, specifies the principal to be used in situations where ejbCreate would otherwise run with an anonymous principal. Under such conditions, the choice of which principal to run as is governed by the following rule:

if create-as-principal-name is set
then use that principal
else
     If a run-as role has been specified for the bean in ejb-jar.xml
     then use a principal according to the rules for setting the run-as-role-assignment
     else
           run ejbCreate as an anonymous principal.

The create-as-principal-name element only needs to be specified if operations within ejbCreate require more permissions than the anonymous principal would have.

This element effects the ejbCreate methods of stateless session beans and message-driven beans.

See also remove-as-principal-name, passivate-as-principal-name, and principal-name.

delay-updates-until-end-of-tx

Function

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 TransactionReadUncommitted, you may want to allow other database users to view the intermediate results of in-progress transactions. In this case, set delay-updates-to-end-of-tx to False to update the bean's persistent store at the conclusion of each method invoke. See Understanding ejbLoad() and ejbStore() Behavior for more information.

Example

<entity-descriptor>
     <persistence>
     ...
     ...
     <delay-updates-until-end-of-tx>False</delay-updates-until-end-of-tx>
     </persistence>
</entity-descriptor>

description

Function

Describes the parent element.

Example

<description>Contains a description of parent element</description>

destination-jndi-name

Function

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.

Example

See message-destination-descriptor and message-driven-descriptor.

destination-resource-link

Function

Maps to a resource within a JMS module defined in ejb-jar.xml to an actual JMS Module Reference in WebLogic Server.

disable-warning

Function

Specifies that WebLogic Server should disable the warning message whose ID is specified. Set this element to one of four values:

Example

To disable the warning message: “Call-by-reference not enabled”, set <disable-warning>, as shown below.

<disable-warning>BEA-010202</disable-warning>

dispatch-policy

Function

Designates which server execute thread pool the EJB should run in. Dispatch polices are supported for all types of beans, including entity, session, and message-driven.

If no dispatch-policy is specified, or the specified dispatch-policy refers to a nonexistent server execute thread pool, then the server's default execute thread pool is used instead.

WebLogic Server ignores dispatch-policy if the host server instance does not have an execute thread queue bearing a corresponding name.

If a message-driven bean (MDB) is driven by a foreign (non-WebLogic) destination source, WebLogic Server might ignore dispatch-policy, as the MDB may instead run in the foreign provider's threading mechanism. For example, for the IBM WebSphere MQSeries messaging software, dispatch-policy is not honored for non-transactional queues; instead the application code runs in an MQSeries thread. For MQSeries transactional queues, and both non-transactional and transactional topics, dispatch-policy is honored.

The maximum number of concurrently running MDB instances is designated by a combination of max-beans-in-free-pool and dispatch-policy values. See MDB Thread Management in WebLogic Server Performance and Tuning.

Example

<dispatch-policy>queue_name</dispatch-policy>

durable-subscription-deletion

Function

This element, which was introduced in WebLogic Server 9.0, indicates whether you want durable topic subscriptions to be automatically deleted when an MDB is undeployed or removed.

Example

<durable-subscription-deletion>True</durable-subscription-deletion>

ejb-local-reference-description

Function

Maps the JNDI name of an EJB in the WebLogic Server instance that is referenced by the bean in the ejb-local-ref element.

Example

<ejb-local-reference-description>
	<ejb-ref-name>AdminBean</ejb-ref-name>
	<jndi-name>payroll.AdminBean</jndi-name>
</ejb-local-reference-description>

ejb-name

Function

Specifies an enterprise bean's name, using the same name for the bean that is specified in ejb-jar.xml. 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 architected relationship between the ejb-name in the deployment descriptor and the JNDI name that the Deployer will assign to the enterprise bean's home.

Example

See method.

ejb-reference-description

Function

Maps the JNDI name of an EJB in WebLogic Server to the name by which it is specified in the ejb-ref-name element in ejb-jar.xml.

Example

<ejb-reference-description>
	<ejb-ref-name>AdminBean</ejb-ref-name>
	<jndi-name>payroll.AdminBean</jndi-name>
</ejb-reference-description>

ejb-ref-name

Function

Specifies a resource reference name. This element is the reference that the EJB provider places within the ejb-jar.xml deployment file.

Example

<ejb-reference-description>
	<ejb-ref-name>AdminBean</ejb-ref-name>
	<jndi-name>payroll.AdminBean</jndi-name>
</ejb-reference-description>

enable-bean-class-redeploy

Function

By default, the EJB implementation class is loaded in the same classloader as the rest of the EJB classes. When the enable-bean-class-redeploy element is enabled, the implementation class, along with its super classes, gets loaded in a child classloader of the EJB module classloader. This allows the EJB implementation class to be redeployed without redeploying the entire EJB module.

There are some potential problems with loading the bean class in a child classloader. First, the bean class will no longer be visible to any classes loaded in the parent classloader, so those classes cannot refer to the bean class or errors will occur. Also, the bean class will not be able to invoke any package protected methods on any classes loaded in a different classloader. So, if your bean class invokes a helper class in the same package, the helper class methods must be declared public or IllegalAccessErrors will result.

Example

The following XML element enables redeployment of an individual bean class:

<enable-bean-class-redeploy>True</enable-bean-class-redeploy>

enable-call-by-reference

Function

When enable-call-by-reference is False, parameters to the EJB methods are copied—or passed by value—regardless of whether the EJB is called remotely or from within the same EAR.

When enable-call-by-reference is True, EJB methods called from within the same EAR file or standalone JAR file will pass arguments by reference. This improves the performance of method invocation since parameters are not copied.

Example

<weblogic-enterprise-bean>
     <entity-descriptor>
          <ejb-name>AccountBean</ejb-name>
          ...
          <enable-call-by-reference>False</enable-call-by-reference>
     </entity-descriptor>
</weblogic-enterprise-bean>

enable-dynamic-queries

Function

Set to True to enable dynamic queries. Dynamic queries are only available for use with EJB 2.x CMP beans.

Example

<enable-dynamic-queries>True</enable-dynamic-queries>

entity-always-uses-transaction

Function

This element, introduced in WebLogic Server 9.0, allows you to specify whether an entity bean must always use a transaction. Before WebLogic Server 9.0, when an entity bean ran in an unspecified transaction, the EJB container would create a transaction for the entity bean. Now, the EJB container no longer creates a transaction when an entity bean runs in an unspecified transaction. To disable this behavior and cause the EJB container to create a transaction for entity beans that run in unspecified transaction, set the value of this element to True.

entity-cache

Function

Defines the following options used to cache entity EJB instances within WebLogic Server:

See Understanding Entity Caching for more information.

Example

<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>

entity-cache-name

Function

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. 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

For more information about the weblogic-application.xml file, see “Enterprise Application Deployment Descriptor Elements” in Developing Applications with WebLogic Server.

Example

See entity-cache-ref.

entity-cache-ref

Function

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 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. A MultiVersion cache supports the Database, ReadOnly, and Optimistic concurrency strategies.

Example

<entity-cache-ref>
	<entity-cache-name>AllEntityCache</entity-cache-name>
	<read-timeout-seconds>600</read-timeout-seconds>
	<cache-between-transactions>true</cache-between-transactions>
	<concurrency-strategy>ReadOnly</concurrency-strategy>
	<estimated-bean-size>20</estimated-bean-size>
</entity-cache-ref>

entity-clustering

Function

Specifies how an entity bean will be replicated in a WebLogic cluster:

Example

<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>
	<use-serverside-stubs>True</use-serverside-stubs>
</entity-clustering>

entity-descriptor

Function

Specifies the following deployment parameters that are applicable to an entity bean:

Example

<entity-descriptor>
	<entity-cache>...</entity-cache>
	<persistence>...</persistence>
	<entity-clustering>...</entity-clustering>
	<invalidation-target>...</invalidation-target>
	<enable-dynamic-queries>...</enable-dynamic-queries>
</entity-descriptor>

estimated-bean-size

Function

Specifies the estimated average size of the instances of an entity bean in bytes. This is the average number of bytes 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.

Example

See entity-cache-ref.

externally-defined

Function

Indicates that a particular security role is defined externally in a security realm, outside of the deployment descriptor. Because the security role and its principal-name mapping is defined elsewhere, principal-names are not to be specified in the deployment descriptor. This tag is used as an indicative placeholder instead of a set of principal-name elements. Use this element instead of global-role, which has been deprecated and was removed from WebLogic Server in release 9.0.

finders-load-bean

Function

Valid only for CMP entity EJBs. 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.

Example

<entity-descriptor>
	<persistence>
		<finders-load-bean>True</finders-load-bean>
	</persistence>
</entity-descriptor>

generate-unique-jms-client-id

Function

Indicates whether or not you want the EJB container to generate a unique client-id for every instance of an MDB which makes is easier to deploy durable MDBs to multiple server instances in a WebLogic Server cluster.

global-role

The global-role element is deprecated and was removed from WebLogic Server in release 9.0. Use the externally-defined element instead.

home-call-router-class-name

Function

Specifies the name of a custom class to use for routing bean method calls. This class must implement weblogic.rmi.cluster.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.

Example

See entity-clustering and stateful-session-clustering.

home-is-clusterable

Function

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.

Example

See entity-clustering.

home-load-algorithm

Function

Specifies the algorithm to use for load balancing between replicas of the EJB home in a cluster. 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:

For more information, see “Load Balancing for EJBs and RMI Objects” in Using WebLogic Server Clusters.

Example

See entity-clustering and stateful-session-clustering.

idempotent-methods

Function

Defines list of methods of a clustered EJB 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.

Clustering must be enabled for the EJB. To enable clustering, see entity-clustering, stateful-session-clustering, and stateless-clustering.

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.

Example

<idempotent-method>
	<method>
		<description>...</description>
		<ejb-name>...</ejb-name>
		<method-intf>...</method-intf>
		<method-name>...</method-name>
		<method-params>...</method-params>
	</method>
</idempotent-method>

identity-assertion

Function

Specifies whether the EJB supports or requires identity assertion.

Example

See iiop-security-descriptor.

idle-timeout-seconds

Function

Defines the maximum length of time an 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. See Caching and Passivating Stateful Session EJBs and Managing Entity Bean Pooling and Caching for more information.

Also defines the maximum length of time an EJB should remain idle in the free pool before it is removed. After this time has elapsed, WebLogic Server removes the bean instance from the free pool so long as doing so will not cause the number of beans in the pool to fall below the number specified in initial-beans-in-free-pool.

Example

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>

iiop-security-descriptor

Function

Specifies security configuration parameters at the bean level. These parameters determine the IIOP security information contained in the IOR.

Example

<iiop-security-descriptor>
	<transport-requirements>...</transport-requirements>
	<client-authentication>supported<client-authentication>
	<identity-assertion>supported</identity-assertion>
</iiop-security-descriptor>

init-suspend-seconds

Function

Specifies the initial number of seconds to suspend an MDB’s JMS connection when the EJB container detects a JMS resource outage. For more information, see Configuring Suspension of Message Delivery During JMS Resource Outages.

initial-beans-in-free-pool

Function

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.

Example

See pool.

initial-context-factory

Function

Specifies the initial context factory used by the JMS provider to create initial context. See Configuring MDBs for Destinations and How to Set initial-context-factory.

Example

<message-driven-descriptor>
    <initial-context-factory>fiorano.jms.rtl.FioranoInitialContextFactory
    </initial-context-factory>
</message-driven-descriptor>

See also message-destination-descriptor.

integrity

Function

Specifies the transport integrity requirements for the EJB. Using the integrity element ensures that the data is sent between the client and server in such a way that it cannot be changed in transit.

Example

See transport-requirements.

invalidation-target

Function

Specifies a Read-Only entity EJB that should be invalidated when this container-managed persistence entity EJB has been modified.

The target ejb-name must be a Read-Only entity EJB and this element can only be specified for an EJB 2.x container-managed persistence entity EJB.

Example

<invalidation-target>
	<ejb-name>StockReaderEJB</ejb-name>
</invalidation-target>

is-modified-method-name

Function

Specifies a method that WebLogic 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.

Example

<entity-descriptor>
	<persistence>
	<is-modified-method-name>semidivine</is-modified-method-name>
	</persistence>
</entity-descriptor>

isolation-level

Function

Defines method-level transaction isolation settings for an EJB. Allowable values include:

Oracle-Only Isolation Levels

These addition values are supported only for Oracle databases, and only for container-managed persistence (CMP) EJBs:

Refer to your database documentation for more information on support for different isolation levels.

Example

See transaction-isolation.

jms-client-id

Function

Specifies a client ID for the MDB when it connects to a JMS destination. Required for durable subscriptions to JMS topics.

If you specify the connection factory that the MDB uses in connection-factory-jndi-name, the client ID can be defined in the ClientID element of the associated JMSConnectionFactory element in config.xml.

If JMSConnectionFactory in config.xml does not specify a ClientID, or if you use the default connection factory, (you do not specify connection-factory-jndi-name) the message-driven bean uses the jms-client-id value as its client id.

Example

<jms-client-id>MyClientID</jms-client-id>

jms-polling-interval-seconds

Function

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.

Example

<jms-polling-interval-seconds>5</jms-polling-interval-seconds>

jndi-name

Function

Specifies the JNDI name of an actual EJB, resource, or reference available in WebLogic Server.

Example

See resource-description and ejb-reference-description.

local-jndi-name

Function

JNDI name for a bean’s local home. If a bean has both a remote and a local home, then it can be assigned two JNDI names; one for each home.

Example

<local-jndi-name>weblogic.jndi.WLInitialContext
</local-jndi-name>

max-beans-in-cache

Function

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, as described in Caching and Passivating Stateful Session EJBs.

Example

<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-messages-in-transaction

Function

Specifies the maximum number of messages that can be in a transaction for this MDB.

max-beans-in-free-pool

Function

WebLogic Server maintains a free pool of EJBs for every entity bean, stateless session bean, and message-driven bean class. The max-beans-in-free-pool element defines the size of this pool.

Example

See pool.

max-queries-in-cache

Function

This element, introduced in WebLogic Server 9.0, specifies the maximum number of read-only entity queries to cache at the bean level. For information on caching read-only entity queries at the application level, see

max-suspend-seconds

Function

Specifies the maximum number of seconds to suspend an MDB’s JMS connection when the EJB container detects a JMS resource outage. To disable JMS connection suspension when the EJB container detects a JMS resource outage, set the value of this element to 0. For more information, see Configuring Suspension of Message Delivery During JMS Resource Outages.

message-destination-descriptor

Function

Maps a message destination reference in the ejb-jar.xml file to an actual message destination, such as a JMS Queue or Topic, in WebLogic Server.

Example

<message-destination-descriptor>
   <message-destination-name>...</message-destination-name>

   <destination-jndi-name>...</destination-jndi-name>

   <resource-link>...</resource-link>

   <initial-context-factory>...</initial-context-factory>

   <provider-url>...</provider-url>
</message-destination-descriptor>

message-destination-name

Function

Specifies the name of a message destination reference. This is the reference that the EJB provider places within the ejb-jar.xml deployment file.

Example

See message-destination-descriptor.

message-driven-descriptor

Function

Associates a message-driven bean with a JMS destination in WebLogic Server.

Example

<message-driven-descriptor>
   <pool>...</pool>
   <destination-jndi-name>...</destination-jndi-name>
   <initial-context-factory>...</initial-context-factory>
   <provider-url>...</provider-url>
   <connection-factory-jndi-name>...</connection-factory-jndi-name>
   <jms-polling-interval-seconds>...</jms-polling-interval-seconds>
   <jms-client-id>...</jms-client-id>
   <generate-unique-jms-client-id>...</generate-unique-jms-client-id>
   <durable-subscription-deletion>...</durable-subscription-deletion>
   <max-messages-in-transaction>...</max-messages-in-transaction>
</message-driven-descriptor>

method

Function

Defines a method or set of methods for an enterprise bean’s home or remote interface.

Example

<method>
	<description>...</description>
	<ejb-name>...</ejb-name>
	<method-intf>...</method-intf>
	<method-name>...</method-name>
	<method-params>...</method-params>
</method>

method-intf

Function

Specifies the EJB interface to which WebLogic Server applies isolation level properties, if the method has the same signature in multiple interfaces.

Example

See method.

method-name

Function

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.

Example

See method.

method-param

Function

Specifies the fully-qualified Java type name of a method parameter.

Example

See method-params.

method-params

Function

Contains one or more elements that define the Java type name of each of the method’s parameters.

Example

The method-params element contains one or more method-param elements, as shown here:

<method-params>
	<method-param>java.lang.String</method-param>
	...
</method-params>

network-access-point

Function

Assigns a custom network channel that the EJB will use for network communications. A network channel defines a set of connection attributes. For more information, see “Configure Network Resources” in Configuring WebLogic Server Environments.

Example

<weblogic-enterprise-bean>
     <network-access-point>SSLChannel</network-access-point>
</weblogic-enterprise-bean>

passivate-as-principal-name

Function

The passivate-as-principal-name element, introduced in WebLogic Server 8.1 SP01, specifies the principal to be used in situations where ejbPassivate would otherwise run with an anonymous principal. Under such conditions, the choice of which principal to run as is governed by the following rule:

If passivate-as-principal-name is set
then use that principal
else
     if a run-as role has been specified for the bean in ejb-jar.xml
     then use a principal according to the rules for setting the run-as-role-assignment
     else
           run ejbPassivate as an anonymous principal.

The passivate-as-principal-name element only needs to be specified if operations within ejbPassivate require more permissions than the anonymous principal would have.

This element affects the ejbPassivate methods of stateless session beans when passivation occurs due to a cache timeout.

See also remove-as-principal-name, create-as-principal-name, and principal-name.

persistence

Function

Required only for entity EJBs that use container-managed persistence services. 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:

Example

<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-beand>...</finders-load-bean>
      <persistence-use>...</persistence-use>
   </persistence>
</entity-descriptor>

persistence-use

Function

Required only for entity EJBs that use container-managed persistence services. The persistence-use element stores an identifier of the persistence type to be used for this particular bean.

Example

<persistence-use>
	<type-identifier>WebLogic_CMP_RDBMS</type-identifier>
	<type-version>5.1.0</type-version>
	<type-storage>META-INF/weblogic-cmp-jar.xml</type-storage>
</persistence-use>

persistent-store-dir

Function

Specifies a file system directory where WebLogic Server stores the state of passivated stateful session bean instances. For more information, see Specifying the Persistent Store Directory for Passivated Beans.

Example

<stateful-session-descriptor>
   <stateful-session-cache>...</stateful-session-cache>
   <allow-concurrent-calls>...</allow-concurrent-calls>
   <persistent-store-dir>MyPersistenceDir</persistent-store-dir>
   <stateful-session-clustering>...</stateful-session-clustering>
   <allow-remove-during-transaction>
</stateful-session-descriptor>

persistent-store-logical-name

Function

Specifies the name of a persistent store on the server’s file system where WebLogic Server stores timer objects. If you do not specify a persistent store name in this element, WebLogic Server stores timer objects in the default store.

pool

Function

Configures the behavior of the WebLogic Server free pool for entity EJBs, stateless session EJBs, and message-driven EJBs. The options are:

Example

<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

Function

Specifies the name of an actual WebLogic Server principal to apply to the specified role-name. At least one principal-name is required in the security-role-assignment element. You may define more than one principal-name for each role-name.

Example

See security-role-assignment.

provider-url

Function

Specifies the URL to be used by the InitialContext. See Configuring MDBs for Destinations and How to Set provider-url.

Example

<message-driven-descriptor>
     <provider-url>WeblogicURL:Port</provider-url>
</message-driven-descriptor>

See also message-destination-descriptor.

read-timeout-seconds

Function

Specifies the number of seconds between ejbLoad() calls on a Read-Only entity bean. A value of 0 causes WebLogic Server to call ejbLoad() only when the bean is brought into the cache.

Example

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>

remote-client-timeout

Function

Specifies the length of time that a remote RMI client will wait before it will time out. See Using the RMI Timeout in Programming WebLogic RMI.

Example

The following entry causes a remote RMI client to timeout after waiting 5 seconds.

<weblogic-enterprise-bean>
	<ejb-name>AccountBean</ejb-name>
	...
	<remote-client-timeout>5</remote-client-timeout>
</weblogic-enterprise-bean>

remove-as-principal-name

Function

This parameter only needs to be specified if operations within ejbRemove need more permissions than the anonymous principal would have.

The remove-as-principal-name element, introduced in WebLogic Server 8.1 SP1, specifies the principal to be used in situations where ejbRemove would otherwise run with an anonymous principal. Under such conditions, the choice of which principal to run as is governed by the following rule:

If remove-as-principal-name is set
then use that principal
else
     if a run-as role has been specified for the bean in ejb-jar.xml
     then use a principal according to the rules for setting the run-as-role-assignment
     else
           run ejbRemove as an anonymous principal

The remove-as-principal-name element only needs to be specified if operations within ejbRemove require more permissions than the anonymous principal would have.

This element effects the ejbRemove methods of stateless session beans and message-drive beans.

See also passivate-as-principal-name, create-as-principal-name, and principal-name.

replication-type

Function

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.

Example

See stateful-session-clustering.

res-env-ref-name

Function

Specifies the name of a resource environment reference.

Example

See resource-description.

res-ref-name

Function

Specifies the name of a resourcefactory reference. This is the reference that the EJB provider places within the ejb-jar.xml deployment file. Required element if the EJB specifies resource references in ejb-jar.xml

Example

See resource-description.

resource-adapter-jndi-name

Function

Identifies the resource adapter that this MDB receives messages from.

resource-description

Function

Maps a resource reference defined in ejb-jar.xml to the JNDI name of an actual resource available in WebLogic Server.

Example

<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>

resource-env-description

Function

Maps a resource environment reference defined in ejb-jar.xml to the JNDI name of an actual resource available in WebLogic Server.

Example

<resource-env-description>
	<res-env-ref-name>. . .</res-env-ref-name>
	<jndi-name>...</jndi-name>
</reference-env-description>

When jndi-name is not a valid URL, WebLogic Server treats it as a object that maps to a URL and is already bound in the JNDI tree, and binds a LinkRef with that jndi-name.

resource-link

Function

Maps to a resource within a JMS module defined in ejb-jar.xml to an actual JMS Module Reference in WebLogic Server.

Example

See message-destination-descriptor.

retry-count

Function

Specifies the number of times you want the EJB container to automatically retry a container-managed transaction method that has rolled back.

retry-methods-on-rollback

Function

Specifies the methods for which you want the EJB container to automatically retry container-managed transactions that have rolled back. Automatic transaction retry is supported for session and entity beans that use container-managed transaction demarcation. Additionally, regardless of the methods specified in this element, the EJB container does not retry transactions that fail because of system exception-based errors.

role-name

Function

Identifies an application role name that the EJB provider placed in the ejb-jar.xml deployment descriptor. Subsequent principal-name elements in the element map WebLogic Server principals to the specified role-name.

Example

See security-role-assignment.

run-as-identity-principal

Function

The run-as-identity-principal element specifies which security principal name is to be used as the run-as principal for a bean that has specified a security identity run-as-role-name its ejb-jar.xml deployment descriptor.

For an explanation of how the mapping of run-as role-names to run-as-identity-principals or run-as-principal-names occurs, see the comments for the run-as-role-assignment element.

Example

<run-as-identity-principal>
     Fred
</run-as-identity-principal>

run-as-principal-name

Function

Specifies which security principal name is to be used as the run-as principal for a bean that has specified a security-identity run-as role-name in its ejb-jar.xml deployment descriptor.

For an explanation of how the mapping of run-as role-names to run-as-principal-names occurs, see the comments for the run-as-role-assignment element.

Example

<run-as-principal-name>
     Fred
</run-as-principal-name>

run-as-role-assignment

Function

Maps a given security-identity run-as role-name specified in the ejb-jar.xml deployment descriptor file to a run-as-principal-name.

The value of the run-as-principal-name for a given role-name that is specified here is scoped to all beans in the ejb-jar.xml deployment descriptor; it applies to all beans that specify that role-name as their security-identity run-as-role-name.

The run-as-principal-name value specified here can be overridden at the individual bean level by specifying a run-as-principal-name under that bean's weblogic-enterprise-bean element.

Example

Suppose that in the ejb-jar.xml deployment descriptor file:

Consider the following excerpts from the corresponding weblogic-ejb-jar.xml deployment descriptor file:

<weblogic-ejb-jar>
     <weblogic-enterprise-bean>
          <ejb-name>
               A_EJB_with_runAs_role_x
          </ejb-name>
     </weblogic-enterprise-bean>

     <weblogic-enterprise-bean>
          <ejb-name>
               B_EJB_with_runAs_role_X
          </ejb-name>
          <run-as-principal-name>
               Joe 
          </run-as-principal-name>
     </weblogic-enterprise-bean>

     <weblogic-enterprise-bean>
          <ejb-name>
               C_EJB_with_runAs_role_Y
          </ejb-name>
     </weblogic-enterprise-bean>

     <security-role-assignment>
          <role-name>
               runAs_role_Y
          </role-name>
          <principal-name>
               first_principal_of_role_Y
          </principal-name>
          <principal-name>
               second_principal_of_role_Y
          </principal-name>
     </security-role-assignment>

     <run-as-role-assignment>
          <role-name> 
               runAs_role_X 
          </role-name>
          <run-as-principal-name>
               Fred
          </run-as-principal-name>
     </run-as-role-assignment>
</weblogic-ejb-jar>

Each of the beans chooses a different principal name to use as its run-as-principal-name:

A_EJB_with_runAs_role_X

This bean's run-as role-name is 'runAs_role_X'. The jar scoped <run-as-role-assignment> mapping will be used to look up the name of the principal to use.

The <run-as-role-assignment> mapping specifies that for <role-name> 'runAs_role_X' we are to use <run-as-principal-name> 'Fred'.

“Fred” is the principal name that will be used.

B_EJB_with_runAs_role_X

This bean's run-as role-name is also 'runAs_role_X'. This bean will not use the jar scoped <run-as-role-assignment> to look up the name of the principal to use because that value is overridden by this bean's <weblogic-enterprise-bean> <run-as-principal-name> value 'Joe'.

“Joe” is the principal name that will be used.

C_EJB_with_runAs_role_Y

This bean's run-as role-name is 'runAs_role_Y'. There is no explicit mapping of 'runAs_role_Y' to a run-as principal name; that is, there is no jar-scoped <run-as-role-assignment> for 'runAs_role_Y' nor is there a bean scoped <run-as-principal-name> specified in this bean's weblogic-enterprise-bean.

To determine the principal name to use, the <security-role-assignment> for <role-name> “runAs_role_Y” is examined. The first <principal-name> corresponding to a User (i.e. not a Group) is chosen.

“first_principal_of_role_Y” is the principal name that will be used.

security-permission

Function

Specifies a security permission that is associated with a J2EE Sandbox.

For more information, see Sun's implementation of the security permission specification:

http://java.sun.com/j2se/1.3/docs/guide/security/PolicyFiles.html#FileSyntax

Example

<security-permission>
     <description>Optional explanation goes here</description>
          <security-permission-spec>
          ...
     </security-permission-spec>
</security-permission> 

security-permission-spec

Function

Specifies a single security permission based on the Security policy file syntax.

For more information, see Sun's implementation of the security permission specification:

http://java.sun.com/j2se/1.3/docs/guide/security/PolicyFiles.html#FileSyntax

Example

To grant the “read” permission to “java.vm.version,” and prevent it from being overwritten:

security-role-assignment

Function

Maps application roles in the ejb-jar.xml file to the names of security principals available in WebLogic Server.

Example

<security-role-assignment>
	<role-name>PayrollAdmin</role-name>
	<principal-name>Tanya</principal-name>
	<principal-name>system</principal-name>
	<externally-defined>True</externally-defined>
	...
</security-role-assignment>

service-reference-description

Function

Maps a Web Service destination reference in the ejb-jar.xml file to an actual Web Service in WebLogic Server.

Example

<service-reference-description>
    <service-ref-name>service/WebServiceBroker</service-ref-name>

    <wsdl-url>http://@PROXY_SERVER@/webservice/
          BrokerServiceBean?wsdl</wsdl-url>

    <call-property>...</call-property>

    <port-info>
       <port-name>BrokerServiceIntfPort</port-name>
      <stub-property>
       <name>javax.xml.rpc.service.endpoint.address</name>
        <value>http://@PROXY_SERVER@/webservice/BrokerServiceBean<;/value>
      </stub-property>

    </port-info>
</service-reference-description>

session-timeout-seconds

Function

Determines how long the EJB container leaves a passivated stateful session bean on disk. The container removes a passivated EJB session-timeout-seconds after passivating the bean instance to disk. If session-timeout-seconds is not specified, the default is the value specified by idle-timeout-seconds.

Example

<stateful-session-descriptor>
     <stateful-session-cache>
          <max-beans-in-cache>4</max-beans-in-cache>           <idle-timeout-seconds>5</idle-timeout-seconds>           <session-timeout-seconds>120</session-timeout-seconds>
          <cache-type>LRU</cache-type>
     </stateful-session-cache>
</stateful-session-descriptor>

stateful-session-cache

Function

Defines the following options used to cache stateful session EJB instances.

See Caching and Passivating Stateful Session EJBs for more information about caching of stateful session beans.

Example

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>
	<session-timeout-seconds>...</session-timeout-seconds>
	<cache-type>...</cache-type>
</stateful-session-cache>

stateful-session-clustering

Function

Specifies the following options that determine how WebLogic Server replicates stateful session EJB instances in a cluster:

Example

<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>

stateful-session-descriptor

Function

Defines deployment behaviors, such as caching, clustering, and persistence, for stateless session EJBs in WebLogic Server.

Example

<stateful-session-descriptor>
	<stateful-session-cache>...</stateful-session-cache>
	<allow-concurrent-calls>...</allow-concurrent-calls>
	<allow-remove-during-transaction>...
	</allow-remove-during-transaction>
	<persistent-store-dir>/myPersistenceStore</persistent-store-dir>
	<stateful-session-clustering>...</stateful-session-clustering>
</stateful-session-descriptor>

stateless-bean-call-router-class-name

Function

Specifies the name of a custom class to use for routing bean method calls. This class must implement weblogic.rmi.cluster.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.

Example

See stateless-clustering.

stateless-bean-is-clusterable

Function

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.

Example

See stateless-clustering.

stateless-bean-load-algorithm

Function

Specifies the algorithm to use for load balancing between replicas of the EJB home.

You can define stateless-bean-load-algorithm as one of the following values:

For more information, see “Load Balancing for EJBs and RMI Objects” in Using WebLogic Server Clusters.

Example

See stateless-clustering.

stateless-bean-methods-are-idempotent

Function

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 have 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.

Example

See stateless-clustering.

stateless-clustering

Function

Specifies options that determine how WebLogic Server replicates stateless session EJB instances in a cluster.

Example

<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>

stateless-session-descriptor

Function

Defines deployment parameters, such as caching, clustering, and persistence for stateless session EJBs in WebLogic Server.

Example

<stateless-session-descriptor>
	<pool>...</pool>
	<stateless-clustering>...</stateless-clustering>
</stateless-session-descriptor>

stick-to-first-server

Function

Defines “sticky” load balancing in a cluster. The server chosen for servicing the first request is used for all subsequent requests.

Example

<stick-to-first-server>
   True
</stick-to-first-server>

timer-descriptor

Function

Specifies an EJB timer object.

timer-implementation

Function

Specifies whether the EJB timer service is cluster aware.

Example

<timer-implementation>
   Clustered
</timer-implementation>

transaction-descriptor

Function

Specifies options that define transaction behavior in WebLogic Server. Currently, this element includes only one child element: trans-timeout-seconds.

Example

<transaction-descriptor>
	<trans-timeout-seconds>20</trans-timeout-seconds>
</transaction-descriptor>

transaction-isolation

Function

Defines method-level transaction isolation settings for an EJB.

Example

<transaction-isolation>
	<isolation-level>...</isolation-level>
	<method>
		<description>...</description>
		<ejb-name>...</ejb-name>
		<method-intf>...</method-intf>
		<method-name>...</method-name>
		<method-params>...</method-params>
	</method>
</transaction-isolation>

For more information, see isolation-level.

transport-requirements

Function

Provides the transport requirements for the EJB.

Example

<iiop-security-descriptor>
	<transport-requirements>
		<confidentiality>supported</confidentiality>
		<integrity>supported</integrity>
		<client-cert-authentication>suppoted 
		</client-cert-authentication>
	</transport-requirements>
</iiop-security-descriptor>

trans-timeout-seconds

Function

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.

Example

See transaction-descriptor.

type-identifier

Function

Required only for entity EJBs that use container-managed persistence services. Specifies 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.

Example

See persistence-use for an example that shows the complete persistence type definition for WebLogic Server RDBMS-based persistence.

type-storage

Function

Required only for entity EJBs that use container-managed persistence services. 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-jar.xml to store persistence data for a bean. This file is stored in the META-INF subdirectory of the JAR file.

Example

See persistence-use for an example that shows the complete persistence type definition for WebLogic Server RDBMS-based persistence.

type-version

Function

Required for entity EJBs that use container-managed persistence service, if multiple versions of the same persistence type are installed. Identifies the version of the specified persistence type. For example, for WebLogic 2.0 CMP persistence, use the value:

6.0

For WebLogic 1.1 CMP persistence, use the value:

5.1.0

This element is necessary if multiple versions of the same persistence type are installed.

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’).

Example

See persistence-use for an example that shows the complete persistence type definition for WebLogic Server RDBMS-based persistence.

use-serverside-stubs

Function

Causes the bean home to use server-side stubs in the context of server.

Example

See the example for entity-clustering.

weblogic-compatibility

Function

This element, introduced in WebLogic Server 9.0 contains elements that specify compatibility flags.

weblogic-ejb-jar

Function

weblogic-ejb-jar is the root element of the weblogic component of the EJB deployment descriptor.

weblogic-enterprise-bean

Function

Contains the deployment information for a bean that is available in WebLogic Server.

work-manager

Function

Specifies a work manager to manage work requests for EJBs.

For more information on work managers, see “Using Work Managers to Optimize Scheduled Work” in Configuring WebLogic Server Environments.