Machine (GigaSpaces 16.4.0 API)

All Superinterfaces:

DumpProvider

All Known Subinterfaces:

InternalMachine

All Known Implementing Classes:

DefaultMachine
```
public interface Machine
extends DumpProvider
```
A Machine is a logical entity identified by a host address. Once a grid service is running on a machine (GridServiceAgent, GridServiceManager, GridServiceContainer, LookupService, SpaceInstance) it is discovered (created) by the admin API.

Author:

kimchy

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)` Allows to add a `ProcessingUnitInstanceLifecycleEventListener`.
`void`	`addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)` Allows to add a `SpaceInstanceLifecycleEventListener`.
`boolean`	`contains(ProcessingUnitInstance processingUnitInstance)` Returns `true` if the processing unit instance exists within the machine.
`boolean`	`contains(SpaceInstance spaceInstance)` Returns `true` if the machine contains the provided space instance.
`GridServiceAgent`	`getGridServiceAgent()` Returns the first grid service agent.
`GridServiceAgents`	`getGridServiceAgents()` Returns the grid service agents running on the machine.
`GridServiceContainers`	`getGridServiceContainers()` Returns the grid service containers running on the machine.
`GridServiceManagers`	`getGridServiceManagers()` Returns the grid service managers running on the machine.
`String`	`getHostAddress()` Returns the host address of the machine.
`String`	`getHostName()` Returns the host name of the machine.
`LookupServices`	`getLookupServices()` Returns the lookup services that are running on the machine.
`OperatingSystem`	`getOperatingSystem()` Returns the operating system of the machine.
`ProcessingUnitInstanceAddedEventManager`	`getProcessingUnitInstanceAdded()` Returns the processing unit instance added event manager allowing to add and remove `ProcessingUnitInstanceAddedEventListener`s.
`ProcessingUnitInstanceRemovedEventManager`	`getProcessingUnitInstanceRemoved()` Returns the processing unit instance removed event manager allowing to add and remove `ProcessingUnitInstanceRemovedEventListener`s.
`ProcessingUnitInstance[]`	`getProcessingUnitInstances()` Returns all the processing unit instances running on the machine.
`ProcessingUnitInstance[]`	`getProcessingUnitInstances(String processingUnitName)` Returns the processing unit instances of the specified name that are currently deployed on the machine.
`ProcessingUnit[]`	`getProcessingUnits()`
`SpaceInstanceAddedEventManager`	`getSpaceInstanceAdded()` Returns the space instance added event manager allowing to add and remove `SpaceInstanceAddedEventListener`s.
`SpaceInstanceRemovedEventManager`	`getSpaceInstanceRemoved()` Returns the space instance removed event manager allowing to add and remove `SpaceInstanceRemovedEventListener`s.
`SpaceInstance[]`	`getSpaceInstances()` Returns all the space instances running on the machine.
`Transports`	`getTransports()` Returns the transports "running" on the machine.
`String`	`getUid()` Returns the UID of the machine.
`VirtualMachine`	`getVirtualMachineByPID(long pid)` Return a virtual machine by its pid.
`VirtualMachines`	`getVirtualMachines()` Returns the virtual machines running on the machine.
`boolean`	`hasGridComponents()` Returns `true` if there are grid components.
`void`	`removeLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)` Allows to remove a `ProcessingUnitInstanceLifecycleEventListener`.
`void`	`removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)` Allows to remove a `SpaceInstanceLifecycleEventListener`.

Methods inherited from interface org.openspaces.admin.dump.DumpProvider
generateDump, generateDump

- Method Detail
  - getUid
```
String getUid()
```
    Returns the UID of the machine.
  - getHostAddress
```
String getHostAddress()
```
    Returns the host address of the machine.
  - getHostName
```
String getHostName()
```
    Returns the host name of the machine.
  - getLookupServices
```
LookupServices getLookupServices()
```
    Returns the lookup services that are running on the machine.
  - getGridServiceAgent
```
GridServiceAgent getGridServiceAgent()
```
    Returns the first grid service agent. Note, there will usually be only a single agent per machine. Returns null if there is no GridServiceAgent running on the machine.
  - getGridServiceAgents
```
GridServiceAgents getGridServiceAgents()
```
    Returns the grid service agents running on the machine.
  - getGridServiceManagers
```
GridServiceManagers getGridServiceManagers()
```
    Returns the grid service managers running on the machine.
  - getGridServiceContainers
```
GridServiceContainers getGridServiceContainers()
```
    Returns the grid service containers running on the machine.
  - getOperatingSystem
```
OperatingSystem getOperatingSystem()
```
    Returns the operating system of the machine.
  - getVirtualMachines
```
VirtualMachines getVirtualMachines()
```
    Returns the virtual machines running on the machine.
  - hasGridComponents
```
boolean hasGridComponents()
```
    Returns true if there are grid components.
  - getTransports
```
Transports getTransports()
```
    Returns the transports "running" on the machine.
  - getProcessingUnits
```
ProcessingUnit[] getProcessingUnits()
```
    Returns:
    
    Returns the ProcessingUnit of the processing unit instances running on the machine.
    
    Since:
    
    10.1.1
  - getProcessingUnitInstances
```
ProcessingUnitInstance[] getProcessingUnitInstances()
```
    Returns all the processing unit instances running on the machine.
  - getProcessingUnitInstances
```
ProcessingUnitInstance[] getProcessingUnitInstances(String processingUnitName)
```
    Returns the processing unit instances of the specified name that are currently deployed on the machine.
  - contains
```
boolean contains(ProcessingUnitInstance processingUnitInstance)
```
    Returns true if the processing unit instance exists within the machine.
  - getProcessingUnitInstanceAdded
```
ProcessingUnitInstanceAddedEventManager getProcessingUnitInstanceAdded()
```
    Returns the processing unit instance added event manager allowing to add and remove ProcessingUnitInstanceAddedEventListeners.
  - getProcessingUnitInstanceRemoved
```
ProcessingUnitInstanceRemovedEventManager getProcessingUnitInstanceRemoved()
```
    Returns the processing unit instance removed event manager allowing to add and remove ProcessingUnitInstanceRemovedEventListeners.
  - addLifecycleEventListener
```
void addLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
```
    Allows to add a ProcessingUnitInstanceLifecycleEventListener.
  - removeLifecycleEventListener
```
void removeLifecycleEventListener(ProcessingUnitInstanceLifecycleEventListener eventListener)
```
    Allows to remove a ProcessingUnitInstanceLifecycleEventListener.
  - getSpaceInstances
```
SpaceInstance[] getSpaceInstances()
```
    Returns all the space instances running on the machine.
  - contains
```
boolean contains(SpaceInstance spaceInstance)
```
    Returns true if the machine contains the provided space instance.
  - getSpaceInstanceAdded
```
SpaceInstanceAddedEventManager getSpaceInstanceAdded()
```
    Returns the space instance added event manager allowing to add and remove SpaceInstanceAddedEventListeners.
  - getSpaceInstanceRemoved
```
SpaceInstanceRemovedEventManager getSpaceInstanceRemoved()
```
    Returns the space instance removed event manager allowing to add and remove SpaceInstanceRemovedEventListeners.
  - addLifecycleListener
```
void addLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)
```
    Allows to add a SpaceInstanceLifecycleEventListener.
  - removeLifecycleListener
```
void removeLifecycleListener(SpaceInstanceLifecycleEventListener eventListener)
```
    Allows to remove a SpaceInstanceLifecycleEventListener.
  - getVirtualMachineByPID
```
VirtualMachine getVirtualMachineByPID(long pid)
```
    Return a virtual machine by its pid.
    
    Since:
    
    15.8.0

Interface Machine

Method Summary

Methods inherited from interface org.openspaces.admin.dump.DumpProvider

Method Detail

getUid

getHostAddress

getHostName

getLookupServices

getGridServiceAgent

getGridServiceAgents

getGridServiceManagers

getGridServiceContainers

getOperatingSystem

getVirtualMachines

hasGridComponents

getTransports

getProcessingUnits

getProcessingUnitInstances

getProcessingUnitInstances

contains

getProcessingUnitInstanceAdded

getProcessingUnitInstanceRemoved

addLifecycleEventListener

removeLifecycleEventListener

getSpaceInstances

contains

getSpaceInstanceAdded

getSpaceInstanceRemoved

addLifecycleListener

removeLifecycleListener

getVirtualMachineByPID