Package com.ibm.websphere.ola
Class ConnectionSpecImpl
java.lang.Object
com.ibm.websphere.ola.ConnectionSpecImpl
- All Implemented Interfaces:
Serializable,jakarta.resource.cci.ConnectionSpec
public class ConnectionSpecImpl
extends Object
implements jakarta.resource.cci.ConnectionSpec, Serializable
The ConnectionSpec is used to pass resource-specific data to the resource for
purposes of establishing the connection.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intUse a BIT channelstatic final intUse a BIT containerstatic final intUse a CHAR channelstatic final intUse a CHAR containerstatic final StringDefault OTMA Client Name -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanCompares two objectsintGets the connection wait timeout value.booleanGets the flag indicating set connection wait timeout was called.Gets the CICS Link Channel ID set by linkTaskChanID() This method only applies to applications calling into the CICS link server.intGets the CICS Link Channel Type set by linkTaskChanType() This method only applies to applications calling into the CICS link server.booleanGets the flag indicating set LinkTaskChanType was called.Gets the CICS Link Request Container ID set by linkTaskReqContID() This method only applies to applications calling into the CICS link server.intGets the CICS Link Request Container Type set by linkTaskReqContType() This method only applies to applications calling into the CICS link server.booleanGets the flag indicating set LinkTaskReqContType was called.Gets the CICS Link Response Container ID set by linkTaskReqContID() This method only applies to applications calling into the CICS link server.intGets the CICS Link Response Container Type set by linkTaskRspContType() This method only applies to applications calling into the CICS link server.booleanGets the flag indicating set LinkTaskRspContType was called.Gets the CICS Link Transaction ID set by setLinkTaskTranID.Gets the value set by setOTMAClientName().Gets the value set by setOTMAGroupID().intGets the value set by setOTMAMaxRecvSize().booleanGets the flag indicating set OTMAMaxRecvSize was called.intGets the value set by setOTMAMaxSegments().booleanGets the flag indicating set OTMAMaxSegments was called.booleanGets the value set by setOTMARequestLLLL().booleanGets the value set by setOTMARequestLLZZ().booleanGets the flag indicating set OTMARequestLLZZ was called.booleanGets the value set by setOTMAResponseLLLL().booleanGets the value set by setOTMAResponseLLZZ().booleanGets the flag indicating set OTMAResponseLLZZ was called.Gets the value set by setOTMAServerName().Gets the value set by setOTMASyncLevel().Gets the password used to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.Gets the register name to connect to.booleanGets the value set by setRRSTransactional().booleanGets the flag indicating set RRSTransactional was called.booleanGets the value set by setUseCICSContainer.booleanGets the flag indicating set useCICSContainers was called.booleanGets the value set by setOTMA().Gets the user ID used to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.inthashCode()Generates a hash code for object comparisonvoidsetConnectionWaitTimeout(int connectionWaitTimeout) Sets the connection wait timeout value.voidsetLinkTaskChanID(String linkTaskChanID) Sets the CICS Link Channel ID.voidsetLinkTaskChanType(int linkTaskChanType) Sets the CICS Link Channel Type.voidsetLinkTaskReqContID(String linkTaskReqContID) Sets the CICS Link Request Container ID.voidsetLinkTaskReqContType(int linkTaskReqContType) Sets the CICS Link Request Container Type.voidsetLinkTaskRspContID(String linkTaskRspContID) Sets the CICS Link Response Container ID.voidsetLinkTaskRspContType(int linkTaskRspContType) Sets the CICS Link Response Container Type.voidsetLinkTaskTranID(String linkTaskTranID) Sets the CICS Link Transaction ID.voidsetOTMAClientName(String OTMAClientName) Sets the OTMA Client Name.voidsetOTMAGroupID(String OTMAGroupID) Sets the OTMA XCF Group ID Name.voidsetOTMAMaxRecvSize(int OTMAMaxRecvSize) Tells the connection the maximum size for a multi-segment message received using OTMA - if not used, defaults to 32760 bytes.voidsetOTMAMaxSegments(int OTMAMaxSegments) 25@670111A Tells the connection the maximum number of segments that are supported for send and receive processing - if not used, defaults to 1.voidsetOTMARequestLLLL(boolean reqLLLL) Tells the connection that requests to be sent to IMS over OTMA are formatted with LLLLZZ-style length prefixes.voidsetOTMARequestLLZZ(boolean reqLLZZ) Tells the connection that requests to be sent to IMS over OTMA are formatted with LLZZ-style length prefixes.voidsetOTMAResponseLLLL(boolean respLLLL) Tells the connection that responses received from IMS over OTMA are to be formatted with LLLLZZ-style length prefixes.voidsetOTMAResponseLLZZ(boolean respLLZZ) Tells the connection that responses received from IMS over OTMA are to be formatted with LLZZ-style length prefixes.voidsetOTMAServerName(String OTMAServerName) Sets the OTMA Server Name.voidsetOTMASyncLevel(String OTMASyncLevel) Sets the OTMA Sync Level 0=None | 1=Confirm This method only applies to applications calling into IMS programs.voidsetPassword(String password) Sets the password to use to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.voidsetRegisterName(String registerName) Sets the register name.voidsetRRSTransactional(boolean RRSTransactional) Tells the connection that RRS transactions are to be enabled.voidsetUseCICSContainer(boolean useCICSContainer) Tells the connection to use containers when communicating with CICS.voidsetUseCICSContainer(int useCICSContainer) Deprecated.voidsetUseOTMA(boolean useOTMA) Tells the connection to use the IMS OTMA access method for call requests This method only applies to applications calling into IMS programs.voidsetUsername(String username) Sets the user ID to use to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.
-
Field Details
-
BIT_CONTAINER
public static final int BIT_CONTAINERUse a BIT container- See Also:
-
CHAR_CONTAINER
public static final int CHAR_CONTAINERUse a CHAR container- See Also:
-
BIT_CHANNEL
public static final int BIT_CHANNELUse a BIT channel- See Also:
-
CHAR_CHANNEL
public static final int CHAR_CHANNELUse a CHAR channel- See Also:
-
DEFAULT_OTMA_CLIENT_NAME
Default OTMA Client Name- See Also:
-
-
Constructor Details
-
ConnectionSpecImpl
public ConnectionSpecImpl()
-
-
Method Details
-
setRegisterName
Sets the register name.- Parameters:
registerName- The register name to connect to.
-
getRegisterName
Gets the register name to connect to.- Returns:
- The register name.
-
setConnectionWaitTimeout
public void setConnectionWaitTimeout(int connectionWaitTimeout) Sets the connection wait timeout value. This is the amount of time to wait for a connection to become available to the target register name.- Parameters:
connectionWaitTimeout- The number of seconds to wait for a connection
-
getConnectionWaitTimeout
public int getConnectionWaitTimeout()Gets the connection wait timeout value.- Returns:
- The timeout value, in seconds.
-
getConnectionWaitTimeoutFromCSI
public boolean getConnectionWaitTimeoutFromCSI()Gets the flag indicating set connection wait timeout was called.- Returns:
- True or False
-
setLinkTaskTranID
Sets the CICS Link Transaction ID. This is the CICS transaction which will be used to run the Program Link invocation task. If this value is not set, it will default to BBO#. This method only applies to applications calling into the CICS link server.- Parameters:
linkTaskTranID- The transaction to use as the Program Link invocation task. The transaction name is between 1 and 4 characters in length.
-
getLinkTaskTranID
Gets the CICS Link Transaction ID set by setLinkTaskTranID. This method only applies to applications calling into the CICS link server.- Returns:
- The CICS transaction name used to run the Program Link invocation task.
-
setLinkTaskReqContID
Sets the CICS Link Request Container ID. This method only applies to applications calling into the CICS link server.- Parameters:
linkTaskReqContID- The name of the container to pass the request parameters into.
-
getLinkTaskReqContID
Gets the CICS Link Request Container ID set by linkTaskReqContID() This method only applies to applications calling into the CICS link server.- Returns:
- The name of the container to pass the request parameters into.
-
setLinkTaskReqContType
public void setLinkTaskReqContType(int linkTaskReqContType) Sets the CICS Link Request Container Type. The type can be CHAR or BIT. To specify CHAR, use the value 0. To specify BIT, use the value 1. You can also specify the constants CHAR_CONTAINER or BIT_CONTAINER defined in this class. If no value is specified, the default is to use a CHAR container. This method only applies to applications calling into the CICS link server.- Parameters:
linkTaskReqContType- The type of container to use. Specify 0 to use a CHAR container, or 1 to use a BIT container.
-
getLinkTaskReqContType
public int getLinkTaskReqContType()Gets the CICS Link Request Container Type set by linkTaskReqContType() This method only applies to applications calling into the CICS link server.- Returns:
- The type of container to be used.
-
getlinkTaskReqContTypeFromCSI
public boolean getlinkTaskReqContTypeFromCSI()Gets the flag indicating set LinkTaskReqContType was called.- Returns:
- True or False
-
setLinkTaskRspContID
Sets the CICS Link Response Container ID. This method only applies to applications calling into the CICS link server.- Parameters:
linkTaskReqContID- The name of the container to pass the response parameters into.
-
getLinkTaskRspContID
Gets the CICS Link Response Container ID set by linkTaskReqContID() This method only applies to applications calling into the CICS link server.- Returns:
- The name of the container to pass the response parameters into.
-
setLinkTaskRspContType
public void setLinkTaskRspContType(int linkTaskRspContType) Sets the CICS Link Response Container Type. The type can be CHAR or BIT. To specify CHAR, use the value 0. To specify BIT, use the value 1. You can also specify the constants CHAR_CONTAINER or BIT_CONTAINER defined in this class. If no value is specified, the default is to use a CHAR container. This method only applies to applications calling into the CICS link server.- Parameters:
linkTaskRspContType- The type of container to use. Specify 0 to use a CHAR container, or 1 to use a BIT container.
-
getLinkTaskRspContType
public int getLinkTaskRspContType()Gets the CICS Link Response Container Type set by linkTaskRspContType() This method only applies to applications calling into the CICS link server.- Returns:
- The type of container to be used.
-
getlinkTaskRspContTypeFromCSI
public boolean getlinkTaskRspContTypeFromCSI()Gets the flag indicating set LinkTaskRspContType was called.- Returns:
- True or False
-
setUseCICSContainer
public void setUseCICSContainer(int useCICSContainer) Deprecated.Tells the connection to use the containers when communicating with CICS. The names and types of containers used for the request and response can be set by calling other methods on this class. This method only applies to applications calling into the CICS link server.- Parameters:
useCICSContainer- Set this value to '1' to use containers when communicating with the CICS Link Server.- See Also:
-
setUseCICSContainer
public void setUseCICSContainer(boolean useCICSContainer) Tells the connection to use containers when communicating with CICS. The names and types of containers used for the request and response can be set by calling other methods on this class. This method only applies to applications calling into the CICS link server.- Parameters:
useCICSContainer- Set this value to true to use containers when communicating with the CICS Link Server.- See Also:
-
getUseCICSContainer
public boolean getUseCICSContainer()Gets the value set by setUseCICSContainer.- Returns:
- true if containers are used, false if not.
-
getuseCICSContainerFromCSI
public boolean getuseCICSContainerFromCSI()Gets the flag indicating set useCICSContainers was called.- Returns:
- True or False
-
setLinkTaskChanID
Sets the CICS Link Channel ID. This method only applies to applications calling into the CICS link server.- Parameters:
linkTaskChanID- The name of the channel to pass the request parameters into.
-
getLinkTaskChanID
Gets the CICS Link Channel ID set by linkTaskChanID() This method only applies to applications calling into the CICS link server.- Returns:
- The name of the channel to pass the request parameters into.
-
setLinkTaskChanType
public void setLinkTaskChanType(int linkTaskChanType) Sets the CICS Link Channel Type. The type can be CHAR or BIT. To specify CHAR, use the value 0. To specify BIT, use the value 1. You can also specify the constants CHAR_CHANNEL or BIT_CHANNEL defined in this class. If no value is specified, the default is to use a CHAR channel. This method only applies to applications calling into the CICS link server.- Parameters:
linkTaskChanType- The type of channel to use. Specify 0 to use a CHAR channel, or 1 to use a BIT channel.
-
getLinkTaskChanType
public int getLinkTaskChanType()Gets the CICS Link Channel Type set by linkTaskChanType() This method only applies to applications calling into the CICS link server.- Returns:
- The type of channel to be used.
-
getlinkTaskChanTypeFromCSI
public boolean getlinkTaskChanTypeFromCSI()Gets the flag indicating set LinkTaskChanType was called.- Returns:
- True or False
-
setUseOTMA
public void setUseOTMA(boolean useOTMA) Tells the connection to use the IMS OTMA access method for call requests This method only applies to applications calling into IMS programs.- Parameters:
useOTMA- Set this value to true to use OTMA when communicating with IMS.- See Also:
-
getUseOTMA
public boolean getUseOTMA()Gets the value set by setOTMA().- Returns:
- true if IMS OTMA is to be used, false if not.
-
setOTMAClientName
Sets the OTMA Client Name. This method only applies to applications calling into IMS programs.- Parameters:
OTMAClientName- Set this value to the name of the OTMA Client to use when communicating with IMS.- See Also:
-
com.ibm.websphere.ola.ConnectionSpecImpl#setOTMA(boolean)setOTMAServerName(String)setOTMAGroupID(String)setOTMASyncLevel(String)setOTMAMaxSegments(int)setOTMAMaxRecvSize(int)setOTMARequestLLZZ(boolean)setOTMAResponseLLZZ(boolean)
-
getOTMAClientName
Gets the value set by setOTMAClientName().- Returns:
- The name of the OTMA Client used for IMS OTMA calls.
-
setOTMAServerName
Sets the OTMA Server Name. This method only applies to applications calling into IMS programs.- Parameters:
OTMAServerName- Set this value to the name of the OTMA Server to use when communicating with IMS.- See Also:
-
com.ibm.websphere.ola.ConnectionSpecImpl#setOTMA(boolean)setOTMAClientName(String)setOTMAGroupID(String)setOTMASyncLevel(String)setOTMAMaxSegments(int)setOTMAMaxRecvSize(int)setOTMARequestLLZZ(boolean)setOTMAResponseLLZZ(boolean)
-
getOTMAServerName
Gets the value set by setOTMAServerName().- Returns:
- The name of the OTMA Server used for IMS OTMA calls.
-
setOTMAGroupID
Sets the OTMA XCF Group ID Name. This method only applies to applications calling into IMS programs.- Parameters:
OTMAGroupID- Set this value to the name of the OTMA XCF Grouup ID to use when communicating with IMS.- See Also:
-
com.ibm.websphere.ola.ConnectionSpecImpl#setOTMA(boolean)setOTMAClientName(String)setOTMAServerName(String)setOTMASyncLevel(String)setOTMAMaxSegments(int)setOTMAMaxRecvSize(int)setOTMARequestLLZZ(boolean)setOTMAResponseLLZZ(boolean)
-
getOTMAGroupID
Gets the value set by setOTMAGroupID().- Returns:
- The name of the OTMA XCF Group ID used for IMS OTMA calls.
-
setOTMASyncLevel
Sets the OTMA Sync Level 0=None | 1=Confirm This method only applies to applications calling into IMS programs.- Parameters:
OTMASyncLevel- Set this value to the request Sync Level 0|1 to use when communicating with IMS.- See Also:
-
com.ibm.websphere.ola.ConnectionSpecImpl#setOTMA(boolean)setOTMAClientName(String)setOTMAServerName(String)setOTMAGroupID(String)setOTMAMaxSegments(int)setOTMAMaxRecvSize(int)setOTMARequestLLZZ(boolean)setOTMAResponseLLZZ(boolean)
-
getOTMASyncLevel
Gets the value set by setOTMASyncLevel().- Returns:
- The name of the OTMA Sync Level used for IMS OTMA calls.
-
setOTMAMaxSegments
public void setOTMAMaxSegments(int OTMAMaxSegments) 25@670111A Tells the connection the maximum number of segments that are supported for send and receive processing - if not used, defaults to 1.- Parameters:
OTMAMaxSegments- Set this value to the max segments that may be sent or received in a multi-segment message from IMS.- See Also:
-
getOTMAMaxSegments
public int getOTMAMaxSegments()Gets the value set by setOTMAMaxSegments().- Returns:
- max number of IMS OTMA Multi-segments or zero if multi-segment messages are not supported on the connection.
-
getOTMAMaxSegmentsFromCSI
public boolean getOTMAMaxSegmentsFromCSI()Gets the flag indicating set OTMAMaxSegments was called.- Returns:
- True or False
-
setOTMAMaxRecvSize
public void setOTMAMaxRecvSize(int OTMAMaxRecvSize) Tells the connection the maximum size for a multi-segment message received using OTMA - if not used, defaults to 32760 bytes.- Parameters:
OTMAMaxRecvSize- Set this value to the max number bytes that may be received in a multi-segment message from IMS.- See Also:
-
getOTMAMaxRecvSize
public int getOTMAMaxRecvSize()Gets the value set by setOTMAMaxRecvSize().- Returns:
- max receive message size for IMS OTMA requests.
-
getOTMAMaxRecvSizeFromCSI
public boolean getOTMAMaxRecvSizeFromCSI()Gets the flag indicating set OTMAMaxRecvSize was called.- Returns:
- True or False
-
setOTMARequestLLZZ
public void setOTMARequestLLZZ(boolean reqLLZZ) Tells the connection that requests to be sent to IMS over OTMA are formatted with LLZZ-style length prefixes.- Parameters:
reqLLZZ- Set this value to true to indicate that LLZZ format lengths are passed to this routine for message segments to be sent to IMS. When false, message segments are prefixed instead by 4 byte LLLL length indicator.- See Also:
-
getOTMARequestLLZZ
public boolean getOTMARequestLLZZ()Gets the value set by setOTMARequestLLZZ().- Returns:
- true if LLZZ-formatted messages are passed in and are to be sent to IMS, false if LLLL-formatted messages are in use.
-
getOTMARequestLLZZFromCSI
public boolean getOTMARequestLLZZFromCSI()Gets the flag indicating set OTMARequestLLZZ was called.- Returns:
- True or False
-
setOTMARequestLLLL
public void setOTMARequestLLLL(boolean reqLLLL) Tells the connection that requests to be sent to IMS over OTMA are formatted with LLLLZZ-style length prefixes.- Parameters:
reqLLLL- Set this value to true to indicate that LLLL format lengths are passed to this routine for message segments to be sent to IMS. When false, message segments are prefixed instead by 4 byte LLZZ length indicator.- See Also:
-
getOTMARequestLLLL
public boolean getOTMARequestLLLL()Gets the value set by setOTMARequestLLLL().- Returns:
- true if LLLL-formatted messages are in use, false if LLZZ is used.
-
setOTMAResponseLLZZ
public void setOTMAResponseLLZZ(boolean respLLZZ) Tells the connection that responses received from IMS over OTMA are to be formatted with LLZZ-style length prefixes.- Parameters:
respLLZZ- Set this value to true to indicate that LLZZ format lengths are desired for message segments received from IMS. When false, message segments are prefixed instead by 4 byte LLLL length indicator.- See Also:
-
getOTMAResponseLLZZ
public boolean getOTMAResponseLLZZ()Gets the value set by setOTMAResponseLLZZ().- Returns:
- true if LLZZ-formatted messages are expected for responses from IMS, false if LLLL format messages are expected.
-
getOTMAResponseLLZZFromCSI
public boolean getOTMAResponseLLZZFromCSI()Gets the flag indicating set OTMAResponseLLZZ was called.- Returns:
- True or False
-
setRRSTransactional
public void setRRSTransactional(boolean RRSTransactional) Tells the connection that RRS transactions are to be enabled.- Parameters:
RRSTransactional- indicates that RRS is to be enabled when set to 1.
-
getRRSTransactional
public boolean getRRSTransactional()Gets the value set by setRRSTransactional().- Returns:
- true if RRS transactions are to be enabled for calls to IMS applications.
-
getRRSTransactionalFromCSI
public boolean getRRSTransactionalFromCSI()Gets the flag indicating set RRSTransactional was called.- Returns:
- True or False
-
setOTMAResponseLLLL
public void setOTMAResponseLLLL(boolean respLLLL) Tells the connection that responses received from IMS over OTMA are to be formatted with LLLLZZ-style length prefixes.- Parameters:
respLLLL- Set this value to true to indicate that LLLL format lengths are desired for message segments received from IMS. When false, message segments are prefixed instead by 4 byte LLZZ length indicator.- See Also:
-
getOTMAResponseLLLL
public boolean getOTMAResponseLLLL()Gets the value set by setOTMAResponseLLLL().- Returns:
- true if LLLL-formatted messages are in use, false if LLZZ is used.
-
setUsername
Sets the user ID to use to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.- Parameters:
userID- The user ID
-
getUsername
Gets the user ID used to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.- Returns:
- The user ID
-
setPassword
Sets the password to use to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.- Parameters:
password- The password
-
getPassword
Gets the password used to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.- Returns:
- The password
-
hashCode
public int hashCode()Generates a hash code for object comparison -
equals
Compares two objects
-
setUseCICSContainer(boolean)