com.ibm.ctg.monitoring

Interface ContainerInfo

  • All Superinterfaces:
    java.io.Serializable


    public interface ContainerInfo
    extends java.io.Serializable
    Provides monitoring information about a container in the channel associated with an ECI request.
    See Also:
    ChannelInfo
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface and Description
      static class  ContainerInfo.DataType
      Defines the type of data in a container and whether it is subject to code page conversion.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      byte[] getBitData()
      Returns a byte array that is a copy of the data in the container.
      byte[] getBitData(int offset, int length)
      Returns a byte array copy of length bytes taken from offset bytes into the container.
      java.lang.String getCharData()
      Returns a string that is a copy of the data in the container.
      java.lang.String getCharData(int offset, int length)
      Returns a String copy of length characters taken from offset characters into the container.
      int getLength()
      Gets the length of the data in the container.
      java.lang.String getName()
      Gets the name of the container.
      ContainerInfo.DataType getType()
      Gets the data type of the container.
    • Method Detail

      • getName

        java.lang.String getName()
        Gets the name of the container.
        Returns:
        the name of the container
      • getLength

        int getLength()
        Gets the length of the data in the container. For BIT containers the data length is measured in bytes, and for CHAR containers the data length is measured in characters.
        Returns:
        the number of bytes or characters in the container
        See Also:
        getType()
      • getType

        ContainerInfo.DataType getType()
        Gets the data type of the container.

        BIT containers hold binary data. Code page conversion is not performed when applications read or update the contents of the container.

        CHAR containers hold character data. Code page conversion is performed when applications read or update the contents of the container.

        Returns:
        the type of the container
      • getBitData

        byte[] getBitData(int offset,
                        int length)
                          throws java.lang.IndexOutOfBoundsException,
                                 InvalidContainerTypeException,
                                 ContainerInfoContentException
        Returns a byte array copy of length bytes taken from offset bytes into the container. The data in the container is only valid during the RequestExit eventFired() method.
        Parameters:
        offset - the starting byte offset into the container
        length - the number of bytes to copy
        Returns:
        the specified section of the container
        Throws:
        java.lang.IndexOutOfBoundsException - if the offset is less than 0 or greater than the length of the container or the length is less than 0 or greater than the length of the container less the offset
        InvalidContainerTypeException - if this is not a BIT container
        ContainerInfoContentException - if container data is no longer valid
      • getCharData

        java.lang.String getCharData(int offset,
                                   int length)
                                     throws java.lang.IndexOutOfBoundsException,
                                            InvalidContainerTypeException,
                                            ContainerInfoContentException
        Returns a String copy of length characters taken from offset characters into the container. The data in the container is only valid during the RequestExit eventFired() method.
        Parameters:
        offset - the starting character offset into the container
        length - the number of characters to copy
        Returns:
        the specified section of the container
        Throws:
        java.lang.IndexOutOfBoundsException - if the offset is less than 0 or greater than the length of the container or the length is less than 0 or greater than the length of the container less the offset
        InvalidContainerTypeException - if this is not a BIT container
        ContainerInfoContentException - if container data is no longer valid

©Copyright IBM Corp. 1994, 2017


Legal