public final class ECIInteractionSpec
extends java.lang.Object
implements javax.resource.cci.InteractionSpec
Constructor and Description |
---|
ECIInteractionSpec()
Default constructor.
|
ECIInteractionSpec(int verb,
java.lang.String prog)
Simple constructor.
|
ECIInteractionSpec(int verb,
java.lang.String prog,
int commLen)
Complete constructor allows specification of all properties.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a listener to those that are informed when a
bound property is changed.
|
int |
getCommareaLength()
Returns the COMMAREA length.
|
java.lang.String |
getFunctionName()
Returns the function name.
|
int |
getInteractionVerb()
Returns the interaction verb.
|
java.lang.String |
getTPNName()
Returns the transaction name TPNName.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a registered listener from the list.
|
void |
setCommareaLength(int length)
Sets the COMMAREA length.
|
void |
setFunctionName(java.lang.String name)
Sets the function name.
|
void |
setInteractionVerb(int verb)
Sets the interaction verb.
|
void |
setTPNName(java.lang.String newTPNName)
Sets the transaction name TPNName.
|
java.lang.String |
toString()
Provides a string representation of this object.
|
public ECIInteractionSpec(int verb, java.lang.String prog, int commLen) throws javax.resource.ResourceException
verb
- The interaction verb to use.prog
- The name of the CICS program to call.commLen
- The length of the COMMAREA being passed to CICS.javax.resource.ResourceException
- If there is a problem creating the InteractionSpec.public ECIInteractionSpec(int verb, java.lang.String prog) throws javax.resource.ResourceException
verb
- The interaction verb to useprog
- The name of the CICS program to calljavax.resource.ResourceException
- If there is a problem creating the InteractionSpec.public ECIInteractionSpec()
public java.lang.String toString()
toString
in class java.lang.Object
public int getInteractionVerb()
The current interaction verb is SYNC_SEND, SYNC_RECEIVE or SYNC_SEND_RECEIVE.
public java.lang.String getFunctionName()
When SYNC_SEND or SYNC_SEND_RECEIVE is specified in the interaction verb property, FunctionName needs to contain the name of the program to execute on CICS.
public int getCommareaLength()
The length of the COMMAREA being passed to CICS inside your input record. If this is not supplied a default is used:
public java.lang.String getTPNName()
This is the name of the CICS mirror transaction that the called program runs under.
public void setInteractionVerb(int verb) throws javax.resource.ResourceException
The interaction verb values are SYNC_SEND, SYNC_RECEIVE and SYNC_SEND_RECEIVE.
verb
- The interaction verb for the InteractionSpec.javax.resource.ResourceException
- An incorrect interaction verb is specified.public void setFunctionName(java.lang.String name)
When SYNC_SEND or SYNC_SEND_RECEIVE is specified in the interaction verb property, function name needs to contain the name of the program to execute on CICS.
name
- The name of the program to execute on CICS.public void setCommareaLength(int length)
The length of the COMMAREA being passed to CICS inside your input record. If this is not supplied a default is used:
Application developers are advised to use a maximum size of 32500 bytes, as this is guaranteed to be flowed successfully across all protocols. COMMAREA sizes greater than this might generate an ECI_ERR_INVALID_DATA_LENGTH return code.
length
- The length of the COMMAREA.public void setTPNName(java.lang.String newTPNName)
This is the name of the CICS mirror transaction that the called program runs under. This option is like the TRANSID option on an EXEC CICS LINK command. A transaction definition in CICS for this TRANSID must point to the DFHMIRS program. Setting the TPNName in the ECIInteractionSpec overrides any value set at deployment time, or on the ManagedConnectionFactory, if a non-managed environment.
If the interaction is performed within a transaction scope, this field has a meaning only for the first interaction within the transaction. Subsequent interactions within the same transaction use the mirror transaction specified on the first interaction.
newTPNName
- The name of the mirror transaction for the interaction.public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)