XDoclet Overview News and Status Download/Installation Using XDoclet Best Practices FAQ License Ant Task Reference <ejbdoclet .. /> <webdoclet .. /> <hibernatedoclet .. /> <mockdoclet .. /> <jdodoclet .. /> <jmxdoclet .. /> <doclet .. /> Tag Reference apache (@soap @struts) bea (@weblogic) borland (@bes) caucho (@resin) ejb (@ejb @dao) exolab (@castor) hp (@hpas) hibernate (@hibernate) ibm (@websphere) java (@javabean) jboss (@jboss) jdo (@jdo) jmx (@jmx) macromedia (@jrun) mockobjects (@mock) mvcsoft (@mvcsoft) mx4j (@mx4j) objectweb (@jonas) oracle (@oc4j) orion (@orion) pramati (@pramati) sybase (@easerver) web (@web @jsp) webwork (@webwork) xdoclet (@xdoclet @doc) Feature Documentation Using Value Objects Advanced Maven Plug-in Merge Points Log4J Configuration IDE Integration Migration from EJBDoclet Ant 1.5 Troubleshooting Community Feedback Resources Tools Development Developer Guide Javadoc (API) Template Language (*.xdt) XJavaDoc Site Project Documentation Front Page Project Info Project Reports Development Process | ### Tag Reference for @weblogic Tags for creation of WebLogic specific resources Class Level Tags @weblogic.pool @weblogic.message-driven @weblogic.persistence @weblogic.cache @weblogic.cache-ref @weblogic.lifecycle @weblogic.ejb-reference-description @weblogic.ejb-local-reference-description @weblogic.resource-description @weblogic.resource-env-description @weblogic.clustering @weblogic.invalidation-target @weblogic.enable-dynamic-queries @weblogic.transaction-isolation @weblogic.allow-concurrent-calls @weblogic.enable-call-by-reference @weblogic.run-as-identity-principal @weblogic.transaction-descriptor Method Level Tags @weblogic.transaction-isolation Field Level Tags ### Tag Usage, Class Level (@weblogic) #### @weblogic.pool (0..1) Used to specify various options for instance pooling.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
max-beans-in-free-pool | int |  | WebLogic EJB maintains a free pool of beans for every bean class. This property decides the maximum size of the pool. | false
initial-beans-in-free-pool | int |  | WebLogic EJB maintains a free pool of beans for every bean class. This property decides the initial size of the pool. | false
#### @weblogic.message-driven (0..1) Used to specify various options for message driven beans.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
connection-factory-jndi-name | text | Message Driven beans | This parameter specifies the JNDI name of the JMS ConnectionFactory that the MessageDriven Bean should look up to create its Queues and Topics. If not specified, it will default to weblogic.jms.MessageDrivenBeanConnectionFactory, which must have been declared in config.xml. | false
jms-polling-interval-seconds | int | Message Driven beans | The jms-polling-interval-seconds determines the number of seconds between each attempt to reconnect to the JMS destination. | false
jms-client-id | text | Message Driven beans | The JMS specification allows JMS consumers to specify an associated id. This id is necessary for durable subscriptions to JMS topics | false
destination-jndi-name | text | Message Driven beans | The destination-jndi-name element is used to associate a message-driven bean with a JMS Queue or Topic that has been deployed in the WebLogic JNDI tree. | false
initial-context-factory | text | Message Driven beans | This element specifies the initial ContextFactory that the container will use to create its connection factories. If not specified, it will default to weblogic.jndi.WLInitialContextFactory. | false
provider-url | text | Message Driven beans | This element specifies the URL provider to be put in the Properties used by the InitialContext. It is typically host:port and used in conjunction with initial-context-factory and connection-factory-jndi-name. | false
#### @weblogic.persistence (0..1) Used to specify various options for entity beans.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
delay-updates-until-end-of-tx | bool | Entity beans | Applicable to entity beans only (both container- and bean-managed). This optional optimization affects when changes to a bean's state propogated to the persistent store. If this is set to "True" (which is the default) updates of the persistent store of all beans in the transaction will be performed just before the end of the transaction. If this is set to "False" the pstore update of a bean will be performed at the conclusion of each method invoke. | false
is-modified-method-name | text | Entity beans | Applies to bean managed persistence or EJB 1.1 container-managed persistence entity EJBs. EJB 2.0 entity EJBs do not need to implement an is-modified-method. The EJB container can automatically detect which fields were modified in a transaction. | false
finders-load-bean | text | Entity beans | Applicable to CMP entity beans only. This optional optimization affects whether the beans returned by a finder (or ejbSelect method) are loaded immediately into the cache before the finder method returns. Valid options are: True False | false
#### @weblogic.cache (0..1) Used to specify various options for the caching.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
max-beans-in-cache | int |  | Maximum number of objects of this class that are allowed in memory. Objects are kept in an LRU chain, and the ones dropped from the end of the chain are passivated. | false
idle-timeout-seconds | int |  | The cache (see "max-beans-in-cache" above) is scrubbed of inactive objects after at least this many seconds. Objects scrubbed are passivated. | false
read-timeout-seconds | int | Entity beans | The read-timeout-seconds is the number of seconds between ejbLoad calls on a Read-Only entity bean. If read-timeout-seconds is 0, ejbLoad will only be called when the bean is brought into the cache. | false
concurrency-strategy | text | Entity beans | The concurrency-strategy specifies how the container should manage concurrent access to an entity bean.<br/> The concurrent-strategy can be one of the following values:<br/> -&nbsp;"Exclusive": The exclusive locking scheme used in WebLogic Server versions 3.1 through 5.1<br/> -&nbsp;"Database": A scheme where a separate Entity Bean instance is allocated for each transaction and the locking and caching is handled by the database.<br/> -&nbsp;"ReadOnly" : For read-only entity beans<br/> -&nbsp;"Optimistic" : (since v7.0) When using optimistic concurrency, no locks are held in the EJB container or database during a transaction. The EJB container verifies that none of the data that was updated by a transaction has changed before committing the transaction. If any updated data has been changed, the transaction is rolled back. Valid options are: Exclusive Database ReadOnly Optimistic Default value(s): Database | false
cache-type | text | Stateless Session Beans (WLS 6.1) | The cache-type can be one of "NRU" or "LRU". The default is "NRU".<br/> Used in: stateful-session-cache Valid options are: NRU LRU Default value(s): NRU | false
#### @weblogic.cache-ref (0..1) Used to add a entity-cache-ref element to weblogic-ejb-jar.xml. This element is used to refer 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 descriptor
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
cache-name | text |  | The entity-cache-name element is used to name the application level entity cache that an entity bean uses. An application level entity cache is a cache that may be shared by multiple entity beans in the same application. Application level entity caches are declared in the weblogic-application.xml deployment descriptor. | true
concurrency-strategy | text |  | The concurrency-strategy specifies how the container should manage concurrent access to an entity bean Valid options are: Exclusive Database ReadOnly Optimistic Default value(s): Database | true
cache-between-transactions | bool |  | The cache-between-transactions element tells the EJB container whether to cache the persistent data of an entity bean across (between) transactions. true or false. false by default. | false
estimated-bean-size | int |  | The estimated-bean-size element is used to specify 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 | false
#### @weblogic.lifecycle (0..1) The lifecycle element is used to specify various options for the management of the lifecycle of stateful beans.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
passivation-strategy | text |  | The passivation-strategy can be either "default" or "transaction". With the "default" setting the container will attempt to keep a working set of beans in the cache. With the "transaction" setting, the container will passivate the bean after every transaction (or method call for a non-transactional invocation). Valid options are: default transaction Default value(s): default | false
#### @weblogic.ejb-reference-description (0..1) Used to specify a reference to an EJB external to the current deployment-package. There must be an @ejb.ejb-ref tag too which points to the referenced bean.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
jndi-name | text |  | The jndi-name element gives the JNDI name where the bean or resource will be bound in WebLogic Server. References the tag @ejb.bean with "jndi-name" property | true
ejb-ref-name | text |  | EJB reference name, this is the reference that you put in the tag @ejb.ejb-ref with ref-name parameter | true
#### @weblogic.ejb-local-reference-description (0..1) Used to specify a reference to an EJB. There must be an @ejb.ejb-ref tag too which points to the referenced bean. Only for Weblogic 6.1 and later
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
jndi-name | text |  | The jndi-name element gives the JNDI name where the bean or resource will be bound in WebLogic Server. References the tag @ejb.bean with "jndi-name" property | true
ejb-ref-name | text |  | EJB reference name, this is the reference that you put in the tag @ejb.ejb-ref with ref-name parameter | true
#### @weblogic.resource-description (0..1) Used to specify a reference to resource. There must be a matching @ejb.resource-ref tag too which points to the referenced resource.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
jndi-name | text |  | Reference to the resource | true
res-ref-name | text |  | The jndi-name from the @ejb.resource-ref tag | true
#### @weblogic.resource-env-description (0..1) Used to specify a reference to resource. There must be a matching @ejb.resource-env-ref tag too which points to the referenced resource.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
jndi-name | text |  | Reference to the resource | true
res-env-ref-name | text |  | The name from the @ejb.resource-env-ref | true
#### @weblogic.clustering (0..1) The clustering element is used to specify various options for how an entity bean will be invoked in a WebLogic cluster. Setting home-is-clusterable to "True" enables clustering for both the home and remote stubs of the Entity bean.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
home-is-clusterable | text |  | If "True," this bean can be deployed from multiple servers in a cluster. Calls to the home stub will be load-balanced between the servers on which this bean is deployed, and if a server hosting the bean is unreachable, the call will automatically failover to another server hosting the bean Valid options are: True False |
home-load-algorithm | text |  | The home-load-algorithm specifies the algorithm to use for load-balancing between replicas of this home. If this property is not specified, the algorithm specified by the server property weblogic.cluster.defaultLoadAlgorithm will be used. Valid options are: RoundRobin Random WeightBased |
home-call-router-class-name | text |  | The home-call-router-class-name specifies a custom class to be used for routing home method calls. This class must implement weblogic.rmi.cluster.CallRouter. |
replication-type | text | Statefull Session beans | The replication-type element describes how to replicate stateful session beans in a cluster. Valid options are: InMemory None Default value(s): None |
stateless-bean-call-router-class-name | text | Stateless Session beans | The stateless-bean-call-router-class-name specifies a custom class to be used for routing bean method calls. This class must implement weblogic.rmi.cluster.CallRouter. If specified, an instance of this class will be called before each method call and be given the opportunity to choose a server to route to based on the method parameters. It either returns a server name or null indicating that the current load algorithm should be used to pick the server. |
stateless-bean-is-clusterable | text | Stateless Session beans | The valid values of the stateless-bean-is-clusterable parameter are "True" or "False." The parameter is applicable only to session EJBeans with a session-type value of "Stateless" (see ejb-jar.dtd). If home-is-clusterable is "True" and this parameter is also "true", calls to this bean stub will be load-balanced between all the the servers on which this bean is deployed, and if a server hosting the bean becomes unreachable, the call will automatically failover to another server hosting the bean. Valid options are: True False |
stateless-bean-load-algorithm | text | Stateless Session beans | The stateless-bean-load-algorithm specifies the algorithm to use for load-balancing between replicas of this bean. If this property is not specified, the algorithm specified by the server property weblogic.cluster.defaultLoadAlgorithm will be used. Valid options are: RoundRobin Random WeightBased |
#### @weblogic.invalidation-target (0..1) Only for Weblogic 6.1 or later
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
ejb-name | text |  |  |
#### @weblogic.enable-dynamic-queries (0..*) Only for Weblogic 7.0 or greater
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
| bool |  |  |
#### @weblogic.transaction-isolation (0..*) Set the transaction isolation level.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
| text |  | Valid options are: TRANSACTION_SERIALIZABLE TRANSACTION_READ_COMMITTED TRANSACTION_READ_UNCOMMITTED TRANSACTION_REPEATABLE_READ TRANSACTION_READ_COMMITTED_FOR_UPDATE Default value(s): | false
#### @weblogic.allow-concurrent-calls (0..*) The allow-concurrent-calls specifies whether a stateful session bean instance will allow concurrent method calls. The value of this element may be either "True" or "False". When a stateful session bean instance is currently in a method call and another (concurrent) method call arrives on the server, the EJB specification requires that the server throw a RemoteException. By default, allow-concurrent-calls is false, and the EJB container will follow the EJB specification. When this value is set to true, the EJB container will block the concurrent method call and allow it to proceed when the previous call has completed. Allowed values are: True, False
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
| bool |  |  | false
#### @weblogic.enable-call-by-reference (0..*) 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). Allowed values are True, False
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
| bool |  |  | false
#### @weblogic.run-as-identity-principal (0..*) The run-as-identity-principal element specifies which security principal is to be used for the run-as identity. This tag is necessary if the role specified in the run-as element of the ejb-jar.xml descriptor does not map to a single security principal representing a User in the security realm. This could be true in two cases. One case is where the role maps to multiple security principals (see security-role-assignment element). In this case, the run-as-identity-principal element must be used to specify which of the security principals you would like to be used. The other case is where the role maps to a single security principal that represents a Group in the security realm. In this case the run-as-identity-principal element must be used to specify a particular User in the security realm.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
| text |  |  |
#### @weblogic.transaction-descriptor (0..*) The transaction-descriptor specifies properties relating to transactions. Applicable to all bean types
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
trans-timeout-seconds | int |  | Maximum duration of EJB container initiated transactions. If the transaction takes longer then the trans-timeout-seconds, the Weblogic Server will rollback the transaction. | false
### Tag Usage, Method Level (@weblogic) #### @weblogic.transaction-isolation (0..*) Set the transaction isolation level.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
| text |  | Valid options are: TRANSACTION_SERIALIZABLE TRANSACTION_READ_COMMITTED TRANSACTION_READ_UNCOMMITTED TRANSACTION_REPEATABLE_READ TRANSACTION_READ_COMMITTED_FOR_UPDATE Default value(s): | false
### Tag Usage, Field Level (@weblogic)