com.metamatrix.admin.server
Class ServerRuntimeStateAdminImpl

java.lang.Object
  com.metamatrix.admin.server.AbstractAdminImpl
      com.metamatrix.admin.server.ServerRuntimeStateAdminImpl

All Implemented Interfaces:

ServerRuntimeStateAdmin, RuntimeStateAdmin

public class ServerRuntimeStateAdminImpl
extends AbstractAdminImpl
implements ServerRuntimeStateAdmin

Since:

4.3

Field Summary

Fields inherited from class com.metamatrix.admin.server.AbstractAdminImpl

OBJECT_TYPE_CACHE, OBJECT_TYPE_CONNECTION_POOL, OBJECT_TYPE_CONNECTOR_BINDING, OBJECT_TYPE_CONNECTOR_TYPE, OBJECT_TYPE_EXTENSION_MODULE, OBJECT_TYPE_GROUP, OBJECT_TYPE_LOG_CONFIGURATION, OBJECT_TYPE_MODEL, OBJECT_TYPE_PROCESS_OBJECT, OBJECT_TYPE_PROPERTY_DEFINITION, OBJECT_TYPE_QUEUE_WORKER_POOL, OBJECT_TYPE_REQUEST, OBJECT_TYPE_ROLE, OBJECT_TYPE_SESSION, OBJECT_TYPE_TRANSACTION, OBJECT_TYPE_VDB, OBJECTS_PACKAGE, parent, registry

Constructor Summary

ServerRuntimeStateAdminImpl(ServerAdminImpl parent, ClusteredRegistryState registry)

Method Summary

void	bounceSystem(boolean waitUntilDone) Stop and restart the entire system.
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 newStatus) Change the status of a Deployed VDB
void	clearCache(java.lang.String cacheIdentifier) Clear the cache or caches specified by the cacheIdentifier.
void	restart() Restart System
void	shutdown(int millisToWait) Stop the MM Query.
void	startConnectorBinding(java.lang.String identifier) Start Connector Binding
void	startHost(java.lang.String hostName, boolean waitUntilDone) Start the Host for this cluster
void	startProcess(java.lang.String identifier, boolean waitUntilDone) Start a Process in the system.
void	stopConnectorBinding(java.lang.String identifier, boolean stopNow) Stop Connector Binding
void	stopHost(java.lang.String hostName, boolean stopNow, boolean waitUntilDone) Stop the Host for this cluster
void	stopProcess(java.lang.String identifier, boolean stopNow, boolean waitUntilDone) Stop Process running in the system.
void	stopSystem() Stop the entire system.
void	synchronizeSystem(boolean waitUntilDone) Synchronize the entire system.
void	terminateSession(java.lang.String identifier) Terminate the Session
void	terminateTransaction(java.lang.String transactionId, java.lang.String sessionId) Mark the given transaction as rollback only.
void	terminateTransaction(javax.transaction.xa.Xid transactionId) Mark the given global transaction as rollback only.

Methods inherited from class com.metamatrix.admin.server.AbstractAdminImpl

convertPropertyDefinitions, convertPropertyDefinitions, convertPropertyDefinitions, convertToAdminVDB, getAdminObjects, getAuthorizationServiceProxy, getConfigurationModel, getConfigurationServiceProxy, getConnectorBindingNamesFromUUIDs, getConnectorBindingNamesMapFromUUIDs, getDeployedComponent, getExtensionSourceManager, getMembershipServiceProxy, getName, getObjectType, getParent, getQueryServiceProxy, getRuntimeStateAdminAPIHelper, getSessionID, getSessionServiceProxy, getUserName, getVDBs, identifierMatches, identifierMatches, logDetail, shutDownConnectorBinding, throwProcessingException, validateSession

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerRuntimeStateAdminImpl

public ServerRuntimeStateAdminImpl(ServerAdminImpl parent,
                                   ClusteredRegistryState registry)

Method Detail

cancelRequest

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

Description copied from interface: RuntimeStateAdmin

Cancel Request

Specified by:

cancelRequest in interface RuntimeStateAdmin

Parameters:

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

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.cancelRequest(java.lang.String)

cancelSourceRequest

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

Description copied from interface: RuntimeStateAdmin

Cancel Source Request

Specified by:

cancelSourceRequest in interface RuntimeStateAdmin

Parameters:

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

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.cancelSourceRequest(java.lang.String)

startConnectorBinding

public void startConnectorBinding(java.lang.String identifier)
                           throws AdminException

Description copied from interface: RuntimeStateAdmin

Start Connector Binding

Specified by:

startConnectorBinding in interface RuntimeStateAdmin

Parameters:

identifier - 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

See Also:

RuntimeStateAdmin.startConnectorBinding(java.lang.String)

startHost

public void startHost(java.lang.String hostName,
                      boolean waitUntilDone)
               throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Start the Host for this cluster

Specified by:

startHost in interface ServerRuntimeStateAdmin

Parameters:

hostName - the unique identifier for for a Host in the system.

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.startHost(java.lang.String, boolean)

startProcess

public void startProcess(java.lang.String identifier,
                         boolean waitUntilDone)
                  throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Start a Process in the system.

Specified by:

startProcess in interface ServerRuntimeStateAdmin

Parameters:

identifier - the unique identifier for for a ProcessObject in the system.

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.startProcess(java.lang.String, boolean)

stopConnectorBinding

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

Description copied from interface: RuntimeStateAdmin

Stop Connector Binding

Specified by:

stopConnectorBinding in interface RuntimeStateAdmin

Parameters:

identifier - 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

See Also:

com.metamatrix.admin.api.server.ServerRuntimeStateAdmin#stopConnectorBinding(java.lang.String)

stopHost

public void stopHost(java.lang.String hostName,
                     boolean stopNow,
                     boolean waitUntilDone)
              throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop the Host for this cluster

Specified by:

stopHost in interface ServerRuntimeStateAdmin

Parameters:

hostName - the unique identifier for for a Host in the system.

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

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.stopHost(java.lang.String, boolean, boolean)

stopProcess

public void stopProcess(java.lang.String identifier,
                        boolean stopNow,
                        boolean waitUntilDone)
                 throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop Process running in the system.

Specified by:

stopProcess in interface ServerRuntimeStateAdmin

Parameters:

identifier - the unique identifier for for a ProcessObject in the system.

stopNow - a boolean value indicating whether to halt the process immediately or let it finish processing first.

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.stopProcess(java.lang.String, boolean, boolean)

stopSystem

public void stopSystem()
                throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop the entire system.

Specified by:

stopSystem in interface ServerRuntimeStateAdmin

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.stopSystem()

restart

public void restart()
             throws AdminException

Description copied from interface: RuntimeStateAdmin

Restart System

Specified by:

restart in interface RuntimeStateAdmin

Parameters:

waitUntilDone - Ignored: the waiting for this method is done in ServerAdminClientInterceptor on the client-side.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.bounceSystem(boolean)

synchronizeSystem

public void synchronizeSystem(boolean waitUntilDone)
                       throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Synchronize the entire system. Synchronization will attempt to make the runtime state match the configuration.

Specified by:

synchronizeSystem in interface ServerRuntimeStateAdmin

Parameters:

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerRuntimeStateAdmin.synchronizeSystem(boolean)

clearCache

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

Description copied from interface: RuntimeStateAdmin

Clear the cache or caches specified by the cacheIdentifier.

Specified by:

clearCache in interface RuntimeStateAdmin

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

See Also:

RuntimeStateAdmin.clearCache(java.lang.String)

terminateSession

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

Description copied from interface: RuntimeStateAdmin

Terminate the Session

Specified by:

terminateSession in interface RuntimeStateAdmin

Parameters:

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

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.terminateSession(java.lang.String)

changeVDBStatus

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

Description copied from interface: RuntimeStateAdmin

Change the status of a Deployed VDB

Specified by:

changeVDBStatus in interface RuntimeStateAdmin

Parameters:

name - Name of the Virtual Database

version - Version of the Virtual Database

newStatus - Active, InActive, Delete

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

RuntimeStateAdmin.changeVDBStatus(java.lang.String, java.lang.String, int)

terminateTransaction

public void terminateTransaction(java.lang.String transactionId,
                                 java.lang.String sessionId)
                          throws AdminException

Description copied from interface: RuntimeStateAdmin

Mark the given transaction as rollback only.

Specified by:

terminateTransaction in interface RuntimeStateAdmin

Throws:

AdminException

terminateTransaction

public void terminateTransaction(javax.transaction.xa.Xid transactionId)
                          throws AdminException

Description copied from interface: RuntimeStateAdmin

Mark the given global transaction as rollback only.

Specified by:

terminateTransaction in interface RuntimeStateAdmin

Throws:

AdminException

bounceSystem

public void bounceSystem(boolean waitUntilDone)
                  throws AdminException

Description copied from interface: ServerRuntimeStateAdmin

Stop and restart the entire system.

Specified by:

bounceSystem in interface ServerRuntimeStateAdmin

Parameters:

waitUntilDone - If true, this method waits until the operation is finished before returning. This may take a long time to complete. If false, this method returns immediately, even though the operation may not be finished. NOTE: If waitUntilDone is true, this method will wait until the server is able to connect to, but it may not wait until non-essential services are available.

Throws:

AdminException - if there's a system error.

shutdown

public void shutdown(int millisToWait)
              throws AdminException

Description copied from interface: RuntimeStateAdmin

Stop the MM Query. If millisToWait is >0, then close to incoming queries, wait the time period for work to stop, then stop the MM Query. Otherwise, stop immediately, aborting all running queries.

Specified by:

shutdown in interface RuntimeStateAdmin

Parameters:

millisToWait - Milliseconds to wait (if >0) or <=0 for no wait before stopping

Throws:

AdminException