GigaSpaces XAP 9.7.2 API

org.openspaces.admin.gsc
Interface GridServiceContainer

All Superinterfaces:
AdminAware, AgentGridComponent, DiscoverableComponent, DumpProvider, GridComponent, Iterable<ProcessingUnitInstance>, LogProviderGridComponent, MachineAware, OperatingSystemAware, TransportAware, VirtualMachineAware, ZoneAware

public interface GridServiceContainer
extends AgentGridComponent, Iterable<ProcessingUnitInstance>, LogProviderGridComponent, DumpProvider

A Grid Service Container is a container for ProcessingUnitInstances allocated to it through the GridServiceManager that manages it.

Author:
kimchy

Method Summary
 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.
 ExactZonesConfig getExactZones()
           
 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.
 void removeProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
          Removes a processing unit lifecycle listener to the container.
 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 interface org.openspaces.admin.AgentGridComponent
getAgentId, getGridServiceAgent, kill, restart
 
Methods inherited from interface java.lang.Iterable
iterator
 
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

waitFor

boolean waitFor(int numberOfProcessingUnitInstances)
Waits indefinitely for the given number of processing unit instances to run within the container.


waitFor

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. Returns true if the number was reached, false if the timeout expired.


waitFor

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.


waitFor

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. Returns true if the number was reached, false if the timeout expired.


getProcessingUnitInstances

ProcessingUnitInstance[] getProcessingUnitInstances()
Returns the processing unit instances that are currently deployed within the grid service container.


getProcessingUnitInstances

ProcessingUnitInstance[] getProcessingUnitInstances(String processingUnitName)
Returns the processing unit instances of the specified name that are currently deployed within the grid service container.


getProcessingUnitInstanceByUID

ProcessingUnitInstance getProcessingUnitInstanceByUID(String processingUnitInstanceUid)
Returns the processing unit instance that are currently deployed within the grid service container according to its uid.

Since:
8.0

contains

boolean contains(ProcessingUnitInstance processingUnitInstance)
Returns true if the GSC contains the provided processing unit instance.


getProcessingUnitInstanceAdded

ProcessingUnitInstanceAddedEventManager getProcessingUnitInstanceAdded()
Returns an event manager allowing to register for processing unit instance additions to the container.


getProcessingUnitInstanceRemoved

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


addProcessingUnitInstanceLifecycleEventListener

void addProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
Adds a processing unit lifecycle listener to the container.


removeProcessingUnitInstanceLifecycleEventListener

void removeProcessingUnitInstanceLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
Removes a processing unit lifecycle listener to the container.


getExactZones

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

GigaSpaces XAP 9.7.2 API

Copyright © GigaSpaces.