com.ibm.websphere.xs.ra
Interface ObjectGridJ2CConnectionMBean

public interface ObjectGridJ2CConnectionMBean

Allows administration clients control the lifecycle of the eXtreme Scale resource adapter's connection.

The object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=ObjectGridJ2CConnection,objectGridName=<objectgrid>,domain=<domain name>,connectionName=<connection name>
 

Note: Additional properties may be included.

Since:

8.5, XC10

Field Summary

static String	CONNECTIONNAME_DEFAULT The default connection name prefix when not specified.
static String	CONNECTIONSTATUS_CONNECTED The connection status indicating that a connection has been established.
static String	CONNECTIONSTATUS_DISCONNECTED The connection status indicating that client is no longer connected.
static String	MBEAN_TYPE The MBean type

Method Summary

String	getCatalogServiceEndpoints() The catalog service endpoints of the catalog service.
String	getConnectionName() The name of the connection as specified on the J2C ConnectionFactory, or "DEFAULT" if not specified.
String	getConnectionStatus() The status of the connection.
String	getDomainName() The domain name of the catalog service domain as reported by the catalog service.
String	getObjectGridName() The name of the ObjectGrid that is connected.
void	resetObjectGridConnection() Reset the ObjectGrid connection.

Field Detail

MBEAN_TYPE

static final String MBEAN_TYPE

The MBean type

See Also:

Constant Field Values

CONNECTIONSTATUS_CONNECTED

static final String CONNECTIONSTATUS_CONNECTED

The connection status indicating that a connection has been established.

See Also:

Constant Field Values

CONNECTIONSTATUS_DISCONNECTED

static final String CONNECTIONSTATUS_DISCONNECTED

The connection status indicating that client is no longer connected.

See Also:

Constant Field Values

CONNECTIONNAME_DEFAULT

static final String CONNECTIONNAME_DEFAULT

The default connection name prefix when not specified.

See Also:

Constant Field Values

Method Detail

resetObjectGridConnection

void resetObjectGridConnection()

Reset the ObjectGrid connection.

This destroys the client connection to the ObjectGrid, including any local cache that may be created.

Subsequent uses of the ManagedConnectionFactory will result in a new ObjectGrid connection.

getObjectGridName

String getObjectGridName()

The name of the ObjectGrid that is connected.

Returns:

the ObjectGrid name

getConnectionName

String getConnectionName()

The name of the connection as specified on the J2C ConnectionFactory, or "DEFAULT" if not specified. If there are multiple connections with the same attributes in the same process, the "DEFAULT" name will have an integer appended.

Returns:

the connection name.

getDomainName

String getDomainName()

The domain name of the catalog service domain as reported by the catalog service.

Returns:

the catalog service domain name.

getCatalogServiceEndpoints

String getCatalogServiceEndpoints()

The catalog service endpoints of the catalog service.

Returns:

the catalog service endpoints

getConnectionStatus

String getConnectionStatus()

The status of the connection. Valid states include "CONNECTED" or "DISCONNECTED".

Other states may be returned in the future.

Returns:

one of the CONNECTIONSTATUS constants defined in this interface.