bea.com | products | dev2dev | support | askBEA
 Download Docs   Site Map   Glossary 
Search

Programming WebLogic Enterprise JavaBeans

 Previous Next Contents Index View as PDF  

The weblogic-ejb-jar.xml Deployment Descriptor

The following sections describe the EJB 2.0 deployment descriptor elements found in the weblogic-ejb-jar.xml file, the weblogic-specific XML document type definitions (DTD) file. Use these definitions to create the WebLogic-specific weblogic-ejb-jar.xml file that is part of your EJB deployment.

For information on the EJB 1.1 deployment descriptor elements see Important Information for EJB 1.1 Users.

 


EJB Deployment Descriptors

The EJB deployment descriptors contain structural and application assembly information for an enterprise bean. You specify this information by specifying values for the deployment descriptors in three EJB XML DTD files. These files are:

You package these three XML files with the EJB and other classes into a deployable EJB component, usually a JAR file, called ejb.jar.

The ejb-jar.xml file is based on the deployment descriptors found in Sun Microsystems's ejb.jar.xml file. The other two XML files are weblogic-specific files that are based on the deployment descriptors found in weblogic-ejb-jar.xml and weblogic-cmp-rdbms-jar.xml.

 


DOCTYPE Header Information

When you edit or create XML deployment files, it is critical to include the correct DOCTYPE header for the deployment file. In particular, using an incorrect PUBLIC element within the DOCTYPE header can result in parser errors that may be difficult to diagnose.

WebLogic provides a public location for you to access the correct text for the WebLogic Server-specific DTD file, weblogic-ejb-jar.xml. However, an identical version of this DTD file is embedded in WebLogic Server for internal use. weblogic.appc uses this file when the XML parser checks the sequence of the deployment descriptors files.

The correct text for the PUBLIC elements for the WebLogic Server-specific weblogic-ejb-jar.xml file are as follows.

XML File

PUBLIC Element String

weblogic-ejb-jar.xml

`-//BEA Systems, Inc.//DTD WebLogic 8.1.0 EJB//EN` `http://www.bea.com/servers/wls810/dtd/weblogic-ejb-jar.dtd`

weblogic-ejb-jar.xml

`-//BEA Systems, Inc.//DTD WebLogic 7.0.0 EJB//EN` `http://www.bea.com/servers/wls700/dtd/weblogic-ejb-jar.dtd`

weblogic-ejb-jar.xml

`-//BEA Systems, Inc.//DTD WebLogic 6.0.0 EJB//EN` `http://www.bea.com/servers/wls600/dtd/weblogic-ejb-jar.dtd`

weblogic-ejb-jar.xml

`-//BEA Systems, Inc.//DTD WebLogic 5.1.0 EJB//EN'

`http://www.bea.com/servers/wls510/dtd/weblogic-ejb-jar.dtd'

The correct text for the PUBLIC elements for the Sun Microsystem-specific ejb-jar.xml file are as follows.

XML File

PUBLIC Element String

ejb-jar.xml

`-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN' `

ejb-jar.xml

`-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN'

`http://www.java.sun.com/j2ee/dtds/ejb-jar_1_1.dtd'

For example, the entire DOCTYPE header for a weblogic-ejb-jar.xml file is as follows:

<!DOCTYPE weblogic-ejb-jar PUBLIC 
'-//BEA Systems, Inc.//DTD WebLogic 8.1.0 EJB//EN' 'http://www.bea.com/servers/wls810/dtd/weblogic-ejb-jar.dtd'>

XML files with incorrect header information may yield error messages similar to the following, when used with a tool that parses the XML (such as appc):

SAXException: This document may not have the identifier `identifier_name'

identifier_name generally includes the invalid text from the PUBLIC element.

Document Type Definitions (DTDs) for Validation

The contents and arrangement of elements in your XML files must conform to the Document Type Definition (DTD) for each file you use. WebLogic Server ignores the DTDs embedded within the DOCTYPE header of XML deployment files, and instead uses the DTD locations that were installed along with the server. However, the DOCTYPE header information must include a valid URL syntax in order to avoid parser errors.

Note: Most browsers do not display the contents of files having the .dtd extension. To view the DTD file contents in your browser, save the links as text files and view them with a text editor.

weblogic-ejb-jar.xml

The following links provide the public locations for weblogic-ejb-jar.xml DTDs, by version number.

ejb-jar.xml

The following links provide the public DTD locations for the ejb-jar.xml deployment files used with WebLogic Server:

Note: Refer to the appropriate JavaSoft EJB specification for a description of the ejb-jar.xml deployment descriptors.

 


2.0 weblogic-ejb-jar.xml Deployment Descriptor 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 8.1 weblogic-ejb-jar.xml are as follows:

 


2.0 weblogic-ejb-jar.xml Deployment Descriptor Elements

 


allow-concurrent-calls

Range of values:

True | False

Default value:

False

Requirements:

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.

Parent elements:

weblogic-enterprise-bean

     stateful-session-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See stateful-session-descriptor

 


cache-between-transactions

Range of values:

True | False

Default value:

False

Requirements:

Optional element. Valid only for entity EJBs.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

Deployment file:

weblogic-ejb-jar.xml

Function

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.

See Caching Between Transactions for more information.

Example

See persistence.

 


cache-type

Range of values:

NRU | LRU

Default value:

NRU

Requirements:


Parent elements:

weblogic-enterprise-bean

     stateful-session-cache

Deployment file:

weblogic-ejb-jar.xml

Function

The cache-type element specifies the order in which EJBs are removed from the cache. The values are:

Example

The following example shows the structure of the cache-type element.

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

 


client-authentication

Range of values:

none | supported | required

Default value:


Requirements:

n/a

Parent elements:

weblogic-enterprise-bean

     iiop-security-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The client-authentication element specifies whether the EJB supports or requires client authentication.

Example

See iiop-security-descriptor.

 


client-cert-authentication

Range of values:

none | supported | required

Default value:


Requirements:

n/a

Parent elements:

weblogic-enterprise-bean

     iiop-security-descriptor

          transport-requirements

Deployment file:

weblogic-ejb-jar.xml

Function

The client-cert-authentication element specifies whether the EJB supports or requires client certificate authentication at the transport level.

Example

See transport-requirements.

 


clients-on-same-server

Range of values:

True | False

Default value:

False

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

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.

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

Example

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

Range of values:

Exclusive | Database | ReadOnly | Optimistic

Default value:

Database

Requirements:

Optional element. Valid only for entity EJBs.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          entity-cache

Deployment file:

weblogic-ejb-jar.xml

Function

The concurrency-strategy element specifies how the container should manage concurrent access to an entity bean. Set this element to one of four values:

SeeEJB Concurrency Strategy for more information on the Exclusive and Database locking behaviors. SeeRead-Only Multicast Invalidation for more information about read-only entity EJBs.

Example

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>

 


confidentiality

Range of values:

none | supported | required

Default value:

n/a

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean

     iiop-security-descriptor

          transport-requirements n

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See transport-requirements.

 


connection-factory-jndi-name

Range of values:

valid name

Default value:

weblogic.jms.MessageDrivenBeanConnectionFactory in config.xml

Requirements:

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.

Parent elements:

weblogic-enterprise-bean

     message-driven-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

The following example shows the structure of the connection-factory-jndi-name element:

<message-driven-descriptor> 
<connection-factory-jndi-name>weblogic.jms.MessageDrivenBean
ConnectionFactory
</connection-factory-jndi-name>
</message-driven-descriptor>

 


delay-updates-until-end-of-tx

Range of values:

True | False

Default value:

True

Requirements:

Valid only for entity EJBs.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

Deployment file:

weblogic-ejb-jar.xml

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 TransactionReadCommittedUncommitted, 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. See ejbLoad() and ejbStore() Behavior for Entity EJBs for more information.

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.

Example

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

Range of values:

n/a

Default value:

n/a

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean,
     transaction-isolation
          method

Deployment file:

weblogic-ejb-jar.xml

Function

The description element is used to provide text that describes the parent element.

Example

The following example specifies the description element.

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

 


destination-jndi-name

Range of values:

Valid JNDI name

Default value:

n/a

Requirements:

Required in message-driven-descriptor.

Parent elements:

weblogic-enterprise-bean
     message-driven-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See message-driven-descriptor.

 


ejb-name

Range of values:

Name of an EJB defined in ejb-jar.xml

Default value:

n/a

Requirements:

Required element in method stanza. The name must conform to the lexical rules for an NMTOKEN.

Parent elements:

weblogic-enterprise-bean
     method

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See method.

 


ejb-reference-description

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     reference-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

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

Range of values:

n/a

Default value:

n/a

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     reference-description
          ejb-reference-description

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

The ejb-ref-name stanza is shown here:

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

 


ejb-local-reference-description

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     reference-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The ejb-local-reference-description element maps the JNDI name of an EJB in the WebLogic Server that is referenced by the bean in the ejb-local-ref element.

Example

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>

 


enable-call-by-reference

Range of values:

True | False

Default value:

False

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     reference-descriptor

          ejb-reference-description

Deployment file:

weblogic-ejb-jar.xml

Function

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

Example

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>

 


enable-dynamic-queries

Range of values:

True | False

Default value:

True

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

The following example enables dynamic queries:

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

 


entity-cache

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

The entity-cache stanza is optional, and is valid only for entity EJBs.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The entity-cache element defines the following options used to cache entity EJB instances within WebLogic Server:

SeeEJB Lifecycle in WebLogic Server for a general discussion of the caching services available in WebLogic Server.

Example

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>

 


entity-cache-name

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

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.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor
          entity-cache-ref

Deployment file:

weblogic-ejb-jar.xml

Function

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.

For more information about the weblogic-application.xml file, see the application deployment descriptors.

Example

See entity-cache-ref.

 


entity-cache-ref

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

The entity-cache-name element in the entity-cache-ref stanza must contain the name of the application level cache.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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-strategyto 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 banes with a concurrency-strategy of Exclusive. While a MultiVersion cache supports the Database, ReadOnly, and Optimistic concurrency strategies.

Example

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

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element. Valid only for entity EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The entity-clustering element uses the following options to specify how an entity bean will be replicated in a WebLogic cluster:

Example

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>

 


entity-descriptor

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

One entity-descriptor stanza is required for each entity EJB in the .jar.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

The entity-descriptor element specifies the following deployment parameters that are applicable to an entity bean:

Example

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>

 


estimated-bean-size

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean
     entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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 ad 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 instance s of A are cached, this implies that 0 instances of B are cached.

Example

See entity-cache-ref.

 


finders-load-bean

Range of values:

True | False

Default value:

True

Requirements:

Optional element. Valid only for CMP entity EJBs.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

Deployment file:

weblogic-ejb-jar.xml

Function

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

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>

 


home-call-router-class-name

Range of values:

Valid router class name

Default value:

null

Requirements:

Optional element. Valid only for entity EJBs, stateful session EJBs, and stateless session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          entity-clustering

and

weblogic-enterprise-bean
     stateful-session-descriptor
          stateful-session-clustering

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See entity-clustering and stateful-session-clustering.

 


home-is-clusterable

Range of values:

True | False

Default value:

True

Requirements:

Optional element. Valid only for entity EJBs and stateful session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          entity-clustering

and

weblogic-enterprise-bean
     stateful-session-descriptor
          stateful-session-clustering

Deployment file:

weblogic-ejb-jar.xml

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

Range of values:

round-robin | random | weight-based

Default value:

Value of weblogic.cluster.defaultLoadAlgorithm

Requirements:

Optional element. Valid only for entity EJBs and stateful session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          entity-clustering

and

weblogic-enterprise-bean
     stateful-session-descriptor
          stateful-session-clustering

Deployment file:

weblogic-ejb-jar.xml

Function

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:

Example

See entity-clustering and stateful-session-clustering.

 


idempotent-method

Range of values:

n/a

Default value:

n/a

Requirements:

Clustering must be enabled for the EJB.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

s

Function

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.

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

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>

 


identity-assertion

Range of values:

none | supported | required

Default value:


Requirements:

n/a

Parent elements:

weblogic-enterprise-bean

     iiop-security-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The identity-assertion element specifies whether the EJB supports or requires identity assertion.

Example

See iiop-security-descriptor.

 


idle-timeout-seconds

Range of values:

1 to maxSeconds

Default value:

600

Requirements:

Optional element

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          entity-cache

and

weblogic-enterprise-bean,
     stateful-session-descriptor,
          stateful-session-cache

Deployment file:

weblogic-ejb-jar.xml

Function

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. See EJB Lifecycle in WebLogic Server for more information.

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

Range of values:

n/a

Default value:

n/a

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

The iiop-security-descriptor element specifies security configuration parameters at the bean-level. These parameters determine the IIOP security information contained in the IOR.

Example

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

Range of values:

0 to maxBeans

Default value:

0

Requirements:

Optional element. Valid for stateless session, entity, and message-driven EJBs.

Parent elements:

weblogic-enterprise-bean,
     stateless-session-descriptor, message-bean-descriptor, entity-descriptor
          pool

Deployment file:

weblogic-ejb-jar.xml

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

Range of values:

True | False

Default value:

weblogic.jndi.WLInitialContextFactory

Requirements:

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.

Parent elements:

weblogic-enterprise-bean

     message-driven-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

The following example specifies the initial-context-factory element.

<message-driven-descriptor>
<initial-context-factory>weblogic.jndi.WLInitialContextFactory
</initial-context-factory>
</message-driven-descriptor>

 


integrity

Range of values:

none | supported | required

Default value:


Requirements:

n/a.

Parent elements:

weblogic-enterprise-bean

     iiop-security-descriptor
          transport-requirements

Deployment file:

weblogic-ejb-jar.xml

Function

The integrity element specifies the transport integrity requirements for he 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

Range of values:


Default value:


Requirements:

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.

Parent elements:

weblogic-enterprise-bean

     entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The invalidation-target element specifies a Read-Only entity EJB that should be invalidated when this container-managed persistence entity EJB has been modified.

Example

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

Range of values:

Valid entity EJB method name

Default value:

None

Requirements:

Optional element. Valid only for entity EJBs.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

Deployment file:

weblogic-ejb-jar.xml

Function

is-modified-method-name 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.

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.

Example

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

Range of values:

Serializable | ReadCommitted | ReadUncommitted | RepeatableRead

Default value:

n/a

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean,
     transaction-isolation

Deployment file:

weblogic-ejb-jar.xml

Function

isolation-level specifies the isolation level for all of the EJB's database operations. The following are possible values for isolation-level:

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

Example

See transaction-isolation.

 


jms-polling-interval-seconds

Range of values:

n/a

Default value:

10 seconds

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

The following entry specifies the jms polling intervals for message-driven beans:

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

 


jms-client-id

Range of values:

n/a

Default value:

The default client identifier is the ejb-name for this EJB.

Requirements:

The jms-client-id is necessary for durable subscriptions to JMS topics.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

The following entry specifies an associated id for JMS consumers:

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

 


jndi-name

Range of values:

Valid JNDI name

Default value:

n/a

Requirements:

Required in resource-description and ejb-reference-description.

Parent elements:

weblogic-enterprise-bean

and

weblogic-enterprise-bean
     reference-descriptor
          resource-description

and

weblogic-enterprise-bean
     reference-descriptor
          ejb-reference-description

Deployment file:

weblogic-ejb-jar.xml

Function

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

Range of values:

Valid JNDI name

Default value:

n/a

Requirements:

Required if the bean has a local home.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

The following example shows the specifies the local-jndi-name element.

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

 


max-beans-in-cache

Range of values:

1 to maxBeans

Default value:

1000

Requirements:

Optional element

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          entity-cache

and

weblogic-enterprise-bean
     stateful-session-descriptor
          stateful-session-cache

Deployment file:

weblogic-ejb-jar.xml

Function

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, as described inEJB Concurrency Strategy.

Example

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-beans-in-free-pool

Range of values:

0 to maxBeans

Default value:

max Int

Requirements:

Optional element. Valid only for stateless session EJBs.

Parent elements:

weblogic-enterprise-bean,
     stateless-session-descriptor, message-bean-descriptor, entity-descriptor
          pool

Deployment file:

weblogic-ejb-jar.xml

Function

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. See Stateless Session EJB Life Cycle and Differences Between Message-Driven Beans and Stateless Session EJBs for more information.

Example

See pool.

 


message-driven-descriptor

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:


Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

The message-driven-descriptor element associates a message-driven bean with a JMS destination in WebLogic Server. This element specifies the following deployment parameters:

Example

The following example shows the structure of the message-driven-descriptor stanza:

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

 


method

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element. You can specify more than one method stanza to configure multiple EJB methods.

Parent elements:

weblogic-enterprise-bean

     transaction-isolation

Deployment file:

weblogic-ejb-jar.xml

Function

The method element defines a method or set of methods for an enterprise bean's home or remote interface.

Example

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

Range of values:

Home | Remote

Default value:

n/a

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     transaction-isolation
          method

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See method.

 


method-name

Range of values:

Name of an EJB defined in ejb-jar.xml | *

Default value:

n/a

Requirements:

Required element in method stanza.

Parent elements:

weblogic-enterprise-bean
     transaction-isolation
          method

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See method.

 


method-param

Range of values:

Fully qualified Java type of a method parameter

Default value:

n/a

Requirements:

Required element in method-params.

Parent elements:

weblogic-enterprise-bean

     transaction-isolation
          method
               method-params

Deployment file:

weblogic-ejb-jar.xml

Function

The method-param element specifies the fully qualified Java type name of a method parameter.

Example

See method-params.

 


method-params

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional stanza.

Parent elements:

weblogic-enterprise-bean

     transaction-isolation
          method

Deployment file:

weblogic-ejb-jar.xml

Function

The method-params stanza contains one or more elements that define the Java type name of each of the method's parameters.

Example

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>

 


persistence

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Required only for entity EJBs that use container-managed persistence services.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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

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-beand>...</finders-load-bean>
		<persistence-type>...</persistence-type>
		<db-is-shared>False</db-is-shared>
		<persistence-use>...</persistence-use>
	</persistence>
</entity-descriptor>

 


persistence-type

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Required only for entity EJBs that use container-managed persistence services.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

Deployment file:

weblogic-ejb-jar.xml

Function

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:

Example

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

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Required only for entity EJBs that use container-managed persistence services.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

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>

 


persistent-store-dir

Range of values:

Fully qualified filesystem path

Default value:

n/a

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean

     stateful-session-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The persistent-store-dir element specifies a file system directory where WebLogic Server stores the state of passivated stateful session bean instances.

Example

See stateful-session-descriptor.

 


pool

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     stateless-session-descriptor, message-bean-descriptor, entity-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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

Example

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

Range of values:

valid WebLogic Server principal name

Default value:

n/a

Requirements:

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.

Parent elements:

weblogic-enterprise-bean
     security-role-assignment

Deployment file:

weblogic-ejb-jar.xml

Function

principal-name specifies the name of an actual WebLogic Server principal to apply to the specified role-name.

Example

See security-role-assignment.

 


provider-url

Range of values:

valid name

Default value:

n/a

Requirements:

Used in conjunction with initial-context-factory and connection-factory-jndi-name.

Parent elements:

weblogic-enterprise-bean
     message-driven-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The provider-url element specifies the URL provider to be used by the InitialContext. Typically, this is the host port and is used in conjunction with initial-context-factory and connection-factory-jndi-name.

Example

The following example specifies the provider-url element.

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

 


read-timeout-seconds

Range of values:

0 to maxSeconds

Default value:

600

Requirements:

Optional element. Valid only for entity EJBs.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          entity-cache

Deployment file:

weblogic-ejb-jar.xml

Function

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.

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>

 


reference-descriptor

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

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>

 


relationship-description

This element is no longer supported in WebLogic Server.

 


replication-type

Range of values:

InMemory | None

Default value:

None

Requirements:

Optional element. Valid only for stateful session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean
     stateful-session-descriptor
          stateful-session-clustering

Deployment file:

weblogic-ejb-jar.xml

Function

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.

See In-Memory Replication for Stateful Session EJBs for more information.

Example

See stateful-session-clustering.

 


res-env-ref-name

Range of values:

A valid resource environment reference name from the ejb-jar.xml file

Default value:

n/a

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean
     reference-descriptor
          resource-env-description

Deployment file:

weblogic-ejb-jar.xml

Function

The res-env-ref-name element specifies the name of a resource environment reference.

Example

See resource-description.

 


res-ref-name

Range of values:

A valid resource reference name from the ejb-jar.xml file

Default value:

n/a

Requirements:

Required element if the EJB specifies resource references in ejb-jar.xml

Parent elements:

weblogic-enterprise-bean
     reference-descriptor
          resource-description

Deployment file:

weblogic-ejb-jar.xml

Function

The res-ref-name element specifies the name of a resourcefactory reference. This is the reference that the EJB provider places within the ejb-jar.xml deployment file.

Example

See resource-description.

 


resource-description

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     reference-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

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

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean
     reference-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

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>

 


role-name

Range of values:

An EJB role name defined in ejb-jar.xml

Default value:

n/a

Requirements:

Required element in security-role-assignment.

Parent elements:

weblogic-enterprise-bean
     security-role-assignment

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See security-role-assignment.

 


security-permission

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

.

Parent elements:

n/a

Deployment file:

weblogic-ejb-jar.xml

Function

The security-permission element specifies a security permission

Example

The security-permission stanza can contain one or more of the following elements:

<security-permission> </security-permission>

 


security-permission-spec

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

n/a

Parent elements:

security-permission

Deployment file:

weblogic-ejb-jar.xml

Function

The security-permission element specifies a single security permission based on the Security policy file syntax.

Example

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

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Required element if ejb-jar.xml defines application roles.

Parent elements:

n/a

Deployment file:

weblogic-ejb-jar.xml

Function

The security-role-assignment element maps application roles in the ejb-jar.xml file to the names of security principals available in WebLogic Server.

Example

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

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

The stateful-session-cache stanza is optional, and is valid only for stateful session EJBs.

Parent elements:

weblogic-enterprise-bean,
     stateful-session-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The stateful-session-cache element defines the following options used to cache stateful session EJB instances within WebLogic Server.

SeeEJB Lifecycle in WebLogic Server for a general discussion of the caching services available in WebLogic Server.

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

 


stateful-session-clustering

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element. Valid only for stateful session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     stateful-session-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The stateful-session-clustering stanza element specifies the following options that determine how WebLogic Server replicates stateful session EJB instances in a cluster:

Example

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>

 


stateful-session-descriptor

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

One stateful-session-descriptor stanza is required for each stateful session EJB in the .jar.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

The stateful-session-descriptor element specifies the following deployment parameters that are applicable for stateful session EJBs in WebLogic Server:

Example

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>

 


stateless-bean-call-router-class-name

Range of values:

Valid router class name

Default value:

n/a

Requirements:

Optional element. Valid only for stateless session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     stateless-session-descriptor
          stateless-clustering

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See stateless-clustering.

 


stateless-bean-is-clusterable

Range of values:

True | False

Default value:

True

Requirements:

Optional element. Valid only for stateless session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     stateless-session-descriptor
          stateless-clustering

Deployment file:

weblogic-ejb-jar.xml

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

Range of values:

round-robin | random | weight-based

Default value:

Value of weblogic.cluster.defaultLoadAlgorithm

Requirements:

Optional element. Valid only for stateless session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     stateless-session-descriptor
          stateless-clustering

Deployment file:

weblogic-ejb-jar.xml

Function

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:

Example

See stateless-clustering.

 


stateless-bean-methods-are-idempotent

Range of values:

True | False

Default value:

False

Requirements:

Optional element. Valid only for stateless session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     stateless-session-descriptor
          stateless-clustering

Deployment file:

weblogic-ejb-jar.xml

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

Example

See stateless-clustering.

 


stateless-clustering

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element. Valid only for stateless session EJBs in a cluster.

Parent elements:

weblogic-enterprise-bean,
     stateless-session-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The stateless-clustering element specifies the following options that determine how WebLogic Server replicates stateless session EJB instances in a cluster:

Example

The following excerpt shows the structure of a stateless-clustering stanza:

<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

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

One stateless-session-descriptor element is required for each stateless session EJB in the JAR file.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

The stateless-session-descriptor element defines deployment parameters, such as caching, clustering, and persistence for stateless session EJBs in WebLogic Server.

Example

The following example shows the structure of the stateless-session-descriptor stanza:

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

 


transaction-descriptor

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-bean

Deployment file:

weblogic-ejb-jar.xml

Function

The transaction-descriptor element specifies options that define transaction behavior in WebLogic Server. Currently, this stanza includes only one element: trans-timeout-seconds.

Example

The following example shows the structure of the transaction-descriptor stanza:

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

 


transaction-isolation

Range of values:

n/a (XML stanza)

Default value:

n/a (XML stanza)

Requirements:

Optional element.

Parent elements:

weblogic-enterprise-jar

Deployment file:

weblogic-ejb-jar.xml

Function

The transaction-isolation element defines method-level transaction isolation settings for an EJB.

Example

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

Range of values:

n/a

Default value:

n/a

Requirements:

n/a

Parent elements:

weblogic-enterprise-bean,
     iiop-security-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

The transport-requirements element provides the transport requirements for the EJB.

Example

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

Range of values:

0 to max

Default value:

30

Requirements:

Optional element. Valid for any type of EJB.

Parent elements:

weblogic-enterprise-bean,
     transaction-descriptor

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

See transaction-descriptor.

 


type-identifier

Range of values:

Valid string

Default value:

n/a

Requirements:

Required only for entity EJBs that use container-managed persistence services.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

               persistence-type

and

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

               persistence-use

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

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

 


type-storage

Range of values:

Valid string

Default value:

n/a

Requirements:

Required only for entity EJBs that use container-managed persistence services.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

               persistence-type

Deployment file:

weblogic-ejb-jar.xml

Function

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.

Example

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

 


type-version

Range of values:

Valid string

Default value:

n/a

Requirements:

Required only for entity EJBs that use container-managed persistence services.

Parent elements:

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

               persistence-type

and

weblogic-enterprise-bean,
     entity-descriptor,
          persistence

               persistence-use

Deployment file:

weblogic-ejb-jar.xml

Function

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

Example

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

 


weblogic-ejb-jar

Range of values:

N/A

Default value:

N/A

Requirements:

N/A

Parent elements:

N/A

Deployment file:

weblogic-ejb-jar.xml

Function

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

 


weblogic-enterprise-bean

Range of values:


Default value:


Requirements:


Parent elements:

weblogic-ejb-jar

Deployment file:

weblogic-ejb-jar.xml

Function

The weblogic-enterprise-bean element contains the deployment information for a bean that is available in WebLogic Server.

 

Back to Top Previous Next