public interface BusinessContextService
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM copyright notice field.
|
Modifier and Type | Method and Description |
---|---|
ActivityToken | begin(ActivityData initData)
This method creates an activity with the given initialization data.
|
ActivityToken | begin(java.lang.String logonId, java.lang.String pwd, ActivityData initData)
This method returns an activity for a given valid user logon ID and password.
|
ActivityToken | begin(java.lang.String logonId, java.lang.String pwd, ActivityDataNameValuePairs initDataNVPs)
This method is the same as begin(String, String, ActivityData), but accepts initialization data as an ActivityDataNameValuePairs object, as per Web service requirements.
|
void | complete(ActivityToken token)
This method completes a given activity.
|
ActivityToken | copyActivity(ActivityToken currentToken, ActivityData sessionData)
This method creates a new activity based on the contexts associated with a given token and session data.
|
ActivityToken | copyActivity(ActivityToken currentToken, ActivityDataNameValuePairs initDataNVPs)
This method is the same as copyActivity(ActivityToken, ActivityData), but accepts session data as an ActivityDataNameValuePairs object, as per Web service requirements.
|
ActivityToken | createTransientClonedActivity(ActivityToken oldToken)
Reserved for IBM internal use.
|
void | endRequest(ActivityToken token)
Reserved for IBM internal use.
|
void | expire(ActivityToken token)
Reserved for IBM internal use.
|
ActivityToken | findActivityTokenById(java.lang.Long activityTokenId)
Reserved for IBM internal use.
|
ActivityToken | findActivityTokenForUserAndStore(java.lang.Long callerId, java.lang.Integer storeId)
Reserved for IBM internal use.
|
Context | findContext(ActivityToken token, java.lang.String strContextName)
This method finds the context with a given name that is associated with a given activity.
|
void | flushCache()
Reserved for IBM internal use.
|
java.util.Map | getContextMap(ActivityToken token)
Reserved for IBM internal use.
|
java.util.List | getContextSPIs(ActivityToken token)
Reserved for IBM internal use.
|
boolean | isContextDirty(ActivityToken token)
Reserved for IBM internal use.
|
boolean | isValidToken(ActivityToken token)
This method checks the validity of a given token.
|
ActivityToken | resolveActivity(ActivityToken token, ActivityData initData)
Reserved for IBM internal use.
|
void | rollbackRequest(ActivityToken token)
Reserved for IBM internal use.
|
void | setContextMap(ActivityToken token, java.util.Map ctxMap)
Reserved for IBM internal use.
|
void | startRequest(ActivityToken token, ActivityData sessionData)
Reserved for IBM internal use.
|
void | stopActivities(java.lang.Long nUserId)
Reserved for IBM internal use.
|
void | stopActivity(ActivityToken token)
Stop the activity.
|
void | synchronizeContexts(ActivityToken token, boolean bRequestStarted)
Reserved for IBM internal use.
|
static final java.lang.String COPYRIGHT
ActivityToken begin(ActivityData initData) throws BusinessContextServiceException
ActivityToken begin(java.lang.String logonId, java.lang.String pwd, ActivityData initData) throws BusinessContextServiceException, BusinessContextServiceAuthenticationException
ActivityToken begin(java.lang.String logonId, java.lang.String pwd, ActivityDataNameValuePairs initDataNVPs) throws ServiceException
Context findContext(ActivityToken token, java.lang.String strContextName) throws BusinessContextServiceException, BusinessContextNotFoundException
void complete(ActivityToken token) throws ServiceException
void expire(ActivityToken token) throws BusinessContextServiceException
This method marks a given activity as expired. Changes the status of the activity to E in the CTXMGMT table to indicate that the activity has expired.
void startRequest(ActivityToken token, ActivityData sessionData) throws BusinessContextServiceException
This method is called before request execution for any necessary setup. The implementation of this method will pass the session data down to the preInvoke(ActivityData) method of each business context associated with the given activity. Next, all the required parameters are extracted and used to update the context. This method is called by a local client before the processing of a request.
void endRequest(ActivityToken token) throws BusinessContextServiceException
This method is called after request execution for any necessary cleanup. The implementation of this method will, in turn, call the postInvoke(ActivityData) method of each business context associated with the given activity. This method is called by a local client after the processing of a request.
void rollbackRequest(ActivityToken token) throws BusinessContextServiceException
This method is called when a request is rolled back. The implementation of this method will, in turn, call the reset() method of each business context associated with the given activity. This method is called by a local client to indicate when a request is rolled back.
ActivityToken copyActivity(ActivityToken currentToken, ActivityData sessionData) throws BusinessContextServiceException
ActivityToken copyActivity(ActivityToken currentToken, ActivityDataNameValuePairs initDataNVPs) throws ServiceException
ActivityToken resolveActivity(ActivityToken token, ActivityData initData) throws BusinessContextServiceException
This method gets the valid activity token that is associated with a particular user and store. This method is mainly used when a user switches from one store to another. The implementation of this method will iterate through all existing activities and return an active one if possible.
ActivityToken findActivityTokenForUserAndStore(java.lang.Long callerId, java.lang.Integer storeId) throws BusinessContextServiceException
This method finds an activity token for a particular caller and store.
ActivityToken findActivityTokenById(java.lang.Long activityTokenId) throws BusinessContextServiceException
This method finds an activity token by the specified activity token id.
boolean isValidToken(ActivityToken token) throws InvalidActivityTokenException
java.util.Map getContextMap(ActivityToken token) throws BusinessContextServiceException
This method gets a map of string representations of all the contexts associated with a given activity. This method is provided for generic user support where contexts persist in a cookie instead of in a database.
void setContextMap(ActivityToken token, java.util.Map ctxMap) throws BusinessContextServiceException
This method initializes the contexts of a given activity based on a map of string representations of all of the activity's contexts. This method is provided for generic user support where contexts are persisted in cookie instead of database.
boolean isContextDirty(ActivityToken token)
This method checks whether any of the contexts associated with a given token are dirty. The implementation of this method will iterate through all the business contexts of the activity and check whether each of them is dirty. This method is used by a local client.
ActivityToken createTransientClonedActivity(ActivityToken oldToken)
This method creates a transient cloned token from a given token. The resulting token is a transient object to be used within a request and will not be persisted. Its contexts are copies of the input token's contexts. This method is used when a temporary change is required to the business context. Changes will not affect the original copies of the business context.
void stopActivities(java.lang.Long nUserId)
This method stops all activities for a given user. The implementation of this method will change the status of all active activities related to the user to 'T'. Once the status is moved from 'A' to 'T', the activity can no longer be used. This method is used to ensure that only one activity related to the given user can be active.
void stopActivity(ActivityToken token)
void flushCache()
This method flushes all activities from the activity cache for the current thread. Business contexts of an activity are cached in the Business Context Service for performance reason to save on context initialization. Activities are stored in the cache in a per thread basis. This method is called to clear the cache for the current thread at the exit point of a request.
java.util.List getContextSPIs(ActivityToken token)
This method gets all the context service provider interface objects that are associated with a given activity. This is similar to the getContextMap(ActivityToken) method, but this method returns the business context in its context service provider interface objects instead of string representations.
void synchronizeContexts(ActivityToken token, boolean bRequestStarted) throws BusinessContextServiceException
This method is called by the base context in response to various changes therein. This method, in turn, calls the recalibrate() method of each context that depends on the base context so that they can recalibrate themselves accordingly.