com.ibm.cics.server

Class Channel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      ContainerIterator containerIterator()
      Create a ContainerIterator for the Channel
      Container createContainer(java.lang.String containerName)
      Create a Container in this Channel.
      void delete()
      Delete the Channel and all of its Containers
      void deleteContainer(java.lang.String containerName)
      Delete a Container from this Channel
      Container getContainer(java.lang.String containerName)
      Get a Container by name from this Channel.
      int getContainerCount()
      Get the container count for this Channel
      java.lang.String getName()
      Get the name of the Channel as known to CICS
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • createContainer

        public Container createContainer(java.lang.String containerName)
                                  throws ContainerErrorException,
                                         ChannelErrorException
        Create a Container in this Channel. The Container created by this method is actually a proxy object, as opposed to a real container within CICS. The actual container in CICS is not created (if it doesn't already exist) until data is written to it using a method such as Container.put(byte[]).
        Parameters:
        containerName - the name of the new Container
        Returns:
        The newly created Container
        Throws:
        ContainerErrorException - CONTAINERERR
        ChannelErrorException - CHANNELERR
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • getContainer

        public Container getContainer(java.lang.String containerName)
                               throws ContainerErrorException
        Get a Container by name from this Channel. This method will only return the Container object if the actual container exists within CICS. Therefore, a call to this method can result in a return value of null, if no data has yet been written to the container or the container does not exist.
        Parameters:
        containerName - the name of the Container to be found
        Returns:
        The Container with the name requested, or null if it does not exist.
        Throws:
        ContainerErrorException - CONTAINERERR
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • getName

        public java.lang.String getName()
        Get the name of the Channel as known to CICS
        Returns:
        The name of the Channel
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • containerIterator

        public ContainerIterator containerIterator()
        Create a ContainerIterator for the Channel
        Returns:
        The ContainerIterator for this Channel
        Since CICS TS version:
        3.1
        Since package version:
        1.0
      • getContainerCount

        public int getContainerCount()
                              throws ChannelErrorException
        Get the container count for this Channel
        Returns:
        int the number of containers in the channel
        Throws:
        ChannelErrorException - CHANNELERR
        Since CICS TS version:
        5.3
        Since package version:
        1.600.0