org.openspaces.admin.internal.space

Class DefaultSpaces

java.lang.Object

org.openspaces.admin.internal.space.DefaultSpaces

All Implemented Interfaces:

Iterable<Space>, AdminAware, InternalSpaceInstancesAware, InternalSpaces, Spaces, StatisticsMonitor

public class DefaultSpaces
extends Object
implements InternalSpaces

Author:

kimchy

Field Summary

Fields inherited from interface org.openspaces.admin.StatisticsMonitor

DEFAULT_HISTORY_SIZE, DEFAULT_MONITOR_INTERVAL

Constructor Summary

Constructors

Constructor and Description
DefaultSpaces(InternalAdmin admin)

Method Summary

Modifier and Type	Method and Description
void	addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener) Allows to add a SpaceInstanceLifecycleEventListener hthat will be called for any space instance discovered.
void	addLifecycleListener(SpaceLifecycleEventListener eventListener) Adds a SpaceLifecycleEventListener to be notified when a Space is added and removed.
void	addSpace(Space space)
void	addSpaceInstance(SpaceInstance spaceInstance)
Admin	getAdmin() Returns the Admin associated with this element.
Map<String,Space>	getNames() Returns a map of Spaces keyed by their names.
ReplicationStatusChangedEventManager	getReplicationStatusChanged() Returns an event manager allowing to globally register for ReplicationStatusChangedEvents that happen on any Space instance currently discovered.
SpaceAddedEventManager	getSpaceAdded() Returns an event manager allowing to add SpaceAddedEventListeners.
Space	getSpaceByName(String name) Returns a space based on its name.
Space	getSpaceByUID(String uid) Returns a space based on its uid.
SpaceInstanceAddedEventManager	getSpaceInstanceAdded() Returns an event manager allowing to globally add SpaceInstanceAddedEventListener that will be called for any space instance discovered.
SpaceInstanceRemovedEventManager	getSpaceInstanceRemoved() Returns an event manager allowing to globally remove SpaceInstanceAddedEventListener that will be called for any space instance discovered.
SpaceInstance[]	getSpaceInstances()
SpaceInstanceStatisticsChangedEventManager	getSpaceInstanceStatisticsChanged() Returns an event manager allowing to register for SpaceInstanceStatisticsChangedEvents that occur on all the currently discovered SpaceInstances.
SpaceModeChangedEventManager	getSpaceModeChanged() Returns an event manager allowing to globally register for SpaceModeChangedEvents that happen on any Space instance currently discovered.
SpaceRemovedEventManager	getSpaceRemoved() Returns an event manager allowing to remove SpaceAddedEventListeners.
Space[]	getSpaces() Returns all the currently discovered Spaces.
SpaceStatisticsChangedEventManager	getSpaceStatisticsChanged() Returns an event manager allowing to register for SpaceStatisticsChangedEvents that occur on all the currently discovered Spaces.
SpaceSuspendTypeChangedEventManager	getSpaceSuspendTypeChanged() Returns an event manager allowing to globally register for SpaceSuspendTypeChangedEvents that happen on any Space instance currently discovered
boolean	isMonitoring() Returns true if statistics are now being monitored.
Iterator<Space>	iterator()
void	refreshScheduledSpaceMonitors()
void	removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener) Allows to remove a SpaceInstanceLifecycleEventListener hthat will be called for any space instance discovered.
void	removeLifecycleListener(SpaceLifecycleEventListener eventListener) Removes a SpaceLifecycleEventListener to be notified when a Space is added and removed.
InternalSpace	removeSpace(String uid)
SpaceInstance	removeSpaceInstance(String uid)
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.
Space	waitFor(String spaceName) Waits indefinitely till the provided Space name is discovered.
Space	waitFor(String spaceName, long timeout, TimeUnit timeUnit) Waits for the given timeout (in time unit) till the space name is discovered.

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

DefaultSpaces

public DefaultSpaces(InternalAdmin admin)

Method Detail

getAdmin

public Admin getAdmin()

Description copied from interface: AdminAware

Returns the Admin associated with this element.

Specified by:

getAdmin in interface AdminAware

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

getSpaces

public Space[] getSpaces()

Description copied from interface: Spaces

Returns all the currently discovered Spaces.

Specified by:

getSpaces in interface Spaces

getSpaceByUID

public Space getSpaceByUID(String uid)

Description copied from interface: Spaces

Returns a space based on its uid.

Specified by:

getSpaceByUID in interface Spaces

getSpaceByName

public Space getSpaceByName(String name)

Description copied from interface: Spaces

Returns a space based on its name.

Specified by:

getSpaceByName in interface Spaces

getNames

public Map<String,Space> getNames()

Description copied from interface: Spaces

Returns a map of Spaces keyed by their names.

Specified by:

getNames in interface Spaces

iterator

public Iterator<Space> iterator()

Specified by:

iterator in interface Iterable<Space>

getSpaceAdded

public SpaceAddedEventManager getSpaceAdded()

Description copied from interface: Spaces

Returns an event manager allowing to add SpaceAddedEventListeners.

Specified by:

getSpaceAdded in interface Spaces

getSpaceRemoved

public SpaceRemovedEventManager getSpaceRemoved()

Description copied from interface: Spaces

Returns an event manager allowing to remove SpaceAddedEventListeners.

Specified by:

getSpaceRemoved in interface Spaces

getSpaceStatisticsChanged

public SpaceStatisticsChangedEventManager getSpaceStatisticsChanged()

Description copied from interface: Spaces

Returns an event manager allowing to register for SpaceStatisticsChangedEvents that occur on all the currently discovered Spaces.

Note, StatisticsMonitor.startStatisticsMonitor() must be called in order to start monitor statistics.

Specified by:

getSpaceStatisticsChanged in interface Spaces

getSpaceInstanceStatisticsChanged

public SpaceInstanceStatisticsChangedEventManager getSpaceInstanceStatisticsChanged()

Description copied from interface: Spaces

Returns an event manager allowing to register for SpaceInstanceStatisticsChangedEvents that occur on all the currently discovered SpaceInstances.

Note, StatisticsMonitor.startStatisticsMonitor() must be called in order to start monitoring statistics.

Specified by:

getSpaceInstanceStatisticsChanged in interface Spaces

waitFor

public Space waitFor(String spaceName)

Description copied from interface: Spaces

Waits indefinitely till the provided Space name is discovered.

Specified by:

waitFor in interface Spaces

Parameters:

spaceName - The space name to wait for

waitFor

public Space waitFor(String spaceName,
                     long timeout,
                     TimeUnit timeUnit)

Description copied from interface: Spaces

Waits for the given timeout (in time unit) till the space name is discovered. Returns true if the space is discovered, false if the timeout expired.

Specified by:

waitFor in interface Spaces

addLifecycleListener

public void addLifecycleListener(SpaceLifecycleEventListener eventListener)

Description copied from interface: Spaces

Adds a SpaceLifecycleEventListener to be notified when a Space is added and removed.

Specified by:

addLifecycleListener in interface Spaces

removeLifecycleListener

public void removeLifecycleListener(SpaceLifecycleEventListener eventListener)

Description copied from interface: Spaces

Removes a SpaceLifecycleEventListener to be notified when a Space is added and removed.

Specified by:

removeLifecycleListener in interface Spaces

getSpaceModeChanged

public SpaceModeChangedEventManager getSpaceModeChanged()

Description copied from interface: Spaces

Returns an event manager allowing to globally register for SpaceModeChangedEvents that happen on any Space instance currently discovered.

Specified by:

getSpaceModeChanged in interface Spaces

getSpaceSuspendTypeChanged

public SpaceSuspendTypeChangedEventManager getSpaceSuspendTypeChanged()

Description copied from interface: Spaces

Returns an event manager allowing to globally register for SpaceSuspendTypeChangedEvents that happen on any Space instance currently discovered

Specified by:

getSpaceSuspendTypeChanged in interface Spaces

getReplicationStatusChanged

public ReplicationStatusChangedEventManager getReplicationStatusChanged()

Description copied from interface: Spaces

Returns an event manager allowing to globally register for ReplicationStatusChangedEvents that happen on any Space instance currently discovered.

Specified by:

getReplicationStatusChanged in interface Spaces

getSpaceInstances

public SpaceInstance[] getSpaceInstances()

Specified by:

getSpaceInstances in interface InternalSpaceInstancesAware

getSpaceInstanceAdded

public SpaceInstanceAddedEventManager getSpaceInstanceAdded()

Description copied from interface: Spaces

Returns an event manager allowing to globally add SpaceInstanceAddedEventListener that will be called for any space instance discovered.

Specified by:

getSpaceInstanceAdded in interface Spaces

getSpaceInstanceRemoved

public SpaceInstanceRemovedEventManager getSpaceInstanceRemoved()

Description copied from interface: Spaces

Returns an event manager allowing to globally remove SpaceInstanceAddedEventListener that will be called for any space instance discovered.

Specified by:

getSpaceInstanceRemoved in interface Spaces

addLifecycleListener

public void addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)

Description copied from interface: Spaces

Allows to add a SpaceInstanceLifecycleEventListener hthat will be called for any space instance discovered.

Specified by:

addLifecycleListener in interface Spaces

removeLifecycleListener

public void removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)

Description copied from interface: Spaces

Allows to remove a SpaceInstanceLifecycleEventListener hthat will be called for any space instance discovered.

Specified by:

removeLifecycleListener in interface Spaces

addSpace

public void addSpace(Space space)

Specified by:

addSpace in interface InternalSpaces

removeSpace

public InternalSpace removeSpace(String uid)

Specified by:

removeSpace in interface InternalSpaces

addSpaceInstance

public void addSpaceInstance(SpaceInstance spaceInstance)

Specified by:

addSpaceInstance in interface InternalSpaces

removeSpaceInstance

public SpaceInstance removeSpaceInstance(String uid)

Specified by:

removeSpaceInstance in interface InternalSpaces

refreshScheduledSpaceMonitors

public void refreshScheduledSpaceMonitors()

Specified by:

refreshScheduledSpaceMonitors in interface InternalSpaces