org.openspaces.admin.internal.space

Class DefaultSpace

java.lang.Object

org.openspaces.admin.internal.space.DefaultSpace

All Implemented Interfaces:

Iterable<SpaceInstance>, InternalSpace, InternalSpaceInstancesAware, Space, StatisticsMonitor

public class DefaultSpace
extends Object
implements InternalSpace

Author:

kimchy

Field Summary

Fields inherited from interface org.openspaces.admin.StatisticsMonitor

DEFAULT_HISTORY_SIZE, DEFAULT_MONITOR_INTERVAL

Constructor Summary

Constructors

Constructor and Description
DefaultSpace(InternalSpaces spaces, String uid, String name)

Method Summary

Modifier and Type	Method and Description
void	addInstance(SpaceInstance spaceInstance)
void	addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener) Allows to add SpaceInstanceLifecycleEventListener.
Admin	getAdmin()
SpaceStatistics	getBackupsStatistics() Returns an aggregated view of all the statistics of the backup instances.
GigaSpace	getGigaSpace() Returns the clustered view of the space to operate on.
IJSpace	getIJSpace()
SpaceInstance[]	getInstances() Returns all the space instances that are currently discovered that are part of this Space topology.
SpaceInstanceStatisticsChangedEventManager	getInstanceStatisticsChanged() Allows to register for space instance level statistics SpaceInstanceStatisticsChangedEvents.
String	getName() Returns the name of the Space.
int	getNumberOfBackups() Returns the number of backups per Space Instance.
int	getNumberOfInstances() Returns the number of instances as per the Space topology.
SpacePartition	getPartition(int partitionId) Returns a partition for a specific partition id.
SpacePartition[]	getPartitions() Returns all the partitions that form this Space topology.
SpaceStatistics	getPrimariesStatistics() Returns an aggregated view of all the statistics of the primary instances.
SpaceReplicationManager	getReplicationManager() Returns a replication manager for this space.
ReplicationStatusChangedEventManager	getReplicationStatusChanged() Allows to globally register for each SpaceInstance ReplicationStatusChangedEvent.
SpaceRuntimeDetails	getRuntimeDetails() Returns an aggregated view of all the Space runtime details of all primary instances.
int	getSize() Returns the number of currently discovered space instances.
SpaceInstanceAddedEventManager	getSpaceInstanceAdded() Allows to registered SpaceInstanceAddedEventListener to be notified when space instances are added.
SpaceInstance	getSpaceInstanceByUid(String uid) returns the Space instance based on its uid (see GridComponent.getUid())
SpaceInstanceRemovedEventManager	getSpaceInstanceRemoved() Allows to registered SpaceInstanceRemovedEventListener to be notified when space instances are removed.
SpaceInstance[]	getSpaceInstances()
SpaceModeChangedEventManager	getSpaceModeChanged() Allows to globally register for each SpaceInstance SpaceModeChangedEvent.
Spaces	getSpaces() Returns the spaces this space is one of.
SpaceSuspendTypeChangedEventManager	getSpaceSuspendTypeChanged() Allows to globally register for each SpaceInstance SpaceSuspendTypeChangedEvent
SpaceStatistics	getStatistics() Returns an aggregated view of all the statistics of all the instances.
SpaceStatisticsChangedEventManager	getStatisticsChanged() Allows to register for aggregated Space level statistics SpaceStatisticsChangedEvent.
int	getTotalNumberOfInstances() Returns the total number of instances.
String	getUid() Returns the uid of the Space.
boolean	isEmpty() Returns true if there are currently no space instances discovered.
boolean	isMonitoring() Returns true if statistics are now being monitored.
Iterator<SpaceInstance>	iterator()
void	refreshScheduledSpaceMonitors()
InternalSpaceInstance	removeInstance(String uid)
void	removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener) Allows to remove SpaceInstanceLifecycleEventListener.
void	setStatisticsHistorySize(int historySize) Sets the history size of number of statistics stored.
void	setStatisticsInterval(long interval, TimeUnit timeUnit) Sets the statistics interval, automatically updating the monitoring scheduled tasks if monitoring is enabled.
void	startStatisticsMonitor() Starts the statistics monitor, starting a scheduled monitor that polls for statistics.
void	stopStatisticsMonitor() Stops the statistics monitor.
boolean	waitFor(int numberOfSpaceInstances) Waits till at least the provided number of Space Instances are up.
boolean	waitFor(int numberOfSpaceInstances, long timeout, TimeUnit timeUnit) Waits till at least the provided number of Space Instances are up for the specified timeout.
boolean	waitFor(int numberOfSpaceInstances, SpaceMode spaceMode) Waits till at least the provided number of Space Instances that are of the space mode type are up.
boolean	waitFor(int numberOfSpaceInstances, SpaceMode spaceMode, long timeout, TimeUnit timeUnit) Waits till at least the provided number of Space Instances are of the space mode type are up for the specified timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultSpace

public DefaultSpace(InternalSpaces spaces,
                    String uid,
                    String name)

Method Detail

getSpaces

public Spaces getSpaces()

Description copied from interface: Space

Returns the spaces this space is one of.

Specified by:

getSpaces in interface Space

getUid

public String getUid()

Description copied from interface: Space

Returns the uid of the Space.

Specified by:

getUid in interface Space

getName

public String getName()

Description copied from interface: Space

Returns the name of the Space.

Specified by:

getName in interface Space

setStatisticsInterval

public void setStatisticsInterval(long interval,
                                  TimeUnit timeUnit)

Description copied from interface: StatisticsMonitor

Sets the statistics interval, automatically updating the monitoring scheduled tasks if monitoring is enabled.

Specified by:

setStatisticsInterval in interface StatisticsMonitor

setStatisticsHistorySize

public void setStatisticsHistorySize(int historySize)

Description copied from interface: StatisticsMonitor

Sets the history size of number of statistics stored.

Specified by:

setStatisticsHistorySize in interface StatisticsMonitor

startStatisticsMonitor

public void startStatisticsMonitor()

Description copied from interface: StatisticsMonitor

Starts the statistics monitor, starting a scheduled monitor that polls for statistics. Monitoring is required only when wanting to receive statistics change events.

Specified by:

startStatisticsMonitor in interface StatisticsMonitor

stopStatisticsMonitor

public void stopStatisticsMonitor()

Description copied from interface: StatisticsMonitor

Stops the statistics monitor.

Specified by:

stopStatisticsMonitor in interface StatisticsMonitor

isMonitoring

public boolean isMonitoring()

Description copied from interface: StatisticsMonitor

Returns true if statistics are now being monitored.

Specified by:

isMonitoring in interface StatisticsMonitor

getNumberOfInstances

public int getNumberOfInstances()

Description copied from interface: Space

Returns the number of instances as per the Space topology. Will return 4 if we have a replicated topology, and 2 if we have a 2 partitions each with one backup topology.

Specified by:

getNumberOfInstances in interface Space

getNumberOfBackups

public int getNumberOfBackups()

Description copied from interface: Space

Returns the number of backups per Space Instance. Returns 1 when we deploy a 2 partitions each with one backup topology.

Specified by:

getNumberOfBackups in interface Space

getTotalNumberOfInstances

public int getTotalNumberOfInstances()

Description copied from interface: Space

Returns the total number of instances. If there are no backups, will return Space.getNumberOfInstances(). If there are backups, will return Space.getNumberOfInstances() * (Space.getNumberOfBackups() + 1)

Specified by:

getTotalNumberOfInstances in interface Space

getInstances

public SpaceInstance[] getInstances()

Description copied from interface: Space

Returns all the space instances that are currently discovered that are part of this Space topology.

Specified by:

getInstances in interface Space

iterator

public Iterator<SpaceInstance> iterator()

Specified by:

iterator in interface Iterable<SpaceInstance>

getPartitions

public SpacePartition[] getPartitions()

Description copied from interface: Space

Returns all the partitions that form this Space topology.

Specified by:

getPartitions in interface Space

getPartition

public SpacePartition getPartition(int partitionId)

Description copied from interface: Space

Returns a partition for a specific partition id.

Specified by:

getPartition in interface Space

getSpaceModeChanged

public SpaceModeChangedEventManager getSpaceModeChanged()

Description copied from interface: Space

Allows to globally register for each SpaceInstance SpaceModeChangedEvent.

Specified by:

getSpaceModeChanged in interface Space

getSpaceSuspendTypeChanged

public SpaceSuspendTypeChangedEventManager getSpaceSuspendTypeChanged()

Description copied from interface: Space

Allows to globally register for each SpaceInstance SpaceSuspendTypeChangedEvent

Specified by:

getSpaceSuspendTypeChanged in interface Space

getReplicationStatusChanged

public ReplicationStatusChangedEventManager getReplicationStatusChanged()

Description copied from interface: Space

Allows to globally register for each SpaceInstance ReplicationStatusChangedEvent.

Specified by:

getReplicationStatusChanged in interface Space

getStatisticsChanged

public SpaceStatisticsChangedEventManager getStatisticsChanged()

Description copied from interface: Space

Allows to register for aggregated Space level statistics SpaceStatisticsChangedEvent.

Note, statistics monitoring must be started using StatisticsMonitor.startStatisticsMonitor() in order to receive events.

Specified by:

getStatisticsChanged in interface Space

getInstanceStatisticsChanged

public SpaceInstanceStatisticsChangedEventManager getInstanceStatisticsChanged()

Description copied from interface: Space

Allows to register for space instance level statistics SpaceInstanceStatisticsChangedEvents.

Note, statistics monitoring must be started using StatisticsMonitor.startStatisticsMonitor() in order to receive events.

Specified by:

getInstanceStatisticsChanged in interface Space

getStatistics

public SpaceStatistics getStatistics()

Description copied from interface: Space

Returns an aggregated view of all the statistics of all the instances.

Specified by:

getStatistics in interface Space

getPrimariesStatistics

public SpaceStatistics getPrimariesStatistics()

Description copied from interface: Space

Returns an aggregated view of all the statistics of the primary instances.

Specified by:

getPrimariesStatistics in interface Space

getBackupsStatistics

public SpaceStatistics getBackupsStatistics()

Description copied from interface: Space

Returns an aggregated view of all the statistics of the backup instances.

Specified by:

getBackupsStatistics in interface Space

getRuntimeDetails

public SpaceRuntimeDetails getRuntimeDetails()

Description copied from interface: Space

Returns an aggregated view of all the Space runtime details of all primary instances.

Specified by:

getRuntimeDetails in interface Space

getReplicationManager

public SpaceReplicationManager getReplicationManager()

Description copied from interface: Space

Returns a replication manager for this space.

Specified by:

getReplicationManager in interface Space

addInstance

public void addInstance(SpaceInstance spaceInstance)

Specified by:

addInstance in interface InternalSpace

removeInstance

public InternalSpaceInstance removeInstance(String uid)

Specified by:

removeInstance in interface InternalSpace

refreshScheduledSpaceMonitors

public void refreshScheduledSpaceMonitors()

Specified by:

refreshScheduledSpaceMonitors in interface InternalSpace

getSize

public int getSize()

Description copied from interface: Space

Returns the number of currently discovered space instances.

Specified by:

getSize in interface Space

isEmpty

public boolean isEmpty()

Description copied from interface: Space

Returns true if there are currently no space instances discovered.

Specified by:

isEmpty in interface Space

getIJSpace

public IJSpace getIJSpace()

getGigaSpace

public GigaSpace getGigaSpace()

Description copied from interface: Space

Returns the clustered view of the space to operate on.

Specified by:

getGigaSpace in interface Space

waitFor

public boolean waitFor(int numberOfSpaceInstances)

Description copied from interface: Space

Waits till at least the provided number of Space Instances are up.

Specified by:

waitFor in interface Space

waitFor

public boolean waitFor(int numberOfSpaceInstances,
                       long timeout,
                       TimeUnit timeUnit)

Description copied from interface: Space

Waits till at least the provided number of Space Instances are up for the specified timeout.

Specified by:

waitFor in interface Space

waitFor

public boolean waitFor(int numberOfSpaceInstances,
                       SpaceMode spaceMode)

Description copied from interface: Space

Waits till at least the provided number of Space Instances that are of the space mode type are up.

Specified by:

waitFor in interface Space

waitFor

public boolean waitFor(int numberOfSpaceInstances,
                       SpaceMode spaceMode,
                       long timeout,
                       TimeUnit timeUnit)

Description copied from interface: Space

Waits till at least the provided number of Space Instances are of the space mode type are up for the specified timeout.

Specified by:

waitFor in interface Space

getSpaceInstances

public SpaceInstance[] getSpaceInstances()

Specified by:

getSpaceInstances in interface InternalSpaceInstancesAware

getSpaceInstanceAdded

public SpaceInstanceAddedEventManager getSpaceInstanceAdded()

Description copied from interface: Space

Allows to registered SpaceInstanceAddedEventListener to be notified when space instances are added.

Specified by:

getSpaceInstanceAdded in interface Space

getSpaceInstanceRemoved

public SpaceInstanceRemovedEventManager getSpaceInstanceRemoved()

Description copied from interface: Space

Allows to registered SpaceInstanceRemovedEventListener to be notified when space instances are removed.

Specified by:

getSpaceInstanceRemoved in interface Space

addLifecycleListener

public void addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)

Description copied from interface: Space

Allows to add SpaceInstanceLifecycleEventListener.

Specified by:

addLifecycleListener in interface Space

removeLifecycleListener

public void removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)

Description copied from interface: Space

Allows to remove SpaceInstanceLifecycleEventListener.

Specified by:

removeLifecycleListener in interface Space

getAdmin

public Admin getAdmin()

Specified by:

getAdmin in interface InternalSpace

getSpaceInstanceByUid

public SpaceInstance getSpaceInstanceByUid(String uid)

Description copied from interface: InternalSpace

returns the Space instance based on its uid (see GridComponent.getUid())

Specified by:

getSpaceInstanceByUid in interface InternalSpace

Parameters:

uid - the unique id of the Space instance

Returns:

the Space instance or null