com.ibm.connector2.cics

Class CICSConnection

java.lang.Object

com.ibm.connector2.cics.CICSConnection

All Implemented Interfaces:

javax.resource.cci.Connection

Direct Known Subclasses:

ECIConnection

public abstract class CICSConnection
extends java.lang.Object
implements javax.resource.cci.Connection

This abstract class provides the general CICS connection class. It provides support for the connection metadata and the log writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this connection if it is not already closed.
javax.resource.cci.ConnectionMetaData	getMetaData() Returns the metadata for this connection.
javax.resource.cci.ResultSetInfo	getResultSetInfo() Returns the resultSetInfo object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.resource.cci.Connection

createInteraction, getLocalTransaction

Method Detail

getResultSetInfo

public javax.resource.cci.ResultSetInfo getResultSetInfo()
                                                  throws javax.resource.ResourceException

Returns the resultSetInfo object. This is not supported by CICS resource adapters, so a NotSupportedException is always thrown.

Specified by:

getResultSetInfo in interface javax.resource.cci.Connection

Returns:

ResultSetInfo.

Throws:

javax.resource.NotSupportedException - If feature not supported.

javax.resource.ResourceException

getMetaData

public javax.resource.cci.ConnectionMetaData getMetaData()
                                                  throws javax.resource.ResourceException

Returns the metadata for this connection.

Specified by:

getMetaData in interface javax.resource.cci.Connection

Returns:

ConnectionMetaData.

Throws:

javax.resource.ResourceException

close

public void close()
           throws javax.resource.ResourceException

Closes this connection if it is not already closed. Any subclass that overrides this method must call the method on the superclass. The managed connection is asked to remove this connection and an event is fired to say the connection is closed. The connection is flagged as being in the closed state and cannot be used any more.

Attempting to close an already closed connection results in a ResourceException being thrown.

Any method providing a subclass close now cannot throw explicit exceptions. This facility can be provided under a different method name and the subclass will inherit and invoke this method rather than super().close();

Specified by:

close in interface javax.resource.cci.Connection

Throws:

javax.resource.ResourceException - If the connection is already closed.