|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.BTTOperation
com.ibm.btt.base.BTTServerOperation
com.ibm.btt.automaton.html.DSEHtmlProcessorOperation
public class DSEHtmlProcessorOperation
This class represents a virtual processor manager for the Homebanking HTML Client. It enables processes to be run over multiple invocations across the HTML C/S Mechanism without having to maintain the processor object on the server machine. This class provides for persistence of a processor object so that it can be reinstantiated in the state it was in on the last CS invocation. The class also provides for updating the processor context with data obtained on each invocation across the CS mechanism.
Field Summary | |
---|---|
static java.lang.String |
ILLEGALSWITCH
|
static java.lang.String |
NORMAL
|
Fields inherited from class com.ibm.btt.base.BTTOperation |
---|
aOperationRepliedListener, COMPID, externalizer |
Constructor Summary | |
---|---|
DSEHtmlProcessorOperation()
DSEHtmlProcessorOperation constructor. |
|
DSEHtmlProcessorOperation(java.lang.String anOperationName)
DSEHtmlProcessorOperation constructor. |
|
DSEHtmlProcessorOperation(java.lang.String anOperationName,
Context aParentContext)
DSEHtmlProcessorOperation constructor. |
|
DSEHtmlProcessorOperation(java.lang.String anOperationName,
java.lang.String aParentContext)
DSEHtmlProcessorOperation constructor. |
Method Summary | |
---|---|
static void |
chainToApplicationSessionContext(Context context,
java.lang.String sessionId,
java.lang.String applicationId)
This utility method chains the supplied context to the session context identified by the sessionId argument. |
static void |
chainToSessionContext(Context context,
java.lang.String sessionId)
This utility method chains the supplied context to the session context identified by the sessionId argument. |
protected boolean |
checkBackClick(java.lang.String currentPageId,
java.lang.String previousPageId)
This utility method checks to see if this invocation of the processor operation has occured as a result of a back click by the user (either by using the browser navigation bar, or browser history or by typing a previously viewed URL in the location bar). |
protected boolean |
checkLegalSwitch(Processor processor,
java.lang.String processorState)
This is a utility method that checks to see whether it is legal (from the point of view of consequentiality) for this processor to be put in the state specified by the supplied state name. |
void |
close()
Closes the processor operation. |
void |
closeProcessor(Processor processor)
This is equivalent of calling closeProcessor(Processor, false) |
void |
closeProcessor(Processor processor,
boolean removeParents)
Closes the processor supplied to it as argument. |
void |
closeWithoutCleanProcessor()
Closes the processor operation. |
protected Processor |
createProcessor(java.lang.String processorName)
Creates a processor object of the type specified by the name argument supplied to it. |
Processor |
createSubProcessor(java.lang.String procName,
Processor parent)
Creates a sub processor for the supplied processor object using the supplied processor name. |
protected void |
doDataMapping(DataMapperFormat format,
Context sourceCtx,
Context targetCtx)
This utility method maps data from the source context to the target context using the supplied DataMapperFormat. |
protected void |
doDataMapping(Tag formatTag,
Context sourceCtx,
Context targetCtx)
This utility method maps data from the source context to the target context using the supplied DataMapperFormat. |
void |
execute(java.lang.String eventName)
Serves as the entry point for executing the processor object currently being managed by the processor operation. |
Context |
getContext()
|
protected Processor |
getParent(Processor processor)
Obtains the parent processor, if it exists, for the processor supplied as argument. |
Processor |
getProcessor()
Returns the processor object currently being managed. |
java.lang.String |
getResponseId()
Returns the current response ID existing in the toolkit. |
java.lang.String |
getStatus()
Returns the status attributes of this object. |
protected java.lang.String |
getValidEventName(Processor currentProcessor,
Processor parentProcessor,
java.lang.String currentEventName)
Returns a valid notifier name. |
protected java.lang.Object |
getValueFromContext(Context context,
java.lang.String name,
boolean required)
This utility method attempts to obtain the value corresponding to the supplied name from the supplied context. |
protected java.lang.Object |
getValueFromKColl(KeyedCollection coll,
java.lang.String name,
boolean required)
This utility method attempts to obtain the value corresponding to the supplied name from the supplied collection. |
void |
initializeProcessor(KeyedCollection coll)
Creates or restores a processor object. |
protected boolean |
isEmpty(java.lang.String s)
Checks for an empty string by first checking if the string is null and then checking if it contains any characters. |
protected boolean |
isEmpty(java.lang.String string,
boolean trim)
Checks for an empty string by first checking if the string is null then checking if it contains any characters. |
boolean |
isProcessorSaved()
Returns the processorSaved. |
protected void |
mapDataFromChild(Processor child,
Processor parent,
java.lang.String exitEventName)
This utility method maps data from a child processor to its parent upon the child processor's completion. |
protected boolean |
processorHasParent(DSEHtmlProcessor processor)
Checks to see if the processor supplied as argument has a parent. |
protected boolean |
processorHasParent(Processor processor)
Checks to see if the processor supplied as argument has a parent. |
boolean |
replaceCtxIfNeeded()
Gets the transition context from the processor context (which is only stored there if there is a skipValidation transition), chains the transition context to the processor context, and removes the transition context from the processor context. |
void |
setFinalResponseId(java.lang.String id)
Sets the reply page. |
void |
setProcessor(Processor processor)
Sets the processor object to be managed. |
void |
setProcessorSaved(boolean processorSaved)
Sets the processorSaved. |
void |
setResponseId(java.lang.String id)
Sets the response ID to be set into the HTML Client toolkit. |
void |
setStatus(java.lang.String newStatus)
Sets the status of this object. |
void |
startSubProcessor(java.lang.String processorName)
This is a utility method for creating and executing a subprocessor. |
boolean |
updateContext(KeyedCollection collection)
Requests that the processor (which this processor operation is handling) update its context with the data supplied in the collection supplied as argument. |
boolean |
updateContext(KeyedCollection collection,
java.lang.String convType)
Requests that the processor (which this processor operation is handling) update its context with the data supplied in the collection supplied as argument. |
void |
updateLocale(java.lang.String localeString)
|
Methods inherited from class com.ibm.btt.base.BTTServerOperation |
---|
createOperation, execute, getCSReplyFormat, getCSRequestFormat, getOriginWorkstation, runInSession, setCSReplyFormat, setCSRequestFormat, setOriginWorkstation, validate, validate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.btt.base.Operation |
---|
addElement, addOperationRepliedListener, chainTo, getApplicationId, getContextName, getElementAt, getFormat, getFormats, getKeyedCollection, getName, getParent, getService, getType, getValueAt, isChained, prune, removeAt, removeOperationRepliedListener, setApplicationId, setContext, setContextName, setKeyedCollection, setName, setType, setValueAt, unchain, xValidate |
Methods inherited from interface com.ibm.btt.base.Cacheable |
---|
isCacheable, reinitialize |
Field Detail |
---|
public static final java.lang.String NORMAL
public static final java.lang.String ILLEGALSWITCH
Constructor Detail |
---|
public DSEHtmlProcessorOperation()
public DSEHtmlProcessorOperation(java.lang.String anOperationName) throws java.io.IOException
anOperationName
- java.lang.String
java.io.IOException
public DSEHtmlProcessorOperation(java.lang.String anOperationName, java.lang.String aParentContext) throws java.io.IOException, DSEObjectNotFoundException, DSEInvalidRequestException
anOperationName
- java.lang.StringaParentContext
- java.lang.String
java.io.IOException
DSEObjectNotFoundException
DSEInvalidRequestException
public DSEHtmlProcessorOperation(java.lang.String anOperationName, Context aParentContext) throws java.io.IOException, DSEInvalidRequestException
anOperationName
- java.lang.StringaParentContext
- com.ibm.btt.base.Context
java.io.IOException
DSEInvalidRequestException
Method Detail |
---|
public static void chainToApplicationSessionContext(Context context, java.lang.String sessionId, java.lang.String applicationId) throws DSEException
processor
- com.ibm.btt.base.ContextsessionId
- java.lang.String
DSEException
public static void chainToSessionContext(Context context, java.lang.String sessionId) throws DSEException
processor
- com.ibm.btt.base.ContextsessionId
- java.lang.String
DSEException
protected boolean checkBackClick(java.lang.String currentPageId, java.lang.String previousPageId)
pageId
- java.lang.StringlastPageId
- java.lang.String
protected boolean checkLegalSwitch(Processor processor, java.lang.String processorState)
processor
- com.ibm.btt.automaton.ProcessorprocessorState
- java.lang.String
public void close() throws DSEInvalidRequestException, DSEObjectNotFoundException
close
in interface ProcessorOperation
close
in interface Operation
close
in class BTTOperation
DSEInvalidRequestException
com.ibm.btt.base.DSEDSEObjectNotFoundException
DSEObjectNotFoundException
public void closeProcessor(Processor processor)
closeProcessor
in interface ProcessorOperation
processor
- com.ibm.btt.automaton.Processorpublic void closeProcessor(Processor processor, boolean removeParents)
processor
- com.ibm.btt.automaton.ProcessorremoveParents
- booleanpublic void closeWithoutCleanProcessor() throws DSEInvalidRequestException, DSEObjectNotFoundException
DSEInvalidRequestException
com.ibm.btt.base.DSEDSEObjectNotFoundException
DSEObjectNotFoundException
protected Processor createProcessor(java.lang.String processorName) throws DSEHtmlCreateProcessorException
processorName
- java.lang.String
DSEHtmlCreateProcessorException
public Processor createSubProcessor(java.lang.String procName, Processor parent) throws DSEHtmlCreateProcessorException
procName
- java.lang.Stringparent
- com.ibm.btt.automaton.Processor
DSEHtmlCreateProcessorException
protected void doDataMapping(DataMapperFormat format, Context sourceCtx, Context targetCtx) throws DSEException
format
- com.ibm.btt.base.DataMapperFormatsourceCtx
- com.ibm.btt.base.ContexttargetCtx
- com.ibm.btt.base.Context
DSEException
protected void doDataMapping(Tag formatTag, Context sourceCtx, Context targetCtx) throws DSEException
format
- com.ibm.btt.base.DataMapperFormatsourceCtx
- com.ibm.btt.base.ContexttargetCtx
- com.ibm.btt.base.Context
DSEException
public void execute(java.lang.String eventName) throws DSEException, DSEInvalidArgumentException
execute
in interface ProcessorOperation
eventName
- java.lang.String
DSEException
DSEInvalidArgumentException
public Context getContext()
getContext
in interface Operation
getContext
in class BTTOperation
protected Processor getParent(Processor processor)
processor
- com.ibm.btt.automaton.Processor
public Processor getProcessor()
getProcessor
in interface ProcessorOperation
public java.lang.String getResponseId() throws DSEException
getResponseId
in interface ProcessorOperation
DSEException
public java.lang.String getStatus()
getStatus
in interface ProcessorOperation
protected java.lang.String getValidEventName(Processor currentProcessor, Processor parentProcessor, java.lang.String currentEventName)
eventName
- java.lang.StringtypePage
- boolean
protected java.lang.Object getValueFromContext(Context context, java.lang.String name, boolean required) throws DSEException
context
- com.ibm.btt.base.Contextname
- java.lang.Stringrequired
- boolean
DSEException
protected java.lang.Object getValueFromKColl(KeyedCollection coll, java.lang.String name, boolean required) throws DSEException
coll
- com.ibm.btt.base.KeyedCollectionname
- java.lang.Stringrequired
- boolean
DSEException
public void initializeProcessor(KeyedCollection coll) throws DSEException
If a processor id is supplied, this method makes an attempt to load the processor from storage. If the processor ID is not supplied and the processor name is, this method creates a new processor object corresponding to the name. An error results if neither the processor ID nor processor name are supplied. Once the method obtains a processor object, its state is changed to the one specified in the keyed collection.
initializeProcessor
in interface ProcessorOperation
coll
- com.ibm.btt.base.KeyedCollection
DSEException
protected boolean isEmpty(java.lang.String s)
s
- java.lang.String
protected boolean isEmpty(java.lang.String string, boolean trim)
string
- java.lang.Stringtrim
- boolean
protected void mapDataFromChild(Processor child, Processor parent, java.lang.String exitEventName) throws DSEException
child
- com.ibm.btt.automaton.Processorparent
- com.ibm.btt.automaton.ProcessorexitEventName
- java.lang.String
DSEException
protected boolean processorHasParent(DSEHtmlProcessor processor)
processor
- com.ibm.btt.automaton.html.DSEHtmlProcessor
protected boolean processorHasParent(Processor processor)
processor
- com.ibm.btt.automaton.html.DSEHtmlProcessor
public boolean replaceCtxIfNeeded()
public void setFinalResponseId(java.lang.String id) throws DSEInvalidArgumentException, DSEObjectNotFoundException, DSEInvalidRequestException
id
- java.lang.String
DSEInvalidArgumentException
DSEObjectNotFoundException
DSEInvalidRequestException
public void setProcessor(Processor processor)
setProcessor
in interface ProcessorOperation
processor
- com.ibm.btt.automaton.Processorpublic void setResponseId(java.lang.String id) throws DSEInvalidArgumentException, DSEObjectNotFoundException
setResponseId
in interface ProcessorOperation
id
- java.lang.String
DSEInvalidArgumentException
DSEObjectNotFoundException
public void setStatus(java.lang.String newStatus)
setStatus
in interface ProcessorOperation
newStatus
- java.lang.Stringpublic void startSubProcessor(java.lang.String processorName) throws DSEException
processName
- java.lang.String
DSEException
public boolean updateContext(KeyedCollection collection) throws DSETypeException, DSEObjectNotFoundException, DSEInvalidArgumentException
updateContext
in interface ProcessorOperation
updateContext
in class BTTServerOperation
collection
- com.ibm.btt.base.KeyedCollection
DSETypeException
DSEObjectNotFoundException
DSEInvalidArgumentException
public boolean updateContext(KeyedCollection collection, java.lang.String convType) throws DSETypeException, DSEObjectNotFoundException, DSEInvalidArgumentException
updateContext
in class BTTServerOperation
kcReqData
- com.ibm.btt.base.KeyedCollectionconvType
- java.lang.String
DSETypeException
DSEObjectNotFoundException
DSEInvalidArgumentException
public void updateLocale(java.lang.String localeString) throws DSEObjectNotFoundException, DSEInvalidArgumentException
DSEObjectNotFoundException
DSEInvalidArgumentException
public boolean isProcessorSaved()
public void setProcessorSaved(boolean processorSaved)
processorSaved
- The processorSaved to set
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |