A B C D E G I L P R S V W 

A

append(byte[]) - Method in interface com.ibm.cics.jcicsx.BITContainer
Append the object to the end of the container.
append(String) - Method in interface com.ibm.cics.jcicsx.CHARContainer
Append the object to the end of the container.
append(byte[]) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Append the object to the end of the container.
append(String) - Method in interface com.ibm.cics.jcicsx.WritableCHARContainer
Append the object to the end of the container.
append(T) - Method in interface com.ibm.cics.jcicsx.WritableContainer
Append the object to the end of the container.
appendWith(Serializer<T>, T) - Method in interface com.ibm.cics.jcicsx.BITContainer
Add the provided object of type T to the container, using the provided Serializer to convert from bytes.
appendWith(Serializer<T>, int, T) - Method in interface com.ibm.cics.jcicsx.BITContainer
Put the provided object of type T into the container, using the provided Serializer to convert from bytes.
appendWith(Serializer<T>, T) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Add the provided object of type T to the container, using the provided Serializer to convert from bytes.
appendWith(Serializer<T>, int, T) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Put the provided object of type T into the container, using the provided Serializer to convert from bytes.
asInputStream(int) - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Get the content of this CICS Container as an InputStream.
asOutputStream(boolean, int) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Get a view of this BIT container as an OutputStream.
asReadableBITContainer() - Method in interface com.ibm.cics.jcicsx.ReadableCHARContainer
Returns a view of this container as a BIT container, which exposes the raw bytes in the CICS container, without having CICS convert them to a target codepage.

B

BITContainer - Interface in com.ibm.cics.jcicsx
A CICS BIT container which can be both read from, and written to

C

Channel - Interface in com.ibm.cics.jcicsx
A CICS channel
ChannelProgramLinker - Interface in com.ibm.cics.jcicsx
An interface for linking to a CICS program, using a Channel and its associated Containers to pass data on input, and retrieve data on output.
ChannelProgramLinkerResponse - Interface in com.ibm.cics.jcicsx
A ChannelProgramLinkerResponse is returned when a program is linked to using ChannelProgramLinker.link().
CHARContainer - Interface in com.ibm.cics.jcicsx
 
CICSConditionException - Exception in com.ibm.cics.jcicsx
Exception class representing a failure when executing an EXEC CICS API command.
CICSConditionException(RespCode, int) - Constructor for exception com.ibm.cics.jcicsx.CICSConditionException
Constructor
CICSConditionException(RespCode, int, Throwable) - Constructor for exception com.ibm.cics.jcicsx.CICSConditionException
Constructor
CICSConditionIOException - Exception in com.ibm.cics.jcicsx
Exception class representing a failure when executing an EXEC CICS API command.
CICSConditionIOException(CICSConditionException) - Constructor for exception com.ibm.cics.jcicsx.CICSConditionIOException
Constructor
CICSConditionRuntimeException - Exception in com.ibm.cics.jcicsx
A runtime exception to handle CICS Response Exceptions for overriding methods that can?t have checked exceptions
CICSConditionRuntimeException(RespCode, int) - Constructor for exception com.ibm.cics.jcicsx.CICSConditionRuntimeException
Constructor
CICSConditionRuntimeException(RespCode, int, Throwable) - Constructor for exception com.ibm.cics.jcicsx.CICSConditionRuntimeException
Constructor
CICSContext - Interface in com.ibm.cics.jcicsx
The environment that the API is executing in.
CICSContextProvider - Interface in com.ibm.cics.jcicsx
Factory interface for implementors of the JCICSX API to provide instances of CICSContext.
com.ibm.cics.jcicsx - package com.ibm.cics.jcicsx
CICS TS JCICSX API
Container - Interface in com.ibm.cics.jcicsx
A CICS container
createProgramLinker(String) - Method in interface com.ibm.cics.jcicsx.CICSContext
Create a ProgramLinker for invoking a program without input or output
createProgramLinkerWithChannel(String, String) - Method in interface com.ibm.cics.jcicsx.CICSContext
Create a ProgramLinker for invoking a program using a channel with a specific name
createProgramLinkerWithChannel(String, Channel) - Method in interface com.ibm.cics.jcicsx.CICSContext
Create a ProgramLinker for invoking a program with a specific Channel instance

D

delete() - Method in interface com.ibm.cics.jcicsx.Channel
Deletes this channel and all the containers that are in it
- Any data in containers is discarded
- All storage related to the channel and its containers is released
delete() - Method in interface com.ibm.cics.jcicsx.Container
Deletes this container
- Discards any data stored in this container
deserialize(InputStream) - Method in interface com.ibm.cics.jcicsx.Deserializer
Deserializes the content of a container into an object of type T.
Deserializer<T> - Interface in com.ibm.cics.jcicsx
A Deserializer is capable of transforming the content of a BitContainer into an object of type T.
Deserializers - Class in com.ibm.cics.jcicsx
Common implementations of Deserializer for various useful functions.

E

exists() - Method in interface com.ibm.cics.jcicsx.Channel
Determines if this channel exists in CICS
exists() - Method in interface com.ibm.cics.jcicsx.Container
Determines whether or not this container exists in CICS.

G

get() - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Read the contents of this container as a byte[]
get() - Method in interface com.ibm.cics.jcicsx.ReadableCHARContainer
Get the contents of this container as a String
get() - Method in interface com.ibm.cics.jcicsx.ReadableContainer
Get the contents of this container
getBITContainer(String) - Method in interface com.ibm.cics.jcicsx.Channel
Get a container of BIT type, i.e.
getBytesOutput(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinkerResponse
Convenience method for reading a named string from a named CHAR container.
getCause() - Method in exception com.ibm.cics.jcicsx.CICSConditionIOException
getChannel() - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Get the Channel being used by this ChannelLinker
getChannel() - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinkerResponse
Get the Channel that was used by the ChannelProgramLinker that constructed this response, i.e.
getChannel(String) - Method in interface com.ibm.cics.jcicsx.CICSContext
Create a channel with the supplied name.
getCHARContainer(String) - Method in interface com.ibm.cics.jcicsx.Channel
Get a container of CHAR type, i.e.
getCICSContext() - Static method in interface com.ibm.cics.jcicsx.CICSContext
Get an instance of the current CICSContext.
getCICSContext() - Method in interface com.ibm.cics.jcicsx.CICSContextProvider
Get the current CICSContext
getContainerCount() - Method in interface com.ibm.cics.jcicsx.Channel
Get the number of containers in this channel
getInputBITContainer(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Get a named container to use for supplying binary data input
getInputCHARContainer(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Get a named container to use for supplying character data input
getLength() - Method in interface com.ibm.cics.jcicsx.Container
Get the length in bytes of the current contents of the CICS Container
getMessage() - Method in exception com.ibm.cics.jcicsx.CICSConditionException
 
getMessage() - Method in exception com.ibm.cics.jcicsx.CICSConditionIOException
Get the message for this exception
getMessage() - Method in exception com.ibm.cics.jcicsx.CICSConditionRuntimeException
Get the message for this exception
getName() - Method in interface com.ibm.cics.jcicsx.Channel
Get the name of this channel
getName() - Method in interface com.ibm.cics.jcicsx.Container
Get the name of the container
getOutputBITContainer(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinkerResponse
Get a named container to use for reading binary data output.
getOutputCHARContainer(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinkerResponse
Get a named container to use for reading character data output.
getResp2() - Method in exception com.ibm.cics.jcicsx.CICSConditionException
Get the CICS RESP2 code associated with this Exception
getResp2() - Method in exception com.ibm.cics.jcicsx.CICSConditionIOException
Get the CICS RESP2 code associated with this Exception
getResp2() - Method in exception com.ibm.cics.jcicsx.CICSConditionRuntimeException
Get the CICS RESP2 code associated with this Exception
getRespCode() - Method in exception com.ibm.cics.jcicsx.CICSConditionException
Get the CICS RESP code associated with this Exception
getRespCode() - Method in exception com.ibm.cics.jcicsx.CICSConditionIOException
Get the CICS RESP code associated with this Exception
getRespCode() - Method in exception com.ibm.cics.jcicsx.CICSConditionRuntimeException
Get the CICS RESP code associated with this Exception
getStringOutput(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinkerResponse
Convenience method for reading a named string from a named CHAR container.
getTaskNumber() - Method in interface com.ibm.cics.jcicsx.CICSContext
Get the task number of the currently executing CICS task
getTransactionChannel() - Method in interface com.ibm.cics.jcicsx.CICSContext
Get the transaction Channel, if any.
getValue() - Method in enum com.ibm.cics.jcicsx.RespCode
Returns the numeric value associated with this RespCode
getWith(Deserializer<T>) - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Read the content of the container into an object of type T, using the provided Deserializer.
getWith(Deserializer<T>, int) - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Read the content of the container into an object of type T, using the provided Deserializer.

I

iterator() - Method in interface com.ibm.cics.jcicsx.Channel
Returns an iterator over elements of type Container.

L

link() - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Link to another program expecting return.
link() - Method in interface com.ibm.cics.jcicsx.ProgramLinker
Link to another program expecting return.

P

ProgramLinker - Interface in com.ibm.cics.jcicsx
An interface for linking to a CICS program.
ProgramLinkerResponse - Interface in com.ibm.cics.jcicsx
A ProgramLinkerResponse is returned when program is linked to using ProgramLinker.link().
put(byte[]) - Method in interface com.ibm.cics.jcicsx.BITContainer
Overwrite the container contents with the supplied object.
put(String) - Method in interface com.ibm.cics.jcicsx.CHARContainer
Overwrite the container contents with the supplied object.
put(byte[]) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Overwrite the container contents with the supplied object.
put(String) - Method in interface com.ibm.cics.jcicsx.WritableCHARContainer
Overwrite the container contents with the supplied object.
put(T) - Method in interface com.ibm.cics.jcicsx.WritableContainer
Overwrite the container contents with the supplied object.
putWith(Serializer<T>, T) - Method in interface com.ibm.cics.jcicsx.BITContainer
Put the provided object of type T into the container, using the provided Serializer to convert from bytes.
putWith(Serializer<T>, int, T) - Method in interface com.ibm.cics.jcicsx.BITContainer
Put the provided object of type T into the container, using the provided Serializer to convert from bytes.
putWith(Serializer<T>, T) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Put the provided object of type T into the container, using the provided Serializer to convert from bytes.
putWith(Serializer<T>, int, T) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Put the provided object of type T into the container, using the provided Serializer to convert from bytes.

R

read(byte[]) - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Read the contents of the CICS Container into an application supplied byte[].
read(byte[], int, int, int) - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Read part of the contents of the CICS Container into part of an application supplied byte[]
ReadableBITContainer - Interface in com.ibm.cics.jcicsx
A CICS BIT container which can be read from
ReadableCHARContainer - Interface in com.ibm.cics.jcicsx
 
ReadableContainer<T> - Interface in com.ibm.cics.jcicsx
A CICS container of objects of type T
RespCode - Enum in com.ibm.cics.jcicsx
Enum representing EXEC CICS API RESP codes

S

serialize(T, OutputStream) - Method in interface com.ibm.cics.jcicsx.Serializer
Serializes the supplied object to the supplied OutputStream.
Serializer<T> - Interface in com.ibm.cics.jcicsx
A Serializer is capable of transforming an object of type T into a byte-array representation and writing it to a BITContainer.
Serializers - Class in com.ibm.cics.jcicsx
Common implementations of Serializer for various useful functions.
setBytesInput(String, byte[]) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Convenience method to append a byte[] to a named BIT container
setStringInput(String, String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Convenience method to append a string to a named CHAR container
setSyncOnReturn(boolean) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Specifies that the server region named on the SYSID option is to take a sync point on successful completion of the server program.
setSyncOnReturn(boolean) - Method in interface com.ibm.cics.jcicsx.ProgramLinker
Specifies that the server region named on the SYSID option is to take a sync point on successful completion of the server program.
setSysId(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Specify the system name of a CICS server region to where the program link request is to be routed.
setSysId(String) - Method in interface com.ibm.cics.jcicsx.ProgramLinker
Specify the system name of a CICS server region to where the program link request is to be routed.
setTransId(String) - Method in interface com.ibm.cics.jcicsx.ChannelProgramLinker
Specifies the name of the mirror transaction that the remote region is to attach and under which it is to run the server program.
setTransId(String) - Method in interface com.ibm.cics.jcicsx.ProgramLinker
Specifies the name of the mirror transaction that the remote region is to attach and under which it is to run the server program.
stringDeserializer(Charset) - Static method in class com.ibm.cics.jcicsx.Deserializers
Create a deserializer to read Strings from a ReadableBITContainer using Java's integrated codepage support to decode them.
stringSerializer(Charset) - Static method in class com.ibm.cics.jcicsx.Serializers
Create a serializer to write Strings to a WritableBITContainer using Java to encode them

V

valueOf(String) - Static method in enum com.ibm.cics.jcicsx.RespCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ibm.cics.jcicsx.RespCode
Returns an array containing the constants of this enum type, in the order they are declared.

W

with(Deserializer<T>, int) - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Return a container that wraps this container and allows objects of type T to be retrieved from it directly.
with(Deserializer<T>) - Method in interface com.ibm.cics.jcicsx.ReadableBITContainer
Return a container that wraps this container and allows objects of type T to be retrieved from it directly.
with(Serializer<T>, int) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Return a container that wraps this container and allows objects of type T to be written to it directly.
with(Serializer<T>) - Method in interface com.ibm.cics.jcicsx.WritableBITContainer
Return a container that wraps this container and allows objects of type T to be written to it directly.
WritableBITContainer - Interface in com.ibm.cics.jcicsx
An interface which describes a CICS container with BIT datatype that can be written to
WritableCHARContainer - Interface in com.ibm.cics.jcicsx
An interface which describes a CICS container with CHAR datatype which can be written to.
WritableContainer<T> - Interface in com.ibm.cics.jcicsx
An interface that describes a CICS container that can be written to
A B C D E G I L P R S V W