public interface ChannelProgramLinker extends ProgramLinker
Channel
and
its associated Container
s to pass data on input, and retrieve data
on output.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
Copyright
|
Modifier and Type | Method and Description |
---|---|
Channel |
getChannel()
Get the Channel being used by this ChannelLinker
|
default WritableBITContainer |
getInputBITContainer(java.lang.String containerName)
Get a named container to use for supplying binary data input
|
default WritableCHARContainer |
getInputCHARContainer(java.lang.String containerName)
Get a named container to use for supplying character data input
|
ChannelProgramLinkerResponse |
link()
Link to another program expecting return.
|
default ChannelProgramLinker |
setBytesInput(java.lang.String containerName,
byte[] value)
Convenience method to append a byte[] to a named BIT container
|
default ChannelProgramLinker |
setStringInput(java.lang.String containerName,
java.lang.String value)
Convenience method to append a string to a named CHAR container
|
ChannelProgramLinker |
setSyncOnReturn(boolean syncOnReturn)
Specifies that the server region named on the SYSID option is to take a
sync point on successful completion of the server program.
|
ChannelProgramLinker |
setSysId(java.lang.String sysId)
Specify the system name of a CICS server region to where the program link
request is to be routed.
|
ChannelProgramLinker |
setTransId(java.lang.String transId)
Specifies the name of the mirror transaction that the remote region is to
attach and under which it is to run the server program.
|
static final java.lang.String COPYRIGHT
default WritableCHARContainer getInputCHARContainer(java.lang.String containerName)
containerName
- Name of the containerWritableCHARContainer
for providing character data input to a
programdefault WritableBITContainer getInputBITContainer(java.lang.String containerName)
containerName
- Name of the containerdefault ChannelProgramLinker setStringInput(java.lang.String containerName, java.lang.String value) throws CICSConditionException
See Channel.getCHARContainer(String)
and
WritableCHARContainer.append(String)
for information about
EXEC CICS
API commands and potential RespCode
s.
containerName
- Name of the container to usevalue
- Value to supplyCICSConditionException
- if an error occurs. See
Channel.getCHARContainer(String)
and
WritableCHARContainer.append(String)
for RespCode
information.default ChannelProgramLinker setBytesInput(java.lang.String containerName, byte[] value) throws CICSConditionException
See Channel.getBITContainer(String)
and
WritableBITContainer.append(byte[])
for information about
EXEC CICS
API commands and potential RespCode
s.
containerName
- Name of the container to usevalue
- Value to supplyChannelProgramLinker
instance for chainingCICSConditionException
- if an error occurs. See
Channel.getBITContainer(String)
and
WritableBITContainer.append(byte[])
for RespCode
information.Channel getChannel()
ChannelProgramLinkerResponse link() throws CICSConditionException
EXEC CICS API commands:
EXEC CICS LINK PROGRAM
link
in interface ProgramLinker
CICSConditionException
- if there is a problem linking
to the target program
RespCodes:
ChannelProgramLinker setSyncOnReturn(boolean syncOnReturn)
A CICSConditionException
with a RespCode.ROLLEDBACK
is
thrown by ProgramLinker.link()
if changes to recoverable resources are rolled
back before return from the server program.
A CICSConditionException
with a RespCode.TERMERR
is
thrown by ProgramLinker.link()
following failure of the communications link or
the system in which the server program is running. Programs are responsible
for handling this condition and ensuring that data consistency is restored.
setSyncOnReturn
in interface ProgramLinker
syncOnReturn
- Whether to take a syncpoint after the target program has
been invoked. The default value is false
ProgramLinker
instanceChannelProgramLinker setSysId(java.lang.String sysId)
A remote system name specified on the SYSID option takes priority over any remote system name specified on the PROGRAM resource definition or returned by the dynamic routing program.
setSysId
in interface ProgramLinker
sysId
- Specifies the system name of a CICS server region to where the
program link request is to be routedProgramLinker
instanceChannelProgramLinker setTransId(java.lang.String transId)
If you omit the TRANSID option, reference is made to PROGRAM resource definitions held locally if the installed PROGRAM definition specifies remote attribute DYNAMIC(YES). Otherwise, the server region attaches either CSMI, CPMI, or CVMI by default.
setTransId
in interface ProgramLinker
transId
- Specifies the name of the mirror transaction that the remote
region is to attach and under which it is to run the server
programProgramLinker
instance