com.metamatrix.admin.api.core
Interface CoreRuntimeStateAdmin

All Known Subinterfaces:

Admin, EmbeddedAdmin, EmbeddedRuntimeStateAdmin, ServerAdmin, ServerRuntimeStateAdmin

All Known Implementing Classes:

DQPRuntimeStateAdminImpl, ServerAdminImpl, ServerRuntimeStateAdminImpl

public interface CoreRuntimeStateAdmin

This interface defines the methods to interact with the MetaMatrix system during runtime.

As a core interface, this administration is common to both the MetaMatrix server and MM Query.

Since:

4.3

Method Summary

void	cancelRequest(java.lang.String identifier) Cancel Request
void	cancelSourceRequest(java.lang.String identifier) Cancel Source Request
void	changeVDBStatus(java.lang.String name, java.lang.String version, int status) Change the status of a Deployed VDB
void	clearCache(java.lang.String cacheIdentifier) Clear the cache or caches specified by the cacheIdentifier.
void	startConnectorBinding(java.lang.String connectorBindingIdentifier) Start Connector Binding
void	stopConnectorBinding(java.lang.String connectorBindingIdentifier, boolean stopNow) Stop Connector Binding
void	terminateSession(java.lang.String identifier) Terminate the Session

Method Detail

startConnectorBinding

void startConnectorBinding(java.lang.String connectorBindingIdentifier)
                           throws AdminException

Start Connector Binding

Parameters:

connectorBindingIdentifier - identifier for ConnectorBinding

• "*" - for all connector bindings in the system
• "name*" - for all connector bindings that begin with given name
• "name" - for single connector binding by the given name

Throws:

AdminException - if there's a system error.

Since:

4.3

stopConnectorBinding

void stopConnectorBinding(java.lang.String connectorBindingIdentifier,
                          boolean stopNow)
                          throws AdminException

Stop Connector Binding

Parameters:

connectorBindingIdentifier - identifier for ConnectorBinding

• "*" - for all connector bindings in the system
• "name*" - for all connector bindings that begin with given name
• "name" - for single connector binding by the given name

stopNow - If true, stop the process forcefully. If false, wait until any pending work is done.

Throws:

AdminException - - if there's a system error.

Since:

4.3

clearCache

void clearCache(java.lang.String cacheIdentifier)
                throws AdminException

Clear the cache or caches specified by the cacheIdentifier.

Parameters:

cacheIdentifier - Cache name identifier Cache. No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

terminateSession

void terminateSession(java.lang.String identifier)
                      throws AdminException

Terminate the Session

Parameters:

identifier - Session Idenitfier Session. No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

cancelRequest

void cancelRequest(java.lang.String identifier)
                   throws AdminException

Cancel Request

Parameters:

identifier - The request identifer defined by Request No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

cancelSourceRequest

void cancelSourceRequest(java.lang.String identifier)
                         throws AdminException

Cancel Source Request

Parameters:

identifier - The request identifer defined by Request No wild cards currently supported, must be explicit

Throws:

AdminException - if there's a system error.

Since:

4.3

changeVDBStatus

void changeVDBStatus(java.lang.String name,
                     java.lang.String version,
                     int status)
                     throws AdminException

Change the status of a Deployed VDB

Parameters:

name - Name of the Virtial Database

version - Version of the Virtial Database

status - Active, InActive, Delete

Throws:

AdminException - if there's a system error.

Since:

4.3