GigaSpaces XAP 7.0 API

org.openspaces.admin.vm
Interface VirtualMachine

All Superinterfaces:
MachineAware, StatisticsMonitor, ZoneAware

public interface VirtualMachine
extends MachineAware, ZoneAware, StatisticsMonitor

A virtual machine is a JVM that runs grid components.

Author:
kimchy

Field Summary
 
Fields inherited from interface org.openspaces.admin.StatisticsMonitor
DEFAULT_HISTORY_SIZE, DEFAULT_MONITOR_INTERVAL
 
Method Summary
 void addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)
          Adds an SpaceInstanceLifecycleEventListener allowing to be notified when a space instance was added or removed from this virtual machine.
 void addProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
          Adds an ProcessingUnitInstanceLifecycleEventListener allowing to be notified when a processing unit instance was added or removed from this virtual machine.
 VirtualMachineDetails getDetails()
          Returns the details (non changeable information) of the virtual machine.
 GridServiceAgent getGridServiceAgent()
          Returns the grid service agent started within this virtual machine.
 GridServiceContainer getGridServiceContainer()
          Returns the grid service container started within this virtual machine.
 GridServiceManager getGridServiceManager()
          Returns the grid service manager started within this virtual machine.
 ProcessingUnitInstanceAddedEventManager getProcessingUnitInstanceAdded()
          Returns an event manager allowing to register ProcessingUnitInstanceAddedEventListeners for processing unit instances added on this virtual machine.
 ProcessingUnitInstanceRemovedEventManager getProcessingUnitInstanceRemoved()
          Returns an event manager allowing to register ProcessingUnitRemovedEventListeners for processing unit instances removed on this virtual machine.
 ProcessingUnitInstance[] getProcessingUnitInstances()
          Returns the processing unit instances started within this virtual machine.
 SpaceInstanceAddedEventManager getSpaceInstanceAdded()
          Returns an event manager allowing to register for SpaceInstanceAddedEventListeners for space instances added on this virtual machine.
 SpaceInstanceRemovedEventManager getSpaceInstanceRemoved()
          Returns an event manager allowing to register for SpaceInstanceRemovedEventListeners for space instances added on this virtual machine.
 SpaceInstance[] getSpaceInstances()
          Returns the space instances started within this virtual machine.
 VirtualMachineStatistics getStatistics()
          Returns the statistics of the virtual machine.
 String getUid()
          Returns the uid of the virtual machine.
 VirtualMachineStatisticsChangedEventManager getVirtualMachineStatisticsChanged()
          Returns an event manager allowing to register for VirtualMachineStatisticsChangedEvents.
 void removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)
          Removes an SpaceInstanceLifecycleEventListener allowing to be notified when a space instance was added or removed from this virtual machine.
 void removeProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
          Removes an ProcessingUnitInstanceLifecycleEventListener allowing to be notified when a processing unit instance was added or removed from this virtual machine.
 void runGc()
          Runs GC on the virtual machine.
 
Methods inherited from interface org.openspaces.admin.machine.MachineAware
getMachine
 
Methods inherited from interface org.openspaces.admin.zone.ZoneAware
getZones
 
Methods inherited from interface org.openspaces.admin.StatisticsMonitor
isMonitoring, setStatisticsHistorySize, setStatisticsInterval, startStatisticsMonitor, stopStatisticsMontior
 

Method Detail

getUid

String getUid()
Returns the uid of the virtual machine.


getDetails

VirtualMachineDetails getDetails()
Returns the details (non changeable information) of the virtual machine.


getStatistics

VirtualMachineStatistics getStatistics()
Returns the statistics of the virtual machine.


runGc

void runGc()
Runs GC on the virtual machine.


getGridServiceAgent

GridServiceAgent getGridServiceAgent()
Returns the grid service agent started within this virtual machine. Returns null if no grid service agent was started within it.


getGridServiceManager

GridServiceManager getGridServiceManager()
Returns the grid service manager started within this virtual machine. Returns null if no grid service manager was started within it.


getGridServiceContainer

GridServiceContainer getGridServiceContainer()
Returns the grid service container started within this virtual machine. Returns null if no grid service manager was started within it.


getProcessingUnitInstances

ProcessingUnitInstance[] getProcessingUnitInstances()
Returns the processing unit instances started within this virtual machine.


getSpaceInstances

SpaceInstance[] getSpaceInstances()
Returns the space instances started within this virtual machine.


getProcessingUnitInstanceAdded

ProcessingUnitInstanceAddedEventManager getProcessingUnitInstanceAdded()
Returns an event manager allowing to register ProcessingUnitInstanceAddedEventListeners for processing unit instances added on this virtual machine.


getProcessingUnitInstanceRemoved

ProcessingUnitInstanceRemovedEventManager getProcessingUnitInstanceRemoved()
Returns an event manager allowing to register ProcessingUnitRemovedEventListeners for processing unit instances removed on this virtual machine.


addProcessingUnitInstanceLifecycleEventListener

void addProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
Adds an ProcessingUnitInstanceLifecycleEventListener allowing to be notified when a processing unit instance was added or removed from this virtual machine.


removeProcessingUnitInstanceLifecycleEventListener

void removeProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
Removes an ProcessingUnitInstanceLifecycleEventListener allowing to be notified when a processing unit instance was added or removed from this virtual machine.


getSpaceInstanceAdded

SpaceInstanceAddedEventManager getSpaceInstanceAdded()
Returns an event manager allowing to register for SpaceInstanceAddedEventListeners for space instances added on this virtual machine.


getSpaceInstanceRemoved

SpaceInstanceRemovedEventManager getSpaceInstanceRemoved()
Returns an event manager allowing to register for SpaceInstanceRemovedEventListeners for space instances added on this virtual machine.


addLifecycleListener

void addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)
Adds an SpaceInstanceLifecycleEventListener allowing to be notified when a space instance was added or removed from this virtual machine.


removeLifecycleListener

void removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)
Removes an SpaceInstanceLifecycleEventListener allowing to be notified when a space instance was added or removed from this virtual machine.


getVirtualMachineStatisticsChanged

VirtualMachineStatisticsChangedEventManager getVirtualMachineStatisticsChanged()
Returns an event manager allowing to register for VirtualMachineStatisticsChangedEvents.

Note, the events will be raised only when the StatisticsMonitor.startStatisticsMonitor() is called.


GigaSpaces XAP 7.0 API

Copyright © GigaSpaces.