IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.appprofile.accessintent
Interface AccessIntent


public interface AccessIntent

This interface defines the essential access intents available at runtime. The intents are specified in a named component profile and selected by the EJB container at runtime by mapping an application profile task name to the set of available component policies.


Field Summary
static int ACCESS_TYPE_READ
           
static int ACCESS_TYPE_UPDATE
           
static int COLLECTION_SCOPE_ACTIVITYSESSION
           
static int COLLECTION_SCOPE_TRANSACTION
           
static int CONCURRENCY_CONTROL_OPTIMISTIC
           
static int CONCURRENCY_CONTROL_PESSIMISTIC
           
static int DEFERRED_OPERATION_ALL
           
static int DEFERRED_OPERATION_CREATE_ONLY
           
static int DEFERRED_OPERATION_NONE
           
static int PARTIAL_OPERATION_BOTH
           
static int PARTIAL_OPERATION_NONE
           
static int PARTIAL_OPERATION_UPDATE_ONLY
           
static int PESSIMISTIC_UPDATE_LOCK_HINT_EXCLUSIVE
           
static int PESSIMISTIC_UPDATE_LOCK_HINT_NOCOLLISION
           
static int PESSIMISTIC_UPDATE_LOCK_HINT_NONE
           
static int PESSIMISTIC_UPDATE_LOCK_HINT_WEAKEST_LOCK_AT_LOAD
           
static int VERIFY_READ_ONLY_DATA_AT_TRAN_BEGIN
           
static int VERIFY_READ_ONLY_DATA_AT_TRAN_END
           
static int VERIFY_READ_ONLY_DATA_NONE
           
 
Method Summary
 int getAccessType()
          Returns access type intent, which indicates the application intends either update or read accesss of the current component in the context of the current transaction.
 boolean getBatch()
          Persistence Option 2: Returns batch intent, which indicates: when DEFERRED_OPERATION_ALL, using database batch update or not to flush the database operations
 int getCollectionIncrement()
          Returns the number of elements the application requests be contained in each segment of the element collection returned by the currently executing finder.
 int getCollectionScope()
          Returns the collection scope, which indicates the maximum lifespan of a lazy collection.
 int getConcurrencyControl()
          Returns the concurrency control intent, which indicates the application prefers either pessimistic or optimistic concurrency control when accessing the current component in the context of the current transaction.
 int getDeferredOperation()
          Persistence Option 1: Returns deferred operation intent, which indicates: DEFERRED_OPERATION_NONE: all ejbCreate/ejbStore/ejbRemove goes immediately to database DEFERRED_OPERATION_CREATE_ONLY , ejbCreate will not insert row into database, but wait till the next ejbStore DEFERRED_OPERATION_ALL, all ejbCreate/ejbStore/ejbRemove will not go to database, until a flush is needed (at the end of transaction or before a finder) current component in the context of the current transaction.
 int getPartialOperation()
          Persistence Option 3: Returns deferred operation intent, which indicates: DPARTIAL_OPERATION_NONE: ejbLoad/ejbStore will load and store all the fields DPARTIAL_OPERATION_UPDATE_ONLY: ejbStore will store partial fields by group DPARTIAL_OPERATION_BOTH: ejbLoad/ejbStore will both load and store partial fields by group
 int getPartialOperationGroup()
          Persistence Option 4: Returns partial operation group intent, which indicates When partial operation is not NONE, use the group index determine which set of the fields are loaded or stored
 boolean getPessimisticUpdateHintExclusive()
          Deprecated.  
 boolean getPessimisticUpdateHintNoCollision()
          Deprecated.  
 boolean getPessimisticUpdateHintWeakestLockAtLoad()
          Deprecated.  
 int getPessimisticUpdateLockHint()
           
 ReadAheadHint getReadAheadHint()
          Returns the ReadAheadHint requested by the application for the currently executing finder.
 int getResourceManagerPreFetchIncrement()
          Returns the number of elements the application requests be contained in each segment of a a query made on a database.
 int getVerifyReadOnlyData()
          Persistence Option 5: Returns verify read only data intent, which indicates When LifeTimeInCache is set, when to verify the read only data: VERIFY_READ_ONLY_DATA_NONE: read only data will not be verified VERIFY_READ_ONLY_DATA_AT_TRAN_BEGIN: during ejbLoad, verify the readonly data with database to see if data changed.
 

Field Detail

CONCURRENCY_CONTROL_PESSIMISTIC

static final int CONCURRENCY_CONTROL_PESSIMISTIC
See Also:
Constant Field Values

CONCURRENCY_CONTROL_OPTIMISTIC

static final int CONCURRENCY_CONTROL_OPTIMISTIC
See Also:
Constant Field Values

ACCESS_TYPE_UPDATE

static final int ACCESS_TYPE_UPDATE
See Also:
Constant Field Values

ACCESS_TYPE_READ

static final int ACCESS_TYPE_READ
See Also:
Constant Field Values

PESSIMISTIC_UPDATE_LOCK_HINT_NOCOLLISION

static final int PESSIMISTIC_UPDATE_LOCK_HINT_NOCOLLISION
See Also:
Constant Field Values

PESSIMISTIC_UPDATE_LOCK_HINT_WEAKEST_LOCK_AT_LOAD

static final int PESSIMISTIC_UPDATE_LOCK_HINT_WEAKEST_LOCK_AT_LOAD
See Also:
Constant Field Values

PESSIMISTIC_UPDATE_LOCK_HINT_NONE

static final int PESSIMISTIC_UPDATE_LOCK_HINT_NONE
See Also:
Constant Field Values

PESSIMISTIC_UPDATE_LOCK_HINT_EXCLUSIVE

static final int PESSIMISTIC_UPDATE_LOCK_HINT_EXCLUSIVE
See Also:
Constant Field Values

COLLECTION_SCOPE_TRANSACTION

static final int COLLECTION_SCOPE_TRANSACTION
See Also:
Constant Field Values

COLLECTION_SCOPE_ACTIVITYSESSION

static final int COLLECTION_SCOPE_ACTIVITYSESSION
See Also:
Constant Field Values

DEFERRED_OPERATION_NONE

static final int DEFERRED_OPERATION_NONE
See Also:
Constant Field Values

DEFERRED_OPERATION_CREATE_ONLY

static final int DEFERRED_OPERATION_CREATE_ONLY
See Also:
Constant Field Values

DEFERRED_OPERATION_ALL

static final int DEFERRED_OPERATION_ALL
See Also:
Constant Field Values

PARTIAL_OPERATION_NONE

static final int PARTIAL_OPERATION_NONE
See Also:
Constant Field Values

PARTIAL_OPERATION_UPDATE_ONLY

static final int PARTIAL_OPERATION_UPDATE_ONLY
See Also:
Constant Field Values

PARTIAL_OPERATION_BOTH

static final int PARTIAL_OPERATION_BOTH
See Also:
Constant Field Values

VERIFY_READ_ONLY_DATA_NONE

static final int VERIFY_READ_ONLY_DATA_NONE
See Also:
Constant Field Values

VERIFY_READ_ONLY_DATA_AT_TRAN_BEGIN

static final int VERIFY_READ_ONLY_DATA_AT_TRAN_BEGIN
See Also:
Constant Field Values

VERIFY_READ_ONLY_DATA_AT_TRAN_END

static final int VERIFY_READ_ONLY_DATA_AT_TRAN_END
See Also:
Constant Field Values
Method Detail

getConcurrencyControl

int getConcurrencyControl()
Returns the concurrency control intent, which indicates the application prefers either pessimistic or optimistic concurrency control when accessing the current component in the context of the current transaction.


getAccessType

int getAccessType()
Returns access type intent, which indicates the application intends either update or read accesss of the current component in the context of the current transaction.


getPessimisticUpdateHintWeakestLockAtLoad

boolean getPessimisticUpdateHintWeakestLockAtLoad()
Deprecated. 

Returns a boolean where true indicates that data should be fetched with the weakest lock available; updates may result in lock escalation at store.

Returns:
true indicates the data should be fetched with the weakest lock available.

getPessimisticUpdateHintNoCollision

boolean getPessimisticUpdateHintNoCollision()
Deprecated. 

Returns a boolean where true indicates that the container should assume that there will be no collision on retrieved rows.

Returns:
true indicates the container should assume there will be no collision on retrieved rows.

getPessimisticUpdateHintExclusive

boolean getPessimisticUpdateHintExclusive()
Deprecated. 

Returns a boolean where true indicates that the container should assume that there will be collisions on retrieved rows.

Returns:
indicates the container should assume there will be collisions on retrieved rows.

getPessimisticUpdateLockHint

int getPessimisticUpdateLockHint()

getCollectionScope

int getCollectionScope()
Returns the collection scope, which indicates the maximum lifespan of a lazy collection.


getCollectionIncrement

int getCollectionIncrement()
Returns the number of elements the application requests be contained in each segment of the element collection returned by the currently executing finder.


getReadAheadHint

ReadAheadHint getReadAheadHint()
Returns the ReadAheadHint requested by the application for the currently executing finder.


getResourceManagerPreFetchIncrement

int getResourceManagerPreFetchIncrement()
Returns the number of elements the application requests be contained in each segment of a a query made on a database.


getDeferredOperation

int getDeferredOperation()
Persistence Option 1: Returns deferred operation intent, which indicates: DEFERRED_OPERATION_NONE: all ejbCreate/ejbStore/ejbRemove goes immediately to database DEFERRED_OPERATION_CREATE_ONLY , ejbCreate will not insert row into database, but wait till the next ejbStore DEFERRED_OPERATION_ALL, all ejbCreate/ejbStore/ejbRemove will not go to database, until a flush is needed (at the end of transaction or before a finder) current component in the context of the current transaction.


getBatch

boolean getBatch()
Persistence Option 2: Returns batch intent, which indicates: when DEFERRED_OPERATION_ALL, using database batch update or not to flush the database operations


getPartialOperation

int getPartialOperation()
Persistence Option 3: Returns deferred operation intent, which indicates: DPARTIAL_OPERATION_NONE: ejbLoad/ejbStore will load and store all the fields DPARTIAL_OPERATION_UPDATE_ONLY: ejbStore will store partial fields by group DPARTIAL_OPERATION_BOTH: ejbLoad/ejbStore will both load and store partial fields by group


getPartialOperationGroup

int getPartialOperationGroup()
Persistence Option 4: Returns partial operation group intent, which indicates When partial operation is not NONE, use the group index determine which set of the fields are loaded or stored


getVerifyReadOnlyData

int getVerifyReadOnlyData()
Persistence Option 5: Returns verify read only data intent, which indicates When LifeTimeInCache is set, when to verify the read only data: VERIFY_READ_ONLY_DATA_NONE: read only data will not be verified VERIFY_READ_ONLY_DATA_AT_TRAN_BEGIN: during ejbLoad, verify the readonly data with database to see if data changed. VERIFY_READ_ONLY_DATA_AT_TRAN_END: at the end of transaction m verify the readonly data with database to see if data changed.


IBM WebSphere Application ServerTM
Release 8