Class EPIManagedConnection

java.lang.Object
com.ibm.jakarta.connector2.cics.CICSManagedConnection
com.ibm.jakarta.connector2.cics.EPIManagedConnection
All Implemented Interfaces:
jakarta.resource.spi.ManagedConnection

public final class EPIManagedConnection extends CICSManagedConnection
This class represents the real connection from an application server point of view. This holds and controls the properties of the EPI Terminal which are
signon Type
SIGNON_CAPABLE = 0, SIGNON_INCAPABLE = 1
device Type
The Terminal Device Type
encoding
the encoding to be used when creating the 3270 data stream
logon logoff class
This is called if you have a signon capable or signon unknown terminal created
read timeout
The timeout for replies to conversional transactions
install timeout
The timeout for a terminal to install
netname
The requested netname of the terminal

most of these properties are defined by the EPIManagedConnectionFactory. Device Type can be overridden by the DeviceType property in the EPIConnectionSpec Object. Netname is driven purely by the Netname property in the EPIConnectionSpec, and is not a property of the EPIManagedConnectionFactory.

  • Field Details

  • Method Details

    • cleanup

      public void cleanup() throws jakarta.resource.ResourceException
      This method is called to cleanup an EPI managed connection and return it to the pool for reuse. it will attempt to return the terminal to an idle state. If it cannot it will disconnect the terminal.
      Specified by:
      cleanup in interface jakarta.resource.spi.ManagedConnection
      Overrides:
      cleanup in class CICSManagedConnection
      Throws:
      jakarta.resource.ResourceException - If a problem occurs
    • destroy

      public void destroy() throws jakarta.resource.ResourceException
      This destroys this managed connection. It will disconnect the Terminal and will close the gateway as well.
      Specified by:
      destroy in interface jakarta.resource.spi.ManagedConnection
      Overrides:
      destroy in class CICSManagedConnection
      Throws:
      jakarta.resource.ResourceException
    • associateConnection

      public void associateConnection(Object Connection) throws jakarta.resource.ResourceException
      this allows an application level connection that already exists to be linked to this EPI managed Connection.
      Specified by:
      associateConnection in interface jakarta.resource.spi.ManagedConnection
      Overrides:
      associateConnection in class CICSManagedConnection
      Parameters:
      Connection - The EPIConnection to associate with this EPI managed Connection
      Throws:
      jakarta.resource.ResourceException - if Managed Connection Dirty.
    • getConnection

      public Object getConnection(Subject security, jakarta.resource.spi.ConnectionRequestInfo connReq) throws jakarta.resource.ResourceException
      return an EPI Connection linked to this EPI managed Connection. The Connection may re-authenticate based on information provided by the application server through the Subject or from the application via the Connection Request Info (which comes from the EPI Connection Spec)
      Parameters:
      security - Security subject passed by application server
      connReq - EPIConnectionRequestInfo Object
      Returns:
      an EPIConnection Object
      Throws:
      jakarta.resource.ResourceException
    • getLocalTransaction

      public jakarta.resource.spi.LocalTransaction getLocalTransaction() throws jakarta.resource.NotSupportedException
      This method is not supported for the EPI Resource Adapter and will just throw a not supported Exception
      Throws:
      jakarta.resource.NotSupportedException - This feature is not supported
    • getXAResource

      public XAResource getXAResource() throws jakarta.resource.NotSupportedException
      This method is not supported for the EPI Resource Adapter and will just throw a not supported Exception
      Throws:
      jakarta.resource.NotSupportedException - This feature is not supported
    • getMetaData

      public jakarta.resource.spi.ManagedConnectionMetaData getMetaData()
      returns a ManagedConnection MetaData Object for this resource adapter.
      Specified by:
      getMetaData in interface jakarta.resource.spi.ManagedConnection
      Overrides:
      getMetaData in class CICSManagedConnection
      Returns:
      ManagedConnectionMetaData
    • toString

      public String toString()
      Return a String representation of this class. This will return a string containing all the relevant property contents of this class.
      Overrides:
      toString in class CICSManagedConnection
      Returns:
      String