GigaSpaces XAP 10.0.1 API

org.openspaces.admin.gsa
Interface GridServiceAgent

All Superinterfaces:
AdminAware, DiscoverableComponent, DumpProvider, GridComponent, LogProviderGridComponent, MachineAware, OperatingSystemAware, TransportAware, VirtualMachineAware, ZoneAware

public interface GridServiceAgent
extends GridComponent, LogProviderGridComponent, DumpProvider

A Grid Service Agent is a process manager allowing to start and stop (on the operating system process level) processes (such as GridServiceManager, GridServiceContainer and LookupService. It can also globally manage certain process type (a process type is a GSM for example), which means that when running X number of Grid Service Agents, at least N processes will run between them.

Author:
kimchy

Method Summary
 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.
 ExactZonesConfig getExactZones()
           
 com.gigaspaces.grid.gsa.AgentProcessesDetails getProcessesDetails()
          Returns all the processes details this agent is currently running.
 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(LogProcessType type, long pid, LogEntryMatcher matcher)
          Extract the log entries matching the provided matcher for the process type and process id.
 void shutdown()
          Shuts down the GSA.
 void startGridService(ElasticServiceManagerOptions options)
          Starts a ElasticServiceManager based on the provided options.
 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.
 ElasticServiceManager startGridServiceAndWait(ElasticServiceManagerOptions options)
          Starts a ElasticServiceManager based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.
 ElasticServiceManager startGridServiceAndWait(ElasticServiceManagerOptions options, long timeout, TimeUnit timeUnit)
          Starts a ElasticServiceManager 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.
 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 interface org.openspaces.admin.LogProviderGridComponent
logEntries, logEntriesDirect
 
Methods inherited from interface org.openspaces.admin.GridComponent
getUid
 
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.transport.TransportAware
getTransport
 
Methods inherited from interface org.openspaces.admin.os.OperatingSystemAware
getOperatingSystem
 
Methods inherited from interface org.openspaces.admin.vm.VirtualMachineAware
getVirtualMachine
 
Methods inherited from interface org.openspaces.admin.zone.ZoneAware
getZones
 
Methods inherited from interface org.openspaces.admin.dump.DumpProvider
generateDump, generateDump
 

Method Detail

getProcessesDetails

com.gigaspaces.grid.gsa.AgentProcessesDetails getProcessesDetails()
Returns all the processes details this agent is currently running.


startGridService

void startGridService(GridServiceManagerOptions options)
Starts a GridServiceManager based on the provided options.


startGridServiceAndWait

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.


startGridServiceAndWait

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.


startGridService

void startGridService(ElasticServiceManagerOptions options)
Starts a ElasticServiceManager based on the provided options.


startGridServiceAndWait

ElasticServiceManager startGridServiceAndWait(ElasticServiceManagerOptions options)
Starts a ElasticServiceManager based on the provided options and waits indefinitely until it is discovered by the admin, which is then returned.


startGridServiceAndWait

ElasticServiceManager startGridServiceAndWait(ElasticServiceManagerOptions options,
                                              long timeout,
                                              TimeUnit timeUnit)
Starts a ElasticServiceManager 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.


startGridService

void startGridService(GridServiceContainerOptions options)
Starts a GridServiceContainer based on the provided options.


startGridServiceAndWait

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.


startGridServiceAndWait

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.


startGridService

void startGridService(LookupServiceOptions options)
Starts a LookupService based on the provided options.


startGridServiceAndWait

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.


startGridServiceAndWait

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.


startGridService

int startGridService(GridServiceOptions options)
Starts a generic process of a given type.


killByAgentId

void killByAgentId(int agentId)
Kills a process based on the agent id provided to it.


logEntries

LogEntries logEntries(LogProcessType type,
                      long pid,
                      LogEntryMatcher matcher)
Extract the log entries matching the provided matcher for the process type and process id.


liveLogEntries

CompoundLogEntries liveLogEntries(LogEntryMatcher matcher)
Extracts all the log entries of all the "live" runtime components that this agent is running matching the given matcher.


allLogEntries

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.


shutdown

void shutdown()
Shuts down the GSA.

Since:
7.1.2

getExactZones

ExactZonesConfig getExactZones()
Returns:
the list of zones that the GSA satisfies
Since:
9.1.0
See Also:
ProcessingUnit#getRequiredAgentZones()}

GigaSpaces XAP 10.0.1 API

Copyright © GigaSpaces.