IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.ola
Class ConnectionSpecImpl

java.lang.Object
  extended by com.ibm.websphere.ola.ConnectionSpecImpl
All Implemented Interfaces:
javax.resource.cci.ConnectionSpec

public class ConnectionSpecImpl
extends java.lang.Object
implements javax.resource.cci.ConnectionSpec

The ConnectionSpec is used to pass resource-specific data to the resource for purposes of establishing the connection.


Field Summary
static int BIT_CONTAINER
          Use a BIT container
static int CHAR_CONTAINER
          Use a CHAR container
 
Constructor Summary
ConnectionSpecImpl()
           
 
Method Summary
 int getConnectionWaitTimeout()
          Gets the connection wait timeout value.
 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.
 int getLinkTaskReqContType()
          Gets the CICS Link Request Container Type set by linkTaskReqContType() This method only applies to applications calling into the CICS link server.
 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.
 int getLinkTaskRspContType()
          Gets the CICS Link Response Container Type set by linkTaskRspContType() This method only applies to applications calling into the CICS link server.
 java.lang.String getLinkTaskTranID()
          Gets the CICS Link Transaction ID set by setLinkTaskTranID.
 java.lang.String getRegisterName()
          Gets the register name to connect to.
 boolean getUseCICSContainer()
          Gets the value set by setUseCICSContainer.
 void setConnectionWaitTimeout(int connectionWaitTimeout)
          Sets the connection wait timeout value.
 void setLinkTaskReqContID(java.lang.String linkTaskReqContID)
          Sets the CICS Link Request Container ID.
 void setLinkTaskReqContType(int linkTaskReqContType)
          Sets the CICS Link Request Container Type.
 void setLinkTaskRspContID(java.lang.String linkTaskRspContID)
          Sets the CICS Link Response Container ID.
 void setLinkTaskRspContType(int linkTaskRspContType)
          Sets the CICS Link Response Container Type.
 void setLinkTaskTranID(java.lang.String linkTaskTranID)
          Sets the CICS Link Transaction ID.
 void setRegisterName(java.lang.String registerName)
          Sets the register name.
 void setUseCICSContainer(boolean useCICSContainer)
          Tells the connection to use the containers when communicating with CICS.
 void setUseCICSContainer(int useCICSContainer)
          Deprecated. Use setUseCICSContainer(boolean)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BIT_CONTAINER

public static final int BIT_CONTAINER
Use a BIT container

See Also:
Constant Field Values

CHAR_CONTAINER

public static final int CHAR_CONTAINER
Use a CHAR container

See Also:
Constant Field Values
Constructor Detail

ConnectionSpecImpl

public ConnectionSpecImpl()
Method Detail

setRegisterName

public void setRegisterName(java.lang.String registerName)
Sets the register name.

Parameters:
registerName - The register name to connect to.

getRegisterName

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

setLinkTaskTranID

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

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

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

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

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.

setLinkTaskRspContID

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.

Parameters:
linkTaskReqContID - The name of the container to pass the response parameters into.

getLinkTaskRspContID

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

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.

setUseCICSContainer

public void setUseCICSContainer(int useCICSContainer)
Deprecated. Use setUseCICSContainer(boolean)

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:
setLinkTaskReqContID(String), setLinkTaskRspContID(String), setLinkTaskReqContType(int), setLinkTaskRspContType(int)

setUseCICSContainer

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:
setLinkTaskReqContID(String), setLinkTaskRspContID(String), setLinkTaskReqContType(int), setLinkTaskRspContType(int)

getUseCICSContainer

public boolean getUseCICSContainer()
Gets the value set by setUseCICSContainer.

Returns:
true if containers are used, false if not.

IBM WebSphere Application ServerTM
Release 7