com.metamatrix.platform.admin.api
Interface RuntimeStateAdminAPI

All Superinterfaces:

SubSystemAdminAPI

All Known Implementing Classes:

RuntimeStateAdminAPIImpl

public interface RuntimeStateAdminAPI
extends SubSystemAdminAPI

Method Summary

java.util.List	getLogEntries(java.util.Date startTime, java.util.Date endTime, java.util.List levels, java.util.List contexts, int maxRows) Get the log entries that match the specified criteria.
ProcessStatistics	getProcessStatistics(java.lang.String hostName, java.lang.String processName) Return VMStatistics object for Process.
java.util.Date	getServerStartTime() Returns a Date object representing the time the server was started.
ServiceID	getServiceIDByName(java.lang.String hostName, java.lang.String processName, java.lang.String serviceName) Return the ServiceID by Name
java.util.Collection	getServiceQueueStatistics(ServiceID serviceID) Return Collection of QueueStats for service.
WorkerPoolStats	getServiceQueueStatistics(ServiceID serviceID, java.lang.String queueName) Return QueueStats object for queue.
SystemState	getSystemState() Return the running state of the system.
java.util.List	getVMControllerBindings() Returns a list that contains all of the VMControllerBindings for all the VMControllers running in the MetaMatrix system.
boolean	isSystemStarted() Return TRUE if the system is started; i.e.
void	restartService(ServiceID serviceID) Restart a failed or stopped service.
void	setLoggingConfiguration(Configuration config, LogConfiguration logConfig, java.util.List actions) Sets the LogConfiguration on the given Configuration.
void	shutdownServer() Gracefully shutdown server waiting for work to complete.
void	startHost(java.lang.String host) Start up all processes and services for the host.
void	startProcess(java.lang.String host, java.lang.String process) Start up all process and services.
void	stopHost(java.lang.String host) Stop host processes/services once work is complete.
void	stopHostNow(java.lang.String host) Stop host processes/services now.
void	stopProcess(java.lang.String hostname, java.lang.String processName, boolean now) Stop process once work is complete.
void	stopService(ServiceID serviceID) Stop service once work is complete.
void	stopServiceNow(ServiceID serviceID) Stop service now.
void	synchronizeServer() Synchronize running services with runtime configuration.

Method Detail

isSystemStarted

boolean isSystemStarted()
                        throws AuthorizationException,
                               InvalidSessionException,
                               MetaMatrixComponentException

Return TRUE if the system is started; i.e. at leat one of every essential services in a product is running. Authorization, Configuration, Membership and Session services are considered to be essential.

Returns:

Boolean - TRUE if system is started, FALSE if not.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

stopService

void stopService(ServiceID serviceID)
                 throws AuthorizationException,
                        InvalidSessionException,
                        MetaMatrixComponentException

Stop service once work is complete.

Parameters:

callerSessionID - ID of the caller's current session.

serviceID - ID of service instance.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

stopServiceNow

void stopServiceNow(ServiceID serviceID)
                    throws AuthorizationException,
                           InvalidSessionException,
                           MetaMatrixComponentException

Stop service now.

Parameters:

callerSessionID - ID of the caller's current session.

serviceID - ID of service instance.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

stopProcess

void stopProcess(java.lang.String hostname,
                 java.lang.String processName,
                 boolean now)
                 throws AuthorizationException,
                        InvalidSessionException,
                        MetaMatrixComponentException

Stop process once work is complete.

Parameters:

callerSessionID - ID of the caller's current session.

processID - VMControllerID.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

shutdownServer

void shutdownServer()
                    throws AuthorizationException,
                           InvalidSessionException,
                           MetaMatrixComponentException

Gracefully shutdown server waiting for work to complete.

Parameters:

callerSessionID - ID of the caller's current session.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

getSystemState

SystemState getSystemState()
                           throws AuthorizationException,
                                  InvalidSessionException,
                                  MetaMatrixComponentException

Return the running state of the system.

Returns:

SysteState object that represents the system.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

restartService

void restartService(ServiceID serviceID)
                    throws AuthorizationException,
                           InvalidSessionException,
                           MetaMatrixComponentException

Restart a failed or stopped service.

Parameters:

serviceID - ID of service instance.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

startHost

void startHost(java.lang.String host)
               throws AuthorizationException,
                      InvalidSessionException,
                      MetaMatrixComponentException

Start up all processes and services for the host.

Parameters:

host - Host to start

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

startProcess

void startProcess(java.lang.String host,
                  java.lang.String process)
                  throws AuthorizationException,
                         InvalidSessionException,
                         MetaMatrixComponentException

Start up all process and services.

Parameters:

host - Host processes belongs to.

process - Processes to start

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

stopHost

void stopHost(java.lang.String host)
              throws AuthorizationException,
                     InvalidSessionException,
                     MetaMatrixComponentException,
                     MultipleException

Stop host processes/services once work is complete.

Parameters:

host - Name of host.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

MultipleException

stopHostNow

void stopHostNow(java.lang.String host)
                 throws AuthorizationException,
                        InvalidSessionException,
                        MetaMatrixComponentException,
                        MultipleException

Stop host processes/services now.

Parameters:

host - Name of host.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

MultipleException

synchronizeServer

void synchronizeServer()
                       throws AuthorizationException,
                              InvalidSessionException,
                              MetaMatrixComponentException,
                              MultipleException

Synchronize running services with runtime configuration.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

MultipleException

getServerStartTime

java.util.Date getServerStartTime()
                                  throws AuthorizationException,
                                         InvalidSessionException,
                                         MetaMatrixComponentException

Returns a Date object representing the time the server was started. If the server is not started a null is returned.

Returns:

Date

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

setLoggingConfiguration

void setLoggingConfiguration(Configuration config,
                             LogConfiguration logConfig,
                             java.util.List actions)
                             throws AuthorizationException,
                                    InvalidSessionException,
                                    MetaMatrixComponentException

Sets the LogConfiguration on the given Configuration. If the configuration is operational, then the log configuration is set on the Logmanager running in each VM.

Parameters:

config - The configuration for which to set the log configuration.

logConfig - The log configuration with which to affect the log properties.

actions - The Actions from the ConfigurationObjectEditor used to affect the configuration database.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

getServiceQueueStatistics

java.util.Collection getServiceQueueStatistics(ServiceID serviceID)
                                               throws AuthorizationException,
                                                      InvalidSessionException,
                                                      MetaMatrixComponentException

Return Collection of QueueStats for service.

Parameters:

serviceID - ID of the service.

Returns:

Collection of QueueStats objects.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

getServiceQueueStatistics

WorkerPoolStats getServiceQueueStatistics(ServiceID serviceID,
                                          java.lang.String queueName)
                                          throws AuthorizationException,
                                                 InvalidSessionException,
                                                 MetaMatrixComponentException

Return QueueStats object for queue.

Parameters:

serviceID - ID of the service.

queueName - Name of queue.

Returns:

QueueStats object.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

getProcessStatistics

ProcessStatistics getProcessStatistics(java.lang.String hostName,
                                       java.lang.String processName)
                                       throws AuthorizationException,
                                              InvalidSessionException,
                                              MetaMatrixComponentException

Return VMStatistics object for Process.

Parameters:

VMControllerID - ID of the process.

Returns:

VMStatistics.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

getServiceIDByName

ServiceID getServiceIDByName(java.lang.String hostName,
                             java.lang.String processName,
                             java.lang.String serviceName)
                             throws AuthorizationException,
                                    InvalidSessionException,
                                    MetaMatrixComponentException

Return the ServiceID by Name

Parameters:

hostName - name of the host to that the service is configured

processName - process name of the service is configured

serviceName - name of the service to be retrieved

Returns:

ServiceID

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurred in communicating with a component.

Since:

4.2

getVMControllerBindings

java.util.List getVMControllerBindings()
                                       throws InvalidSessionException,
                                              AuthorizationException,
                                              MetaMatrixComponentException

Returns a list that contains all of the VMControllerBindings for all the VMControllers running in the MetaMatrix system.

Returns:

List of VMControllerBindings

Throws:

InvalidSessionException - if the callerSessionID is not valid or is expired.

AuthorizationException

MetaMatrixComponentException

Since:

4.2.1

getLogEntries

java.util.List getLogEntries(java.util.Date startTime,
                             java.util.Date endTime,
                             java.util.List levels,
                             java.util.List contexts,
                             int maxRows)
                             throws AuthorizationException,
                                    InvalidSessionException,
                                    MetaMatrixComponentException

Get the log entries that match the specified criteria.

Parameters:

startTime -

endTime - If null, will ignore this criterion.

levels - List of Integers

levels - List of Strings. If null, will ignore this criterion and return entries with any context.

maxRows -

Returns:

List of LogEntry objects

Throws:

AuthorizationException

InvalidSessionException

MetaMatrixComponentException

Since:

4.3