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 Details

    • _RETURN_FROM_SESSION_DEFAULT_LENGTH

      protected static final int _RETURN_FROM_SESSION_DEFAULT_LENGTH
      See Also:

    • DEFAULT_HANDLER

      public int DEFAULT_HANDLER

  • Constructor Details

    • CicsBaseService

      public CicsBaseService(CicsBaseService parent)

    • CicsBaseService

      public CicsBaseService()
      Deprecated.
      Constructor

  • Method Details

    • getEibaid

      public Eibaid getEibaid()
      Specified by:
      getEibaid in interface ICicsBaseService

    • getDfhaid

      public Dfhaid getDfhaid()

    • setAbend

      public void setAbend(boolean abend)
      this method is used in passing abend information between CICS LINK calls
      Specified by:
      setAbend in interface ICicsBaseService

    • isAbend

      public boolean isAbend()
      this method is used in passing abend information between CICS LINK calls
      Specified by:
      isAbend in interface ICicsBaseService

    • 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)

    • 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

    • commitAndReleaseConnection

      public void commitAndReleaseConnection(boolean doCommit)
      for internal use only
      - Commits all open transactions (if not already committed)
      - closes any CicsPersistence.resultsets in this program which have not been already closed
      - releases any connections associated with CicsPersistence.resultsets
      Overrides:
      commitAndReleaseConnection in class BaseService

    • 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

    • 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)

    • getChannel

      public String getChannel()

    • assignNetname

      public void assignNetname(String netName)

    • getNetname

      public String getNetname()

    • 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

    • reInitializeAllDAOs

      public void reInitializeAllDAOs(boolean resetDAOInitialValues)
      Description copied from class: BaseService
      reinitializes CBLBeans to their default char-array representation, and AbstractCOntainer to their default values This allows system to reuse the Wrapper classes in other programs. This is only used in Cics applications . NOTES: A goBack() and end of the execution will clear all DAO's passed via AddCallParameters (Linkage-Section).
      Overrides:
      reInitializeAllDAOs 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 - cannot reserve any resources in web-application ...
      Specified by:
      cicsEnq in interface ICicsBaseService
      Parameters:
      enqDO -

    • 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 public void cicsSpiinquiretask(InquireTaskDO inquireTaskDO)
      Deprecated.
      Specified by:
      cicsSpiinquiretask in interface ICicsBaseService

    • cicsSpiinquireFile

      @Deprecated public void cicsSpiinquireFile(InquireFileDO inquireFileDO)
      Deprecated.
      Specified by:
      cicsSpiinquireFile in interface ICicsBaseService

    • cicsInquireFile

      @Deprecated public void cicsInquireFile(InquireFileDO inquireFileDO)
      Deprecated.
      Specified by:
      cicsInquireFile in interface ICicsBaseService

    • cicsInquiretask

      @Deprecated public void cicsInquiretask(InquireTaskDO inquireTaskDO)
      Deprecated.
      Specified by:
      cicsInquiretask in interface ICicsBaseService

    • assignProgram

      @Deprecated public void assignProgram(String programName)
      Deprecated.

    • assignProgram

      @Deprecated public void assignProgram(ISMString programName)
      Deprecated.

    • 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()

    • 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:

    • cicsSpiInquireSystem

      public int cicsSpiInquireSystem(InquireSystemDO dao)
      This method currently does not perform anything
      Specified by:
      cicsSpiInquireSystem in interface ICicsBaseService

    • 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

    • getChannelList

      public HashMap<String,HashMap<String,String>> getChannelList()

    • createOrRetrieveContainerListFromChannel

      public HashMap<String,String> createOrRetrieveContainerListFromChannel(String channelName)
      For internal use only
      Parameters:
      channelName -
      Returns:

    • processCicsAbendException

      protected void processCicsAbendException(Exception e)
      Description copied from class: BaseService
      For internal use only
      Overrides:
      processCicsAbendException in class BaseService