DefaultProcessingUnit (GigaSpaces 16.4.0 API)

java.lang.Object
- org.openspaces.admin.internal.pu.DefaultProcessingUnit

All Implemented Interfaces:

Iterable<ProcessingUnitInstance>, AdminAware, InternalApplicationAware, InternalProcessingUnit, InternalProcessingUnitInstancesAware, ProcessingUnit, StatisticsMonitor
```
public class DefaultProcessingUnit
extends Object
implements InternalProcessingUnit
```
Author:

kimchy

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

Constructor Summary

Constructors
Constructor and Description
`DefaultProcessingUnit(InternalAdmin admin, InternalProcessingUnits processingUnits, com.gigaspaces.grid.gsm.PUDetails details, BeanLevelProperties beanLevelProperties)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBackupGridServiceManager(GridServiceManager backupGridServiceManager)`
`void`	`addEmbeddedSpace(Space space)`
`void`	`addLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)` Adds a `ProcessingUnitInstanceLifecycleEventListener`.
`void`	`addManagingGridServiceManager(GridServiceManager gridServiceManager)`
`void`	`addProcessingUnitInstance(ProcessingUnitInstance processingUnitInstance)`
`void`	`addStatisticsCalculation(ProcessingUnitStatisticsId statisticsId)` Adds the specified statistics calculation
`void`	`cancelScaleOut()`
`boolean`	`canDecrementInstance()`
`boolean`	`canIncrementInstance()`
`void`	`decrementInstance()` Removes a randomly chosen instance from the processing unit, and decrements the number of instances.
`boolean`	`decrementPlannedInstances()` Decrements a planned instance if the number of planned instances is less then the actual instances to maintain.
`boolean`	`equals(Object o)`
`Admin`	`getAdmin()` Returns the `Admin` associated with this element.
`Application`	`getApplication()`
`String`	`getApplicationDependencies()` This method is used by the webui.
`String`	`getApplicationName()`
`String`	`getArchiveName()`
`GridServiceManager`	`getBackupGridServiceManager(String gridServiceManagerUID)`
`BackupGridServiceManagerChangedEventManager`	`getBackupGridServiceManagerChanged()`
`GridServiceManager[]`	`getBackupGridServiceManagers()`
`BeanLevelProperties`	`getBeanLevelProperties()`
`String`	`getClusterSchema()`
`ClusterTopology`	`getClusterTopology()`
`ProcessingUnitDependencies<ProcessingUnitDependency>`	`getDependencies()`
`GridServiceContainer[]`	`getGridServiceContainers()`
`ExactZonesConfig`	`getHostingGridServiceAgentZones(ProcessingUnitInstance processingUnitInstance)` return the exact zones of the agent that belongs to processing unit instance
`ProcessingUnitInstance[]`	`getInstances()`
`GridServiceManager`	`getManagingGridServiceManager()`
`ManagingGridServiceManagerChangedEventManager`	`getManagingGridServiceManagerChanged()`
`int`	`getMaxInstancesPerMachine()`
`int`	`getMaxInstancesPerVM()`
`Map<String,Integer>`	`getMaxInstancesPerZone()`
`String`	`getName()`
`int`	`getNumberOfBackups()`
`int`	`getNumberOfInstances()` Deprecated.
`ProcessingUnitPartition`	`getPartition(int partitionId)`
`ProcessingUnitPartition[]`	`getPartitions()`
`int`	`getPlannedNumberOfInstances()` For stateful processing unit (primary+backup Space) will return the current planned number of instances (including backups).
`int`	`getPlannedNumberOfPartitions()` For stateful processing unit (primary+backup Space) will return the planned partition count - i.e.
`Set<String>`	`getPrimaryZones()`
`ProcessingUnitInstance`	`getProcessingUnitInstance(int instanceId, int backupId)`
`ProcessingUnitInstanceAddedEventManager`	`getProcessingUnitInstanceAdded()`
`ProcessingUnitInstance`	`getProcessingUnitInstanceByUid(String uid)` returns the processing unit instance based on its uid (see `GridComponent.getUid()`)
`ProcessingUnitInstanceMemberAliveIndicatorStatusChangedEventManager`	`getProcessingUnitInstanceMemberAliveIndicatorStatusChanged()`
`ProcessingUnitInstanceProvisionStatusChangedEventManager`	`getProcessingUnitInstanceProvisionStatusChanged()`
`ProcessingUnitInstanceRemovedEventManager`	`getProcessingUnitInstanceRemoved()`
`ProcessingUnitInstance[]`	`getProcessingUnitInstances()`
`ProcessingUnitInstanceStatisticsChangedEventManager`	`getProcessingUnitInstanceStatisticsChanged()`
`ProcessingUnits`	`getProcessingUnits()`
`ProcessingUnitStatusChangedEventManager`	`getProcessingUnitStatusChanged()`
`Map<String,InternalProvisionStatusHolder>`	`getProvisionStatusPerInstance()`
`QuiesceDetails`	`getQuiesceDetails()`
`RequiredZonesConfig`	`getRequiredContainerZones()`
`String[]`	`getRequiredZones()`
`String`	`getSimpleName()` In the case of application name prefix just processing unit name will be returned.
`Space`	`getSpace()`
`ProcessingUnitSpaceCorrelatedEventManager`	`getSpaceCorrelated()`
`Space[]`	`getSpaces()`
`ProcessingUnitStatistics`	`getStatistics()`
`Set<ProcessingUnitStatisticsId>`	`getStatisticsCalculations()`
`DeploymentStatus`	`getStatus()`
`int`	`getTotalNumberOfInstances()` Deprecated.
`ProcessingUnitType`	`getType()`
`int`	`hashCode()`
`boolean`	`hasSpace()` Returns true if there are any embedded spaces, false otherwise.
`void`	`incrementInstance()` Increments the number of processing unit instances.
`boolean`	`isBackupGsmInSync()`
`boolean`	`isManaged()`
`boolean`	`isMonitoring()` Returns `true` if statistics are now being monitored.
`boolean`	`isRequiresIsolation()`
`boolean`	`isStandaloneProcessingUnit()`
`boolean`	`isStub()`
`Iterator<ProcessingUnitInstance>`	`iterator()`
`SharedLock`	`lock()`
`SharedLock`	`lock(long timeout, TimeUnit timeunit)`
`void`	`processProvisionEvent(org.jini.rio.monitor.ProvisionLifeCycleEvent provisionLifeCycleEvent)`
`QuiesceResult`	`quiesce(QuiesceRequest request)` Requests a quiesce request from the GSM.
`QuiesceResult`	`quiesceUnsafe(QuiesceRequest request)` Performs quiesce - should always be called after acquiring pu lock
`void`	`removeBackupGridServiceManager(String gsmUID)`
`boolean`	`removeEmbeddedSpace(Space space)`
`void`	`removeLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)` Removes a `ProcessingUnitInstanceLifecycleEventListener`.
`void`	`removeProcessingUnitInstance(String uid)`
`void`	`removeStatisticsCalculation(ProcessingUnitStatisticsId statisticsId)` Removes the specified statistics calculation
`void`	`scaleHorizontal(int target, String memory, String cpu, String requestId)`
`void`	`scaleVertical(String memory, String cpu, Long timeout, PuScaleVStatusChangedEventListener listener)`
`void`	`setApplication(Application application)`
`void`	`setBackupGsmInSync(boolean backupGsmIsInSync)`
`void`	`setLogLevel(String loggerName, String level)`
`void`	`setManagingGridServiceManager(GridServiceManager gridServiceManager)`
`void`	`setNumberOfBackups(int numberOfBackups)`
`void`	`setNumberOfInstances(int numberOfInstances)`
`void`	`setStatisticsHistorySize(int historySize)` Sets the history size of number of statistics stored.
`void`	`setStatisticsInterval(long interval, TimeUnit timeUnit)` Sets the statistics interval, automatically updating the monitoring scheduled tasks if monitoring is enabled.
`boolean`	`setStatus(int statusCode)`
`void`	`setStub(boolean stub)`
`void`	`startStatisticsMonitor()` Starts the statistics monitor, starting a scheduled monitor that polls for statistics.
`void`	`stopStatisticsMonitor()` Stops the statistics monitor.
`void`	`undeploy()`
`void`	`undeployAndWait()` Un-deploys the processing unit and waits until all instances have been undeployed.
`boolean`	`undeployAndWait(long timeout, TimeUnit timeUnit)` Undeploy the processing unit and wait until all instances have been undeployed.
`CompletableFuture<?>`	`undeployAsync()`
`CompletableFuture<?>`	`undeployAsync(UndeployOptions options)`
`void`	`unquiesce(QuiesceRequest request)` Requests a unquiesce request from the GSM.
`void`	`updateStub(ProcessingUnitInstance processingUnitInstance)`
`boolean`	`waitFor(int numberOfProcessingUnitInstances)` Waits till at least the provided number of Processing Unit Instances are up.
`boolean`	`waitFor(int numberOfProcessingUnitInstances, long timeout, TimeUnit timeUnit)` Waits till at least the provided number of Processing Unit Instances are up for the specified timeout.
`boolean`	`waitFor(QuiesceState desiredState)` Same as `ProcessingUnit.waitFor(com.gigaspaces.admin.quiesce.QuiesceState, long, java.util.concurrent.TimeUnit)` but with endless timeout
`boolean`	`waitFor(QuiesceState desiredState, long timeout, TimeUnit timeUnit)`
`GridServiceManager`	`waitForManaged()` Waits till there is a managing `GridServiceManager` for the processing unit.
`GridServiceManager`	`waitForManaged(long timeout, TimeUnit timeUnit)` Waits till there is a managing `GridServiceManager` for the processing unit for the specified timeout.
`Space`	`waitForSpace()` Waits till an embedded Space is correlated with the processing unit.
`Space`	`waitForSpace(long timeout, TimeUnit timeUnit)` Waits till an embedded Space is correlated with the processing unit for the specified timeout.

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

- Constructor Detail
  - DefaultProcessingUnit
```
public DefaultProcessingUnit(InternalAdmin admin,
                             InternalProcessingUnits processingUnits,
                             com.gigaspaces.grid.gsm.PUDetails details,
                             BeanLevelProperties beanLevelProperties)
```
- Method Detail
  - getProcessingUnits
```
public ProcessingUnits getProcessingUnits()
```
    Specified by:
    
    getProcessingUnits in interface ProcessingUnit
    
    Returns:
    
    Returns the handle to all the different processing units.
  - getAdmin
```
public Admin getAdmin()
```
    Description copied from interface: AdminAware
    
    Returns the Admin associated with this element.
    
    Specified by:
    
    getAdmin in interface AdminAware
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface ProcessingUnit
    
    Returns:
    
    Returns the name of the processing unit.
  - getBeanLevelProperties
```
public BeanLevelProperties getBeanLevelProperties()
```
    Specified by:
    
    getBeanLevelProperties in interface ProcessingUnit
    
    Returns:
    
    Return the deploy time properties of the processing unit.
  - getType
```
public ProcessingUnitType getType()
```
    Specified by:
    
    getType in interface ProcessingUnit
    
    Returns:
    
    Returns the type of processing unit: stateless, stateful, mirror, web.
  - getManagingGridServiceManagerChanged
```
public ManagingGridServiceManagerChangedEventManager getManagingGridServiceManagerChanged()
```
    Specified by:
    
    getManagingGridServiceManagerChanged in interface ProcessingUnit
    
    Returns:
    
    Returns an event manger allowing to listen for ManagingGridServiceManagerChangedEvents.
  - setLogLevel
```
public void setLogLevel(String loggerName,
                        String level)
                 throws AdminException
```
    Specified by:
    
    setLogLevel in interface ProcessingUnit
    
    Throws:
    
    AdminException
  - getBackupGridServiceManagerChanged
```
public BackupGridServiceManagerChangedEventManager getBackupGridServiceManagerChanged()
```
    Specified by:
    
    getBackupGridServiceManagerChanged in interface ProcessingUnit
    
    Returns:
    
    Returns an event manager allowing to listen for BackupGridServiceManagerChangedEvents.
  - hasSpace
```
public boolean hasSpace()
```
    Description copied from interface: ProcessingUnit
    
    Returns true if there are any embedded spaces, false otherwise.
    
    Specified by:
    
    hasSpace in interface ProcessingUnit
  - getSpace
```
public Space getSpace()
```
    Specified by:
    
    getSpace in interface ProcessingUnit
    
    Returns:
    
    Returns the (first) embedded space within a processing unit. Returns null if no embedded space is defined within the processing unit or if no processing unit instance has been added to the processing unit.
  - getSpaces
```
public Space[] getSpaces()
```
    Specified by:
    
    getSpaces in interface ProcessingUnit
    
    Returns:
    
    Returns all the embedded spaces within a processing unit. Returns an empty array if there are no embedded spaces defined within the processing unit, or none has been associated with the processing unit yet.
  - addEmbeddedSpace
```
public void addEmbeddedSpace(Space space)
```
    Specified by:
    
    addEmbeddedSpace in interface InternalProcessingUnit
  - removeEmbeddedSpace
```
public boolean removeEmbeddedSpace(Space space)
```
    Specified by:
    
    removeEmbeddedSpace in interface InternalProcessingUnit
  - getProcessingUnitStatusChanged
```
public ProcessingUnitStatusChangedEventManager getProcessingUnitStatusChanged()
```
    Specified by:
    
    getProcessingUnitStatusChanged in interface ProcessingUnit
    
    Returns:
    
    Returns an event manager allowing to listen for ProcessingUnitStatusChangedEvents.
  - getProcessingUnitInstanceAdded
```
public ProcessingUnitInstanceAddedEventManager getProcessingUnitInstanceAdded()
```
    Specified by:
    
    getProcessingUnitInstanceAdded in interface ProcessingUnit
    
    Returns:
    
    Returns an event manager allowing to register ProcessingUnitInstanceAddedEventListeners.
  - getProcessingUnitInstanceRemoved
```
public ProcessingUnitInstanceRemovedEventManager getProcessingUnitInstanceRemoved()
```
    Specified by:
    
    getProcessingUnitInstanceRemoved in interface ProcessingUnit
    
    Returns:
    
    Returns an event manager allowing to register ProcessingUnitInstanceRemovedEventListeners.
  - getSpaceCorrelated
```
public ProcessingUnitSpaceCorrelatedEventManager getSpaceCorrelated()
```
    Specified by:
    
    getSpaceCorrelated in interface ProcessingUnit
    
    Returns:
    
    Returns an event manager allowing to listen for ProcessingUnitSpaceCorrelatedEvents.
  - getProcessingUnitInstance
```
public ProcessingUnitInstance getProcessingUnitInstance(int instanceId,
                                                        int backupId)
```
    Specified by:
    
    getProcessingUnitInstance in interface ProcessingUnit
    
    Returns:
    
    Returns a processing unit instance based on the specified instance id and backup id
  - addLifecycleListener
```
public void addLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
```
    Description copied from interface: ProcessingUnit
    
    Adds a ProcessingUnitInstanceLifecycleEventListener.
    
    Specified by:
    
    addLifecycleListener in interface ProcessingUnit
  - removeLifecycleListener
```
public void removeLifecycleListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
```
    Description copied from interface: ProcessingUnit
    
    Removes a ProcessingUnitInstanceLifecycleEventListener.
    
    Specified by:
    
    removeLifecycleListener in interface ProcessingUnit
  - getNumberOfInstances
```
@Deprecated
public int getNumberOfInstances()
```
    Deprecated.
    
    Specified by:
    
    getNumberOfInstances in interface ProcessingUnit
    
    Returns:
    
    Returns the number of required instances as defined in the processing unit's SLA. If there are backups, it will only return the number of primary instances and not the number of backup.
  - getPlannedNumberOfPartitions
```
public int getPlannedNumberOfPartitions()
```
    Description copied from interface: ProcessingUnit
    
    For stateful processing unit (primary+backup Space) will return the planned partition count - i.e. the number of planned primary instances (excluding backups). If called for a stateless processing unit, will return the planned number of instances.
    Note that this method does not count the number of running instances, but rather the number of planned primary instances for the processing unit. To count the number of currently discovered running processing unit partitions use the method ProcessingUnit.getPartitions().
    
    Specified by:
    
    getPlannedNumberOfPartitions in interface ProcessingUnit
    
    Returns:
    
    Returns the number of planned primary instances excluding backup instances.
  - getPlannedNumberOfInstances
```
public int getPlannedNumberOfInstances()
```
    Description copied from interface: ProcessingUnit
    
    For stateful processing unit (primary+backup Space) will return the current planned number of instances (including backups). For stateless processing unit will return the number of current planned instances. The plan denoted by the initial SLA may change due to increments/decrements performed manually.
    Note that this method does not count the number of running instances, but rather the number of planned number of instances for the processing unit. To count the number of currently discovered running processing unit instances use the method ProcessingUnit.getInstances().
    
    Specified by:
    
    getPlannedNumberOfInstances in interface ProcessingUnit
    
    Returns:
    
    Returns the number of required instances as defined in the processing unit's current SLA.
  - setNumberOfInstances
```
public void setNumberOfInstances(int numberOfInstances)
```
    Specified by:
    
    setNumberOfInstances in interface InternalProcessingUnit
  - getNumberOfBackups
```
public int getNumberOfBackups()
```
    Specified by:
    
    getNumberOfBackups in interface ProcessingUnit
    
    Returns:
    
    Returns the number of backups (if the topology is a backup one) per instance, as defined in the processing unit's SLA. Note that this method does not return he number of running backup instances, but rather the number of planned backup instances per primary as defined by the initial SLA.
  - setNumberOfBackups
```
public void setNumberOfBackups(int numberOfBackups)
```
    Specified by:
    
    setNumberOfBackups in interface InternalProcessingUnit
  - getTotalNumberOfInstances
```
@Deprecated
public int getTotalNumberOfInstances()
```
    Deprecated.
    
    Specified by:
    
    getTotalNumberOfInstances in interface ProcessingUnit
    
    Returns:
    
    Returns the total required number of instances as defined in the processing SLA. If there are no backups, will returnProcessingUnit.getNumberOfInstances(). If there are backups, will return ProcessingUnit.getNumberOfInstances() * (ProcessingUnit.getNumberOfBackups() + 1)
  - getMaxInstancesPerVM
```
public int getMaxInstancesPerVM()
```
    Specified by:
    
    getMaxInstancesPerVM in interface ProcessingUnit
    
    Returns:
    
    Returns the number of instances of this processing unit that can run within a VM.
    In case of a partitioned with backup topology, it applies on a per partition level (meaning that a primary and backup will not run on the same VM).
    In case of a non backup based topology, it applies on the number of instances of the whole processing unit that can run on the same VM).
  - isRequiresIsolation
```
public boolean isRequiresIsolation()
```
    Specified by:
    
    isRequiresIsolation in interface ProcessingUnit
    
    Returns:
    
    true if isolation is required per virtual machine. No processing unit instances can run on the same virtual machine. Default false.
  - getMaxInstancesPerMachine
```
public int getMaxInstancesPerMachine()
```
    Specified by:
    
    getMaxInstancesPerMachine in interface ProcessingUnit
    
    Returns:
    
    Returns the number of instances of this processing unit that can run within a Machine.
    In case of a partitioned with backup topology, it applies on a per partition level (meaning that a primary and backup will not run on the same Machine).
    In case of a non backup based topology, it applies on the number of instances of the whole processing unit that can run on the same Machine).
  - getClusterSchema
```
public String getClusterSchema()
```
    Specified by:
    
    getClusterSchema in interface InternalProcessingUnit
  - getMaxInstancesPerZone
```
public Map<String,Integer> getMaxInstancesPerZone()
```
    Specified by:
    
    getMaxInstancesPerZone in interface ProcessingUnit
    
    Returns:
    
    Returns a map containing the zone name and the maximum number of instances for that zone.
  - getRequiredZones
```
public String[] getRequiredZones()
```
    Specified by:
    
    getRequiredZones in interface ProcessingUnit
    
    Returns:
    
    Returns the list of zones this processing units are required to run on. If there is more than one zone, the processing unit can run on either of the zones.
  - getPrimaryZones
```
public Set<String> getPrimaryZones()
```
    Specified by:
    
    getPrimaryZones in interface ProcessingUnit
    
    Returns:
    
    Returns the preferred zones for primary instances.
  - getStatus
```
public DeploymentStatus getStatus()
```
    Specified by:
    
    getStatus in interface ProcessingUnit
    
    Returns:
    
    Returns the deployment status of the processing unit.
  - waitFor
```
public boolean waitFor(int numberOfProcessingUnitInstances)
```
    Description copied from interface: ProcessingUnit
    
    Waits till at least the provided number of Processing Unit Instances are up.
    
    Specified by:
    
    waitFor in interface ProcessingUnit
    
    Returns:
    
    true if discovered the required number of instances within the default timeout and false if the waiting time elapsed before the discovery took place
  - waitFor
```
public boolean waitFor(int numberOfProcessingUnitInstances,
                       long timeout,
                       TimeUnit timeUnit)
```
    Description copied from interface: ProcessingUnit
    
    Waits till at least the provided number of Processing Unit Instances are up for the specified timeout.
    
    Specified by:
    
    waitFor in interface ProcessingUnit
    
    Returns:
    
    true if discovered the required number of instances within the specified timeout and false if the waiting time elapsed before the discovery took place
  - waitForSpace
```
public Space waitForSpace()
```
    Description copied from interface: ProcessingUnit
    
    Waits till an embedded Space is correlated with the processing unit.
    
    Specified by:
    
    waitForSpace in interface ProcessingUnit
    
    Returns:
    
    Returns the embedded Space within a processing unit if the Space was correlated within the default timeout; Otherwise null if the waiting time elapsed before correlation took place.
  - waitForSpace
```
public Space waitForSpace(long timeout,
                          TimeUnit timeUnit)
```
    Description copied from interface: ProcessingUnit
    
    Waits till an embedded Space is correlated with the processing unit for the specified timeout.
    
    Specified by:
    
    waitForSpace in interface ProcessingUnit
    
    Returns:
    
    Returns the embedded Space within a processing unit if the Space was correlated within the specified timeout; Otherwise null if the waiting time elapsed before correlation took place.
  - waitForManaged
```
public GridServiceManager waitForManaged()
```
    Description copied from interface: ProcessingUnit
    
    Waits till there is a managing GridServiceManager for the processing unit.
    
    Specified by:
    
    waitForManaged in interface ProcessingUnit
    
    Returns:
    
    Returns the managing (primary) GSM for the processing unit if GSM was discovered within the default timeout; Otherwise null if the waiting time elapsed before discovery took place.
  - waitForManaged
```
public GridServiceManager waitForManaged(long timeout,
                                         TimeUnit timeUnit)
```
    Description copied from interface: ProcessingUnit
    
    Waits till there is a managing GridServiceManager for the processing unit for the specified timeout.
    
    Specified by:
    
    waitForManaged in interface ProcessingUnit
    
    Returns:
    
    Returns the managing (primary) GSM for the processing unit if GSM was discovered within the specified timeout; Otherwise null if the waiting time elapsed before discovery took place.
  - canIncrementInstance
```
public boolean canIncrementInstance()
```
    Specified by:
    
    canIncrementInstance in interface ProcessingUnit
    
    Returns:
    
    Returns true if this processing unit allows to increment instances on it.
  - canDecrementInstance
```
public boolean canDecrementInstance()
```
    Specified by:
    
    canDecrementInstance in interface ProcessingUnit
    
    Returns:
    
    Returns true if this processing unit allows to decrement instances on it.
  - incrementInstance
```
public void incrementInstance()
```
    Description copied from interface: ProcessingUnit
    
    Increments the number of processing unit instances. Does not apply for partitioned nor replicated topologies.
    
    Specified by:
    
    incrementInstance in interface ProcessingUnit
  - decrementInstance
```
public void decrementInstance()
```
    Description copied from interface: ProcessingUnit
    
    Removes a randomly chosen instance from the processing unit, and decrements the number of instances. For finer control use ProcessingUnitInstance.decrement() instead. Does not apply for partitioned nor replicated topologies.
    
    Specified by:
    
    decrementInstance in interface ProcessingUnit
  - getManagingGridServiceManager
```
public GridServiceManager getManagingGridServiceManager()
```
    Specified by:
    
    getManagingGridServiceManager in interface ProcessingUnit
    
    Returns:
    
    Returns the managing (primary) GSM for the processing unit.
  - getBackupGridServiceManagers
```
public GridServiceManager[] getBackupGridServiceManagers()
```
    Specified by:
    
    getBackupGridServiceManagers in interface ProcessingUnit
    
    Returns:
    
    Returns the backup GSMs for the processing unit.
  - isManaged
```
public boolean isManaged()
```
    Specified by:
    
    isManaged in interface ProcessingUnit
    
    Returns:
    
    Returns true if there is a managing GSM for it.
  - getBackupGridServiceManager
```
public GridServiceManager getBackupGridServiceManager(String gridServiceManagerUID)
```
    Specified by:
    
    getBackupGridServiceManager in interface ProcessingUnit
    
    Returns:
    
    Returns the backup GSM matching the provided UID.
  - undeployAsync
```
public CompletableFuture<?> undeployAsync()
```
    Specified by:
    
    undeployAsync in interface ProcessingUnit
    
    Returns:
    
    A future which can be used to track completion
  - undeployAsync
```
public CompletableFuture<?> undeployAsync(UndeployOptions options)
```
    Specified by:
    
    undeployAsync in interface ProcessingUnit
    
    Parameters:
    
    options - determine the wanted drain behaviour before undeploy
    
    Returns:
    
    A future which can be used to track completion
    
    See Also:
    
    UndeployOptions
  - undeployAndWait
```
public boolean undeployAndWait(long timeout,
                               TimeUnit timeUnit)
```
    Description copied from interface: ProcessingUnit
    
    Undeploy the processing unit and wait until all instances have been undeployed. In case of an Elastic processing unit, it waits until all containers have been removed.
    The undeployment process will wait for the given timeout and return when all processing units have undeployed or timeout expired.
    
    Specified by:
    
    undeployAndWait in interface ProcessingUnit
    
    Returns:
    
    True if un-deploy completed successfully within the specified timeout. False if undeploy is still in progress.
    
    See Also:
    
    ProcessingUnit.undeployAsync(), ProcessingUnit.undeployAndWait(), ProcessingUnit.undeploy()
  - undeployAndWait
```
public void undeployAndWait()
```
    Description copied from interface: ProcessingUnit
    
    Un-deploys the processing unit and waits until all instances have been undeployed. In case of an Elastic processing unit, also waits for containers to shutdown.
    The undeployment process will wait indefinitely and return when all processing units have undeployed.
    
    Specified by:
    
    undeployAndWait in interface ProcessingUnit
    
    See Also:
    
    ProcessingUnit.undeployAsync(), ProcessingUnit.undeployAndWait(long, TimeUnit), ProcessingUnit.undeploy()
  - undeploy
```
public void undeploy()
```
    Specified by:
    
    undeploy in interface ProcessingUnit
    
    See Also:
    
    (), ProcessingUnit.undeployAndWait(), ProcessingUnit.undeployAndWait(long, TimeUnit)
  - setManagingGridServiceManager
```
public void setManagingGridServiceManager(GridServiceManager gridServiceManager)
```
    Specified by:
    
    setManagingGridServiceManager in interface InternalProcessingUnit
  - addManagingGridServiceManager
```
public void addManagingGridServiceManager(GridServiceManager gridServiceManager)
```
    Specified by:
    
    addManagingGridServiceManager in interface InternalProcessingUnit
  - addBackupGridServiceManager
```
public void addBackupGridServiceManager(GridServiceManager backupGridServiceManager)
```
    Specified by:
    
    addBackupGridServiceManager in interface InternalProcessingUnit
  - removeBackupGridServiceManager
```
public void removeBackupGridServiceManager(String gsmUID)
```
    Specified by:
    
    removeBackupGridServiceManager in interface InternalProcessingUnit
  - setStatus
```
public boolean setStatus(int statusCode)
```
    Specified by:
    
    setStatus in interface InternalProcessingUnit
  - iterator
```
public Iterator<ProcessingUnitInstance> iterator()
```
    Specified by:
    
    iterator in interface Iterable<ProcessingUnitInstance>
  - getInstances
```
public ProcessingUnitInstance[] getInstances()
```
    Specified by:
    
    getInstances in interface ProcessingUnit
    
    Returns:
    
    Returns the processing unit instances currently discovered.
  - getProcessingUnitInstances
```
public ProcessingUnitInstance[] getProcessingUnitInstances()
```
    Specified by:
    
    getProcessingUnitInstances in interface InternalProcessingUnitInstancesAware
  - getPartitions
```
public ProcessingUnitPartition[] getPartitions()
```
    Specified by:
    
    getPartitions in interface ProcessingUnit
    
    Returns:
    
    Returns the processing unit partitions of this processing unit.
  - getPartition
```
public ProcessingUnitPartition getPartition(int partitionId)
```
    Specified by:
    
    getPartition in interface ProcessingUnit
    
    Returns:
    
    Returns a processing unit partition based on the specified partition id.
  - addProcessingUnitInstance
```
public void addProcessingUnitInstance(ProcessingUnitInstance processingUnitInstance)
```
    Specified by:
    
    addProcessingUnitInstance in interface InternalProcessingUnit
  - removeProcessingUnitInstance
```
public void removeProcessingUnitInstance(String uid)
```
    Specified by:
    
    removeProcessingUnitInstance in interface InternalProcessingUnit
  - getProcessingUnitInstanceStatisticsChanged
```
public ProcessingUnitInstanceStatisticsChangedEventManager getProcessingUnitInstanceStatisticsChanged()
```
    Specified by:
    
    getProcessingUnitInstanceStatisticsChanged in interface ProcessingUnit
    
    Returns:
    
    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.
  - setStatisticsInterval
```
public void setStatisticsInterval(long interval,
                                  TimeUnit timeUnit)
```
    Description copied from interface: StatisticsMonitor
    
    Sets the statistics interval, automatically updating the monitoring scheduled tasks if monitoring is enabled.
    
    Specified by:
    
    setStatisticsInterval in interface StatisticsMonitor
  - setStatisticsHistorySize
```
public void setStatisticsHistorySize(int historySize)
```
    Description copied from interface: StatisticsMonitor
    
    Sets the history size of number of statistics stored.
    
    Specified by:
    
    setStatisticsHistorySize in interface StatisticsMonitor
  - startStatisticsMonitor
```
public void startStatisticsMonitor()
```
    Description copied from interface: StatisticsMonitor
    
    Starts the statistics monitor, starting a scheduled monitor that polls for statistics. Monitoring is required only when wanting to receive statistics change events.
    
    Specified by:
    
    startStatisticsMonitor in interface StatisticsMonitor
  - stopStatisticsMonitor
```
public void stopStatisticsMonitor()
```
    Description copied from interface: StatisticsMonitor
    
    Stops the statistics monitor.
    
    Specified by:
    
    stopStatisticsMonitor in interface StatisticsMonitor
  - isMonitoring
```
public boolean isMonitoring()
```
    Description copied from interface: StatisticsMonitor
    
    Returns true if statistics are now being monitored.
    
    Specified by:
    
    isMonitoring in interface StatisticsMonitor
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getApplicationName
```
public String getApplicationName()
```
    Specified by:
    
    getApplicationName in interface InternalProcessingUnit
  - getApplication
```
public Application getApplication()
```
    Specified by:
    
    getApplication in interface ProcessingUnit
    
    Returns:
    
    the application that this processing unit is associated with or null if this processing unit is not part of an application
  - setApplication
```
public void setApplication(Application application)
```
    Specified by:
    
    setApplication in interface InternalApplicationAware
  - decrementPlannedInstances
```
public boolean decrementPlannedInstances()
```
    Description copied from interface: InternalProcessingUnit
    
    Decrements a planned instance if the number of planned instances is less then the actual instances to maintain.
    
    Specified by:
    
    decrementPlannedInstances in interface InternalProcessingUnit
    
    Returns:
    
    true if a planned instance was successfully decremented; false planned instances hasn't changed.
  - getApplicationDependencies
```
public String getApplicationDependencies()
```
    This method is used by the webui. Need to use getDependencies once Cloudify is migrated to use the dependencies API
    
    Specified by:
    
    getApplicationDependencies in interface InternalProcessingUnit
    
    Returns:
    
    The property value, in a CSV format.
  - getDependencies
```
public ProcessingUnitDependencies<ProcessingUnitDependency> getDependencies()
```
    Specified by:
    
    getDependencies in interface ProcessingUnit
    
    Returns:
    
    the dependencies this processing unit has on other processing units.
  - processProvisionEvent
```
public void processProvisionEvent(org.jini.rio.monitor.ProvisionLifeCycleEvent provisionLifeCycleEvent)
```
    Specified by:
    
    processProvisionEvent in interface InternalProcessingUnit
  - getProvisionStatusPerInstance
```
public Map<String,InternalProvisionStatusHolder> getProvisionStatusPerInstance()
```
    Specified by:
    
    getProvisionStatusPerInstance in interface InternalProcessingUnit
  - getSimpleName
```
public String getSimpleName()
```
    Description copied from interface: InternalProcessingUnit
    
    In the case of application name prefix just processing unit name will be returned. Otherwise name will be returned.
    
    Specified by:
    
    getSimpleName in interface InternalProcessingUnit
  - getProcessingUnitInstanceProvisionStatusChanged
```
public ProcessingUnitInstanceProvisionStatusChangedEventManager getProcessingUnitInstanceProvisionStatusChanged()
```
    Specified by:
    
    getProcessingUnitInstanceProvisionStatusChanged in interface ProcessingUnit
    
    Returns:
    
    Returns an event manager allowing to register ProcessingUnitInstanceProvisionStatusChangedEventListeners.
  - getProcessingUnitInstanceMemberAliveIndicatorStatusChanged
```
public ProcessingUnitInstanceMemberAliveIndicatorStatusChangedEventManager getProcessingUnitInstanceMemberAliveIndicatorStatusChanged()
```
    Specified by:
    
    getProcessingUnitInstanceMemberAliveIndicatorStatusChanged in interface ProcessingUnit
    
    Returns:
    
    Returns an event manager allowing to register ProcessingUnitInstanceMemberAliveIndicatorStatusChangedEventListeners.
  - getStatistics
```
public ProcessingUnitStatistics getStatistics()
```
    Specified by:
    
    getStatistics in interface InternalProcessingUnit
    
    Returns:
    
    the processing unit (aggregated) statistics.
  - getHostingGridServiceAgentZones
```
public ExactZonesConfig getHostingGridServiceAgentZones(ProcessingUnitInstance processingUnitInstance)
                                                 throws AdminException
```
    Description copied from interface: InternalProcessingUnit
    
    return the exact zones of the agent that belongs to processing unit instance
    
    Specified by:
    
    getHostingGridServiceAgentZones in interface InternalProcessingUnit
    
    Parameters:
    
    processingUnitInstance -
    
    Returns:
    
    Throws:
    
    AdminException
  - addStatisticsCalculation
```
public void addStatisticsCalculation(ProcessingUnitStatisticsId statisticsId)
```
    Description copied from interface: InternalProcessingUnit
    
    Adds the specified statistics calculation
    
    Specified by:
    
    addStatisticsCalculation in interface InternalProcessingUnit
  - removeStatisticsCalculation
```
public void removeStatisticsCalculation(ProcessingUnitStatisticsId statisticsId)
```
    Description copied from interface: InternalProcessingUnit
    
    Removes the specified statistics calculation
    
    Specified by:
    
    removeStatisticsCalculation in interface InternalProcessingUnit
  - getStatisticsCalculations
```
public Set<ProcessingUnitStatisticsId> getStatisticsCalculations()
```
    Specified by:
    
    getStatisticsCalculations in interface InternalProcessingUnit
    
    Returns:
    
    the generated statistics identifiers.
  - getRequiredContainerZones
```
public RequiredZonesConfig getRequiredContainerZones()
```
    Specified by:
    
    getRequiredContainerZones in interface ProcessingUnit
    
    Returns:
    
    the @{link GridServiceContainer} zones that can satisfy this processing unit. For example: boolean gscMatch = pu.getRequiredContainerZones().isSatisfiedBy(gsc.getExactZones());
  - getGridServiceContainers
```
public GridServiceContainer[] getGridServiceContainers()
```
    Specified by:
    
    getGridServiceContainers in interface ProcessingUnit
    
    Returns:
    
    Returns the @{link GridServiceContainer}s this processing unit is deployed on.
  - isBackupGsmInSync
```
public boolean isBackupGsmInSync()
```
    Specified by:
    
    isBackupGsmInSync in interface InternalProcessingUnit
    
    Returns:
    
    true if backup GSM is in sync with primary GSM, false if out of sync or no backup gsm.
  - getProcessingUnitInstanceByUid
```
public ProcessingUnitInstance getProcessingUnitInstanceByUid(String uid)
```
    Description copied from interface: InternalProcessingUnit
    
    returns the processing unit instance based on its uid (see GridComponent.getUid())
    
    Specified by:
    
    getProcessingUnitInstanceByUid in interface InternalProcessingUnit
    
    Parameters:
    
    uid - the unique id of the processing unit instance
    
    Returns:
    
    the processing unit instance or null
  - isStandaloneProcessingUnit
```
public boolean isStandaloneProcessingUnit()
```
    Specified by:
    
    isStandaloneProcessingUnit in interface InternalProcessingUnit
    
    Returns:
    
    true if this processing unit is un-managed by the Service Grid.
  - setBackupGsmInSync
```
public void setBackupGsmInSync(boolean backupGsmIsInSync)
```
    Specified by:
    
    setBackupGsmInSync in interface InternalProcessingUnit
    
    Parameters:
    
    backupGsmIsInSync - - true if backup GSM is in sync with primary GSM, false if out of sync.
  - quiesce
```
public QuiesceResult quiesce(QuiesceRequest request)
```
    Description copied from interface: ProcessingUnit
    
    Requests a quiesce request from the GSM. If the request ended successfully (ProcessingUnit.waitFor(com.gigaspaces.admin.quiesce.QuiesceState) returned true) all space instances and listeners will switch to quiesced mode. If the GSM rejects the request an exception with the rejection failure will be thrown. (precondition: the processing unit is intact)
    
    Specified by:
    
    quiesce in interface ProcessingUnit
    
    Parameters:
    
    request - with the quiesce description
    
    Returns:
    
    QuiesceRequest if the request was approved by the server
  - quiesceUnsafe
```
public QuiesceResult quiesceUnsafe(QuiesceRequest request)
                            throws IOException,
                                   QuiesceFailedException
```
    Performs quiesce - should always be called after acquiring pu lock
    
    Parameters:
    
    request -
    
    Returns:
    
    QuiesceResult
    
    Throws:
    
    IOException
    
    QuiesceFailedException
  - unquiesce
```
public void unquiesce(QuiesceRequest request)
```
    Description copied from interface: ProcessingUnit
    
    Requests a unquiesce request from the GSM. If the request ended successfully (ProcessingUnit.waitFor(com.gigaspaces.admin.quiesce.QuiesceState) returned true) all space instances and listeners will switch to unquiesced mode. If the GSM rejects the request an exception with the rejection failure will be thrown. (precondition: the processing unit is intact)
    
    Specified by:
    
    unquiesce in interface ProcessingUnit
    
    Parameters:
    
    request - with the quiesce description
  - waitFor
```
public boolean waitFor(QuiesceState desiredState,
                       long timeout,
                       TimeUnit timeUnit)
```
    Specified by:
    
    waitFor in interface ProcessingUnit
    
    Returns:
    
    true if the processing unit reached to desired as well as all instances in the requested timeout, false otherwise.
  - waitFor
```
public boolean waitFor(QuiesceState desiredState)
```
    Description copied from interface: ProcessingUnit
    
    Same as ProcessingUnit.waitFor(com.gigaspaces.admin.quiesce.QuiesceState, long, java.util.concurrent.TimeUnit) but with endless timeout
    
    Specified by:
    
    waitFor in interface ProcessingUnit
  - getQuiesceDetails
```
public QuiesceDetails getQuiesceDetails()
```
    Specified by:
    
    getQuiesceDetails in interface ProcessingUnit
    
    Returns:
    
    the quiesce details of the processing unit - QuiesceDetails
  - getArchiveName
```
public String getArchiveName()
```
    Specified by:
    
    getArchiveName in interface ProcessingUnit
    
    Returns:
    
    the archive(jar/war etc') the pu is running with
  - scaleHorizontal
```
public void scaleHorizontal(int target,
                            String memory,
                            String cpu,
                            String requestId)
```
    Specified by:
    
    scaleHorizontal in interface InternalProcessingUnit
  - cancelScaleOut
```
public void cancelScaleOut()
                    throws IOException,
                           TimeoutException,
                           InterruptedException
```
    Specified by:
    
    cancelScaleOut in interface InternalProcessingUnit
    
    Throws:
    
    IOException
    
    TimeoutException
    
    InterruptedException
  - scaleVertical
```
public void scaleVertical(String memory,
                          String cpu,
                          Long timeout,
                          PuScaleVStatusChangedEventListener listener)
```
    Specified by:
    
    scaleVertical in interface InternalProcessingUnit
  - getClusterTopology
```
public ClusterTopology getClusterTopology()
                                   throws IOException
```
    Specified by:
    
    getClusterTopology in interface InternalProcessingUnit
    
    Throws:
    
    IOException
  - lock
```
public SharedLock lock()
                throws Exception
```
    Specified by:
    
    lock in interface InternalProcessingUnit
    
    Throws:
    
    Exception
  - lock
```
public SharedLock lock(long timeout,
                       TimeUnit timeunit)
                throws IOException,
                       TimeoutException,
                       InterruptedException
```
    Specified by:
    
    lock in interface InternalProcessingUnit
    
    Throws:
    
    IOException
    
    TimeoutException
    
    InterruptedException
  - setStub
```
public void setStub(boolean stub)
```
    Specified by:
    
    setStub in interface InternalProcessingUnit
    
    Parameters:
    
    stub - - true if PU was created before any instance
  - isStub
```
public boolean isStub()
```
    Specified by:
    
    isStub in interface InternalProcessingUnit
  - updateStub
```
public void updateStub(ProcessingUnitInstance processingUnitInstance)
```
    Specified by:
    
    updateStub in interface InternalProcessingUnit

Class DefaultProcessingUnit

Field Summary

Fields inherited from interface org.openspaces.admin.StatisticsMonitor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

DefaultProcessingUnit

Method Detail

getProcessingUnits

getAdmin

getName

getBeanLevelProperties

getType

getManagingGridServiceManagerChanged

setLogLevel

getBackupGridServiceManagerChanged

hasSpace

getSpace

getSpaces

addEmbeddedSpace

removeEmbeddedSpace

getProcessingUnitStatusChanged

getProcessingUnitInstanceAdded

getProcessingUnitInstanceRemoved

getSpaceCorrelated

getProcessingUnitInstance

addLifecycleListener

removeLifecycleListener

getNumberOfInstances

getPlannedNumberOfPartitions

getPlannedNumberOfInstances

setNumberOfInstances

getNumberOfBackups

setNumberOfBackups

getTotalNumberOfInstances

getMaxInstancesPerVM

isRequiresIsolation

getMaxInstancesPerMachine

getClusterSchema

getMaxInstancesPerZone

getRequiredZones

getPrimaryZones

getStatus

waitFor

waitFor

waitForSpace

waitForSpace

waitForManaged

waitForManaged

canIncrementInstance

canDecrementInstance

incrementInstance

decrementInstance

getManagingGridServiceManager

getBackupGridServiceManagers

isManaged

getBackupGridServiceManager

undeployAsync

undeployAsync

undeployAndWait

undeployAndWait

undeploy

setManagingGridServiceManager

addManagingGridServiceManager

addBackupGridServiceManager

removeBackupGridServiceManager

setStatus

iterator

getInstances

getProcessingUnitInstances

getPartitions

getPartition

addProcessingUnitInstance

removeProcessingUnitInstance

getProcessingUnitInstanceStatisticsChanged

setStatisticsInterval

setStatisticsHistorySize

startStatisticsMonitor