com.metamatrix.platform.vm.api.controller
Interface VMControllerInterface

All Known Implementing Classes:

SocketVMController, VMController

public interface VMControllerInterface

Method Summary

void	checkService(ServiceID serviceID) Check the state of a service
void	dumpThreads() dumps stack trace to log file.
byte[]	exportLogs() Export the server logs to a byte[].
java.net.InetAddress	getAddress() Get the address of the host this VM is running on.
LogConfiguration	getCurrentLogConfiguration() Return current log configuration.
VMControllerID	getID() Get the ID for this controller.
java.lang.String	getName() Get the name for this controller.
java.util.Date	getStartTime() Get the time the VM was initialized.
VMStatistics	getVMStatistics() Return information about VM.
boolean	isShuttingDown() Returns true if system is being shutdown.
void	ping() Method called from registries to determine if VMController is alive.
void	runGC() Run GC on vm.
void	setCurrentLogConfiguration(LogConfiguration logConfiguration) Set the current log configuration.
void	shutdown() Shut down all services waiting for work to complete.
void	shutdownNow() Shut down all services without waiting for work to complete.
void	shutdownService(ServiceID serviceID) Shut down service waiting for work to complete.
void	shutdownServiceNow(ServiceID serviceID) Shut down all services without waiting for work to complete.
void	startDeployedService(ServiceComponentDefnID id) Start the service identified by the ServiceComponentID If synch is true then wait for service to start before returning.
void	startService(ServiceID serviceID) Start a previously stopped service
void	startVM() Starts the VM by invoking all the deployed services
void	stopAllServices() Kill all services once work is complete
void	stopAllServicesNow() Kill all services now
void	stopService(ServiceID id) Kill service once work is complete
void	stopServiceNow(ServiceID id) Kill service now!!!
void	stopVM() Kill all services (waiting for work to complete) and then kill the vm.
void	stopVMNow() Kill all services now, do not wait for work to complete

Method Detail

startVM

void startVM()

Starts the VM by invoking all the deployed services

startDeployedService

void startDeployedService(ServiceComponentDefnID id)

Start the service identified by the ServiceComponentID If synch is true then wait for service to start before returning. Any exceptions will then be thrown to the caller. If synch is false then start service asynchronously.

startService

void startService(ServiceID serviceID)

Start a previously stopped service

stopVM

void stopVM()

Kill all services (waiting for work to complete) and then kill the vm.

stopVMNow

void stopVMNow()

Kill all services now, do not wait for work to complete

stopService

void stopService(ServiceID id)

Kill service once work is complete

stopServiceNow

void stopServiceNow(ServiceID id)

Kill service now!!!

stopAllServices

void stopAllServices()
                     throws MultipleException

Kill all services once work is complete

Throws:

MultipleException

stopAllServicesNow

void stopAllServicesNow()
                        throws MultipleException

Kill all services now

Throws:

MultipleException

checkService

void checkService(ServiceID serviceID)

Check the state of a service

getCurrentLogConfiguration

LogConfiguration getCurrentLogConfiguration()

Return current log configuration.

setCurrentLogConfiguration

void setCurrentLogConfiguration(LogConfiguration logConfiguration)

Set the current log configuration.

getStartTime

java.util.Date getStartTime()

Get the time the VM was initialized.

getAddress

java.net.InetAddress getAddress()

Get the address of the host this VM is running on.

getID

VMControllerID getID()

Get the ID for this controller.

getName

java.lang.String getName()

Get the name for this controller.

ping

void ping()

Method called from registries to determine if VMController is alive.

shutdown

void shutdown()

Shut down all services waiting for work to complete. Essential services will also be shutdown.

shutdownNow

void shutdownNow()

Shut down all services without waiting for work to complete. Essential services will also be shutdown.

shutdownService

void shutdownService(ServiceID serviceID)

Shut down service waiting for work to complete. Essential services will also be shutdown.

shutdownServiceNow

void shutdownServiceNow(ServiceID serviceID)

Shut down all services without waiting for work to complete. Essential services will also be shutdown.

isShuttingDown

boolean isShuttingDown()

Returns true if system is being shutdown.

getVMStatistics

VMStatistics getVMStatistics()

Return information about VM. totalMemory, freeMemory, threadCount

dumpThreads

void dumpThreads()

dumps stack trace to log file.

runGC

void runGC()

Run GC on vm.

exportLogs

byte[] exportLogs()

Export the server logs to a byte[]. The bytes contain the contents of a .zip file containing the logs. This will export all logs on the host that contains this VMController.

Returns:

the logs, as a byte[].

Throws:

AdminException

Since:

4.3