com.ibm.websphere.xs.ra
Class XSConnection

java.lang.Object
  com.ibm.websphere.xs.ra.XSConnection

All Implemented Interfaces:

Connection

public final class XSConnection
extends Object
implements Connection

An XSConnection represents an application level connection handle to an eXtreme Scale ObjectGrid.

Since:

8.5, XC10

Constructor Summary

XSConnection()

Method Summary

void	close() Initiates close of the connection handle at the application level.
Interaction	createInteraction() Creates an Interaction associated with this Connection.
LocalTransaction	getLocalTransaction() Returns an LocalTransaction instance that enables a component to demarcate local transactions on the Connection.
ConnectionMetaData	getMetaData() Gets the information on the underlying eXtreme Scale instance represented through an active connection.
ResultSetInfo	getResultSetInfo() Gets the information on the ResultSet functionality supported by a connected eXtreme Scale instance.
Session	getSession() Retrieve the ObjectGrid Session associated with this connection.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XSConnection

public XSConnection()

Method Detail

getSession

public Session getSession()
                   throws ResourceException

Retrieve the ObjectGrid Session associated with this connection.

Returns:

The ObjectGrid Session

Throws:

ResourceException

close

public void close()
           throws ResourceException

Initiates close of the connection handle at the application level.

Specified by:

close in interface Connection

Throws:

ResourceException

See Also:

Connection.close()

createInteraction

public Interaction createInteraction()
                              throws ResourceException

Creates an Interaction associated with this Connection.

Specified by:

createInteraction in interface Connection

Returns:

Interaction instance

Throws:

ResourceException

NotSupportedException

See Also:

Connection.createInteraction()

getLocalTransaction

public LocalTransaction getLocalTransaction()
                                     throws ResourceException

Returns an LocalTransaction instance that enables a component to demarcate local transactions on the Connection.

Specified by:

getLocalTransaction in interface Connection

Returns:

LocalTransaction instance

Throws:

ResourceException

See Also:

Connection.getLocalTransaction()

getMetaData

public ConnectionMetaData getMetaData()
                               throws ResourceException

Gets the information on the underlying eXtreme Scale instance represented through an active connection.

Specified by:

getMetaData in interface Connection

Returns:

WXS ConnectionMetaData

Throws:

ResourceException

See Also:

Connection.getMetaData()

getResultSetInfo

public ResultSetInfo getResultSetInfo()
                               throws ResourceException

Gets the information on the ResultSet functionality supported by a connected eXtreme Scale instance.

Specified by:

getResultSetInfo in interface Connection

Returns:

ResultSetInfo instance

Throws:

ResourceException

See Also:

Connection.getResultSetInfo()

toString

public String toString()

Overrides:

toString in class Object