org.openspaces.admin.internal.space

Class DefaultSpaceInstance

java.lang.Object

org.openspaces.admin.internal.support.AbstractGridComponent

org.openspaces.admin.internal.space.DefaultSpaceInstance

All Implemented Interfaces:

AdminAware, DiscoverableComponent, GridComponent, InternalMachineAware, InternalOperatingSystemAware, InternalOperatingSystemInfoProvider, InternalSpaceInstance, InternalDiscoverableComponent, InternalGridComponent, InternalTransportAware, InternalTransportInfoProvider, InternalVirtualMachineAware, InternalVirtualMachineInfoProvider, InternalZoneAware, MachineAware, OperatingSystemAware, SpaceInstance, StatisticsMonitor, TransportAware, VirtualMachineAware, ZoneAware

public class DefaultSpaceInstance
extends AbstractGridComponent
implements InternalSpaceInstance, StatisticsMonitor

Author:

kimchy

Field Summary

Fields inherited from class org.openspaces.admin.internal.support.AbstractGridComponent

admin

Fields inherited from interface org.openspaces.admin.StatisticsMonitor

DEFAULT_HISTORY_SIZE, DEFAULT_MONITOR_INTERVAL

Constructor Summary

Constructors

Constructor and Description
DefaultSpaceInstance(PUServiceBean puService, SpaceServiceDetails spaceServiceDetails, InternalAdmin admin, JVMDetails jvmDetails)
DefaultSpaceInstance(ServiceID serviceID, IJSpace directSpace, IInternalRemoteJSpaceAdmin spaceAdmin, InternalAdmin admin, JVMDetails jvmDetails)

Method Summary

Modifier and Type	Method and Description
Future<?>	demote(long maxSuspendTime, TimeUnit timeUnit) Demote a primary space instance to backup
Future<?>	demote(long maxSuspendTime, TimeUnit timeUnit, CredentialsProvider credentialsProvider) Demote a primary space instance to backup with provided security credentials
void	disableLRMIMonitoring()
void	enableLRMIMonitoring()
LRMIMonitoringDetails	fetchLRMIMonitoringDetails()
int	getBackupId() Returns the backup id (if it is a topology with backups) of the space instance.
ClusterInfo	getClusterInfo() Returns the space cluster information.
String	getClusterSchema()
long	getCurrentTimeInMillis()
GigaSpace	getGigaSpace() Returns the direct proxy to the actual space instance.
String	getId() Returns the Space instance Identifier
IJSpace	getIJSpace()
int	getInstanceId() Returns the instance id of the space (starting from 1).
JVMStatistics	getJVMStatistics()
SpaceMode	getMode() Returns the space mode, indicating if the space is primary or backup.
NIODetails	getNIODetails()
NIOStatistics	getNIOStatistics()
int	getNumberOfBackups()
int	getNumberOfInstances()
OSDetails	getOSDetails()
OSStatistics	getOSStatistics()
SpacePartition	getPartition() Returns the partition this instance is part of.
PlatformLogicalVersion	getPlatformLogicalVersion()
ReplicationStatusChangedEventManager	getReplicationStatusChanged() Allows to register for ReplicationStatusChangedEvents.
ReplicationTarget[]	getReplicationTargets() Returns the replication targets this space instance is replicating to.
SpaceInstanceRuntimeDetails	getRuntimeDetails() Returns the space runtime information.
RuntimeHolder	getRuntimeHolder()
ServiceID	getServiceID()
Space	getSpace() Returns the space this instance is part of.
IInternalRemoteJSpaceAdmin	getSpaceAdmin()
SpaceConfig	getSpaceConfig()
String	getSpaceInstanceName() Get this Space instance String representation. If the Space is part of a highly-available partition (i.e.
SpaceInstanceRemoteClassLoaderInfo	getSpaceInstanceRemoteClassLoaderInfo() Returns information about the space class loaders
SpaceModeChangedEventManager	getSpaceModeChanged() Allows to register for SpaceModeChangedEvents.
String	getSpaceName()
SpaceSuspendTypeChangedEventManager	getSpaceSuspendTypeChanged() Allows to register for SpaceSuspendTypeChangedEvents.
SpaceURL	getSpaceUrl()
SpaceInstanceStatistics	getStatistics() Returns the space instance statistics.
SpaceInstanceStatisticsChangedEventManager	getStatisticsChanged() Allows to register for SpaceInstanceStatisticsChangedEvents.
StatisticsHolder	getStatisticsHolder()
SuspendInfo	getSuspendInfo()
String	getUid() Returns the unique id of the grid component.
boolean	isMonitoring() Returns true if statistics are now being monitored.
void	runGc()
protected void	setIJSpace(ISpaceProxy spaceProxy)
void	setMode(SpaceMode spaceMode)
void	setPartition(SpacePartition spacePartition)
void	setReplicationTargets(ReplicationTarget[] replicationTargets)
void	setSpace(Space space)
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	setSuspendInfo(SuspendInfo suspendInfo)
void	startStatisticsMonitor() Starts the statistics monitor, starting a scheduled monitor that polls for statistics.
void	stopStatisticsMonitor() Stops the statistics monitor.
String	toString()
boolean	waitForMode(SpaceMode requiredMode, long timeout, TimeUnit timeUnit) Waits for the space instance to move to the provided space mode.

Methods inherited from class org.openspaces.admin.internal.support.AbstractGridComponent

addZone, assertStateChangesPermitted, getAdmin, getJVMDetails, getMachine, getOperatingSystem, getTransport, getVirtualMachine, getZones, isDiscovered, setDiscovered, setMachine, setOperatingSystem, setTransport, setVirtualMachine

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openspaces.admin.AdminAware

getAdmin

Methods inherited from interface org.openspaces.admin.internal.support.InternalDiscoverableComponent

setDiscovered

Methods inherited from interface org.openspaces.admin.DiscoverableComponent

isDiscovered

Methods inherited from interface org.openspaces.admin.internal.machine.InternalMachineAware

setMachine

Methods inherited from interface org.openspaces.admin.machine.MachineAware

getMachine

Methods inherited from interface org.openspaces.admin.internal.transport.InternalTransportAware

setTransport

Methods inherited from interface org.openspaces.admin.transport.TransportAware

getTransport

Methods inherited from interface org.openspaces.admin.internal.os.InternalOperatingSystemAware

setOperatingSystem

Methods inherited from interface org.openspaces.admin.os.OperatingSystemAware

getOperatingSystem

Methods inherited from interface org.openspaces.admin.internal.vm.InternalVirtualMachineInfoProvider

getJVMDetails

Methods inherited from interface org.openspaces.admin.internal.vm.InternalVirtualMachineAware

setVirtualMachine

Methods inherited from interface org.openspaces.admin.vm.VirtualMachineAware

getVirtualMachine

Methods inherited from interface org.openspaces.admin.internal.zone.InternalZoneAware

addZone

Methods inherited from interface org.openspaces.admin.zone.ZoneAware

getZones

Constructor Detail

DefaultSpaceInstance

public DefaultSpaceInstance(ServiceID serviceID,
                            IJSpace directSpace,
                            IInternalRemoteJSpaceAdmin spaceAdmin,
                            InternalAdmin admin,
                            JVMDetails jvmDetails)

DefaultSpaceInstance

public DefaultSpaceInstance(PUServiceBean puService,
                            SpaceServiceDetails spaceServiceDetails,
                            InternalAdmin admin,
                            JVMDetails jvmDetails)

Method Detail

getId

public String getId()

Description copied from interface: SpaceInstance

Returns the Space instance Identifier

Specified by:

getId in interface SpaceInstance

getUid

public String getUid()

Description copied from interface: GridComponent

Returns the unique id of the grid component.

Specified by:

getUid in interface GridComponent

Specified by:

getUid in interface InternalVirtualMachineInfoProvider

getServiceID

public ServiceID getServiceID()

Specified by:

getServiceID in interface InternalSpaceInstance

getGigaSpace

public GigaSpace getGigaSpace()

Description copied from interface: SpaceInstance

Returns the direct proxy to the actual space instance.

Specified by:

getGigaSpace in interface SpaceInstance

getClusterInfo

public ClusterInfo getClusterInfo()

Description copied from interface: SpaceInstance

Returns the space cluster information.

Specified by:

getClusterInfo in interface SpaceInstance

getClusterSchema

public String getClusterSchema()

Specified by:

getClusterSchema in interface InternalSpaceInstance

getNumberOfInstances

public int getNumberOfInstances()

Specified by:

getNumberOfInstances in interface InternalSpaceInstance

getNumberOfBackups

public int getNumberOfBackups()

Specified by:

getNumberOfBackups in interface InternalSpaceInstance

getSpaceUrl

public SpaceURL getSpaceUrl()

Specified by:

getSpaceUrl in interface SpaceInstance

getSpaceName

public String getSpaceName()

Specified by:

getSpaceName in interface InternalSpaceInstance

getSpaceModeChanged

public SpaceModeChangedEventManager getSpaceModeChanged()

Description copied from interface: SpaceInstance

Allows to register for SpaceModeChangedEvents.

Specified by:

getSpaceModeChanged in interface SpaceInstance

getSpaceSuspendTypeChanged

public SpaceSuspendTypeChangedEventManager getSpaceSuspendTypeChanged()

Description copied from interface: SpaceInstance

Allows to register for SpaceSuspendTypeChangedEvents.

Specified by:

getSpaceSuspendTypeChanged in interface SpaceInstance

getReplicationStatusChanged

public ReplicationStatusChangedEventManager getReplicationStatusChanged()

Description copied from interface: SpaceInstance

Allows to register for ReplicationStatusChangedEvents.

Specified by:

getReplicationStatusChanged in interface SpaceInstance

getStatisticsChanged

public SpaceInstanceStatisticsChangedEventManager getStatisticsChanged()

Description copied from interface: SpaceInstance

Allows to register for SpaceInstanceStatisticsChangedEvents.

Note, monitoring must be started using StatisticsMonitor.startStatisticsMonitor() for events to occur.

Specified by:

getStatisticsChanged in interface SpaceInstance

getSpaceInstanceName

public String getSpaceInstanceName()

Description copied from interface: SpaceInstance

Get this Space instance String representation.
If the Space is part of a highly-available partition (i.e. with backups), returns: {Space name}.{instance/partition id} [backup id] - for example, MySpace.3 [1]
Otherwise, when there are no backups (i.e. only partitioned), returns: {Space name} [instance/partition id] - for example, MySpace [3]

Specified by:

getSpaceInstanceName in interface SpaceInstance

Returns:

this Space instance String representation.

getInstanceId

public int getInstanceId()

Description copied from interface: SpaceInstance

Returns the instance id of the space (starting from 1).

Specified by:

getInstanceId in interface SpaceInstance

getBackupId

public int getBackupId()

Description copied from interface: SpaceInstance

Returns the backup id (if it is a topology with backups) of the space instance.

Specified by:

getBackupId in interface SpaceInstance

getIJSpace

public IJSpace getIJSpace()

Specified by:

getIJSpace in interface InternalSpaceInstance

setIJSpace

protected void setIJSpace(ISpaceProxy spaceProxy)

getSpaceAdmin

public IInternalRemoteJSpaceAdmin getSpaceAdmin()

Specified by:

getSpaceAdmin in interface InternalSpaceInstance

getRuntimeHolder

public RuntimeHolder getRuntimeHolder()
                               throws RemoteException

Specified by:

getRuntimeHolder in interface InternalSpaceInstance

Throws:

RemoteException

setMode

public void setMode(SpaceMode spaceMode)

Specified by:

setMode in interface InternalSpaceInstance

getMode

public SpaceMode getMode()

Description copied from interface: SpaceInstance

Returns the space mode, indicating if the space is primary or backup.

Specified by:

getMode in interface SpaceInstance

waitForMode

public boolean waitForMode(SpaceMode requiredMode,
                           long timeout,
                           TimeUnit timeUnit)

Description copied from interface: SpaceInstance

Waits for the space instance to move to the provided space mode. Returns true if the mode was changed to the required one withing the timeout, or false otherwise.

Specified by:

waitForMode in interface SpaceInstance

getStatistics

public SpaceInstanceStatistics getStatistics()

Description copied from interface: SpaceInstance

Returns the space instance statistics.

Specified by:

getStatistics in interface SpaceInstance

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

getRuntimeDetails

public SpaceInstanceRuntimeDetails getRuntimeDetails()

Description copied from interface: SpaceInstance

Returns the space runtime information.

Specified by:

getRuntimeDetails in interface SpaceInstance

getSpaceInstanceRemoteClassLoaderInfo

public SpaceInstanceRemoteClassLoaderInfo getSpaceInstanceRemoteClassLoaderInfo()

Description copied from interface: SpaceInstance

Returns information about the space class loaders

Specified by:

getSpaceInstanceRemoteClassLoaderInfo in interface SpaceInstance

getReplicationTargets

public ReplicationTarget[] getReplicationTargets()

Description copied from interface: SpaceInstance

Returns the replication targets this space instance is replicating to.

Specified by:

getReplicationTargets in interface SpaceInstance

setReplicationTargets

public void setReplicationTargets(ReplicationTarget[] replicationTargets)

Specified by:

setReplicationTargets in interface InternalSpaceInstance

getSpace

public Space getSpace()

Description copied from interface: SpaceInstance

Returns the space this instance is part of.

Specified by:

getSpace in interface SpaceInstance

setSpace

public void setSpace(Space space)

Specified by:

setSpace in interface InternalSpaceInstance

setPartition

public void setPartition(SpacePartition spacePartition)

Specified by:

setPartition in interface InternalSpaceInstance

getPartition

public SpacePartition getPartition()

Description copied from interface: SpaceInstance

Returns the partition this instance is part of.

Specified by:

getPartition in interface SpaceInstance

getNIODetails

public NIODetails getNIODetails()
                         throws RemoteException

Specified by:

getNIODetails in interface InternalTransportInfoProvider

Throws:

RemoteException

getNIOStatistics

public NIOStatistics getNIOStatistics()
                               throws RemoteException

Specified by:

getNIOStatistics in interface InternalTransportInfoProvider

Throws:

RemoteException

enableLRMIMonitoring

public void enableLRMIMonitoring()
                          throws RemoteException

Specified by:

enableLRMIMonitoring in interface InternalTransportInfoProvider

Throws:

RemoteException

disableLRMIMonitoring

public void disableLRMIMonitoring()
                           throws RemoteException

Specified by:

disableLRMIMonitoring in interface InternalTransportInfoProvider

Throws:

RemoteException

fetchLRMIMonitoringDetails

public LRMIMonitoringDetails fetchLRMIMonitoringDetails()
                                                 throws RemoteException

Specified by:

fetchLRMIMonitoringDetails in interface InternalTransportInfoProvider

Throws:

RemoteException

getCurrentTimeInMillis

public long getCurrentTimeInMillis()
                            throws RemoteException

Specified by:

getCurrentTimeInMillis in interface InternalOperatingSystemInfoProvider

Throws:

RemoteException

getOSDetails

public OSDetails getOSDetails()
                       throws RemoteException

Specified by:

getOSDetails in interface InternalOperatingSystemInfoProvider

Throws:

RemoteException

getOSStatistics

public OSStatistics getOSStatistics()
                             throws RemoteException

Specified by:

getOSStatistics in interface InternalOperatingSystemInfoProvider

Throws:

RemoteException

getJVMStatistics

public JVMStatistics getJVMStatistics()
                               throws RemoteException

Specified by:

getJVMStatistics in interface InternalVirtualMachineInfoProvider

Throws:

RemoteException

runGc

public void runGc()
           throws RemoteException

Specified by:

runGc in interface InternalVirtualMachineInfoProvider

Throws:

RemoteException

toString

public String toString()

Overrides:

toString in class Object

getStatisticsHolder

public StatisticsHolder getStatisticsHolder()
                                     throws RemoteException

Specified by:

getStatisticsHolder in interface InternalSpaceInstance

Throws:

RemoteException

getPlatformLogicalVersion

public PlatformLogicalVersion getPlatformLogicalVersion()

Specified by:

getPlatformLogicalVersion in interface InternalSpaceInstance

getSpaceConfig

public SpaceConfig getSpaceConfig()

Specified by:

getSpaceConfig in interface InternalSpaceInstance

demote

public Future<?> demote(long maxSuspendTime,
                        TimeUnit timeUnit)

Description copied from interface: SpaceInstance

Demote a primary space instance to backup

Specified by:

demote in interface SpaceInstance

demote

public Future<?> demote(long maxSuspendTime,
                        TimeUnit timeUnit,
                        CredentialsProvider credentialsProvider)

Description copied from interface: InternalSpaceInstance

Demote a primary space instance to backup with provided security credentials

Specified by:

demote in interface InternalSpaceInstance

See Also:

SpaceInstance.demote(long, TimeUnit)

setSuspendInfo

public void setSuspendInfo(SuspendInfo suspendInfo)

Specified by:

setSuspendInfo in interface InternalSpaceInstance

getSuspendInfo

public SuspendInfo getSuspendInfo()

Specified by:

getSuspendInfo in interface SpaceInstance