com.ibm.websphere.ola

Class ConnectionSpecImpl

  • java.lang.Object
    • com.ibm.websphere.ola.ConnectionSpecImpl
  • All Implemented Interfaces:
    java.io.Serializable, javax.resource.cci.ConnectionSpec


    public class ConnectionSpecImpl
    extends java.lang.Object
    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
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object thatObject)
      Compares two objects
      int getConnectionWaitTimeout()
      Gets the connection wait timeout value.
      boolean getConnectionWaitTimeoutFromCSI()
      Gets the flag indicating set connection wait timeout was called.
      int getDefaultOtmaRequestTimeout()
      Gets the default OTMA request timeout, in seconds.
      boolean getDefaultOtmaRequestTimeoutFromCSI()
      Gets the flag indicating setDefaultOtmaRequestTimeout was called.
      java.lang.String getLinkTaskChanID()
      Gets the CICS Link Channel ID set by linkTaskChanID() This method only applies to applications calling into the CICS link server.
      int getLinkTaskChanType()
      Gets the CICS Link Channel Type set by linkTaskChanType() This method only applies to applications calling into the CICS link server.
      boolean getlinkTaskChanTypeFromCSI()
      Gets the flag indicating set LinkTaskChanType was called.
      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.
      boolean getlinkTaskReqContTypeFromCSI()
      Gets the flag indicating set LinkTaskReqContType was called.
      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.
      boolean getlinkTaskRspContTypeFromCSI()
      Gets the flag indicating set LinkTaskRspContType was called.
      java.lang.String getLinkTaskTranID()
      Gets the CICS Link Transaction ID set by setLinkTaskTranID.
      java.lang.String getOTMAGroupID()
      Gets the value set by setOTMAGroupID().
      int getOTMAMaxRecvSize()
      Gets the value set by setOTMAMaxRecvSize().
      boolean getOTMAMaxRecvSizeFromCSI()
      Gets the flag indicating set OTMAMaxRecvSize was called.
      int getOTMAMaxSegments()
      Gets the value set by setOTMAMaxSegments().
      boolean getOTMAMaxSegmentsFromCSI()
      Gets the flag indicating set OTMAMaxSegments was called.
      boolean getOTMARequestLLLL()
      Gets the value set by setOTMARequestLLLL().
      boolean getOTMARequestLLZZ()
      Gets the value set by setOTMARequestLLZZ().
      boolean getOTMARequestLLZZFromCSI()
      Gets the flag indicating set OTMARequestLLZZ was called.
      boolean getOTMAResponseLLLL()
      Gets the value set by setOTMAResponseLLLL().
      boolean getOTMAResponseLLZZ()
      Gets the value set by setOTMAResponseLLZZ().
      boolean getOTMAResponseLLZZFromCSI()
      Gets the flag indicating set OTMAResponseLLZZ was called.
      java.lang.String getOTMAServerName()
      Gets the value set by setOTMAServerName().
      java.lang.String getOTMASyncLevel()
      Gets the value set by setOTMASyncLevel().
      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.
      java.lang.String getRegisterName()
      Gets the register name to connect to.
      boolean getRRSTransactional()
      Gets the value set by setRRSTransactional().
      boolean getRRSTransactionalFromCSI()
      Gets the flag indicating set RRSTransactional was called.
      boolean getUseCICSContainer()
      Gets the value set by setUseCICSContainer.
      boolean getuseCICSContainerFromCSI()
      Gets the flag indicating set useCICSContainers was called.
      boolean getUseOTMA()
      Gets the value set by setOTMA().
      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.
      int hashCode()
      Generates a hash code for object comparison
      void setConnectionWaitTimeout(int connectionWaitTimeout)
      Sets the connection wait timeout value.
      void setDefaultOtmaRequestTimeout(int timeout)
      Sets the default OTMA request timeout, in seconds.
      void setLinkTaskChanID(java.lang.String linkTaskChanID)
      Sets the CICS Link Channel ID.
      void setLinkTaskChanType(int linkTaskChanType)
      Sets the CICS Link Channel Type.
      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 setOTMAGroupID(java.lang.String OTMAGroupID)
      Sets the OTMA XCF Group ID Name.
      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.
      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.
      void setOTMARequestLLLL(boolean reqLLLL)
      Tells the connection that requests to be sent to IMS over OTMA are formatted with LLLLZZ-style length prefixes.
      void setOTMARequestLLZZ(boolean reqLLZZ)
      Tells the connection that requests to be sent to IMS over OTMA are formatted with LLZZ-style length prefixes.
      void setOTMAResponseLLLL(boolean respLLLL)
      Tells the connection that responses received from IMS over OTMA are to be formatted with LLLLZZ-style length prefixes.
      void setOTMAResponseLLZZ(boolean respLLZZ)
      Tells the connection that responses received from IMS over OTMA are to be formatted with LLZZ-style length prefixes.
      void setOTMAServerName(java.lang.String OTMAServerName)
      Sets the OTMA Server Name.
      void setOTMASyncLevel(java.lang.String OTMASyncLevel)
      Sets the OTMA Sync Level 0=None | 1=Confirm This method only applies to applications calling into IMS programs.
      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.
      void setRegisterName(java.lang.String registerName)
      Sets the register name.
      void setRRSTransactional(boolean RRSTransactional)
      Tells the connection that RRS transactions are to be enabled.
      void setUseCICSContainer(boolean useCICSContainer)
      Tells the connection to use containers when communicating with CICS.
      void setUseCICSContainer(int useCICSContainer)
      Deprecated. 
      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.
      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
    • 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.
      • getConnectionWaitTimeoutFromCSI

        public boolean getConnectionWaitTimeoutFromCSI()
        Gets the flag indicating set connection wait timeout was called.
        Returns:
        True or False
      • 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.
      • getlinkTaskReqContTypeFromCSI

        public boolean getlinkTaskReqContTypeFromCSI()
        Gets the flag indicating set LinkTaskReqContType was called.
        Returns:
        True or False
      • 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.
      • getlinkTaskRspContTypeFromCSI

        public boolean getlinkTaskRspContTypeFromCSI()
        Gets the flag indicating set LinkTaskRspContType was called.
        Returns:
        True or False
      • 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:
        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.
      • getuseCICSContainerFromCSI

        public boolean getuseCICSContainerFromCSI()
        Gets the flag indicating set useCICSContainers was called.
        Returns:
        True or False
      • setLinkTaskChanID

        public void setLinkTaskChanID(java.lang.String linkTaskChanID)
        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

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

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

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

        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.
      • getOTMASyncLevel

        public java.lang.String getOTMASyncLevel()
        Gets the value set by setOTMASyncLevel().
        Returns:
        The name of the OTMA Sync Level used for IMS OTMA calls.
      • 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
      • 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
      • 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
      • getOTMARequestLLLL

        public boolean getOTMARequestLLLL()
        Gets the value set by setOTMARequestLLLL().
        Returns:
        true if LLLL-formatted messages are in use, false if LLZZ is used.
      • 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
      • getOTMAResponseLLLL

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

        public int getDefaultOtmaRequestTimeout()
        Gets the default OTMA request timeout, in seconds.
      • setDefaultOtmaRequestTimeout

        public void setDefaultOtmaRequestTimeout(int timeout)
        Sets the default OTMA request timeout, in seconds.
      • getDefaultOtmaRequestTimeoutFromCSI

        public boolean getDefaultOtmaRequestTimeoutFromCSI()
        Gets the flag indicating setDefaultOtmaRequestTimeout was called.
        Returns:
        True or False
      • setUsername

        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.
        Parameters:
        userID - The user ID
      • getUsername

        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

        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

        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

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

        public boolean equals(java.lang.Object thatObject)
        Compares two objects
        Overrides:
        equals in class java.lang.Object
IBM WebSphere Application ServerTM
Release 9.0