com.ibm.cics.server
Class Channel

java.lang.Object
  extended by com.ibm.cics.server.Channel

public class Channel
extends java.lang.Object

This is the Java implementation of CICS Channels

Version:
1.0
Author:
Tom Grieve

Method Summary
 ContainerIterator containerIterator()
          Create a ContainerIterator for the Channel
 Container createContainer(java.lang.String containerName)
          Create a Container in this Channel.
 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.
 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
ChannelErrorException

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 may result in a return value of null, if no data has yet been written to the container due to the fact that createContainer(String) creates a proxy object.

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

deleteContainer

public void deleteContainer(java.lang.String containerName)
                     throws ContainerErrorException,
                            ChannelErrorException,
                            CCSIDErrorException,
                            CodePageErrorException,
                            InvalidRequestException
Delete a Container from this Channel

Parameters:
containerName - the name of the Container to be deleted
Throws:
ContainerErrorException
ChannelErrorException
InvalidRequestException
CodePageErrorException
CCSIDErrorException

getName

public java.lang.String getName()
Get the name of the Channel as known to CICS

Returns:
The name of the Channel

containerIterator

public ContainerIterator containerIterator()
Create a ContainerIterator for the Channel

Returns:
The ContainerIterator for this Channel