com.ibm.connector2.cics

Class ECIChannelRecord

  • java.lang.Object
    • com.ibm.connector2.cics.ECIChannelRecord
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map, javax.resource.cci.MappedRecord, javax.resource.cci.Record


    public class ECIChannelRecord
    extends java.lang.Object
    implements javax.resource.cci.MappedRecord
    ECIChannelRecord provides channels and containers support for the CICS ECI resource adapter. This channel record takes the form of a JCA MappedRecord to which container objects can be added.
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K,V>
    • Constructor Summary

      Constructors 
      Constructor and Description
      ECIChannelRecord(java.lang.String name)
      Creates a new empty channel record with the specified name.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void clear()
      Removes all containers from the channel.
      java.lang.Object clone()
      Not supported.
      boolean containsKey(java.lang.Object name)
      Returns whether or not the specified container exists in the channel.
      boolean containsValue(java.lang.Object data)
      Returns whether or not there is a container with the specified data within the channel.
      boolean equals(java.lang.Object o) 
      java.lang.Object get(java.lang.Object name)
      Retrieves the data for the specified container from the channel.
      java.lang.String getRecordName()
      Returns the name of the channel record.
      java.lang.String getRecordShortDescription()
      Returns the short description of the channel record.
      int hashCode() 
      boolean isEmpty()
      Returns whether the channel is empty or not.
      java.util.Set keySet()
      Returns a set of the container names in the channel.
      java.lang.Object put(java.lang.Object name, java.lang.Object data)
      Adds a container to the channel.
      void putAll(java.util.Map containers)
      Puts a group of containers into the channel.
      java.lang.Object remove(java.lang.Object name)
      Removes a container from the channel.
      void setRecordName(java.lang.String name)
      This method does not change the record name.
      void setRecordShortDescription(java.lang.String description)
      Sets the short description of the channel record.
      int size()
      Returns the number of containers in the channel.
      java.util.Collection<?> values()
      Returns the contents of all the containers in the channel.
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ECIChannelRecord

        public ECIChannelRecord(java.lang.String name)
                         throws javax.resource.ResourceException
        Creates a new empty channel record with the specified name.

        The channel name must be between 1 and 16 characters in length and must consist of only the following types of character:

        • Uppercase characters (A-Z)
        • Lowercase characters (a-z)
        • Digits (0-9)
        • Special characters < > $ @ # / % & ? ! : | " = ' ; . - and _

        Channel names are case sensitive.

        Parameters:
        name - The name of the channel.
        Throws:
        javax.resource.ResourceException - if name is null or contains invalid characters, or the length of name is invalid.
    • Method Detail

      • getRecordName

        public java.lang.String getRecordName()
        Returns the name of the channel record.
        Specified by:
        getRecordName in interface javax.resource.cci.Record
      • getRecordShortDescription

        public java.lang.String getRecordShortDescription()
        Returns the short description of the channel record.
        Specified by:
        getRecordShortDescription in interface javax.resource.cci.Record
      • setRecordName

        public void setRecordName(java.lang.String name)
        This method does not change the record name. Channel names are immutable. This method exists solely to conform to the MappedRecord interface.
        Specified by:
        setRecordName in interface javax.resource.cci.Record
      • setRecordShortDescription

        public void setRecordShortDescription(java.lang.String description)
        Sets the short description of the channel record.
        Specified by:
        setRecordShortDescription in interface javax.resource.cci.Record
      • clear

        public void clear()
        Removes all containers from the channel.
        Specified by:
        clear in interface java.util.Map
      • containsKey

        public boolean containsKey(java.lang.Object name)
        Returns whether or not the specified container exists in the channel.
        Specified by:
        containsKey in interface java.util.Map
        Parameters:
        name - A container name.
      • containsValue

        public boolean containsValue(java.lang.Object data)
        Returns whether or not there is a container with the specified data within the channel.
        Specified by:
        containsValue in interface java.util.Map
        Parameters:
        data - A String or byte[].
        Returns:
        true if there is a container with the specified data, false otherwise.
      • get

        public java.lang.Object get(java.lang.Object name)
        Retrieves the data for the specified container from the channel.
        Specified by:
        get in interface java.util.Map
        Parameters:
        name - The name of the container to retrieve.
        Returns:
        The container data, or null if the container did not exist in the channel.
      • isEmpty

        public boolean isEmpty()
        Returns whether the channel is empty or not.
        Specified by:
        isEmpty in interface java.util.Map
      • keySet

        public java.util.Set keySet()
        Returns a set of the container names in the channel.
        Specified by:
        keySet in interface java.util.Map
      • put

        public java.lang.Object put(java.lang.Object name,
                           java.lang.Object data)
        Adds a container to the channel. If a container of the same name already exists in the channel, the existing container is replaced with the new container.

        The container name must be between 1 and 16 characters in length and must consist of only the following types of character:

        • Uppercase characters (A-Z)
        • Lowercase characters (a-z)
        • Digits (0-9)
        • Special characters < > $ @ # / % & ? ! : | " = ' ; . - and _

        Container names are case sensitive.

        To create a CHAR container, the data parameter must be of type String. To create a BIT container, the data parameter must be of type byte[] or be a type that implements the Streamable interface.

        Specified by:
        put in interface java.util.Map
        Parameters:
        name - The name of the container.
        data - The container data.
        Returns:
        null if the container is added, the original container data if the container is replaced

      • putAll

        public void putAll(java.util.Map containers)
        Puts a group of containers into the channel. Any containers of the same name that already exist in the channel are replaced with the new versions of the containers.

        Container names must be between 1 and 16 characters in length and must consist of only the following types of character:

        • Uppercase characters (A-Z)
        • Lowercase characters (a-z)
        • Digits (0-9)
        • Special characters < > $ @ # / % & ? ! : | " = ' ; . - and _

        Container names are case sensitive.

        To create a CHAR container, the data parameter must be of type String. To create a BIT container, the data parameter must be of type byte[] or be a type that implements the Streamable interface.

        Specified by:
        putAll in interface java.util.Map
        Parameters:
        containers - A map of container names to container data.
      • remove

        public java.lang.Object remove(java.lang.Object name)
        Removes a container from the channel.
        Specified by:
        remove in interface java.util.Map
        Parameters:
        name - The name of the container to remove.
        Returns:
        The container data removed from the channel, or null if the container did not exist in the channel.
      • size

        public int size()
        Returns the number of containers in the channel.
        Specified by:
        size in interface java.util.Map
      • values

        public java.util.Collection<?> values()
        Returns the contents of all the containers in the channel.
        Specified by:
        values in interface java.util.Map
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Not supported.
        Specified by:
        clone in interface javax.resource.cci.Record
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException
      • equals

        public boolean equals(java.lang.Object o)
        Specified by:
        equals in interface java.util.Map
        Specified by:
        equals in interface javax.resource.cci.Record
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Map
        Specified by:
        hashCode in interface javax.resource.cci.Record
        Overrides:
        hashCode in class java.lang.Object

©Copyright IBM Corp. 1994, 2017


Legal