com.ibm.cics.jcicsx

Interface CICSContext



  • public interface CICSContext
    The environment that the API is executing in. Entry point to the JCICSX API. Used to create Channels and Containers, ProgramLinkers, and access information about the environment.
    Since CICS TS version:
    5.6
    Since package version:
    1.000.0
    • Method Detail

      • getTaskNumber

        java.lang.Integer getTaskNumber()
        Get the task number of the currently executing CICS task
        Returns:
        the current task number
      • getChannel

        Channel getChannel(java.lang.String channelName)
        Create a channel with the supplied name.
        Parameters:
        channelName - The name of the channel
        Returns:
        The channel
      • getTransactionChannel

        Channel getTransactionChannel()
        Get the transaction Channel, if any.
        Returns:
        The transaction Channel for this task
      • createProgramLinker

        ProgramLinker createProgramLinker(java.lang.String programName)
        Create a ProgramLinker for invoking a program without input or output
        Parameters:
        programName - Name of the program to target
        Returns:
        A ProgramLinker capable of invoking the program with the supplied name
      • createProgramLinkerWithChannel

        default ChannelProgramLinker createProgramLinkerWithChannel(java.lang.String programName,
                                                                    java.lang.String channelName)
        Create a ProgramLinker for invoking a program using a channel with a specific name
        Parameters:
        programName - Name of the program to target
        channelName - Name of the channel to use for input and output
        Returns:
        A ChannelProgramLinker capable of invoking the program
      • createProgramLinkerWithChannel

        ChannelProgramLinker createProgramLinkerWithChannel(java.lang.String programName,
                                                            Channel channel)
        Create a ProgramLinker for invoking a program with a specific Channel instance
        Parameters:
        programName - Name of the program to target
        channel - Channel to use for input and output
        Returns:
        A ProgramLinker capable of invoking the program
      • getCICSContext

        static CICSContext getCICSContext()
        Get an instance of the current CICSContext.
        Returns:
        the current context