com.ibm.websphere.ola

Class ConnectionSpecImpl

  1. java.lang.Object
  2. extended bycom.ibm.websphere.ola.ConnectionSpecImpl
All implemented interfaces:
java.io.Serializable, javax.resource.cci.ConnectionSpec

  1. public class ConnectionSpecImpl
  2. extends java.lang.Object
  3. implements javax.resource.cci.ConnectionSpec, java.io.Serializable
The ConnectionSpec is used to pass resource-specific data to the resource for purposes of establishing the connection.
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
BIT_CONTAINER
Use a BIT container
  1. static
  2. int
CHAR_CONTAINER
Use a CHAR container

Constructor Summary

Constructor and Description
ConnectionSpecImpl()

Method Summary

Modifier and Type Method and Description
  1. boolean
equals(java.lang.Object thatObject)
Compares two objects
  1. int
getConnectionWaitTimeout()
Gets the connection wait timeout value.
  1. java.lang.String
getLinkTaskReqContID()
Gets the CICS Link Request Container ID set by linkTaskReqContID() This method only applies to applications calling into the CICS link server.
  1. int
getLinkTaskReqContType()
Gets the CICS Link Request Container Type set by linkTaskReqContType() This method only applies to applications calling into the CICS link server.
  1. java.lang.String
getLinkTaskRspContID()
Gets the CICS Link Response Container ID set by linkTaskReqContID() This method only applies to applications calling into the CICS link server.
  1. int
getLinkTaskRspContType()
Gets the CICS Link Response Container Type set by linkTaskRspContType() This method only applies to applications calling into the CICS link server.
  1. java.lang.String
getLinkTaskTranID()
Gets the CICS Link Transaction ID set by setLinkTaskTranID.
  1. java.lang.String
getOTMAGroupID()
Gets the value set by setOTMAGroupID().
  1. int
getOTMAMaxRecvSize()
Gets the value set by setOTMAMaxRecvSize().
  1. int
getOTMAMaxSegments()
Gets the value set by setOTMAMaxSegments().
  1. boolean
getOTMARequestLLLL()
Gets the value set by setOTMARequestLLLL().
  1. boolean
getOTMARequestLLZZ()
Gets the value set by setOTMARequestLLZZ().
  1. boolean
getOTMAResponseLLLL()
Gets the value set by setOTMAResponseLLLL().
  1. boolean
getOTMAResponseLLZZ()
Gets the value set by setOTMAResponseLLZZ().
  1. java.lang.String
getOTMAServerName()
Gets the value set by setOTMAServerName().
  1. java.lang.String
getOTMASyncLevel()
Gets the value set by setOTMASyncLevel().
  1. java.lang.String
getPassword()
Gets the password used to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.
  1. java.lang.String
getRegisterName()
Gets the register name to connect to.
  1. boolean
getUseCICSContainer()
Gets the value set by setUseCICSContainer.
  1. boolean
getUseOTMA()
Gets the value set by setOTMA().
  1. java.lang.String
getUsername()
Gets the user ID used to log into the remote WebSphere Application Server for z/OS server when using the remote proxy EJB.
  1. int
hashCode()
Generates a hash code for object comparison
  1. void
setConnectionWaitTimeout(int connectionWaitTimeout)
Sets the connection wait timeout value.
  1. void
setLinkTaskReqContID(java.lang.String linkTaskReqContID)
Sets the CICS Link Request Container ID.
  1. void
setLinkTaskReqContType(int linkTaskReqContType)
Sets the CICS Link Request Container Type.
  1. void
setLinkTaskRspContID(java.lang.String linkTaskRspContID)
Sets the CICS Link Response Container ID.
  1. void
setLinkTaskRspContType(int linkTaskRspContType)
Sets the CICS Link Response Container Type.
  1. void
setLinkTaskTranID(java.lang.String linkTaskTranID)
Sets the CICS Link Transaction ID.
  1. void
setOTMAGroupID(java.lang.String OTMAGroupID)
Sets the OTMA XCF Group ID Name.
  1. 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.
  1. 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.
  1. void
setOTMARequestLLLL(boolean reqLLLL)
Tells the connection that requests to be sent to IMS over OTMA are formatted with LLLL-style length prefixes.
  1. void
setOTMARequestLLZZ(boolean reqLLZZ)
Tells the connection that requests to be sent to IMS over OTMA are formatted with LLZZ-style length prefixes.
  1. void
setOTMAResponseLLLL(boolean respLLLL)
Tells the connection that responses received from IMS over OTMA are to be formatted with LLLL-style length prefixes.
  1. void
setOTMAResponseLLZZ(boolean respLLZZ)
Tells the connection that responses received from IMS over OTMA are to be formatted with LLZZ-style length prefixes.
  1. void
setOTMAServerName(java.lang.String OTMAServerName)
Sets the OTMA Server Name.
  1. void
setOTMASyncLevel(java.lang.String OTMASyncLevel)
Sets the OTMA Sync Level 0=SyncOnReturn | 1=SyncLevel1 This method only applies to applications calling into IMS programs.
  1. void
setPassword(java.lang.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.
  1. void
setRegisterName(java.lang.String registerName)
Sets the register name.
  1. void
setUseCICSContainer(boolean useCICSContainer)
Tells the connection to use the containers when communicating with CICS.
  1. void
setUseCICSContainer(int useCICSContainer)
  1. 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.
  1. void
setUsername(java.lang.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.
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

BIT_CONTAINER

  1. public static final int BIT_CONTAINER
Use a BIT container
See Also:

CHAR_CONTAINER

  1. public static final int CHAR_CONTAINER
Use a CHAR container
See Also:

Constructor Detail

ConnectionSpecImpl

  1. public ConnectionSpecImpl()

Method Detail

setRegisterName

  1. public void setRegisterName(java.lang.String registerName)
Sets the register name.
Parameters:
registerName - The register name to connect to.

getRegisterName

  1. public java.lang.String getRegisterName( )
Gets the register name to connect to.
Returns:
The register name.

setConnectionWaitTimeout

  1. 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

  1. public int getConnectionWaitTimeout( )
Gets the connection wait timeout value.
Returns:
The timeout value, in seconds.

setLinkTaskTranID

  1. public void setLinkTaskTranID(java.lang.String linkTaskTranID)
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

  1. public java.lang.String 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

  1. public void setLinkTaskReqContID( java.lang.String linkTaskReqContID)
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

  1. public java.lang.String 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

  1. 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

  1. 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.

setLinkTaskRspContID

  1. public void setLinkTaskRspContID( java.lang.String linkTaskRspContID)
Sets the CICS Link Response Container ID. This method only applies to applications calling into the CICS link server.

getLinkTaskRspContID

  1. public java.lang.String 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

  1. 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

  1. 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.

setUseCICSContainer

  1. public void setUseCICSContainer( int useCICSContainer)
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

  1. public void setUseCICSContainer( boolean useCICSContainer)
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 true to use containers when communicating with the CICS Link Server.
See Also:

getUseCICSContainer

  1. public boolean getUseCICSContainer( )
Gets the value set by setUseCICSContainer.
Returns:
true if containers are used, false if not.

setUseOTMA

  1. 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

  1. public boolean getUseOTMA()
Gets the value set by setOTMA().
Returns:
true if IMS OTMA is to be used, false if not.

setOTMAServerName

  1. public void setOTMAServerName(java.lang.String OTMAServerName)
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:

getOTMAServerName

  1. public java.lang.String getOTMAServerName( )
Gets the value set by setOTMAServerName().
Returns:
The name of the OTMA Server used for IMS OTMA calls.

setOTMAGroupID

  1. public void setOTMAGroupID(java.lang.String OTMAGroupID)
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:

getOTMAGroupID

  1. public java.lang.String getOTMAGroupID( )
Gets the value set by setOTMAGroupID().
Returns:
The name of the OTMA XCF Group ID used for IMS OTMA calls.

setOTMASyncLevel

  1. public void setOTMASyncLevel(java.lang.String OTMASyncLevel)
Sets the OTMA Sync Level 0=SyncOnReturn | 1=SyncLevel1 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:

getOTMASyncLevel

  1. public java.lang.String getOTMASyncLevel( )
Gets the value set by setOTMASyncLevel().
Returns:
The name of the OTMA Sync Level used for IMS OTMA calls.

setOTMAMaxSegments

  1. 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

  1. 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.

setOTMAMaxRecvSize

  1. 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

  1. public int getOTMAMaxRecvSize()
Gets the value set by setOTMAMaxRecvSize().
Returns:
max receive message size for IMS OTMA requests.

setOTMARequestLLZZ

  1. 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

  1. 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.

setOTMARequestLLLL

  1. public void setOTMARequestLLLL( boolean reqLLLL)
Tells the connection that requests to be sent to IMS over OTMA are formatted with LLLL-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

  1. public boolean getOTMARequestLLLL( )
Gets the value set by setOTMARequestLLLL().
Returns:
true if LLLL-formatted messages are in use, false if LLZZ is used.

setOTMAResponseLLZZ

  1. 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

  1. 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.

setOTMAResponseLLLL

  1. public void setOTMAResponseLLLL( boolean respLLLL)
Tells the connection that responses received from IMS over OTMA are to be formatted with LLLL-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

  1. public boolean getOTMAResponseLLLL( )
Gets the value set by setOTMAResponseLLLL().
Returns:
true if LLLL-formatted messages are in use, false if LLZZ is used.

setUsername

  1. public void setUsername(java.lang.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.

getUsername

  1. public java.lang.String 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

  1. public void setPassword(java.lang.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.
Parameters:
password - The password

getPassword

  1. public java.lang.String 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

  1. public int hashCode()
Generates a hash code for object comparison
Overrides:
hashCode in class java.lang.Object

equals

  1. public boolean equals(java.lang.Object thatObject)
Compares two objects
Overrides:
equals in class java.lang.Object