com.ibm.connector2.cics

Class CICSManagedConnectionFactory

  • java.lang.Object
    • com.ibm.connector2.cics.CICSManagedConnectionFactory
  • All Implemented Interfaces:
    CICSLogTraceLevels, java.io.Serializable, javax.resource.spi.ManagedConnectionFactory, javax.resource.spi.ResourceAdapterAssociation, javax.resource.spi.ValidatingManagedConnectionFactory
    Direct Known Subclasses:
    ECIManagedConnectionFactory, EPIManagedConnectionFactory


    public abstract class CICSManagedConnectionFactory
    extends java.lang.Object
    implements javax.resource.spi.ManagedConnectionFactory, javax.resource.spi.ValidatingManagedConnectionFactory, CICSLogTraceLevels, javax.resource.spi.ResourceAdapterAssociation
    Abstract class that provides the managed connection factory framework for CICS resource adapters.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
      Adds a PropertyChangeListener.
      boolean equals(java.lang.Object inObj)
      Returns a flag indicating whether the objects are identical or not.
      void firePropertyChange(java.lang.String strPropertyName, java.lang.Object oOld, java.lang.Object oNew)
      Fires a PropertyChangeEvent to any listeners.
      java.lang.String getApplid()
      Get the applid for this connection.
      java.lang.String getApplidQualifier()
      Get the applid qualifier for this connection.
      java.lang.String getCipherSuites()
      Return the comma delimited list of cipher suites a SSL connection is able to use.
      java.lang.String getClientSecurity()
      Get the client security class name.
      java.lang.String getConnectionURL()
      Get the CICS TG gateway URL.
      java.util.Set getInvalidConnections(java.util.Set connectionSet)
      Returns a Set of invalid connections (those that have been identified as dirty) from the entire set of CICS managed connections that currently exist
      java.lang.String getKeyRingClass()
      Get the key ring class name (applicable only to SSL protocol).
      java.lang.String getKeyRingPassword()
      Get the key ring password (applicable only to SSL protocol(s)).
      com.ibm.connector2.cics.CICSLogHelper getLogHelper()
      Get the log helper object.
      java.io.PrintWriter getLogWriter()
      Return the current log writer for this instance.
      java.lang.String getPassword()
      Get the password or password phrase for this connection.
      java.lang.String getPortNumber()
      Get the port to communicate with the CICS TG on.
      java.lang.String getRequestExits()
      Get the requestExits for this connection.
      java.lang.String getServerName()
      Return the server to connect to (must be defined to the CICS TG).
      java.lang.String getServerSecurity()
      Get the server security class name.
      java.lang.String getSocketConnectTimeout()
      Returns the socket connect timeout value for a connection to CICS TG.
      java.lang.Integer getTraceLevel()
      Get the trace level for this managed connection factory.
      java.lang.String getUserName()
      Get the username for this connection.
      int hashCode()
      Returns a hashcode based on connectionURL, serverName and portNumber which uniquely identifies the backend server.
      void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
      Removes a PropertyChangeListener.
      void setLogWriter(java.io.PrintWriter newLog)
      Set the log writer to be used by this object.
      java.lang.String toString()
      Return a string representation of this object.
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface javax.resource.spi.ManagedConnectionFactory

        createConnectionFactory, createConnectionFactory, createManagedConnection, matchManagedConnections
    • Constructor Detail

      • CICSManagedConnectionFactory

        public CICSManagedConnectionFactory()
        Default constructor. All properties must be set using the appropriate setters.
    • Method Detail

      • getConnectionURL

        public java.lang.String getConnectionURL()
        Get the CICS TG gateway URL.
        Returns:
        Gateway URL.
      • getServerName

        public java.lang.String getServerName()
        Return the server to connect to (must be defined to the CICS TG).
        Returns:
        The server name.
      • getUserName

        public java.lang.String getUserName()
        Get the username for this connection.
        Returns:
        The username.
      • getRequestExits

        public java.lang.String getRequestExits()
        Get the requestExits for this connection.
        Returns:
        The requestExits.
      • getApplid

        public java.lang.String getApplid()
        Get the applid for this connection.
        Returns:
        The Applid.
      • getApplidQualifier

        public java.lang.String getApplidQualifier()
        Get the applid qualifier for this connection.
        Returns:
        The Applid Qualifier.
      • getPassword

        public java.lang.String getPassword()
        Get the password or password phrase for this connection.
        Returns:
        The password or password phrase.
      • getPortNumber

        public java.lang.String getPortNumber()
        Get the port to communicate with the CICS TG on.
        Returns:
        The port number.
      • getSocketConnectTimeout

        public java.lang.String getSocketConnectTimeout()
        Returns the socket connect timeout value for a connection to CICS TG. The timeout represents the maximum amount of time (in milliseconds) a connection will attempt to open a socket connection successfully to a remote Gateway daemon. The timeout is ignored for attempted connections to a local Gateway instance.
        Returns:
        String socketConnectTimeout The timeout value (in milliseconds). A value of 0 represents no timeout.
      • getClientSecurity

        public java.lang.String getClientSecurity()
        Get the client security class name.
        Returns:
        The client security class name.
      • getServerSecurity

        public java.lang.String getServerSecurity()
        Get the server security class name.
        Returns:
        The server security class name.
      • getKeyRingClass

        public java.lang.String getKeyRingClass()
        Get the key ring class name (applicable only to SSL protocol).
        Returns:
        The key ring class name.
      • getKeyRingPassword

        public java.lang.String getKeyRingPassword()
        Get the key ring password (applicable only to SSL protocol(s)).
        Returns:
        The key ring password.
      • getCipherSuites

        public java.lang.String getCipherSuites()
        Return the comma delimited list of cipher suites a SSL connection is able to use.
        Returns:
        The list of cipher suites.
      • getInvalidConnections

        public java.util.Set getInvalidConnections(java.util.Set connectionSet)
                                            throws javax.resource.ResourceException
        Returns a Set of invalid connections (those that have been identified as dirty) from the entire set of CICS managed connections that currently exist
        Specified by:
        getInvalidConnections in interface javax.resource.spi.ValidatingManagedConnectionFactory
        Parameters:
        connectionSet - The set of all CICS managed connections
        Returns:
        The set of all CICS managed connection that have determined to be invalid
        Throws:
        javax.resource.ResourceException
      • getLogWriter

        public java.io.PrintWriter getLogWriter()
        Return the current log writer for this instance.
        Specified by:
        getLogWriter in interface javax.resource.spi.ManagedConnectionFactory
        Returns:
        The log writer.
      • setLogWriter

        public void setLogWriter(java.io.PrintWriter newLog)
        Set the log writer to be used by this object. Setting this to null will switch off logging. Setting it to a PrintWriter object will turn logging on.
        Specified by:
        setLogWriter in interface javax.resource.spi.ManagedConnectionFactory
        Parameters:
        newLog - The PrintWriter object to use.
      • getTraceLevel

        public java.lang.Integer getTraceLevel()
        Get the trace level for this managed connection factory.
        Returns:
        trace level.
        See Also:
        CICSLogTraceLevels
      • getLogHelper

        public com.ibm.connector2.cics.CICSLogHelper getLogHelper()
        Get the log helper object. As the log helper is transient, we must use this method. It will create a log helper object at the first use.
      • hashCode

        public int hashCode()
        Returns a hashcode based on connectionURL, serverName and portNumber which uniquely identifies the backend server.
        Specified by:
        hashCode in interface javax.resource.spi.ManagedConnectionFactory
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hashcode.
      • equals

        public boolean equals(java.lang.Object inObj)
        Returns a flag indicating whether the objects are identical or not. Objects are identical if they have the same reference or the connection properties match. This version tests everything except userid and password. Note that equals here assumes null and "" are NOT the same, although they will have the same behaviour in the framework.
        Specified by:
        equals in interface javax.resource.spi.ManagedConnectionFactory
        Overrides:
        equals in class java.lang.Object
        Returns:
        true if the objects are equal, false otherwise.
      • toString

        public java.lang.String toString()
        Return a string representation of this object. It is made up of the super.toString() and the properties held in this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this instance.
      • addPropertyChangeListener

        public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
        Adds a PropertyChangeListener.
        Parameters:
        pcl - java.beans.PropertyChangeListener.
      • removePropertyChangeListener

        public void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
        Removes a PropertyChangeListener.
        Parameters:
        pcl - java.beans.PropertyChangeListener.
      • firePropertyChange

        public void firePropertyChange(java.lang.String strPropertyName,
                              java.lang.Object oOld,
                              java.lang.Object oNew)
        Fires a PropertyChangeEvent to any listeners.
        Parameters:
        strPropertyName - java.lang.String.
        oOld - java.lang.Object.
        oNew - java.lang.Object.
©Copyright IBM Corp. 1994, 2013
Legal