com.metamatrix.admin.api.server
Interface ServerRuntimeStateAdmin

All Superinterfaces:

CoreRuntimeStateAdmin

All Known Subinterfaces:

ServerAdmin

All Known Implementing Classes:

ServerAdminImpl, ServerRuntimeStateAdminImpl

@RolesAllowed(value="Admin.ProductAdmin")
public interface ServerRuntimeStateAdmin
extends CoreRuntimeStateAdmin

Interface that exposes the MetaMatrix system for runtime control.

Clients should not code directly to this interface but should instead use ServerAdmin.

Since:

4.3

Method Summary

void	bounceSystem(boolean waitUntilDone) Stop and restart the entire system.
void	startHost(java.lang.String hostIdentifier, boolean waitUntilDone) Start the Host for this cluster
void	startProcess(java.lang.String processIdentifier, boolean waitUntilDone) Start a Process in the system.
void	stopHost(java.lang.String hostIdentifier, boolean stopNow, boolean waitUntilDone) Stop the Host for this cluster
void	stopProcess(java.lang.String processIdentifier, boolean stopNow, boolean waitUntilDone) Stop Process running in the system.
void	stopSystem() Stop the entire system.
void	synchronizeSystem(boolean waitUntilDone) Synchronize the entire system.

Methods inherited from interface com.metamatrix.admin.api.core.CoreRuntimeStateAdmin

cancelRequest, cancelSourceRequest, changeVDBStatus, clearCache, startConnectorBinding, stopConnectorBinding, terminateSession, terminateTransaction, terminateTransaction

Method Detail

stopSystem

void stopSystem()
                throws AdminException

Stop the entire system.

Throws:

AdminException - if there's a system error.

Since:

4.3

bounceSystem

void bounceSystem(boolean waitUntilDone)
                  throws AdminException

Stop and restart the entire system.

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.

Since:

4.3

synchronizeSystem

void synchronizeSystem(boolean waitUntilDone)
                       throws AdminException

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

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

startHost

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

Start the Host for this cluster

Parameters:

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

stopHost

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

Stop the Host for this cluster

Parameters:

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

startProcess

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

Start a Process in the system.

Parameters:

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

stopProcess

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

Stop Process running in the system.

Parameters:

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