Package org.openspaces.admin.vm

Interface VirtualMachines

All Superinterfaces:

AdminAware, Iterable<VirtualMachine>, StatisticsMonitor

All Known Subinterfaces:

InternalVirtualMachines

All Known Implementing Classes:

DefaultVirtualMachines

public interface VirtualMachines
extends AdminAware, Iterable<VirtualMachine>, StatisticsMonitor

Virtual Machines hold all the different VirtualMachines that are currently discovered.

Provides simple means to get all the current virtual machines, as well as as registering for virtual machine lifecycle (added and removed) events.

Provides the ability to start a statistics monitor on all current virtual machines using StatisticsMonitor.startStatisticsMonitor(). Newly discovered virtual machines will automatically use the statistics monitor as well.

Author:

kimchy

Field Summary

Fields inherited from interface org.openspaces.admin.StatisticsMonitor

DEFAULT_HISTORY_SIZE, DEFAULT_MONITOR_INTERVAL

Method Summary

Modifier and Type	Method	Description
void	addLifecycleListener(VirtualMachineLifecycleEventListener eventListener)	Allows to add a VirtualMachineLifecycleEventListener.
VirtualMachinesDetails	getDetails()	Returns the aggregated details of all virtual machines.
int	getSize()	Returns the number of virtual machines current discovered.
VirtualMachinesStatistics	getStatistics()	Returns the aggregated statistics of all virtual machines.
VirtualMachinesStatisticsChangedEventManager	getStatisticsChanged()	Returns a virtual machines statistics change event manager allowing to register for events of VirtualMachinesStatisticsChangedEvent.
Map<String,VirtualMachine>	getUids()	Returns a map of virtual machines with the key as the uid.
VirtualMachineAddedEventManager	getVirtualMachineAdded()	Returns the virtual machine added event manager allowing to add and remove VirtualMachineAddedEventListeners.
VirtualMachine	getVirtualMachineByUID(String uid)	Return a virtual machine by its uid.
VirtualMachineRemovedEventManager	getVirtualMachineRemoved()	Returns the virtual machine removed event manager allowing to add and remove VirtualMachineRemovedEventListeners.
VirtualMachine[]	getVirtualMachines()	Returns the currently discovered virtual machines.
VirtualMachineStatisticsChangedEventManager	getVirtualMachineStatisticsChanged()	Returns a virtual machine statistics change event manger allowing to register for events of VirtualMachineStatisticsChangedEvent.
boolean	isEmpty()	Returns true if there are no virtual machines, false otherwise.
void	removeLifecycleListener(VirtualMachineLifecycleEventListener eventListener)	Allows to remove a VirtualMachineLifecycleEventListener.

Methods inherited from interface org.openspaces.admin.AdminAware

getAdmin

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.openspaces.admin.StatisticsMonitor

isMonitoring, setStatisticsHistorySize, setStatisticsInterval, startStatisticsMonitor, stopStatisticsMonitor

Method Details

getVirtualMachines

VirtualMachine[] getVirtualMachines()

Returns the currently discovered virtual machines.

getDetails

VirtualMachinesDetails getDetails()

Returns the aggregated details of all virtual machines.

getStatistics

VirtualMachinesStatistics getStatistics()

Returns the aggregated statistics of all virtual machines.

getVirtualMachineByUID

VirtualMachine getVirtualMachineByUID(String uid)

Return a virtual machine by its uid.

getUids

Map<String,VirtualMachine> getUids()

Returns a map of virtual machines with the key as the uid.

getSize

int getSize()

Returns the number of virtual machines current discovered.

isEmpty

boolean isEmpty()

Returns true if there are no virtual machines, false otherwise.

getVirtualMachineAdded

VirtualMachineAddedEventManager getVirtualMachineAdded()

Returns the virtual machine added event manager allowing to add and remove VirtualMachineAddedEventListeners.

getVirtualMachineRemoved

VirtualMachineRemovedEventManager getVirtualMachineRemoved()

Returns the virtual machine removed event manager allowing to add and remove VirtualMachineRemovedEventListeners.

addLifecycleListener

void addLifecycleListener(VirtualMachineLifecycleEventListener eventListener)

Allows to add a VirtualMachineLifecycleEventListener.

removeLifecycleListener

void removeLifecycleListener(VirtualMachineLifecycleEventListener eventListener)

Allows to remove a VirtualMachineLifecycleEventListener.

getStatisticsChanged

VirtualMachinesStatisticsChangedEventManager getStatisticsChanged()

Returns a virtual machines statistics change event manager allowing to register for events of VirtualMachinesStatisticsChangedEvent.

Note, in order to receive events, the virtual machines need to be in a "statistics" monitored state.

getVirtualMachineStatisticsChanged

VirtualMachineStatisticsChangedEventManager getVirtualMachineStatisticsChanged()

Returns a virtual machine statistics change event manger allowing to register for events of VirtualMachineStatisticsChangedEvent.

Note, in order to receive events, the virtual machines need to be in a "statistics" monitored state.