|
CICS® Transaction Gateway Programming Reference v7.2.0.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ctg.client.Channel
public class Channel
Constructor Summary | |
---|---|
Channel(java.lang.String channelName)
Channel constructor creates a uniquely named object to hold a collection of application parameter data held in containers. |
Method Summary | |
---|---|
void |
addContainer(Container container)
Adds the provided container to the channel |
Container |
copyContainer(java.lang.String containerName,
Channel sourceChannel)
Copy a container from another channel |
Container |
copyContainer(java.lang.String containerName,
Channel sourceChannel,
java.lang.String newContainerName)
Copy a container from another channel |
Container |
createContainer(java.lang.String containerName,
byte[] data)
Creates a container to hold binary data within the channel. |
Container |
createContainer(java.lang.String containerName,
byte[] data,
int CCSID)
Creates a container to hold character data within the channel. |
Container |
createContainer(java.lang.String containerName,
byte[] data,
java.lang.String encoding)
Creates a container to hold character data within the channel. |
Container |
createContainer(java.lang.String containerName,
java.lang.String data)
Creates a container to hold character data within the channel. |
Container |
createContainer(java.lang.String containerName,
java.lang.String data,
java.lang.String encoding)
Deprecated. |
void |
deleteContainer(java.lang.String name)
Set the container to be deleted from the channel on the next CICS request. |
int |
getCCSID()
Returns the default CCSID associated with the channel |
java.lang.String |
getCodePage()
Returns the default code page associated with the channel |
Container |
getContainer(java.lang.String name)
This method will examine the current containers within this channel looking for a container with the name supplied. |
java.util.Set<java.lang.String> |
getContainerNames()
|
java.util.Collection<Container> |
getContainers()
Get a collection of all of the containers held within the channel |
java.lang.String |
getName()
Returns the name of the channel |
void |
markDeleted(java.lang.String name)
|
Container |
moveContainer(java.lang.String containerName,
Channel sourceChannel)
Move a container from another channel |
Container |
moveContainer(java.lang.String containerName,
Channel sourceChannel,
java.lang.String newContainerName)
Move a container from another channel |
void |
setCCSID(int ccsid)
Sets the CCSID of the channel |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Channel(java.lang.String channelName) throws ChannelException
This channel object has methods to create, modify and delete containers held within the channel.
channelName
- Unique name for this channel
ChannelException
- if the channel name includes invalid characters, or the name
is nullMethod Detail |
---|
public Container createContainer(java.lang.String containerName, byte[] data) throws ContainerException
The contents of the container will be set to the data supplied. Data within this container will not be considered for codepage conversion. The data will be transfered to the CICS application exactly as supplied.
containerName
- name for this container to be referenced bydata
- data to be placed in the container referenced by containerName
ContainerException
- if the container name includes invalid characters, the name
is null, or the container name already exists@Deprecated public Container createContainer(java.lang.String containerName, java.lang.String data, java.lang.String encoding) throws java.io.UnsupportedEncodingException, ContainerException
java.io.UnsupportedEncodingException
ContainerException
public Container createContainer(java.lang.String containerName, byte[] data, java.lang.String encoding) throws java.io.UnsupportedEncodingException, ContainerException
The contents of the container will be set to the data supplied.
containerName
- name for this container to be referenced bydata
- byte data to be placed in the container referenced by
containerNameencoding
- specify the codepage of the String data supplied
ContainerException
- if the container name includes invalid characters, the name
is null, or the container name already exists
java.io.UnsupportedEncodingException
- if the encoding is not supportedpublic Container createContainer(java.lang.String containerName, java.lang.String data) throws java.io.UnsupportedEncodingException, ContainerException
The contents of the container will be set to the String data supplied.
Data within this container will be converted to the appropriate codepage specified in the CICS application.
containerName
- name for this container to be referenced bydata
- String data to be placed in the container referenced by
containerName
ContainerException
- if the container name includes invalid characters, the name
is null, or the container name already exists
java.io.UnsupportedEncodingException
- if the encoding is not supportedpublic Container createContainer(java.lang.String containerName, byte[] data, int CCSID) throws java.io.UnsupportedEncodingException, ContainerException
The contents of the container will be set to the String data supplied.
containerName
- name for this container to be referenced bydata
- byte[] data to be placed in the container referenced by
containerNameCCSID
- specify the CCSID of the String data supplied
ContainerException
- if the container name includes invalid characters, the name
is null, or the container name already exists
java.io.UnsupportedEncodingException
- if the CCSID is not supportedpublic Container copyContainer(java.lang.String containerName, Channel sourceChannel) throws ContainerException
Copy a container from sourceChannel into this channel. The container containerName will be copied to this channel.
containerName
- the container name to be copiedsourceChannel
- reference to the channel that holds the container
ContainerException
- if the container is not found in sourceChannel, or already
exists in this channelpublic Container copyContainer(java.lang.String containerName, Channel sourceChannel, java.lang.String newContainerName) throws ContainerException
Copy a container from sourceChannel into this channel. The container containerName will be copied to this channel with a new name newContainerName
containerName
- the container name to be copiedsourceChannel
- reference to the channel that holds the containernewContainerName
- new container name within this channel
ContainerException
- if the container is not found in sourceChannel, already
exists in this channel, or the newContainerName includes
invalid characters or is nullpublic Container moveContainer(java.lang.String containerName, Channel sourceChannel) throws ContainerException
Move a container from sourceChannel into this channel. The container will no longer exist in sourceChannel. The container containerName will be moved to this channel.
containerName
- the container name to be movedsourceChannel
- reference to the channel that holds the container
ContainerException
- if the container is not found in sourceChannel, or already
exists in this channelpublic Container moveContainer(java.lang.String containerName, Channel sourceChannel, java.lang.String newContainerName) throws ContainerException
Move a container from sourceChannel into this channel. The container will no longer exist in sourceChannel. The container containerName will be moved to this channel with a new name newContainerName
containerName
- the container name to be movedsourceChannel
- reference to the channel that holds the containernewContainerName
- new container name within this channel
ContainerException
- if the container is not found in sourceChannel, already
exists in this channel, or the newContainerName includes
invalid characters or is nullpublic Container getContainer(java.lang.String name) throws ContainerNotFoundException
If a container with a matching name is found then a reference to that container is returned.
name
- the container name to find
ContainerNotFoundException
- if the container name is not foundpublic java.util.Collection<Container> getContainers()
public void deleteContainer(java.lang.String name) throws ContainerException
The container will remain in the channel until the next reuest has been sent as CICS will need to be informed that this container has now been deleted. Once the request has completed this container will actually be deleted.
name
- name of the container to delete
ContainerException
- if the container is not found in the channelpublic void markDeleted(java.lang.String name) throws ContainerException
ContainerException
public void addContainer(Container container) throws ContainerException, ContainerExistsException
container
- The container to add to the channel
ContainerException
- If the container is not of the correct type
ContainerExistsException
- If the container already exists in the channelpublic java.util.Set<java.lang.String> getContainerNames()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getName()
public int getCCSID()
public java.lang.String getCodePage()
public void setCCSID(int ccsid)
ccsid
- The CCSID this channel should set as its default.
|
©Copyright IBM Corp. 1994, 2009 Legal |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |