Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.ejbgen
Annotation Type Entity


@Retention(value=CLASS)
@Target(value=java.lang.annotation.ElementType.TYPE)
public @interface Entity


Required Element Summary
 String ejbName
          Names this Entity bean.
 String primKeyClass
          Names the Java class of the primary key.
 
Optional Element Summary
 String abstractSchemaName
          Gives the abstract schema name for this EJB.
 Constants.Bool cacheBetweenTransactions
          (True|False) Specifies whether to cache the persistent data of an entity bean across (between) transactions.
 Constants.Bool checkExistsOnMethod
          (True|False) Specifies whether the container checks for the existence of a bean for each method call.
 Constants.Bool clientsOnSameServer
          (True|False) Specifies whether the clients are colocated with the EJB on the same server.
 Constants.Bool clusterInvalidationDisabled
          cluster invalidation disabled
 Constants.ConcurrencyStrategy concurrencyStrategy
          (ReadOnly|Exclusive|Database|Optimistic) Defines the concurrency strategy for this bean.
 Entity.DatabaseType databaseType
          (DB2|Informix|Oracle|SQLServer|Sybase|PointBase|SQLServer2000) Specifies the database type of the underlying DBMS.
 String dataSourceName
          Names the DataSource declared in config.xml.
 Constants.Bool dbIsShared
          (True|False)
 String defaultDbmsTablesDdl
          Specifies the DDL file name.
 Constants.TransactionAttribute defaultTransaction
          (NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Sets the default transaction attribute to be applied to all methods that do not have a transaction attribute setting.
 Entity.DelayDatabaseInsertUntil delayDatabaseInsertUntil
          (ejbCreate|ejbPostCreate)
 Constants.Bool delayUpdatesUntilEndOfTx
          (True|False) Determines whether updates will be sent after the transaction has been committed.
 String disableWarning
          A comma-separated line of warnings to disable when running ejbc.
 String dispatchPolicy
          Specifies the dispatch policy queue for this bean.
 Constants.Bool enableBatchOperations
          (True|False) Determines whether to perform batch operations.
 Constants.Bool enableCallByReference
          (True|False) Specifies whether the container will call this EJB by reference.
 Constants.Bool enableDynamicQueries
          (True|False) Specifies whether dynamic queries are enabled.
 Constants.Bool findersLoadBean
          (True|False) If set to True, the beans will immediately be loaded into the cache by the finder.
 String homeCallRouterClassName
          Names the class to be used for routing home method calls.
 Constants.Bool homeIsClusterable
          (True|False) Determines whether this bean can be deployed from multiple servers in a cluster.
 Constants.HomeLoadAlgorithm homeLoadAlgorithm
          (RoundRobin|Random|WeightBased|RoundRobinAffinity|RandomAffinity|WeightBasedAffinity) Specifies the algorithm to use for load-balancing between replicas of this home.
 String idleTimeoutSeconds
          Sets the maximum duration an EJB should stay in the cache, in seconds.
 String initialBeansInFreePool
          Specifies the initial number of beans in the free pool.
 Entity.InstanceLockOrder instanceLockOrder
          (AccessOrder|ValueOrder) The locking order for this Entity bean.
 String invalidationTarget
          Targets the ejb-name of a read-only Entity bean to be invalidated when this Container-Managed Persistence Entity EJB is modified.
 String lockOrder
          Sets the database locking order of this bean when a transaction involves multiple beans.
 String maxBeansInCache
          Sets the maximum number of beans in cache.
 String maxBeansInFreePool
          Specifies the maximum number of beans in the free pool.
 String networkAccessPoint
          Assigns a custom network channel that the EJB will use for network communications.
 String optimisticColumn
          Specifies the column that holds the timestamp for optimistic concurrency.
 Constants.Bool orderDatabaseOperations
          (True|False) Determines whether to sort the database operations.
 Entity.PersistenceType persistenceType
          (cmp|bmp) Sets the type of this Entity bean (default: cmp).
 Constants.Bool primKeyClassNogen
          (True|False) If this keyword is specified, EJBGen will not generate the primary key class (it is assumed that you are providing it).
 String readTimeoutSeconds
          Sets the number of seconds between each ejbLoad() call on a read-only Entity bean.
 Constants.Bool reentrant
          (True|False)
 String remoteClientTimeout
          remote client timeout
 String runAs
          Specifies the role-name for this EJB.
 String runAsIdentityPrincipal
          Gives the name of the principal in case the role maps to several principals.
 String runAsPrincipalName
          Gives the name of the principal in case the role maps to several principals.
 String tableName
          Names the table to which this Entity bean is mapped.
 String timerPersistenceStore
          Deprecated. Use Entity.timerPersistentStore() instead.
 String timerPersistentStore
          Specifies the name of a persistent store on the server's file system where WebLogic Server stores timer objects.
 String transTimeoutSeconds
          Sets the transaction timeout (in seconds).
 String unknownPrimaryKeyField
          The cmp fields to use as the primary key when the primary key is not specified.
 Constants.Bool useCallerIdentity
          (True|False) Determines whether or not this EJB uses the callers identity.
 Constants.Bool useSelectForUpdate
          (True|False) If true, causes SELECT ...
 Entity.ValidateDBSchemaWith validateDbSchemaWith
          (MetaData|TableQuery) Specifies the method used to validate the tables created by the EJB container.
 Entity.VerifyColumns verifyColumns
          (Read|Modified|Version|Timestamp) Specifies how optimistic concurrency verifies that the columns have or have not been modified during transactions.
 Entity.VerifyRows verifyRows
          (Read|Modified) Specifies the rows in a table that should be checked when optimistic concurrency is used.
 

Element Detail

ejbName

public abstract String ejbName
Names this Entity bean.


primKeyClass

public abstract String primKeyClass
Names the Java class of the primary key. In case of a compound primary key, this class will be generated by EJBGen.

tableName

public abstract String tableName
Names the table to which this Entity bean is mapped.

Default:
"UNSPECIFIED"

verifyRows

public abstract Entity.VerifyRows verifyRows
(Read|Modified) Specifies the rows in a table that should be checked when optimistic concurrency is used.

Default:
weblogic.ejbgen.Entity.VerifyRows.UNSPECIFIED

clientsOnSameServer

public abstract Constants.Bool clientsOnSameServer
(True|False) Specifies whether the clients are colocated with the EJB on the same server.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

invalidationTarget

public abstract String invalidationTarget
Targets the ejb-name of a read-only Entity bean to be invalidated when this Container-Managed Persistence Entity EJB is modified.

Default:
"UNSPECIFIED"

useCallerIdentity

public abstract Constants.Bool useCallerIdentity
(True|False) Determines whether or not this EJB uses the callers identity.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

cacheBetweenTransactions

public abstract Constants.Bool cacheBetweenTransactions
(True|False) Specifies whether to cache the persistent data of an entity bean across (between) transactions.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

defaultDbmsTablesDdl

public abstract String defaultDbmsTablesDdl
Specifies the DDL file name.

Default:
"UNSPECIFIED"

defaultTransaction

public abstract Constants.TransactionAttribute defaultTransaction
(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Sets the default transaction attribute to be applied to all methods that do not have a transaction attribute setting.

Default:
weblogic.ejbgen.Constants.TransactionAttribute.UNSPECIFIED

checkExistsOnMethod

public abstract Constants.Bool checkExistsOnMethod
(True|False) Specifies whether the container checks for the existence of a bean for each method call.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

optimisticColumn

public abstract String optimisticColumn
Specifies the column that holds the timestamp for optimistic concurrency.

Default:
"UNSPECIFIED"

orderDatabaseOperations

public abstract Constants.Bool orderDatabaseOperations
(True|False) Determines whether to sort the database operations.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

runAsIdentityPrincipal

public abstract String runAsIdentityPrincipal
Gives the name of the principal in case the role maps to several principals.

Default:
"UNSPECIFIED"

runAsPrincipalName

public abstract String runAsPrincipalName
Gives the name of the principal in case the role maps to several principals.

Default:
"UNSPECIFIED"

delayDatabaseInsertUntil

public abstract Entity.DelayDatabaseInsertUntil delayDatabaseInsertUntil
(ejbCreate|ejbPostCreate)

Default:
weblogic.ejbgen.Entity.DelayDatabaseInsertUntil.UNSPECIFIED

enableCallByReference

public abstract Constants.Bool enableCallByReference
(True|False) Specifies whether the container will call this EJB by reference.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

validateDbSchemaWith

public abstract Entity.ValidateDBSchemaWith validateDbSchemaWith
(MetaData|TableQuery) Specifies the method used to validate the tables created by the EJB container.

Default:
weblogic.ejbgen.Entity.ValidateDBSchemaWith.UNSPECIFIED

dispatchPolicy

public abstract String dispatchPolicy
Specifies the dispatch policy queue for this bean.

Default:
"UNSPECIFIED"

lockOrder

public abstract String lockOrder
Sets the database locking order of this bean when a transaction involves multiple beans.

Default:
"UNSPECIFIED"

findersLoadBean

public abstract Constants.Bool findersLoadBean
(True|False) If set to True, the beans will immediately be loaded into the cache by the finder.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

concurrencyStrategy

public abstract Constants.ConcurrencyStrategy concurrencyStrategy
(ReadOnly|Exclusive|Database|Optimistic) Defines the concurrency strategy for this bean.

Default:
weblogic.ejbgen.Constants.ConcurrencyStrategy.UNSPECIFIED

persistenceType

public abstract Entity.PersistenceType persistenceType
(cmp|bmp) Sets the type of this Entity bean (default: cmp).

Default:
weblogic.ejbgen.Entity.PersistenceType.UNSPECIFIED

maxBeansInCache

public abstract String maxBeansInCache
Sets the maximum number of beans in cache.

Default:
"UNSPECIFIED"

primKeyClassNogen

public abstract Constants.Bool primKeyClassNogen
(True|False) If this keyword is specified, EJBGen will not generate the primary key class (it is assumed that you are providing it).

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

initialBeansInFreePool

public abstract String initialBeansInFreePool
Specifies the initial number of beans in the free pool.

Default:
"UNSPECIFIED"

verifyColumns

public abstract Entity.VerifyColumns verifyColumns
(Read|Modified|Version|Timestamp) Specifies how optimistic concurrency verifies that the columns have or have not been modified during transactions.

Default:
weblogic.ejbgen.Entity.VerifyColumns.UNSPECIFIED

idleTimeoutSeconds

public abstract String idleTimeoutSeconds
Sets the maximum duration an EJB should stay in the cache, in seconds.

Default:
"UNSPECIFIED"

transTimeoutSeconds

public abstract String transTimeoutSeconds
Sets the transaction timeout (in seconds).

Default:
"UNSPECIFIED"

enableBatchOperations

public abstract Constants.Bool enableBatchOperations
(True|False) Determines whether to perform batch operations.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

maxBeansInFreePool

public abstract String maxBeansInFreePool
Specifies the maximum number of beans in the free pool.

Default:
"UNSPECIFIED"

disableWarning

public abstract String disableWarning
A comma-separated line of warnings to disable when running ejbc.

Default:
"UNSPECIFIED"

readTimeoutSeconds

public abstract String readTimeoutSeconds
Sets the number of seconds between each ejbLoad() call on a read-only Entity bean.

Default:
"UNSPECIFIED"

databaseType

public abstract Entity.DatabaseType databaseType
(DB2|Informix|Oracle|SQLServer|Sybase|PointBase|SQLServer2000) Specifies the database type of the underlying DBMS.

Default:
weblogic.ejbgen.Entity.DatabaseType.UNSPECIFIED

reentrant

public abstract Constants.Bool reentrant
(True|False)

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

homeLoadAlgorithm

public abstract Constants.HomeLoadAlgorithm homeLoadAlgorithm
(RoundRobin|Random|WeightBased|RoundRobinAffinity|RandomAffinity|WeightBasedAffinity) Specifies the algorithm to use for load-balancing between replicas of this home.

Default:
weblogic.ejbgen.Constants.HomeLoadAlgorithm.UNSPECIFIED

delayUpdatesUntilEndOfTx

public abstract Constants.Bool delayUpdatesUntilEndOfTx
(True|False) Determines whether updates will be sent after the transaction has been committed.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

runAs

public abstract String runAs
Specifies the role-name for this EJB.

Default:
"UNSPECIFIED"

abstractSchemaName

public abstract String abstractSchemaName
Gives the abstract schema name for this EJB. If not specified, the ejb-name value will be used.

Default:
"UNSPECIFIED"

dbIsShared

public abstract Constants.Bool dbIsShared
(True|False)

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

enableDynamicQueries

public abstract Constants.Bool enableDynamicQueries
(True|False) Specifies whether dynamic queries are enabled.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

homeIsClusterable

public abstract Constants.Bool homeIsClusterable
(True|False) Determines whether this bean can be deployed from multiple servers in a cluster.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

dataSourceName

public abstract String dataSourceName
Names the DataSource declared in config.xml.

Default:
"UNSPECIFIED"

useSelectForUpdate

public abstract Constants.Bool useSelectForUpdate
(True|False) If true, causes SELECT ... FOR UPDATE to be used whenever the bean is loaded from the database.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

instanceLockOrder

public abstract Entity.InstanceLockOrder instanceLockOrder
(AccessOrder|ValueOrder) The locking order for this Entity bean.

Default:
weblogic.ejbgen.Entity.InstanceLockOrder.UNSPECIFIED

clusterInvalidationDisabled

public abstract Constants.Bool clusterInvalidationDisabled
cluster invalidation disabled

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

remoteClientTimeout

public abstract String remoteClientTimeout
remote client timeout

Default:
"UNSPECIFIED"

homeCallRouterClassName

public abstract String homeCallRouterClassName
Names the class to be used for routing home method calls.

Default:
"UNSPECIFIED"

networkAccessPoint

public abstract String networkAccessPoint
Assigns a custom network channel that the EJB will use for network communications. A network channel defines a set of connection attributes

Default:
"UNSPECIFIED"

unknownPrimaryKeyField

public abstract String unknownPrimaryKeyField
The cmp fields to use as the primary key when the primary key is not specified.

Default:
"UNSPECIFIED"

timerPersistenceStore

public abstract String timerPersistenceStore
Deprecated. Use Entity.timerPersistentStore() instead.

Default:
"UNSPECIFIED"

timerPersistentStore

public abstract String timerPersistentStore
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, WebLogic Server stores timer objects in the default store.

Default:
"UNSPECIFIED"

Copyright 1996, 2014, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02