Package com.softwaremining.cics

Class CicsBaseService

java.lang.Object

com.softwaremining.logic.BaseService

com.softwaremining.sql.ESQLBaseService

com.softwaremining.cics.CicsBaseService

All Implemented Interfaces:

EIBFNCodes, ICicsBaseService, Keyboard, IBaseService, Service, SQLHandlerInterface, IDisplayable, Runnable

Direct Known Subclasses:

DliBaseService

public abstract class CicsBaseService
extends ESQLBaseService
implements ICicsBaseService, EIBFNCodes, Keyboard

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	_RETURN_FROM_SESSION_DEFAULT_LENGTH
int	DEFAULT_HANDLER

Fields inherited from class com.softwaremining.sql.ESQLBaseService

staticLogger, totalRuntime

Fields inherited from class com.softwaremining.logic.BaseService

calledParameters, log, PARA_NAME_POSTFIX, profiled_baseService_runtimes, totalRuntime_processControlException, totalRuntime_reflection

Fields inherited from interface com.softwaremining.cics.constants.EIBFNCodes

DUPREC, EIBFN_CODE_ABEND, EIBFN_CODE_ABEND_INT, EIBFN_CODE_DELETE, EIBFN_CODE_DELETEQ_TD, EIBFN_CODE_DELETEQ_TS, EIBFN_CODE_ENDBR, EIBFN_CODE_LINK, EIBFN_CODE_LOAD, EIBFN_CODE_READ, EIBFN_CODE_READNEXT, EIBFN_CODE_READPREV, EIBFN_CODE_READQ_TD, EIBFN_CODE_READQ_TS, EIBFN_CODE_RECEIVE_MAP, EIBFN_CODE_RESETBR, EIBFN_CODE_RETURN, EIBFN_CODE_REWRITE, EIBFN_CODE_SEND_MAP, EIBFN_CODE_SEND_TEXT, EIBFN_CODE_STARTBR, EIBFN_CODE_UNLOCK, EIBFN_CODE_WRITE, EIBFN_CODE_WRITEQ_TD, EIBFN_CODE_WRITEQ_TS, EIBFN_CODE_XCTL, FILENOTFOUND, NOTOPEN, OK

Fields inherited from interface com.softwaremining.ui.IDisplayable

_FKEY_INPUT, _INVALIDATE, FKEY_1, FKEY_10, FKEY_11, FKEY_12, FKEY_2, FKEY_3, FKEY_4, FKEY_5, FKEY_6, FKEY_7, FKEY_8, FKEY_9

Fields inherited from interface com.softwaremining.cics.ui.Keyboard

CLEAR, CLRP, ENTER, MSRE, NULL, OPID, PA1, PA2, PA3, PEN, PF1, PF10, PF11, PF12, PF13, PF14, PF15, PF16, PF17, PF18, PF19, PF2, PF20, PF21, PF22, PF23, PF24, PF3, PF4, PF5, PF6, PF7, PF8, PF9, QUIT, STRF, TRIG

Fields inherited from interface com.softwaremining.sql.SQLHandlerInterface

HANDLER_CONTINUE, HANDLER_GO_TO, HANDLER_METHOD_CALL, HANDLER_NOT_INTIALIZED, HANDLER_PERFORM, HANDLER_STOP, HANDLER_THROW, SQL_SCHEMA_PROP

Constructor Summary

Constructors

Constructor	Description
CicsBaseService()	Deprecated.
CicsBaseService(CicsBaseService parent)

Method Summary

Modifier and Type	Method	Description
void	abendEnclave()	translation of CALL 'CEE3ABD' https://www.ibm.com/docs/en/zos/2.4.0?topic=services-cee3abdterminate-enclave-abend
void	abendEnclave(long abendCode, long cleanup)	translation of CALL 'CEE3ABD' https://www.ibm.com/docs/en/zos/2.4.0?topic=services-cee3abdterminate-enclave-abend# not implemented yet
void	assignBmsMapSetName(String mapName, String mapset_FileName)
void	assignChannelName(String channelName)
void	assignNetname(String netName)
void	assignSessionManager(SessionManager sessionManager)	for internal use only
void	assignThreadManagerDAO(ISMObject data)	for internal use only
void	cancelAbendHandler()
void	cicsAddress(AddressDO addressDO)	Set Address of pointers for TWA and CWA
void	cicsDefineCounter(CounterDO counterDO)	Translation of CICS DEFINE COUNTER https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.html
void	cicsDeq(DeqDO deqDO)	Deprecated.
void	cicsDocumentCreate(DocumentCreateDO param)	Deprecated. - this is a stub method
int	cicsDumpTransaction(DumpTransactionDO dumpTransactionDO)	Dumps data in DAO's as well as COMMAREA and TWA to Config.DATA_DIR /dump/timestamp[/dumpCode]
void	cicsEnq(EnqDO enqDO)	Deprecated.
void	cicsEnterTracenum(EnterTracenumDO enterTracenumDO)
int	cicsGetcounter(CounterDO counterDO)	Translation of CICS GET COUNTER https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.html
void	cicsHandleAbend(HandleAbendDO obj)	Deprecated. - this is a stub method
int	cicsPostEvent(PostEventDO postEventDO)	Deprecated. - please use com.softwaremining.cics.util.EventManager.postEvent
void	cicsQuerySecurity(QuerySecurityDO dao)	Deprecated. Use invalid reference com.softwaremining.cics.util.cicsQuerySecurity#inquire(CicsBaseService, QuerySecurityDO) instead.
protected final int	cicsRollbackSyncpoint()	translation of CICS Sync Point Rollback
void	cicsSpiInquireSystem(InquireSystemDO dao)	Deprecated. Use InquireSystemUtil.inquire(CicsBaseService, InquireSystemDO) instead.
void	cicsSpiInquireTask(InquireTaskDO inquireTaskDO)	Deprecated. Use InquireUtil.inquire(CicsBaseService, InquireDO) instead.
final int	cicsSyncpoint()
protected final int	cicsSyncpoint(SyncpointDO param)	translation of CICS Sync Point
void	cicsUnlock(UnlockDO unlockDO)	Deprecated. - this is a stub method
void	cicsVerifyPassword(VerifyPasswordDO dao)	Deprecated. Use invalid reference com.softwaremining.cics.util.cicsQuerySecurity#inquire(CicsBaseService, QuerySecurityDO) instead.
int	cicsWaitEvent(WaitEventDO waitEventDO)	Deprecated. - please use com.softwaremining.cics.util.EventManager.waitEvent
void	cicsWebExtract(WebExtractDO webextractDo)
void	cicsWebRead(WebReadDO param)	Deprecated. - this is a stub method
void	cicsWebReceive(WebReceiveDO param)	Deprecated. - this is a stub method
void	cicsWebSend(WebSendDO param)	Deprecated. - this is a stub method
void	cicsWebWrite(WebWriteDO param)	Deprecated. - this is a stub method
void	copyChanneForSTART(TaskContext prevTaskContext, String channelName)	Used By ThreadManager by EXEC CICS START statemennt
void	deactivateHandlers()
void	delay()	CICS Delay
void	delay(int seconds)	CICS Delay
void	delay(ISMNumeric seconds)
protected void	destroy()	Close connection all instances of ESQLProcessor Automatically called after exiting a program (normal exit, Go-Back).
protected void	destroyOnFatalError()	Automatically called after fatal error
void	doFinalize(boolean forceRelease, boolean releaseConnection)	Automatically called after CANCELing (ServicesFactory.cancel) running a program - it removes all wrapperLists
int	executeLink()	When there is No parameters, then the system should pass all the parameters which it had received through the Linkage-Area
int	executeLink(ISMDataType commAreaField)	Translation of CICS Link statement.
int	executeLink(ISMDataType[] commAreaDataObjects)
int	executeLink(ISMDataType commAreaDataObject, double commAreaLength)	Translation of CICS Link statement.
int	executeLinkUsingChannel(ISMString channelName)
int	executeLinkUsingChannel(String channelName)	passing CHANNEL List from caller program to this
int	executeTransferControl()	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(boolean invokeHandler)	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(ISMDataType commAreaDataObject)	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(ISMDataType commAreaDataObject, boolean invokeHandler)	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(ISMDataType newCommArea, int commAreaLength)	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(ISMDataType newCommArea, int commAreaLength, boolean invokeHandler)	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(String newCommArea)	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(String newCommArea, int commAreaLength)	Translation of CICS Xctl function: transfers control from one application program to another.
int	executeTransferControl(String newCommArea, int commAreaLength, boolean invokeHandler)	Translation of CICS Xctl function: transfers control from one application program to another.
String	getAbendCode()
AcceptResponse	getAcceptResponse()	for internal use only
String	getApplid()
CicsConditionManager	getCicsConditionManager()
String	getCicsOriginalProgramName()	CICS uses a 8 Character identifier for program names ...
String	getClassName()	used in CICS ASSIGN ...
String	getDefaultChannelName()
Dfhaid	getDfhaid()
Eibaid	getEibaid()
ISMObject	getFieldTally()
String	getInvokingProgram()	Deprecated. please use GetInvokingProgramName
String	getInvokingProgramName()
String	getKeyPressed()
int	getLengthOfTransactionWorkArea()	Deprecated. - please use lengthOfTransactionWorkArea()
String	getNetname()
String	getProgramId()
String	getProgramName()
long	getResponseCode()
String	getReturnprog()
RouteDO	getRoutedBMS()
String	getStartcode()	2byte alpha numeric to show how program was started.
String	getSysid()
int	getTally()
String	getTerminalID()
int	getTwaleng()	Deprecated. - please use lengthOfTransactionWorkArea()
String	getUserId()	used in CICS ASSIGN ...
void	ignoreCondition(int conditionNumber)
void	ignoreCondition(int[] conditionNumber)
void	initializeBaseService()	in ESQL projects commits are manually made e.g EXEC SQL COMMIT END-EXEC Hence turn the auto-commit off during initialization
void	invokeAidEventHandler()
void	invokeConditionHandler(ISMObject responseField, long responseCode, Throwable throwable)	handle the condition - when a CICS operation fails, or throw an AbnormalTerminationException code - then control will be passed to this method to determine whether a.
boolean	isAidEventManagerActive()
boolean	isCicsAutoSyncPointEnabled()
boolean	isFirstTimeExecutionAndNoParameters()	Indicates whether this the first time this program is being executed, or whether the system is re-entering this program.
boolean	isKeyPressed(String key)	check if a key has been prssed
boolean	isNeedScreenUpdate()
boolean	IsWaitingForUI()	Only used in conversion of Conversational to Pseudo-Conv Programs
int	lengthOfCommonWorkArea()
int	lengthOfTransactionWorkArea()	Returns the length of Transaction Work Area associated with this Session.
String	makeUpClassScreenSourceName()	method used internally by SoftwareMining framework
void	processCicsAbendException(Exception e)	For internal use only
void	quit()	Commit changes made by all instances of ESQLProcessor
void	reactivateHandlers()
void	reInitializeBaseService()	for internal use only used by CICS subsystem
void	resetCondition(int conditionNumber)
String	retrieveBmsMapSet_FileName()	for internal use only
CicsPersistence	retrieveCicsPersistenceForDataset(String tableName)	Retrieve the active/opened CicsPersistence DAO registered to the SQL tableName
String	retrieveDataManagerStr()	for internal use only
ACMDbDecorator	retrieveDBDecorator()
jakarta.servlet.http.HttpServletRequest	retrieveHttpServletRequest()	returns the HttpServletRequest received by the Servlet engine.
jakarta.servlet.http.HttpSession	retrieveHttpSession()	Returns associated HttpSession manager, set by PseudoCOnversationalServlet
String	retrieveJSPName()	method used internally by SoftwareMining framework
SessionManager	retrieveSessionManager()	Get the internal SoftwareMining SessionManager
String	retrieveStartCode()
TaskContext	retrieveTaskContext()
void	returnFromSession(String transId)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, ISMBean commArea)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, ISMBean commArea, int commAreaLength)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, ISMBean commArea, String inputMessage, int commAreaLength)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, String commArea)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, String commArea, int commAreaLength)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, String commArea, String inputMessage)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, String commArea, String inputMessage, int commAreaLength)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
protected void	returnFromSession(String transId, String commArea, String inputMessage, int commAreaLength, String programCode)	Translation of EXEC CICS Return. terminates program execution returning control to the invoking program (or CICS Frame work).
void	setAbendHandler(int defaultHandler, String methodName)
void	setAbendHandler(String methodName)
void	setAcceptResponse(AcceptResponse acceptResponse)
void	setAidEventHandler(String keyCode, String methodName)
void	setInvokeHelper(InvokeHelper invokeHelper)	Invoker handler provides handlers to application program Lanchers, shutdown services and Transaction Handlers
void	setKeyPressed(String key)
void	setNeedScreenUpdate(boolean needScreenUpdate)
protected void	setRespCode(int code, AbstractCBLField respCode)
void	setRoutedBMS(RouteDO routedBMS)
void	setTally(int tally)
void	setTaskContext(TaskContext tskContext)
void	setUserId(String userId)
void	setWaitingForUser(boolean waitingForUser)	Only used in conversion of Conversational to Pseudo-Conv Programs
protected void	transfuse(List<ISMDataType> in, List<ISMDataType> out, boolean back)	for internal use only

Methods inherited from class com.softwaremining.sql.ESQLBaseService

abort, closeESQLProcessors, commit, commitThrowingException, doFinalize, getESQLProcessors, populateFromLastSQLMessage, populateFromLastSQLMessage, processSQLException, processSQLException, quit, releaseESQLConnections, resetSQLCA, rollback, setErrorHandler, setErrorHandler, setErrorHandlerForward, setNotFoundHandler, setNotFoundHandler, setNotFoundHandlerForward, setSessionSchemaName, setWarningHandler, setWarningHandler

Methods inherited from class com.softwaremining.logic.BaseService

_goto, accept, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addRuntimeParameter, addRuntimeParameter, assignCallerProgram, assignCyclicBarrier, assignInstanceNumber, assignLastKeyPressed, assignLaunchedInstances, assignPCBFileName, assignTargetXMLScreen, assignUsesAnnotationBasedMethodOrdering, awaitBarrier, callJavaMethod, callJavaMethod, chain, clearCallingParameters, countCallParameters, currentDate, disableGUIScreens, doFinalize, enableReuse, execute, execute, execute, execute, execute, execute, execute, execute, executeWithPointerData, executeWithPointerData, getActiveBeanInstance, getCallerProgram, getDataWrappers, getField, getLastDisplayColumn, getLastDisplayRow, getMethodNumber, getNextPoint, getParagraph, getReportProcessorList, getReturnCode, getScreenClassName, getScreenClient, getServletRunTimeParameterFrom, getSessionId, getWrapperList, getXMLScreenDefReader, goBack, hasReflectionBasedFlowLogic, invoke, invokeRange, isCallerWaiting, isFirstInstance, isGUIScreensEnabled, isTargetXMLScreen, main, objectsAreOfTheSameClass, optimizeUsingTransfuseByReference, popNextRuntimeParameter, receiveExecuteParameter, receiveExecuteParameter, receiveExecuteParameter, receiveExecuteParameter, receiveExecuteParameter, registerDataWrapper, registerDataWrappers, registerExecuteParameters, reInitializeAllDAOs, reRegisterExecuteParameters, resetAllStructuresExcept, retrieveCalledParameters, retrieveCyclicBarrier, retrieveField, retrieveInstanceNumber, retrieveLastKeyPressed, retrieveLaunchedInstances, retrieveTotalNumberOfInstancesLaunched, run, setCallerWaiting, setCommandLineParameters, setExceptionalExitReturnCode, setHttpRequestParameterMap, setLastDisplayColumn, setLastDisplayRow, setReturnCode, setReturnCode, setReturnCode, setScreenClient, setSessionId, setUsesAnnotationBasedMethodOrdering, startUp, stop, stop, tearDown, transfuseByReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softwaremining.logic.IBaseService

_goto, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, addCallParameter, execute, execute, execute, execute, execute, execute, execute, getReturnCode, getSessionId, goBack, invoke, invokeRange, populateFromLastSQLMessage, populateFromLastSQLMessage, setReturnCode, setSessionId, stop

Methods inherited from interface com.softwaremining.ui.IDisplayable

assignLastKeyPressed, assignTargetXMLScreen, disableGUIScreens, getField, getLastDisplayColumn, getLastDisplayRow, getScreenClassName, getScreenClient, getXMLScreenDefReader, isGUIScreensEnabled, isTargetXMLScreen, retrieveField, retrieveLastKeyPressed, setLastDisplayColumn, setLastDisplayRow

Field Details

_RETURN_FROM_SESSION_DEFAULT_LENGTH

protected static final int _RETURN_FROM_SESSION_DEFAULT_LENGTH

See Also:

• Constant Field Values

DEFAULT_HANDLER

public int DEFAULT_HANDLER

Constructor Details

CicsBaseService

public CicsBaseService(CicsBaseService parent)

CicsBaseService

public CicsBaseService()

Deprecated.

Constructor

Method Details

copyChanneForSTART

public void copyChanneForSTART(TaskContext prevTaskContext,
 String channelName)

Used By ThreadManager by EXEC CICS START statemennt

Parameters:

prevTaskContext -

channelName -

getEibaid

public Eibaid getEibaid()

Specified by:

getEibaid in interface ICicsBaseService

getDfhaid

public Dfhaid getDfhaid()

retrieveTaskContext

public TaskContext retrieveTaskContext()

Specified by:

retrieveTaskContext in interface ICicsBaseService

setTaskContext

public void setTaskContext(TaskContext tskContext)

abendEnclave

public void abendEnclave()

translation of CALL 'CEE3ABD' https://www.ibm.com/docs/en/zos/2.4.0?topic=services-cee3abdterminate-enclave-abend

abendEnclave

public void abendEnclave(long abendCode,
 long cleanup)

translation of CALL 'CEE3ABD' https://www.ibm.com/docs/en/zos/2.4.0?topic=services-cee3abdterminate-enclave-abend#
not implemented yet

quit

public void quit()

Description copied from class: ESQLBaseService

Commit changes made by all instances of ESQLProcessor

Overrides:

quit in class ESQLBaseService

isCicsAutoSyncPointEnabled

public boolean isCicsAutoSyncPointEnabled()

Overrides:

isCicsAutoSyncPointEnabled in class BaseService

getCicsConditionManager

public CicsConditionManager getCicsConditionManager()

Specified by:

getCicsConditionManager in interface ICicsBaseService

setRespCode

protected void setRespCode(int code,
 AbstractCBLField respCode)

setInvokeHelper

public void setInvokeHelper(InvokeHelper invokeHelper)

Description copied from interface: ICicsBaseService

Invoker handler provides handlers to application program Lanchers, shutdown services and Transaction Handlers

Specified by:

setInvokeHelper in interface ICicsBaseService

destroy

protected void destroy()

Description copied from class: ESQLBaseService

Close connection all instances of ESQLProcessor Automatically called after exiting a program (normal exit, Go-Back). and prepare for GC

Overrides:

destroy in class ESQLBaseService

destroyOnFatalError

protected void destroyOnFatalError()

Description copied from class: BaseService

Automatically called after fatal error

Overrides:

destroyOnFatalError in class ESQLBaseService

executeTransferControl

public int executeTransferControl()
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.
This version does not pass any parameters to the targetProgram, hence targetProgram.isFirstTimeExecutionAndNoParameters() will return true

Specified by:

executeTransferControl in interface ICicsBaseService

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(boolean invokeHandler)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.
This method does not pass any parameters to the targetProgram, hence targetProgram.isFirstTimeExecutionAndNoParameters() will return true

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

invokeHandler - : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(ISMDataType commAreaDataObject)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

commAreaDataObject - : this data will be passed to target-program as Communication-Area.

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(ISMDataType commAreaDataObject,
 boolean invokeHandler)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

commAreaDataObject - : this data will be passed to target-program as Communication-Area.

invokeHandler - : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(String newCommArea)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

newCommArea - : this data will be passed to target-program as Communication-Area.

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(String newCommArea,
 int commAreaLength)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

newCommArea - : this data will be passed to target-program as Communication-Area.

commAreaLength - : newCommArea will be trimmed to this length prior to passing to targetProgram

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(ISMDataType newCommArea,
 int commAreaLength)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

newCommArea - - this data will be passed to target-program as Communication-Area.

invokeHandler - : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(ISMDataType newCommArea,
 int commAreaLength,
 boolean invokeHandler)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

newCommArea - - this data will be passed to target-program as Communication-Area.

commAreaLength - : newCommArea will be trimmed to this length prior to passing to targetProgram

invokeHandler - : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .

Throws:

AbnormalTerminationException

executeTransferControl

public int executeTransferControl(String newCommArea,
 int commAreaLength,
 boolean invokeHandler)
                           throws AbnormalTerminationException

Translation of CICS Xctl function: transfers control from one application program to another. I.e. the control is not passed back to CALLer, and statements after executeTransferControl will not be executed.

Specified by:

executeTransferControl in interface ICicsBaseService

Parameters:

newCommArea - - this data will be passed to target-program as Communication-Area.

commAreaLength - : newCommArea will be trimmed to this length prior to passing to targetProgram

invokeHandler - : (Default true): Mechanism to disable conditionHandlers. SET to TRUE if RESPONSE-CODE is not provided, FALSE if RESPONSE-CODE is provided .

Throws:

AbnormalTerminationException

returnFromSession

public void returnFromSession(String transId)
                       throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key.. Usually the transId will be the one associated with the current program.

Specified by:

returnFromSession in interface ICicsBaseService

Parameters:

transId - - transaction Id (referring to a program) to pass to the caller program.

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 ISMBean commArea)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 ISMBean commArea,
 int commAreaLength)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

commAreaLength - - commArea will be trimmed (or expanded) to this length

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 String commArea)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 String commArea,
 int commAreaLength)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

commAreaLength - - commArea will be trimmed (or expanded) to this length

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 ISMBean commArea,
 String inputMessage,
 int commAreaLength)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

inputMessage - - inputMessage passed to sessionManager

commAreaLength - - commArea will be trimmed (or expanded) to this length

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 String commArea,
 String inputMessage)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

inputMessage - - inputMessage passed to sessionManager

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 String commArea,
 String inputMessage,
 int commAreaLength)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

inputMessage - - inputMessage passed to sessionManager

commAreaLength - - commArea will be trimmed (or expanded) to this length

Throws:

ControlException

returnFromSession

protected void returnFromSession(String transId,
 String commArea,
 String inputMessage,
 int commAreaLength,
 String programCode)
                          throws ControlException

Translation of EXEC CICS Return.
terminates program execution returning control to the invoking program (or CICS Frame work). When a transid is specified - control will be passed to the program associated with transid, next time a screen is displayed and user clicks on a function/Return key. Usually the transId will be the one associated with the current program.

Parameters:

transId - - transaction Id to pass to the caller program

commArea - - communication-Area data to pass to the caller program

inputMessage - - inputMessage passed to sessionManager

commAreaLength - - commArea will be trimmed (or expanded) to this length

Throws:

ControlException

executeLink

public int executeLink(ISMDataType commAreaField)

Translation of CICS Link statement. Calls another program, and at end of its execution it will return control to this program.

Specified by:

executeLink in interface ICicsBaseService

Parameters:

commAreaField -

executeLink

public int executeLink(ISMDataType commAreaDataObject,
 double commAreaLength)

Translation of CICS Link statement. Calls another program, and at end of its execution it will return control to this program.

Specified by:

executeLink in interface ICicsBaseService

Parameters:

commAreaDataObject - : : this data will be passed to target-program as Communication-Area.

commAreaLength - : length of data in commAreaDataObject will be trimmed to this length prior to passing to targetProgram

executeLink

public int executeLink(ISMDataType[] commAreaDataObjects)

Specified by:

executeLink in interface ICicsBaseService

Parameters:

commAreaDataObject - : : the set of data will be passed to target-program as Communication-Area.

executeLink

public int executeLink()

When there is No parameters, then the system should pass all the parameters which it had received through the Linkage-Area

Specified by:

executeLink in interface ICicsBaseService

executeLinkUsingChannel

public int executeLinkUsingChannel(String channelName)

passing CHANNEL List from caller program to this

Parameters:

channelName -

Returns:

executeLinkUsingChannel

public int executeLinkUsingChannel(ISMString channelName)

cicsSyncpoint

public final int cicsSyncpoint()
                        throws ControlException

Specified by:

cicsSyncpoint in interface ICicsBaseService

Throws:

ControlException

cicsSyncpoint

protected final int cicsSyncpoint(SyncpointDO param)

translation of CICS Sync Point

cicsRollbackSyncpoint

protected final int cicsRollbackSyncpoint()

translation of CICS Sync Point Rollback

doFinalize

public void doFinalize(boolean forceRelease,
 boolean releaseConnection)

Description copied from class: ESQLBaseService

Automatically called after CANCELing (ServicesFactory.cancel) running a program - it removes all wrapperLists

Overrides:

doFinalize in class ESQLBaseService

Parameters:

forceRelease -

cicsDocumentCreate

public void cicsDocumentCreate(DocumentCreateDO param)

Deprecated.

- this is a stub method

Specified by:

cicsDocumentCreate in interface ICicsBaseService

cicsWebWrite

public void cicsWebWrite(WebWriteDO param)

Deprecated.

- this is a stub method

Specified by:

cicsWebWrite in interface ICicsBaseService

cicsWebRead

public void cicsWebRead(WebReadDO param)

Deprecated.

- this is a stub method

Specified by:

cicsWebRead in interface ICicsBaseService

cicsWebReceive

public void cicsWebReceive(WebReceiveDO param)

Deprecated.

- this is a stub method

Specified by:

cicsWebReceive in interface ICicsBaseService

cicsWebSend

public void cicsWebSend(WebSendDO param)

Deprecated.

- this is a stub method

Specified by:

cicsWebSend in interface ICicsBaseService

cicsHandleAbend

public void cicsHandleAbend(HandleAbendDO obj)

Deprecated.

- this is a stub method

Specified by:

cicsHandleAbend in interface ICicsBaseService

setAbendHandler

public void setAbendHandler(String methodName)

Specified by:

setAbendHandler in interface ICicsBaseService

setAbendHandler

public void setAbendHandler(int defaultHandler,
 String methodName)

Specified by:

setAbendHandler in interface ICicsBaseService

cancelAbendHandler

public void cancelAbendHandler()

Specified by:

cancelAbendHandler in interface ICicsBaseService

resetCondition

public void resetCondition(int conditionNumber)

ignoreCondition

public void ignoreCondition(int conditionNumber)

Specified by:

ignoreCondition in interface ICicsBaseService

ignoreCondition

public void ignoreCondition(int[] conditionNumber)

Specified by:

ignoreCondition in interface ICicsBaseService

setAidEventHandler

public void setAidEventHandler(String keyCode,
 String methodName)

Specified by:

setAidEventHandler in interface ICicsBaseService

isAidEventManagerActive

public boolean isAidEventManagerActive()

invokeAidEventHandler

public void invokeAidEventHandler()

invokeConditionHandler

public void invokeConditionHandler(ISMObject responseField,
 long responseCode,
 Throwable throwable)

handle the condition - when a CICS operation fails, or throw an AbnormalTerminationException code - then control will be passed to this method to determine whether a. We use default CICS condition handler b. We Ignore condition c. We pass control (via goto) to a named condition handler

cicsUnlock

public void cicsUnlock(UnlockDO unlockDO)

Deprecated.

- this is a stub method

Not applicable in java

Specified by:

cicsUnlock in interface ICicsBaseService

getClassName

public String getClassName()

used in CICS ASSIGN ... PROGRAM(prog-name)

Specified by:

getClassName in interface ICicsBaseService

Returns:

return the upper-cased, package-removed class name E.g. it will return CICSPROGRAM1 for class com.softwaremining.examples.CicsProgram1

getUserId

public String getUserId()

used in CICS ASSIGN ... PROGRAM(prog-name)

Specified by:

getUserId in interface ICicsBaseService

Returns:

return the upper-cased, package-removed class name E.g. it will return CICSPROGRAM1 for class com.softwaremining.examples.CicsProgram1

setUserId

public void setUserId(String userId)

Specified by:

setUserId in interface ICicsBaseService

getInvokingProgramName

public String getInvokingProgramName()

Specified by:

getInvokingProgramName in interface ICicsBaseService

getInvokingProgram

public String getInvokingProgram()

Deprecated.

please use GetInvokingProgramName

Specified by:

getInvokingProgram in interface ICicsBaseService

Returns:

getReturnprog

public String getReturnprog()

assignChannelName

public void assignChannelName(String channelName)

assignNetname

public void assignNetname(String netName)

getNetname

public String getNetname()

getDefaultChannelName

public String getDefaultChannelName()

getAbendCode

public String getAbendCode()

Specified by:

getAbendCode in interface ICicsBaseService

getProgramId

public String getProgramId()

Specified by:

getProgramId in interface ICicsBaseService

getProgramName

public String getProgramName()

Specified by:

getProgramName in interface ICicsBaseService

getStartcode

public String getStartcode()

2byte alpha numeric to show how program was started. values are:
QD - transient data ATI
S - Interval control start command without data
SD - Interval control start command with data
TD - Terminal Input
U - other task attached by user

Specified by:

getStartcode in interface ICicsBaseService

Returns:

getSysid

public String getSysid()

Specified by:

getSysid in interface ICicsBaseService

getApplid

public String getApplid()

Specified by:

getApplid in interface ICicsBaseService

transfuse

protected void transfuse(List<ISMDataType> in,
 List<ISMDataType> out,
 boolean back)

for internal use only

Overrides:

transfuse in class BaseService

setAcceptResponse

public void setAcceptResponse(AcceptResponse acceptResponse)

Specified by:

setAcceptResponse in interface ICicsBaseService

getAcceptResponse

public AcceptResponse getAcceptResponse()

Description copied from interface: ICicsBaseService

for internal use only

Specified by:

getAcceptResponse in interface ICicsBaseService

Returns:

setNeedScreenUpdate

public void setNeedScreenUpdate(boolean needScreenUpdate)

isNeedScreenUpdate

public boolean isNeedScreenUpdate()

getCicsOriginalProgramName

public String getCicsOriginalProgramName()

CICS uses a 8 Character identifier for program names ... Ie programName PROGRAM1 will result in com.mypackage.Program1 . This method will keep the original name assigned (e.g. PROGRAM1);

Specified by:

getCicsOriginalProgramName in interface ICicsBaseService

retrieveSessionManager

public SessionManager retrieveSessionManager()

Get the internal SoftwareMining SessionManager

Specified by:

retrieveSessionManager in interface ICicsBaseService

assignSessionManager

public void assignSessionManager(SessionManager sessionManager)

for internal use only

retrieveHttpSession

public jakarta.servlet.http.HttpSession retrieveHttpSession()

Returns associated HttpSession manager, set by PseudoCOnversationalServlet

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:

isFirstTimeExecutionAndNoParameters

public boolean isFirstTimeExecutionAndNoParameters()

Indicates whether this the first time this program is being executed, or whether the system is re-entering this program.

Specified by:

isFirstTimeExecutionAndNoParameters in interface ICicsBaseService

Returns:

IsWaitingForUI

public boolean IsWaitingForUI()

Only used in conversion of Conversational to Pseudo-Conv Programs

Returns:

setWaitingForUser

public void setWaitingForUser(boolean waitingForUser)

Only used in conversion of Conversational to Pseudo-Conv Programs

Specified by:

setWaitingForUser in interface ICicsBaseService

Parameters:

waitingForUser -

isKeyPressed

public boolean isKeyPressed(String key)

check if a key has been prssed

Specified by:

isKeyPressed in interface ICicsBaseService

Parameters:

key - : one of entries in "com.softwaremining.cics.Keyboard" interface

Returns:

setKeyPressed

public void setKeyPressed(String key)

Specified by:

setKeyPressed in interface ICicsBaseService

getKeyPressed

public String getKeyPressed()

Specified by:

getKeyPressed in interface ICicsBaseService

getResponseCode

public long getResponseCode()

Specified by:

getResponseCode in interface ICicsBaseService

makeUpClassScreenSourceName

public String makeUpClassScreenSourceName()

method used internally by SoftwareMining framework

Specified by:

makeUpClassScreenSourceName in interface IDisplayable

Overrides:

makeUpClassScreenSourceName in class BaseService

Returns:

- a string representing the XML screen file for program. For example, for class com.softwaremining.examples.Loan, the following string will be returned: /com/softwaremining/examples/loan/xml/screens/Loan.xml

assignBmsMapSetName

public void assignBmsMapSetName(String mapName,
 String mapset_FileName)

retrieveBmsMapSet_FileName

public String retrieveBmsMapSet_FileName()

for internal use only

Returns:

retrieveJSPName

public String retrieveJSPName()

method used internally by SoftwareMining framework

Returns:

retrieveDBDecorator

public ACMDbDecorator retrieveDBDecorator()

reInitializeBaseService

public void reInitializeBaseService()

Description copied from class: BaseService

for internal use only used by CICS subsystem

Overrides:

reInitializeBaseService in class BaseService

initializeBaseService

public void initializeBaseService()

Description copied from class: ESQLBaseService

in ESQL projects commits are manually made e.g EXEC SQL COMMIT END-EXEC Hence turn the auto-commit off during initialization

Overrides:

initializeBaseService in class ESQLBaseService

delay

public void delay()

CICS Delay

Specified by:

delay in interface ICicsBaseService

Parameters:

seconds -

delay

public void delay(int seconds)

CICS Delay

Specified by:

delay in interface ICicsBaseService

Parameters:

seconds -

delay

public void delay(ISMNumeric seconds)

Specified by:

delay in interface ICicsBaseService

getRoutedBMS

public RouteDO getRoutedBMS()

Specified by:

getRoutedBMS in interface ICicsBaseService

setRoutedBMS

public void setRoutedBMS(RouteDO routedBMS)

Specified by:

setRoutedBMS in interface ICicsBaseService

cicsEnq

@Deprecated
public void cicsEnq(EnqDO enqDO)

Deprecated.

CICS ENQ - lock a resource

Specified by:

cicsEnq in interface ICicsBaseService

cicsDeq

@Deprecated
public void cicsDeq(DeqDO deqDO)

Deprecated.

Specified by:

cicsDeq in interface ICicsBaseService

cicsGetcounter

public int cicsGetcounter(CounterDO counterDO)

Translation of CICS GET COUNTER
https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.html

Specified by:

cicsGetcounter in interface ICicsBaseService

Parameters:

counterDO -

cicsDefineCounter

public void cicsDefineCounter(CounterDO counterDO)

Translation of CICS DEFINE COUNTER
https://www-01.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts .applicationprogramming.doc/commands/dfhp4_definecounter.html

Specified by:

cicsDefineCounter in interface ICicsBaseService

Parameters:

counterDO -

cicsSpiInquireTask

@Deprecated(forRemoval=false,
            since="2026.01.08")
public void cicsSpiInquireTask(InquireTaskDO inquireTaskDO)

Deprecated.

Use InquireUtil.inquire(CicsBaseService, InquireDO) instead. This method will be removed in a future release.

Specified by:

cicsSpiInquireTask in interface ICicsBaseService

cicsSpiInquireSystem

@Deprecated(forRemoval=false,
            since="2026.01.08")
public void cicsSpiInquireSystem(InquireSystemDO dao)

Deprecated.

Use InquireSystemUtil.inquire(CicsBaseService, InquireSystemDO) instead. This method will be removed in a future release.

cicsQuerySecurity

@Deprecated(forRemoval=false,
            since="2026.01.08")
public void cicsQuerySecurity(QuerySecurityDO dao)

Deprecated.

Use

invalid reference

com.softwaremining.cics.util.cicsQuerySecurity#inquire(CicsBaseService, QuerySecurityDO)

instead. This method will be removed in a future release.

cicsVerifyPassword

@Deprecated(forRemoval=false,
            since="2026.01.08")
public void cicsVerifyPassword(VerifyPasswordDO dao)

Deprecated.

Use

invalid reference

com.softwaremining.cics.util.cicsQuerySecurity#inquire(CicsBaseService, QuerySecurityDO)

instead. This method will be removed in a future release.

assignThreadManagerDAO

public void assignThreadManagerDAO(ISMObject data)

for internal use only

Parameters:

data -

retrieveDataManagerStr

public String retrieveDataManagerStr()

for internal use only

Returns:

retrieveStartCode

public String retrieveStartCode()

Specified by:

retrieveStartCode in interface ICicsBaseService

cicsWebExtract

public void cicsWebExtract(WebExtractDO webextractDo)

Specified by:

cicsWebExtract in interface ICicsBaseService

retrieveCicsPersistenceForDataset

public CicsPersistence retrieveCicsPersistenceForDataset(String tableName)

Retrieve the active/opened CicsPersistence DAO registered to the SQL tableName

Parameters:

tableName -

Returns:

cicsDumpTransaction

public int cicsDumpTransaction(DumpTransactionDO dumpTransactionDO)

Dumps data in DAO's as well as COMMAREA and TWA to Config.DATA_DIR /dump/timestamp[/dumpCode]

Specified by:

cicsDumpTransaction in interface ICicsBaseService

Parameters:

dumpTransactionDO -

Returns:

cicsEnterTracenum

public void cicsEnterTracenum(EnterTracenumDO enterTracenumDO)

Specified by:

cicsEnterTracenum in interface ICicsBaseService

cicsAddress

public void cicsAddress(AddressDO addressDO)

Set Address of pointers for TWA and CWA

Specified by:

cicsAddress in interface ICicsBaseService

Parameters:

addressDO -

getTwaleng

@Deprecated
public int getTwaleng()

Deprecated.

- please use lengthOfTransactionWorkArea()

Returns:

getLengthOfTransactionWorkArea

@Deprecated
public int getLengthOfTransactionWorkArea()

Deprecated.

- please use lengthOfTransactionWorkArea()

Returns:

lengthOfTransactionWorkArea

public int lengthOfTransactionWorkArea()

Returns the length of Transaction Work Area associated with this Session. if no TWA exists, a zero length is returned.

Specified by:

lengthOfTransactionWorkArea in interface ICicsBaseService

Returns:

lengthOfCommonWorkArea

public int lengthOfCommonWorkArea()

cicsPostEvent

public int cicsPostEvent(PostEventDO postEventDO)

Deprecated.

- please use com.softwaremining.cics.util.EventManager.postEvent

cicsWaitEvent

public int cicsWaitEvent(WaitEventDO waitEventDO)

Deprecated.

- please use com.softwaremining.cics.util.EventManager.waitEvent

reactivateHandlers

public void reactivateHandlers()

Specified by:

reactivateHandlers in interface ICicsBaseService

deactivateHandlers

public void deactivateHandlers()

Specified by:

deactivateHandlers in interface ICicsBaseService

setTally

public void setTally(int tally)

Specified by:

setTally in interface ICicsBaseService

getTally

public int getTally()

Specified by:

getTally in interface ICicsBaseService

getFieldTally

public ISMObject getFieldTally()

Specified by:

getFieldTally in interface ICicsBaseService

processCicsAbendException

public void processCicsAbendException(Exception e)

Description copied from class: BaseService

For internal use only

Specified by:

processCicsAbendException in interface ICicsBaseService

Overrides:

processCicsAbendException in class BaseService

Parameters:

e -

getTerminalID

public String getTerminalID()

Specified by:

getTerminalID in interface ICicsBaseService