org.openspaces.admin.internal.gsc

Class DefaultGridServiceContainer

java.lang.Object

org.openspaces.admin.internal.support.AbstractGridComponent

org.openspaces.admin.internal.support.AbstractAgentGridComponent

org.openspaces.admin.internal.gsc.DefaultGridServiceContainer

All Implemented Interfaces:

Iterable<ProcessingUnitInstance>, AdminAware, AgentGridComponent, DiscoverableComponent, DumpProvider, GridComponent, GridServiceContainer, InternalGridServiceContainer, InternalMachineAware, InternalOperatingSystemAware, InternalOperatingSystemInfoProvider, InternalAgentGridComponent, InternalDiscoverableComponent, InternalGridComponent, InternalTransportAware, InternalTransportInfoProvider, InternalVirtualMachineAware, InternalVirtualMachineInfoProvider, InternalZoneAware, LogProviderGridComponent, MachineAware, MetricProvider, OperatingSystemAware, TransportAware, VirtualMachineAware, ZoneAware

public class DefaultGridServiceContainer
extends AbstractAgentGridComponent
implements InternalGridServiceContainer

Author:

kimchy

Field Summary

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

admin

Constructor Summary

Constructors

Constructor and Description
DefaultGridServiceContainer(ServiceID serviceID, com.gigaspaces.grid.gsc.GSC gsc, InternalAdmin admin, int agentId, String agentUid, JVMDetails jvmDetails)

Method Summary

Modifier and Type	Method and Description
void	addProcessingUnitInstance(ProcessingUnitInstance processingUnitInstance)
void	addProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener) Adds a processing unit lifecycle listener to the container.
boolean	contains(ProcessingUnitInstance processingUnitInstance) Returns true if the GSC contains the provided processing unit instance.
void	disableLRMIMonitoring()
void	enableLRMIMonitoring()
boolean	equals(Object o)
LRMIMonitoringDetails	fetchLRMIMonitoringDetails()
DumpResult	generateDump(String cause, Map<String,Object> context) Generates dump for all the provided dump processors.
DumpResult	generateDump(String cause, Map<String,Object> context, String... processor) Generates dump for the provided processors.
long	getCurrentTimeInMillis()
ExactZonesConfig	getExactZones()
com.gigaspaces.grid.gsc.GSC	getGSC()
JVMStatistics	getJVMStatistics()
NIODetails	getNIODetails()
NIOStatistics	getNIOStatistics()
OSDetails	getOSDetails()
OSStatistics	getOSStatistics()
ProcessingUnitInstanceAddedEventManager	getProcessingUnitInstanceAdded() Returns an event manager allowing to register for processing unit instance additions to the container.
ProcessingUnitInstance	getProcessingUnitInstanceByUID(String processingUnitInstanceUid) Returns the processing unit instance that are currently deployed within the grid service container according to its uid.
ProcessingUnitInstanceRemovedEventManager	getProcessingUnitInstanceRemoved() Returns an event manager allowing to register for processing unit instance removals from the container.
ProcessingUnitInstance[]	getProcessingUnitInstances() Returns the processing unit instances that are currently deployed within the grid service container.
ProcessingUnitInstance[]	getProcessingUnitInstances(String processingUnitName) Returns the processing unit instances of the specified name that are currently deployed within the grid service container.
ServiceID	getServiceID()
String	getUid() Returns the unique id of the grid component.
String[]	getUnconfirmedRemovedProcessingUnitInstancesUid()
int	hashCode()
boolean	hasProcessingUnitInstances()
Iterator<ProcessingUnitInstance>	iterator()
LogEntries	logEntries(LogEntryMatcher matcher) Returns the log entries matching the given matcher for the specific grid component.
LogEntries	logEntriesDirect(LogEntryMatcher matcher) Same as LogProviderGridComponent.logEntries(com.gigaspaces.log.LogEntryMatcher), but does not try and get the logs from the agent.
void	reloadMetricConfiguration()
void	removeProcessingUnitInstance(String uid)
void	removeProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener) Removes a processing unit lifecycle listener to the container.
void	runGc()
boolean	waitFor(int numberOfProcessingUnitInstances) Waits indefinitely for the given number of processing unit instances to run within the container.
boolean	waitFor(int numberOfProcessingUnitInstances, long timeout, TimeUnit timeUnit) Waits for timeout value (in time unit) for the given number of processing unit instances to run within the container.
boolean	waitFor(String processingUnitName, int numberOfProcessingUnitInstances) Waits indefinitely for the given number of processing unit instances of the specified name to run within the container.
boolean	waitFor(String processingUnitName, int numberOfProcessingUnitInstances, long timeout, TimeUnit timeUnit) Waits for timeout value (in time unit) for the given number of processing unit instances of the specified name to run within the container.

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

getAgentId, getAgentUid, getGridServiceAgent, kill, restart, setGridServiceAgent

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

getAgentUid, setGridServiceAgent

Methods inherited from interface org.openspaces.admin.AgentGridComponent

getAgentId, getGridServiceAgent, kill, restart

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

DefaultGridServiceContainer

public DefaultGridServiceContainer(ServiceID serviceID,
                                   com.gigaspaces.grid.gsc.GSC gsc,
                                   InternalAdmin admin,
                                   int agentId,
                                   String agentUid,
                                   JVMDetails jvmDetails)

Method Detail

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 InternalGridServiceContainer

getGSC

public com.gigaspaces.grid.gsc.GSC getGSC()

Specified by:

getGSC in interface InternalGridServiceContainer

iterator

public Iterator<ProcessingUnitInstance> iterator()

Specified by:

iterator in interface Iterable<ProcessingUnitInstance>

getProcessingUnitInstances

public ProcessingUnitInstance[] getProcessingUnitInstances()

Description copied from interface: GridServiceContainer

Returns the processing unit instances that are currently deployed within the grid service container.

Specified by:

getProcessingUnitInstances in interface GridServiceContainer

getProcessingUnitInstances

public ProcessingUnitInstance[] getProcessingUnitInstances(String processingUnitName)

Description copied from interface: GridServiceContainer

Returns the processing unit instances of the specified name that are currently deployed within the grid service container.

Specified by:

getProcessingUnitInstances in interface GridServiceContainer

getProcessingUnitInstanceByUID

public ProcessingUnitInstance getProcessingUnitInstanceByUID(String processingUnitInstanceUid)

Description copied from interface: GridServiceContainer

Returns the processing unit instance that are currently deployed within the grid service container according to its uid.

Specified by:

getProcessingUnitInstanceByUID in interface GridServiceContainer

contains

public boolean contains(ProcessingUnitInstance processingUnitInstance)

Description copied from interface: GridServiceContainer

Returns true if the GSC contains the provided processing unit instance.

Specified by:

contains in interface GridServiceContainer

waitFor

public boolean waitFor(int numberOfProcessingUnitInstances)

Description copied from interface: GridServiceContainer

Waits indefinitely for the given number of processing unit instances to run within the container.

Specified by:

waitFor in interface GridServiceContainer

waitFor

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

Description copied from interface: GridServiceContainer

Waits for timeout value (in time unit) for the given number of processing unit instances to run within the container. Returns true if the number was reached, false if the timeout expired.

Specified by:

waitFor in interface GridServiceContainer

waitFor

public boolean waitFor(String processingUnitName,
                       int numberOfProcessingUnitInstances)

Description copied from interface: GridServiceContainer

Waits indefinitely for the given number of processing unit instances of the specified name to run within the container.

Specified by:

waitFor in interface GridServiceContainer

waitFor

public boolean waitFor(String processingUnitName,
                       int numberOfProcessingUnitInstances,
                       long timeout,
                       TimeUnit timeUnit)

Description copied from interface: GridServiceContainer

Waits for timeout value (in time unit) for the given number of processing unit instances of the specified name to run within the container. Returns true if the number was reached, false if the timeout expired.

Specified by:

waitFor in interface GridServiceContainer

addProcessingUnitInstance

public void addProcessingUnitInstance(ProcessingUnitInstance processingUnitInstance)

Specified by:

addProcessingUnitInstance in interface InternalGridServiceContainer

removeProcessingUnitInstance

public void removeProcessingUnitInstance(String uid)

Specified by:

removeProcessingUnitInstance in interface InternalGridServiceContainer

getProcessingUnitInstanceAdded

public ProcessingUnitInstanceAddedEventManager getProcessingUnitInstanceAdded()

Description copied from interface: GridServiceContainer

Returns an event manager allowing to register for processing unit instance additions to the container.

Specified by:

getProcessingUnitInstanceAdded in interface GridServiceContainer

getProcessingUnitInstanceRemoved

public ProcessingUnitInstanceRemovedEventManager getProcessingUnitInstanceRemoved()

Description copied from interface: GridServiceContainer

Returns an event manager allowing to register for processing unit instance removals from the container.

Specified by:

getProcessingUnitInstanceRemoved in interface GridServiceContainer

addProcessingUnitInstanceLifecycleEventListener

public void addProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)

Description copied from interface: GridServiceContainer

Adds a processing unit lifecycle listener to the container.

Specified by:

addProcessingUnitInstanceLifecycleEventListener in interface GridServiceContainer

removeProcessingUnitInstanceLifecycleEventListener

public void removeProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)

Description copied from interface: GridServiceContainer

Removes a processing unit lifecycle listener to the container.

Specified by:

removeProcessingUnitInstanceLifecycleEventListener in interface GridServiceContainer

logEntries

public LogEntries logEntries(LogEntryMatcher matcher)
                      throws AdminException

Description copied from interface: LogProviderGridComponent

Returns the log entries matching the given matcher for the specific grid component. If it is managed by a GridServiceAgent, will get the log through it instead of creating a load on the actual grid component.

Specified by:

logEntries in interface LogProviderGridComponent

Throws:

AdminException

logEntriesDirect

public LogEntries logEntriesDirect(LogEntryMatcher matcher)
                            throws AdminException

Description copied from interface: LogProviderGridComponent

Same as LogProviderGridComponent.logEntries(com.gigaspaces.log.LogEntryMatcher), but does not try and get the logs from the agent.

Specified by:

logEntriesDirect in interface LogProviderGridComponent

Throws:

AdminException

reloadMetricConfiguration

public void reloadMetricConfiguration()
                               throws AdminException

Specified by:

reloadMetricConfiguration in interface MetricProvider

Throws:

AdminException

generateDump

public DumpResult generateDump(String cause,
                               Map<String,Object> context)
                        throws AdminException

Description copied from interface: DumpProvider

Generates dump for all the provided dump processors. Note, this will include a heap dump which can consume time and potentially be of very large size

Specified by:

generateDump in interface DumpProvider

Parameters:

cause - The cause that this dump was generated

context - Allows to provide specific parameters to specific processors

Throws:

AdminException

generateDump

public DumpResult generateDump(String cause,
                               Map<String,Object> context,
                               String... processor)
                        throws AdminException

Description copied from interface: DumpProvider

Generates dump for the provided processors. The current list of processors include:

• summary: General summary information of the process.
• network: Information on the network layer of the process and the OS network stats.
• thread: Thread dump of the process.
• heap: Heap dump of the process. Note, this is a heavy operation and can produce very large dump files
• log: Adds all the log files of the process to the dump file.
• processingUnits: Dump of all the processing units (applicable only for GSCs) information.

Specified by:

generateDump in interface DumpProvider

Parameters:

cause - The cause this dump was generated.

context - Allows to provide specific parameters to specific processors.

processor - The list of processors to be used.

Throws:

AdminException

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

hasProcessingUnitInstances

public boolean hasProcessingUnitInstances()

Specified by:

hasProcessingUnitInstances in interface InternalGridServiceContainer

Returns:

false only when all processing unit instances have completed shutdown.

See Also:

- use this event to get an indication when processing unit instance has started shutdown.

getUnconfirmedRemovedProcessingUnitInstancesUid

public String[] getUnconfirmedRemovedProcessingUnitInstancesUid()

Specified by:

getUnconfirmedRemovedProcessingUnitInstancesUid in interface InternalGridServiceContainer

Returns:

UIDs of instances that have been removed from the lookup service/Admin API, but are still reported by the GSC

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getExactZones

public ExactZonesConfig getExactZones()

Specified by:

getExactZones in interface GridServiceContainer

Returns:

the list of zones that the GSC satisfies

See Also:

ProcessingUnit#getRequiredContainerZones()}