For use with Java applications generated by SoftwareMining's COBOL-to-Java conversion tools.

Package com.softwaremining.cics

Class SessionManager

java.lang.Object

com.softwaremining.cics.SessionManager

public class SessionManager
extends Object

for internal use only

Field Summary

Fields

Modifier and Type	Field	Description
CicsBaseService	_PreviousConvertedConversationInWaiting
ScreenBean	conversationalBean

Constructor Summary

Constructors

Constructor	Description
SessionManager()

Method Summary

Modifier and Type	Method	Description
void	addScreenRequestToBeProcessed(DisplayRequest request)
void	assignCurrentProgram(CicsBaseService cicsProgramObj)
void	assignHttpServletRequest(jakarta.servlet.http.HttpServletRequest request)	Assigned by Servlet
void	assignPreviousStringifiedDOValue(String mapSet, String mapName, String stringifiedData)	For internal use only Assign Previous Stringified DO Value Used in DATAONLY entry.
void	assignToBeInvalidatedAtEndOfSession()
void	assignTransferControlXTCLToProgramObj(CicsBaseService cicsProgramObj)
void	clearOutstandingScreenRequests()
String	getAbendCode()
AcceptResponse	getAcceptResponse()
static DisplayRequest	getButtonsForRow(int maxRowNumber)
static CommonWorkArea	getCommonWorkArea()	For internal use only The common work area (CWA) is a single control block that is allocated at system startup time and exists for the duration of that CICS JVM .
String	getCommunicationArea()
CicsBaseService	getCurrentProgram()
Dfhaid	getDfhaid()
String	getDliCurrentScreenTransId()
String	getDliNextScreenTransId()
String	getDliPackageName()
String	getDliScratchPadArea()
String	getDliScreenIOArea()	For internal Use Only
Eibaid	getEibaid()
ISMInteger	getFieldTally()
jakarta.servlet.http.HttpSession	getHttpSession()	Return the HTTPSession associated with this session the httpSession is set by PseudoCOnversationalServelets on activation of each page/session.
String	getInputMessage()
String	getJspName()
String	getLastDataSentToScreen()	for internal use only
String	getNameCodeOfNextProgramToRun()
List<DisplayRequest>	getOutstandingScreenRequests()
String	getPackageName()	Used internally by the frameworks.
DisplayRequest	getPreviousDisplayRequest()	for internal use only
String	getRedirectToHtmlPage()	for internal use only
AbstractScreen	getScreen()
long	getSessionId()
int	getTally()
TaskContext	getTaskContext()
TerminalUserArea	getTerminalUserArea(String terminalID)
int	getTerminalUserAreaLength(String terminalID)
String	getTextToDisplay()
String	getTransactionId()
TransactionWorkArea	getTransactionWorkArea()	For internal use only TWA is a User Work Area which is common to all tasks in the session.
ISMBean	getUserDAO(String name)
boolean	hasCommonWorkArea()	For internal use only
void	initializeService(CicsBaseService service, AcceptResponse acceptResponse)	EXISTING instances of EIBASE and DFHAID to program when it gets activated
void	invalidate()	forces system to perform clean up at end of the session Used to indicate to owning HttpSession to invalidate itself (ie invokes httpSession.invalidate(); )
boolean	isInvalidated()	used to indicate to owning HttpSession to invalidate itself
boolean	isToBeInvalidatedAtEndOfSession()
String	popScreenDataBuffer(String mapNmapset_Name)
jakarta.servlet.http.HttpServletRequest	retrieveHttpServletRequest()	returns the HttpServletRequest received by the Servlet engine.
String	retrievePreviousStringifiedDOValue(String mapSet, String mapName)	For internal use only Retreive previos Stringified DO Value Used in DATAONLY entry.
CicsBaseService	retrieveTransferControlXTCLToProgramObj()
void	setAbendCode(String abendCode)
void	setAcceptResponse(AcceptResponse acceptResponse)
void	setCommunicationArea(String commArea)
void	setCommunicationAreaLength(int communicationAreaLength)
void	setDliCurrentScreenTransId(String dliCurrentScreenTransId)
void	setDliNextScreenTransId(String dliNextScreenTransId)
void	setDliPackageName(String dliPackageName)
void	setDliScratchPadArea(String dliScratchPadArea)
void	setDliScreenIOArea(String dliScreenIOArea)	For internal Use Only
void	setInputMessage(String inputMessage)
void	setJspName(String jspName)
void	setLastDataSentToScreen(String dataSentWithoutMap)	for internal use only
void	setNextProgramToRun(String nextProgramToRun)
void	setPackageName(String packageName)
void	setRedirectToHtmlPage(String redirectToHtmlPage)	Redirect to a HTML page e.g setRedirectToHtmlPage("index.html"); please call sessionManager.invalidate() to ensure session information is cleared
void	setScreen(AbstractScreen screen)
void	setScreenDataBuffer(String mapNmapset_Name, String newValue)
void	setSessionId(long newSessionId)
void	setStartCode(String startCode)
void	setTally(int tally)
void	setTextToDisplay(String textToDisplay)
void	setTransactionId(String transId)
void	storeUserDAO(String name, ISMBean dao)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_PreviousConvertedConversationInWaiting

public CicsBaseService _PreviousConvertedConversationInWaiting

conversationalBean

public ScreenBean conversationalBean

Constructor Details

SessionManager

public SessionManager()

Method Details

getTaskContext

public TaskContext getTaskContext()

retrieveTransferControlXTCLToProgramObj

public CicsBaseService retrieveTransferControlXTCLToProgramObj()

assignTransferControlXTCLToProgramObj

public void assignTransferControlXTCLToProgramObj(CicsBaseService cicsProgramObj)

assignCurrentProgram

public void assignCurrentProgram(CicsBaseService cicsProgramObj)

getCurrentProgram

public CicsBaseService getCurrentProgram()

getAbendCode

public String getAbendCode()

setAbendCode

public void setAbendCode(String abendCode)

initializeService

public void initializeService(CicsBaseService service,
 AcceptResponse acceptResponse)

EXISTING instances of EIBASE and DFHAID to program when it gets activated

Parameters:

service - - the reActivated service (program)

acceptResponse - - the latest data recieved from screen

commArea - - communication Area from previous program (service)

getCommunicationArea

public String getCommunicationArea()

setCommunicationArea

public void setCommunicationArea(String commArea)

getInputMessage

public String getInputMessage()

setInputMessage

public void setInputMessage(String inputMessage)

getTransactionId

public String getTransactionId()

setTransactionId

public void setTransactionId(String transId)

getNameCodeOfNextProgramToRun

public String getNameCodeOfNextProgramToRun()

setNextProgramToRun

public void setNextProgramToRun(String nextProgramToRun)

addScreenRequestToBeProcessed

public void addScreenRequestToBeProcessed(DisplayRequest request)

getOutstandingScreenRequests

public List<DisplayRequest> getOutstandingScreenRequests()

clearOutstandingScreenRequests

public void clearOutstandingScreenRequests()

getScreen

public AbstractScreen getScreen()

setScreen

public void setScreen(AbstractScreen screen)

getPackageName

public String getPackageName()

Used internally by the frameworks.
package name of the runnable classes.
e,g something like "com.client.myapplication"

Returns:

package name of the runnable classes.

setPackageName

public void setPackageName(String packageName)

assignToBeInvalidatedAtEndOfSession

public void assignToBeInvalidatedAtEndOfSession()

isToBeInvalidatedAtEndOfSession

public boolean isToBeInvalidatedAtEndOfSession()

invalidate

public void invalidate()

forces system to perform clean up at end of the session Used to indicate to owning HttpSession to invalidate itself (ie invokes httpSession.invalidate(); )

isInvalidated

public boolean isInvalidated()

used to indicate to owning HttpSession to invalidate itself

Returns:

getDfhaid

public Dfhaid getDfhaid()

getEibaid

public Eibaid getEibaid()

setCommunicationAreaLength

public void setCommunicationAreaLength(int communicationAreaLength)

setScreenDataBuffer

public void setScreenDataBuffer(String mapNmapset_Name,
 String newValue)

popScreenDataBuffer

public String popScreenDataBuffer(String mapNmapset_Name)

getTextToDisplay

public String getTextToDisplay()

setTextToDisplay

public void setTextToDisplay(String textToDisplay)

getHttpSession

public jakarta.servlet.http.HttpSession getHttpSession()

Return the HTTPSession associated with this session
the httpSession is set by PseudoCOnversationalServelets on activation of each page/session.

Returns:

assignHttpServletRequest

public void assignHttpServletRequest(jakarta.servlet.http.HttpServletRequest request)

Assigned by Servlet

Parameters:

request -

retrieveHttpServletRequest

public jakarta.servlet.http.HttpServletRequest retrieveHttpServletRequest()

returns the HttpServletRequest received by the Servlet engine.
Access to this variable allows the application logic to directly query the request for other INPUT fields assigned in HTML - the ones which do not map to original BMS screens.

Returns:

assignPreviousStringifiedDOValue

public void assignPreviousStringifiedDOValue(String mapSet,
 String mapName,
 String stringifiedData)

For internal use only Assign Previous Stringified DO Value Used in DATAONLY entry. When A field has been sent as DATAONLY, and contains LOW_VALUES, then the previous values should be displayed

retrievePreviousStringifiedDOValue

public String retrievePreviousStringifiedDOValue(String mapSet,
 String mapName)

For internal use only Retreive previos Stringified DO Value Used in DATAONLY entry. When A field has been sent as DATAONLY, and contains LOW_VALUES, then the previous values should be displayed

setRedirectToHtmlPage

public void setRedirectToHtmlPage(String redirectToHtmlPage)

Redirect to a HTML page e.g setRedirectToHtmlPage("index.html");
please call sessionManager.invalidate() to ensure session information is cleared

Parameters:

redirectToHtmlPage -

getRedirectToHtmlPage

public String getRedirectToHtmlPage()

for internal use only

Returns:

getPreviousDisplayRequest

public DisplayRequest getPreviousDisplayRequest()

for internal use only

Returns:

getLastDataSentToScreen

public String getLastDataSentToScreen()

for internal use only

Returns:

setLastDataSentToScreen

public void setLastDataSentToScreen(String dataSentWithoutMap)

for internal use only

getSessionId

public long getSessionId()

setSessionId

public void setSessionId(long newSessionId)

getDliScreenIOArea

public String getDliScreenIOArea()

For internal Use Only

setDliScreenIOArea

public void setDliScreenIOArea(String dliScreenIOArea)

For internal Use Only

getDliScratchPadArea

public String getDliScratchPadArea()

setDliScratchPadArea

public void setDliScratchPadArea(String dliScratchPadArea)

getDliCurrentScreenTransId

public String getDliCurrentScreenTransId()

setDliCurrentScreenTransId

public void setDliCurrentScreenTransId(String dliCurrentScreenTransId)

getDliPackageName

public String getDliPackageName()

setDliPackageName

public void setDliPackageName(String dliPackageName)

getDliNextScreenTransId

public String getDliNextScreenTransId()

setDliNextScreenTransId

public void setDliNextScreenTransId(String dliNextScreenTransId)

getButtonsForRow

public static DisplayRequest getButtonsForRow(int maxRowNumber)

setStartCode

public void setStartCode(String startCode)

getTransactionWorkArea

public TransactionWorkArea getTransactionWorkArea()

For internal use only TWA is a User Work Area which is common to all tasks in the session. This is a holdover from macro-level CICS and is seldom used.

Returns:

getAcceptResponse

public AcceptResponse getAcceptResponse()

setAcceptResponse

public void setAcceptResponse(AcceptResponse acceptResponse)

getJspName

public String getJspName()

setJspName

public void setJspName(String jspName)

getCommonWorkArea

public static CommonWorkArea getCommonWorkArea()

For internal use only The common work area (CWA) is a single control block that is allocated at system startup time and exists for the duration of that CICS JVM . The size is specified configuration file using CICS_CWA_LENGTH

Returns:

getTerminalUserArea

public TerminalUserArea getTerminalUserArea(String terminalID)

getTerminalUserAreaLength

public int getTerminalUserAreaLength(String terminalID)

hasCommonWorkArea

public boolean hasCommonWorkArea()

For internal use only

Returns:

getFieldTally

public ISMInteger getFieldTally()

getTally

public int getTally()

setTally

public void setTally(int tally)

storeUserDAO

public void storeUserDAO(String name,
 ISMBean dao)

getUserDAO

public ISMBean getUserDAO(String name)