|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.DSEOperation | +--com.ibm.dse.base.DSEServerOperation | +--com.ibm.dse.automaton.html.DSEHtmlProcessorOperation
This class represents a virtual processor manager for the Homebanking HTML Client. It allows for processes to be run over multiple invocations across the HTML CS mechanism, without having to maintain the processor object on the server machine. This class provides for persistence of a processor object such 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.dse.base.DSEOperation |
aOperationRepliedListener,
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 |
chainToSessionContext(Context context,
java.lang.String sessionId)
This utility method chains the supplied context to the session context identified by the session id 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 arisen a 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 for this processor to be put in the state specified by the supplied state name, from the point of view of consequentiality. |
void |
close()
Closes the processor operation. |
void |
closeProcessor(Processor processor)
This is equivalent of calling closeProcessor(Processor, false) |
void |
closeProcessor(Processor processor,
boolean removeParents)
This method close the processor supplied to it as argument. |
protected Processor |
createProcessor(java.lang.String processorName)
This method creates a processor object of the type specified by the name argument supplied to it. |
Processor |
createSubProcessor(java.lang.String procName,
Processor parent)
This method 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. |
void |
execute(java.lang.String eventName)
This method serves as the entry point for execution of the processor object currently being managed by the processor operation. |
protected Processor |
getParent(Processor processor)
This method obtains the parent processor, if any, 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 framework. |
java.lang.String |
getStatus()
Returns the status attributes of this object. |
protected java.lang.String |
getValidEventName(Processor currentProcessor,
Processor parentProcessor,
java.lang.String currentEventName)
This method will make something only when the event name wouldn't include a 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)
This method 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 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. |
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()
This method is used only when a HtmlTransition with its skipValidation value set to true is executed. |
void |
setFinalResponseId(java.lang.String id)
Sets the reply page. |
void |
setProcessor(Processor processor)
Sets the processor object to be managed. |
void |
setResponseId(java.lang.String id)
Sets the response id to be set into the HTML Client framework. |
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)
This method requests that the processor (which this processor operation is handling) update its context with the data supplied in the collection supplied as argument. |
Methods inherited from class com.ibm.dse.base.DSEServerOperation |
execute,
getCSReplyFormat,
getCSRequestFormat,
getOriginWorkstation,
runInSession,
setCSReplyFormat,
setCSRequestFormat,
setOriginWorkstation |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
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.Stringpublic DSEHtmlProcessorOperation(java.lang.String anOperationName, Context aParentContext) throws java.io.IOException, DSEInvalidRequestException
anOperationName
- java.lang.StringaParentContext
- com.ibm.dse.base.Contextpublic DSEHtmlProcessorOperation(java.lang.String anOperationName, java.lang.String aParentContext) throws java.io.IOException, DSEObjectNotFoundException, DSEInvalidRequestException
anOperationName
- java.lang.StringaParentContext
- java.lang.StringMethod Detail |
public static void chainToSessionContext(Context context, java.lang.String sessionId) throws DSEException
processor
- com.ibm.dse.base.ContextsessionId
- java.lang.Stringprotected boolean checkBackClick(java.lang.String currentPageId, java.lang.String previousPageId)
pageId
- java.lang.StringlastPageId
- java.lang.Stringprotected boolean checkLegalSwitch(Processor processor, java.lang.String processorState)
processor
- com.ibm.dse.automaton.ProcessorprocessorState
- java.lang.Stringpublic void close() throws DSEInvalidRequestException, DSEObjectNotFoundException
public void closeProcessor(Processor processor)
processor
- com.ibm.dse.automaton.Processorpublic void closeProcessor(Processor processor, boolean removeParents)
processor
- com.ibm.dse.automaton.ProcessorremoveParents
- booleanprotected Processor createProcessor(java.lang.String processorName) throws DSEHtmlCreateProcessorException
processorName
- java.lang.Stringpublic Processor createSubProcessor(java.lang.String procName, Processor parent) throws DSEHtmlCreateProcessorException
procName
- java.lang.Stringparent
- com.ibm.dse.automaton.Processorprotected void doDataMapping(DataMapperFormat format, Context sourceCtx, Context targetCtx) throws DSEException
format
- com.ibm.dse.base.DataMapperFormatsourceCtx
- com.ibm.dse.base.ContexttargetCtx
- com.ibm.dse.base.Contextpublic void execute(java.lang.String eventName) throws DSEException, DSEInvalidArgumentException
protected Processor getParent(Processor processor)
processor
- com.ibm.dse.automaton.Processorpublic Processor getProcessor()
public java.lang.String getResponseId() throws DSEException
public java.lang.String getStatus()
protected java.lang.String getValidEventName(Processor currentProcessor, Processor parentProcessor, java.lang.String currentEventName)
eventName
- java.lang.StringtypePage
- booleanprotected java.lang.Object getValueFromContext(Context context, java.lang.String name, boolean required) throws DSEException
context
- com.ibm.dse.base.Contextname
- java.lang.Stringrequired
- booleanprotected java.lang.Object getValueFromKColl(KeyedCollection coll, java.lang.String name, boolean required) throws DSEException
coll
- com.ibm.dse.base.KeyedCollectionname
- java.lang.Stringrequired
- booleanpublic void initializeProcessor(KeyedCollection coll) throws DSEException
coll
- com.ibm.dse.base.KeyedCollectionprotected boolean isEmpty(java.lang.String s)
s
- java.lang.Stringprotected boolean isEmpty(java.lang.String string, boolean trim)
string
- java.lang.Stringtrim
- booleanprotected void mapDataFromChild(Processor child, Processor parent, java.lang.String exitEventName) throws DSEException
child
- com.ibm.dse.automaton.Processorparent
- com.ibm.dse.automaton.ProcessorexitEventName
- java.lang.Stringprotected boolean processorHasParent(DSEHtmlProcessor processor)
processor
- com.ibm.dse.automaton.html.DSEHtmlProcessorprotected boolean processorHasParent(Processor processor)
processor
- com.ibm.dse.automaton.html.DSEHtmlProcessorpublic boolean replaceCtxIfNeeded()
public void setFinalResponseId(java.lang.String id) throws DSEInvalidArgumentException, DSEObjectNotFoundException, DSEInvalidRequestException
id
- java.lang.Stringpublic void setProcessor(Processor processor)
processor
- com.ibm.dse.automaton.Processorpublic void setResponseId(java.lang.String id) throws DSEInvalidArgumentException, DSEObjectNotFoundException
id
- java.lang.Stringpublic void setStatus(java.lang.String newStatus)
newStatus
- java.lang.Stringpublic void startSubProcessor(java.lang.String processorName) throws DSEException
processName
- java.lang.Stringpublic boolean updateContext(KeyedCollection collection) throws DSETypeException, DSEObjectNotFoundException, DSEInvalidArgumentException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |