org.openspaces.admin.internal.gsa

Class DefaultGridServiceAgent

java.lang.Object

org.openspaces.admin.internal.support.AbstractGridComponent

org.openspaces.admin.internal.gsa.DefaultGridServiceAgent

All Implemented Interfaces:

AdminAware, DiscoverableComponent, DumpProvider, GridComponent, GridServiceAgent, InternalGridServiceAgent, InternalMachineAware, InternalOperatingSystemAware, InternalOperatingSystemInfoProvider, InternalDiscoverableComponent, InternalGridComponent, InternalTransportAware, InternalTransportInfoProvider, InternalVirtualMachineAware, InternalVirtualMachineInfoProvider, InternalZoneAware, LogProviderGridComponent, MachineAware, MetricProvider, OperatingSystemAware, TransportAware, VirtualMachineAware, ZoneAware

public class DefaultGridServiceAgent
extends AbstractGridComponent
implements InternalGridServiceAgent

Author:

kimchy

Field Summary

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

admin

Constructor Summary

Constructors

Constructor and Description
DefaultGridServiceAgent(ServiceID serviceID, com.gigaspaces.grid.gsa.GSA gsa, InternalAdmin admin, com.gigaspaces.grid.gsa.AgentProcessesDetails processesDetails, JVMDetails jvmDetails)

Method Summary

Modifier and Type	Method and Description
void	addAgentGridComponent(InternalAgentGridComponent agentGridComponent) Invoked to mark a child grid component as added to lookup service
CompoundLogEntries	allLogEntries(LogProcessType type, LogEntryMatcher matcher) Extracts all the log entries for the provided process type including both "live" runtime components and ones that are no longer running.
void	deleteTieredStorageSpaceData(String spaceName) Deletes persistent data of a given tiered storage space
void	disableLRMIMonitoring()
void	enableLRMIMonitoring()
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()
GridServiceContainers	getGridServiceContainers()
GridServiceManagers	getGridServiceManagers()
com.gigaspaces.grid.gsa.GSA	getGSA()
JVMStatistics	getJVMStatistics()
LookupServices	getLookupServices()
NIODetails	getNIODetails()
NIOStatistics	getNIOStatistics()
OSDetails	getOSDetails()
OSStatistics	getOSStatistics()
com.gigaspaces.grid.gsa.AgentProcessesDetails	getProcessesDetails() Returns all the processes details this agent is currently running.
GSAReservationId	getReservationId()
ServiceID	getServiceID()
String	getUid() Returns the unique id of the grid component.
InternalAgentGridComponent[]	getUnconfirmedRemovedAgentGridComponents()
int	internalStartGridService(GridServiceContainerOptions options)
int	internalStartGridService(LookupServiceOptions options)
void	kill(InternalAgentGridComponent agentGridComponent)
void	killByAgentId(int agentId) Kills a process based on the agent id provided to it.
CompoundLogEntries	liveLogEntries(LogEntryMatcher matcher) Extracts all the log entries of all the "live" runtime components that this agent is running matching the given matcher.
LogEntries	logEntries(LogEntryMatcher matcher) Returns the log entries matching the given matcher for the specific grid component.
LogEntries	logEntries(LogProcessType type, long pid, LogEntryMatcher matcher) Extract the log entries matching the provided matcher for the process type and process id.
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	removeAgentGridComponent(InternalAgentGridComponent agentGridComponent) Invoked to mark a child grid component as removed from lookup service
void	restart(InternalAgentGridComponent agentGridComponent)
void	runGc()
void	setProcessesDetails(com.gigaspaces.grid.gsa.AgentProcessesDetails processesDetails)
void	shutdown() Shuts down the GSA.
void	startGridService(GridServiceContainerOptions options) Starts a GridServiceContainer based on the provided options.
void	startGridService(GridServiceManagerOptions options) Starts a GridServiceManager based on the provided options.
int	startGridService(GridServiceOptions options) Starts a generic process of a given type.
void	startGridService(LookupServiceOptions options) Starts a LookupService based on the provided options.
GridServiceContainer	startGridServiceAndWait(GridServiceContainerOptions options) Starts a GridServiceContainer based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.
GridServiceContainer	startGridServiceAndWait(GridServiceContainerOptions options, long timeout, TimeUnit timeUnit) Starts a GridServiceContainer based on the provided options and waits for the given timeout (in time unit) until it is discovered by the admin, which is then returned.
GridServiceManager	startGridServiceAndWait(GridServiceManagerOptions options) Starts a GridServiceManager based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.
GridServiceManager	startGridServiceAndWait(GridServiceManagerOptions options, long timeout, TimeUnit timeUnit) Starts a GridServiceManager based on the provided options and waits for the given timeout (in time unit) until it is discovered by the admin, which is then returned.
LookupService	startGridServiceAndWait(LookupServiceOptions options) Starts a LookupService based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.
LookupService	startGridServiceAndWait(LookupServiceOptions options, long timeout, TimeUnit timeUnit) Starts a LookupService based on the provided options and waits for the given timeout (in time unit) until it is discovered by the admin, which is then returned.

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, toString, wait, wait, wait

Methods inherited from interface org.openspaces.admin.DiscoverableComponent

isDiscovered

Methods inherited from interface org.openspaces.admin.AdminAware

getAdmin

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

getMachine

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

getZones

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

setDiscovered

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

setMachine

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

setTransport

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

setOperatingSystem

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.internal.zone.InternalZoneAware

addZone

Constructor Detail

DefaultGridServiceAgent

public DefaultGridServiceAgent(ServiceID serviceID,
                               com.gigaspaces.grid.gsa.GSA gsa,
                               InternalAdmin admin,
                               com.gigaspaces.grid.gsa.AgentProcessesDetails processesDetails,
                               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

getProcessesDetails

public com.gigaspaces.grid.gsa.AgentProcessesDetails getProcessesDetails()

Description copied from interface: GridServiceAgent

Returns all the processes details this agent is currently running.

Specified by:

getProcessesDetails in interface GridServiceAgent

setProcessesDetails

public void setProcessesDetails(com.gigaspaces.grid.gsa.AgentProcessesDetails processesDetails)

Specified by:

setProcessesDetails in interface InternalGridServiceAgent

getServiceID

public ServiceID getServiceID()

Specified by:

getServiceID in interface InternalGridServiceAgent

getGSA

public com.gigaspaces.grid.gsa.GSA getGSA()

Specified by:

getGSA in interface InternalGridServiceAgent

startGridService

public int startGridService(GridServiceOptions options)

Description copied from interface: GridServiceAgent

Starts a generic process of a given type.

Specified by:

startGridService in interface GridServiceAgent

killByAgentId

public void killByAgentId(int agentId)

Description copied from interface: GridServiceAgent

Kills a process based on the agent id provided to it.

Specified by:

killByAgentId in interface GridServiceAgent

startGridService

public void startGridService(GridServiceManagerOptions options)

Description copied from interface: GridServiceAgent

Starts a GridServiceManager based on the provided options.

Specified by:

startGridService in interface GridServiceAgent

logEntries

public LogEntries logEntries(LogProcessType type,
                             long pid,
                             LogEntryMatcher matcher)

Description copied from interface: GridServiceAgent

Extract the log entries matching the provided matcher for the process type and process id.

Specified by:

logEntries in interface GridServiceAgent

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

liveLogEntries

public CompoundLogEntries liveLogEntries(LogEntryMatcher matcher)

Description copied from interface: GridServiceAgent

Extracts all the log entries of all the "live" runtime components that this agent is running matching the given matcher.

Specified by:

liveLogEntries in interface GridServiceAgent

allLogEntries

public CompoundLogEntries allLogEntries(LogProcessType type,
                                        LogEntryMatcher matcher)

Description copied from interface: GridServiceAgent

Extracts all the log entries for the provided process type including both "live" runtime components and ones that are no longer running.

Specified by:

allLogEntries in interface GridServiceAgent

startGridServiceAndWait

public GridServiceManager startGridServiceAndWait(GridServiceManagerOptions options)

Description copied from interface: GridServiceAgent

Starts a GridServiceManager based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.

Specified by:

startGridServiceAndWait in interface GridServiceAgent

startGridServiceAndWait

public GridServiceManager startGridServiceAndWait(GridServiceManagerOptions options,
                                                  long timeout,
                                                  TimeUnit timeUnit)

Description copied from interface: GridServiceAgent

Starts a GridServiceManager based on the provided options and waits for the given timeout (in time unit) until it is discovered by the admin, which is then returned.

Specified by:

startGridServiceAndWait in interface GridServiceAgent

startGridService

public void startGridService(GridServiceContainerOptions options)

Description copied from interface: GridServiceAgent

Starts a GridServiceContainer based on the provided options.

Specified by:

startGridService in interface GridServiceAgent

internalStartGridService

public int internalStartGridService(GridServiceContainerOptions options)

startGridServiceAndWait

public GridServiceContainer startGridServiceAndWait(GridServiceContainerOptions options)

Description copied from interface: GridServiceAgent

Starts a GridServiceContainer based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.

Specified by:

startGridServiceAndWait in interface GridServiceAgent

startGridServiceAndWait

public GridServiceContainer startGridServiceAndWait(GridServiceContainerOptions options,
                                                    long timeout,
                                                    TimeUnit timeUnit)

Description copied from interface: GridServiceAgent

Starts a GridServiceContainer based on the provided options and waits for the given timeout (in time unit) until it is discovered by the admin, which is then returned.

Specified by:

startGridServiceAndWait in interface GridServiceAgent

startGridService

public void startGridService(LookupServiceOptions options)

Description copied from interface: GridServiceAgent

Starts a LookupService based on the provided options.

Specified by:

startGridService in interface GridServiceAgent

internalStartGridService

public int internalStartGridService(LookupServiceOptions options)

startGridServiceAndWait

public LookupService startGridServiceAndWait(LookupServiceOptions options)

Description copied from interface: GridServiceAgent

Starts a LookupService based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.

Specified by:

startGridServiceAndWait in interface GridServiceAgent

startGridServiceAndWait

public LookupService startGridServiceAndWait(LookupServiceOptions options,
                                             long timeout,
                                             TimeUnit timeUnit)

Description copied from interface: GridServiceAgent

Starts a LookupService based on the provided options and waits for the given timeout (in time unit) until it is discovered by the admin, which is then returned.

Specified by:

startGridServiceAndWait in interface GridServiceAgent

kill

public void kill(InternalAgentGridComponent agentGridComponent)

Specified by:

kill in interface InternalGridServiceAgent

restart

public void restart(InternalAgentGridComponent agentGridComponent)

Specified by:

restart in interface InternalGridServiceAgent

shutdown

public void shutdown()

Description copied from interface: GridServiceAgent

Shuts down the GSA.

Specified by:

shutdown in interface GridServiceAgent

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

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

removeAgentGridComponent

public void removeAgentGridComponent(InternalAgentGridComponent agentGridComponent)

Description copied from interface: InternalGridServiceAgent

Invoked to mark a child grid component as removed from lookup service

Specified by:

removeAgentGridComponent in interface InternalGridServiceAgent

addAgentGridComponent

public void addAgentGridComponent(InternalAgentGridComponent agentGridComponent)

Description copied from interface: InternalGridServiceAgent

Invoked to mark a child grid component as added to lookup service

Specified by:

addAgentGridComponent in interface InternalGridServiceAgent

getUnconfirmedRemovedAgentGridComponents

public InternalAgentGridComponent[] getUnconfirmedRemovedAgentGridComponents()

Specified by:

getUnconfirmedRemovedAgentGridComponents in interface InternalGridServiceAgent

Returns:

all child grid components marked as removed from lookup service, but are still managed by this agent This is a temporary condition that could happen if the grid component is experiencing GC or has other delays updating the lookup lease.

getExactZones

public ExactZonesConfig getExactZones()

Specified by:

getExactZones in interface GridServiceAgent

Returns:

the list of zones that the GSA satisfies

See Also:

ProcessingUnit#getRequiredContainerZones()}

getGridServiceContainers

public GridServiceContainers getGridServiceContainers()

Specified by:

getGridServiceContainers in interface GridServiceAgent

Returns:

Returns the GridServiceContainers started by this GridServiceAgent

getGridServiceManagers

public GridServiceManagers getGridServiceManagers()

Specified by:

getGridServiceManagers in interface GridServiceAgent

Returns:

Returns all the GridServiceManagers started by this GridServiceAgent

getLookupServices

public LookupServices getLookupServices()

Specified by:

getLookupServices in interface GridServiceAgent

Returns:

Returns all the LookupServices started by this GridServiceAgent

deleteTieredStorageSpaceData

public void deleteTieredStorageSpaceData(String spaceName)

Description copied from interface: InternalGridServiceAgent

Deletes persistent data of a given tiered storage space

Specified by:

deleteTieredStorageSpaceData in interface InternalGridServiceAgent

getReservationId

public GSAReservationId getReservationId()

Specified by:

getReservationId in interface InternalGridServiceAgent

Returns:

The identifies the request to start this grid service agent Used to correlate request to start a new agent with this agent. The agent reservation id can be set by the "com.gs.agent.reservationid" GSA system property, or by setting the GSA_RESERVATION_ID environment variable.