public class BusinessContextFacade
extends java.lang.Object
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.
|
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 | 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 | 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.
|
static BusinessContextFacade | getInstance()
This method returns the BusinessContextFacade singleton.
|
void | initialize()
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.
|
public static final java.lang.String COPYRIGHT
public void initialize()
This method initializes this singleton.
public static BusinessContextFacade getInstance()
public ActivityToken begin(ActivityData initData) throws BusinessContextServiceException
public ActivityToken begin(java.lang.String logonId, java.lang.String pwd, ActivityData initData) throws BusinessContextServiceException, BusinessContextServiceAuthenticationException
public Context findContext(ActivityToken token, java.lang.String strContextName) throws BusinessContextServiceException, BusinessContextNotFoundException
public 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.
public void complete(ActivityToken token) throws BusinessContextServiceException
public void startRequest(ActivityToken token, ActivityData sessionData) throws BusinessContextServiceException
This method is called before request execution for any necessary setup. It, in turn, passes the session data down to the preInvoke(ActivityData) method of each business context associated with the given activity. The preInvoke(ActivityData) method extracts all the required parameters and updates the context.
public void endRequest(ActivityToken token) throws BusinessContextServiceException
This method is called after request execution for any necessary cleanup. It, in turn, calls the postInvoke(ActivityData) method of each business context associated with the given activity.
public void rollbackRequest(ActivityToken token) throws BusinessContextServiceException
This method is called when a request is rolled back. It, in turn, calls the reset() method of each business context associated with the given activity.
public ActivityToken copyActivity(ActivityToken currentToken, ActivityData sessionData) throws BusinessContextServiceException
public 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.
public ActivityToken findActivityTokenForUserAndStore(java.lang.Long callerId, java.lang.Integer storeId) throws BusinessContextServiceException
This method finds an activity token for a particular caller and store.
public boolean isValidToken(ActivityToken token) throws InvalidActivityTokenException
public 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.
public 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.
public boolean isContextDirty(ActivityToken token)
This method checks whether any of the contexts associated with a given token are dirty.
public 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. Its contexts are copies of the input token's contexts.
public void stopActivities(java.lang.Long nUserId)
This method stops all activities for a given user.
public void flushCache()
This method flushes all activities from the activity cache for the current thread. This method is called at the exit point of a request, when contexts are no longer required.
public java.util.List getContextSPIs(ActivityToken token)
This method gets all the context service provider interface objects that are associated with a given activity.