Package com.ibm.jakarta.connector2.cics
Class CICSManagedConnectionFactory
java.lang.Object
com.ibm.jakarta.connector2.cics.CICSManagedConnectionFactory
- All Implemented Interfaces:
CICSLogTraceLevels
,jakarta.resource.spi.ManagedConnectionFactory
,jakarta.resource.spi.ResourceAdapterAssociation
,jakarta.resource.spi.ValidatingManagedConnectionFactory
,Serializable
- Direct Known Subclasses:
ECIManagedConnectionFactory
,EPIManagedConnectionFactory
public abstract class CICSManagedConnectionFactory
extends Object
implements jakarta.resource.spi.ManagedConnectionFactory, jakarta.resource.spi.ValidatingManagedConnectionFactory, CICSLogTraceLevels, jakarta.resource.spi.ResourceAdapterAssociation
Abstract class that provides the managed connection factory framework for
CICS resource adapters.
-
Field Summary
FieldsFields inherited from interface com.ibm.jakarta.connector2.cics.CICSLogTraceLevels
RAS_TRACE_ENTRY_EXIT, RAS_TRACE_ERROR_EXCEPTION, RAS_TRACE_INTERNAL, RAS_TRACE_OFF
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a PropertyChangeListener.boolean
Returns a flag indicating whether the objects are identical or not.void
firePropertyChange
(String strPropertyName, Object oOld, Object oNew) Fires a PropertyChangeEvent to any listeners.Get the applid for this connection.Get the applid qualifier for this connection.Return the comma delimited list of cipher suites a SSL connection is able to use.Get the client security class name.Get the CICS TG gateway URL.Gets the name of theGatewayIntercept
plug-in class for this managed connection factory.getInvalidConnections
(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 existGet the key ring class name to use for an SSL connection.Get the key ring password to use for an SSL connection.Get the log helper object.Return the current log writer for this instance.Get the password or password phrase for this connection.Get the port to communicate with the CICS TG on.Get the requestExits for this connection.jakarta.resource.spi.ResourceAdapter
Return the server to connect to (must be defined to the CICS TG).Get the server security class name.Returns the socket connect timeout value for a connection to CICS TG.Get the trace level for this managed connection factory.Get the mandate for Tracking Token.Get the username for this connection.int
hashCode()
Returns a hashcode based on connectionURL, serverName and portNumber which uniquely identifies the backend server.void
Removes a PropertyChangeListener.void
setLogWriter
(PrintWriter newLog) Set the log writer to be used by this object.void
setResourceAdapter
(jakarta.resource.spi.ResourceAdapter cicsRA) toString()
Return a string representation of this object.Methods inherited from interface jakarta.resource.spi.ManagedConnectionFactory
createConnectionFactory, createConnectionFactory, createManagedConnection, matchManagedConnections
-
Field Details
-
CLASS_VERSION
- See Also:
-
-
Constructor Details
-
CICSManagedConnectionFactory
public CICSManagedConnectionFactory()Default constructor. All properties must be set using the appropriate setters.
-
-
Method Details
-
getConnectionURL
Get the CICS TG gateway URL.- Returns:
- Gateway URL.
-
getServerName
Return the server to connect to (must be defined to the CICS TG).- Returns:
- The server name.
-
getUserName
Get the username for this connection.- Returns:
- The username.
-
getRequestExits
Get the requestExits for this connection.- Returns:
- The requestExits.
-
getApplid
Get the applid for this connection.- Returns:
- The Applid.
-
getApplidQualifier
Get the applid qualifier for this connection.- Returns:
- The Applid Qualifier.
-
getPassword
Get the password or password phrase for this connection.- Returns:
- The password or password phrase.
-
getPortNumber
Get the port to communicate with the CICS TG on.- Returns:
- The port number.
-
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
Get the client security class name.- Returns:
- The client security class name.
-
getServerSecurity
Get the server security class name.- Returns:
- The server security class name.
-
getKeyRingClass
Get the key ring class name to use for an SSL connection.- Returns:
- The key ring name.
-
getTrackingToken
Get the mandate for Tracking Token.- Returns:
- mandate for Tracking Token.
-
getKeyRingPassword
Get the key ring password to use for an SSL connection.- Returns:
- The key ring password.
-
getCipherSuites
Return the comma delimited list of cipher suites a SSL connection is able to use.- Returns:
- The list of cipher suites.
-
getInvalidConnections
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 interfacejakarta.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:
jakarta.resource.ResourceException
-
getLogWriter
Return the current log writer for this instance.- Specified by:
getLogWriter
in interfacejakarta.resource.spi.ManagedConnectionFactory
- Returns:
- The log writer.
-
setLogWriter
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 interfacejakarta.resource.spi.ManagedConnectionFactory
- Parameters:
newLog
- The PrintWriter object to use.
-
getTraceLevel
Get the trace level for this managed connection factory.- Returns:
- trace level.
- See Also:
-
getInterceptPlugin
Gets the name of theGatewayIntercept
plug-in class for this managed connection factory.- Returns:
- the name of the Gateway intercept plug-in class
-
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. -
equals
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. -
toString
Return a string representation of this object. It is made up of the super.toString() and the properties held in this object. -
addPropertyChangeListener
Adds a PropertyChangeListener.- Parameters:
pcl
- java.beans.PropertyChangeListener.
-
removePropertyChangeListener
Removes a PropertyChangeListener.- Parameters:
pcl
- java.beans.PropertyChangeListener.
-
firePropertyChange
Fires a PropertyChangeEvent to any listeners.- Parameters:
strPropertyName
- java.lang.String.oOld
- java.lang.Object.oNew
- java.lang.Object.
-
getResourceAdapter
public jakarta.resource.spi.ResourceAdapter getResourceAdapter()- Specified by:
getResourceAdapter
in interfacejakarta.resource.spi.ResourceAdapterAssociation
-
setResourceAdapter
public void setResourceAdapter(jakarta.resource.spi.ResourceAdapter cicsRA) throws jakarta.resource.ResourceException - Specified by:
setResourceAdapter
in interfacejakarta.resource.spi.ResourceAdapterAssociation
- Throws:
jakarta.resource.ResourceException
-