ProcessingUnits (GigaSpaces XAP 14.5.0 API)

All Superinterfaces:

AdminAware, Iterable<ProcessingUnit>, StatisticsMonitor

All Known Subinterfaces:

InternalProcessingUnits

All Known Implementing Classes:

DefaultProcessingUnits
```
public interface ProcessingUnits
extends Iterable<ProcessingUnit>, AdminAware, StatisticsMonitor
```
Holds one or more ProcessingUnits.

Author:

kimchy

Field Summary
- Fields inherited from interface org.openspaces.admin.StatisticsMonitor
  DEFAULT_HISTORY_SIZE, DEFAULT_MONITOR_INTERVAL

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)` Allows to add a `ProcessingUnitInstanceLifecycleEventListener`.
`void`	`addLifecycleListener(ProcessingUnitLifecycleEventListener eventListener)` Allows to add a `ProcessingUnitLifecycleEventListener`.
`BackupGridServiceManagerChangedEventManager`	`getBackupGridServiceManagerChanged()` Returns an event manager allowing to globally register for any `BackupGridServiceManagerChangedEvent`s occurring on any processing unit.
`ElasticAutoScalingFailureEventManager`	`getElasticAutoScalingFailure()`
`ElasticAutoScalingProgressChangedEventManager`	`getElasticAutoScalingProgressChanged()`
`ManagingGridServiceManagerChangedEventManager`	`getManagingGridServiceManagerChanged()` Returns an event manager allowing to globally register for any `ManagingGridServiceManagerChangedEvent`s occurring on any processing unit.
`Map<String,ProcessingUnit>`	`getNames()` Returns a map of `ProcessingUnit` keyed by their respective names.
`ProcessingUnit`	`getProcessingUnit(String name)` Returns the `ProcessingUnit` for the given processing unit name.
`ProcessingUnitAddedEventManager`	`getProcessingUnitAdded()` Returns an event manager allowing to register `ProcessingUnitAddedEventListener`s.
`ProcessingUnitInstanceAddedEventManager`	`getProcessingUnitInstanceAdded()` Returns an event manager allowing to register `ProcessingUnitInstanceAddedEventListener`s.
`ProcessingUnitInstanceMemberAliveIndicatorStatusChangedEventManager`	`getProcessingUnitInstanceMemberAliveIndicatorStatusChanged()` Returns an event manager allowing to register `ProcessingUnitInstanceMemberAliveIndicatorStatusChangedEventListener`s.
`ProcessingUnitInstanceProvisionStatusChangedEventManager`	`getProcessingUnitInstanceProvisionStatusChanged()` Returns an event manager allowing to register `ProcessingUnitInstanceProvisionStatusChangedEventListener`s.
`ProcessingUnitInstanceRemovedEventManager`	`getProcessingUnitInstanceRemoved()` Returns an event manager allowing to register `ProcessingUnitInstanceRemovedEventListener`s.
`ProcessingUnitInstanceStatisticsChangedEventManager`	`getProcessingUnitInstanceStatisticsChanged()` Returns a processing unit instance statistics change event manger allowing to register for events of `ProcessingUnitInstanceStatisticsChangedEvent`.
`ProcessingUnitRemovedEventManager`	`getProcessingUnitRemoved()` Returns an event manager allowing to register `ProcessingUnitRemovedEventListener`s.
`ProcessingUnit[]`	`getProcessingUnits()` Returns the `ProcessingUnit`s currently deployed.
`ProcessingUnitStatusChangedEventManager`	`getProcessingUnitStatusChanged()` Returns an event manager allowing to globally register for any `ProcessingUnitSpaceCorrelatedEvent`s occurring on any processing unit.
`int`	`getSize()` Returns the number of currently deployed `ProcessingUnit`s.
`boolean`	`isEmpty()` Returns `true` if there are no currently deployed processing units.
`void`	`removeLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)` Allows to remove a `ProcessingUnitInstanceLifecycleEventListener`.
`void`	`removeLifecycleListener(ProcessingUnitLifecycleEventListener eventListener)` Allows to remove a `ProcessingUnitLifecycleEventListener`.
`ProcessingUnit`	`waitFor(String processingUnitName)` Waits indefinitely till the processing unit is identified as deployed.
`ProcessingUnit`	`waitFor(String processingUnitName, long timeout, TimeUnit timeUnit)` Waits for the specified timeout (in time interval) till the processing unit is identified as deployed.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface org.openspaces.admin.AdminAware
getAdmin

Methods inherited from interface org.openspaces.admin.StatisticsMonitor
isMonitoring, setStatisticsHistorySize, setStatisticsInterval, startStatisticsMonitor, stopStatisticsMonitor

- Method Detail
  - getSize
```
int getSize()
```
    Returns the number of currently deployed ProcessingUnits.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if there are no currently deployed processing units.
  - getProcessingUnits
```
ProcessingUnit[] getProcessingUnits()
```
    Returns the ProcessingUnits currently deployed.
  - getProcessingUnit
```
ProcessingUnit getProcessingUnit(String name)
```
    Returns the ProcessingUnit for the given processing unit name.
  - getNames
```
Map<String,ProcessingUnit> getNames()
```
    Returns a map of ProcessingUnit keyed by their respective names.
  - waitFor
```
ProcessingUnit waitFor(String processingUnitName)
```
    Waits indefinitely till the processing unit is identified as deployed. Returns the ProcessingUnit.
  - waitFor
```
ProcessingUnit waitFor(String processingUnitName,
                       long timeout,
                       TimeUnit timeUnit)
```
    Waits for the specified timeout (in time interval) till the processing unit is identified as deployed. Returns the ProcessingUnit. Return null if the processing unit is not deployed within the specified timeout.
  - getProcessingUnitAdded
```
ProcessingUnitAddedEventManager getProcessingUnitAdded()
```
    Returns an event manager allowing to register ProcessingUnitAddedEventListeners.
  - getProcessingUnitRemoved
```
ProcessingUnitRemovedEventManager getProcessingUnitRemoved()
```
    Returns an event manager allowing to register ProcessingUnitRemovedEventListeners.
  - addLifecycleListener
```
void addLifecycleListener(ProcessingUnitLifecycleEventListener eventListener)
```
    Allows to add a ProcessingUnitLifecycleEventListener.
  - removeLifecycleListener
```
void removeLifecycleListener(ProcessingUnitLifecycleEventListener eventListener)
```
    Allows to remove a ProcessingUnitLifecycleEventListener.
  - getProcessingUnitInstanceAdded
```
ProcessingUnitInstanceAddedEventManager getProcessingUnitInstanceAdded()
```
    Returns an event manager allowing to register ProcessingUnitInstanceAddedEventListeners.
  - getProcessingUnitInstanceRemoved
```
ProcessingUnitInstanceRemovedEventManager getProcessingUnitInstanceRemoved()
```
    Returns an event manager allowing to register ProcessingUnitInstanceRemovedEventListeners.
  - addLifecycleListener
```
void addLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
```
    Allows to add a ProcessingUnitInstanceLifecycleEventListener.
  - removeLifecycleListener
```
void removeLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
```
    Allows to remove a ProcessingUnitInstanceLifecycleEventListener.
  - getManagingGridServiceManagerChanged
```
ManagingGridServiceManagerChangedEventManager getManagingGridServiceManagerChanged()
```
    Returns an event manager allowing to globally register for any ManagingGridServiceManagerChangedEvents occurring on any processing unit.
  - getBackupGridServiceManagerChanged
```
BackupGridServiceManagerChangedEventManager getBackupGridServiceManagerChanged()
```
    Returns an event manager allowing to globally register for any BackupGridServiceManagerChangedEvents occurring on any processing unit.
  - getProcessingUnitStatusChanged
```
ProcessingUnitStatusChangedEventManager getProcessingUnitStatusChanged()
```
    Returns an event manager allowing to globally register for any ProcessingUnitSpaceCorrelatedEvents occurring on any processing unit.
  - getProcessingUnitInstanceStatisticsChanged
```
ProcessingUnitInstanceStatisticsChangedEventManager getProcessingUnitInstanceStatisticsChanged()
```
    Returns a processing unit instance statistics change event manger allowing to register for events of ProcessingUnitInstanceStatisticsChangedEvent.
    Note, in order to receive events, the virtual machines need to be in a "statistics" monitored state.
  - getProcessingUnitInstanceProvisionStatusChanged
```
ProcessingUnitInstanceProvisionStatusChangedEventManager getProcessingUnitInstanceProvisionStatusChanged()
```
    Returns an event manager allowing to register ProcessingUnitInstanceProvisionStatusChangedEventListeners.
    
    Since:
    
    8.0.6
  - getProcessingUnitInstanceMemberAliveIndicatorStatusChanged
```
ProcessingUnitInstanceMemberAliveIndicatorStatusChangedEventManager getProcessingUnitInstanceMemberAliveIndicatorStatusChanged()
```
    Returns an event manager allowing to register ProcessingUnitInstanceMemberAliveIndicatorStatusChangedEventListeners.
    
    Since:
    
    8.0.6
  - getElasticAutoScalingProgressChanged
```
ElasticAutoScalingProgressChangedEventManager getElasticAutoScalingProgressChanged()
```
    Returns:
    
    an event manager allowing to register ElasticAutoScalingProgressChangedEventListeners
    
    Since:
    
    9.0.0
  - getElasticAutoScalingFailure
```
ElasticAutoScalingFailureEventManager getElasticAutoScalingFailure()
```
    Returns:
    
    an event manager allowing to register ElasticAutoScalingFailureEventListeners
    
    Since:
    
    9.0.0

Interface ProcessingUnits

Field Summary

Fields inherited from interface org.openspaces.admin.StatisticsMonitor

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.openspaces.admin.AdminAware

Methods inherited from interface org.openspaces.admin.StatisticsMonitor

Method Detail

getSize

isEmpty

getProcessingUnits

getProcessingUnit

getNames

waitFor

waitFor

getProcessingUnitAdded

getProcessingUnitRemoved

addLifecycleListener

removeLifecycleListener

getProcessingUnitInstanceAdded

getProcessingUnitInstanceRemoved

addLifecycleListener

removeLifecycleListener

getManagingGridServiceManagerChanged

getBackupGridServiceManagerChanged

getProcessingUnitStatusChanged

getProcessingUnitInstanceStatisticsChanged

getProcessingUnitInstanceProvisionStatusChanged

getProcessingUnitInstanceMemberAliveIndicatorStatusChanged

getElasticAutoScalingProgressChanged

getElasticAutoScalingFailure