GigaSpaces XAP 9.7.2 API

org.openspaces.admin.gateway
Interface GatewayProcessingUnits

All Superinterfaces:
AdminAware, Iterable<GatewayProcessingUnit>

public interface GatewayProcessingUnits
extends Iterable<GatewayProcessingUnit>, AdminAware

Holds one or more GatewayProcessingUnits.

Since:
9.5
Author:
evgeny

Method Summary
 void addLifecycleListener(GatewayProcessingUnitLifecycleEventListener eventListener)
          Allows to add a GatewayProcessingUnitLifecycleEventListener.
 GatewayProcessingUnit getGatewayProcessingUnit(String uid)
          Returns the GatewayProcessingUnit for the given gateway processing unit name.
 GatewayProcessingUnitAddedEventManager getGatewayProcessingUnitAdded()
          Returns an event manager allowing to register GatewayProcessingUnitAddedEventListeners.
 GatewayProcessingUnitRemovedEventManager getGatewayProcessingUnitRemoved()
          Returns an event manager allowing to register GatewayProcessingUnitRemovedEventListeners.
 GatewayProcessingUnit[] getGatewayProcessingUnits()
          Returns the GatewayProcessingUnits currently deployed.
 Map<String,GatewayProcessingUnit> getNames()
          Returns a map of GatewayProcessingUnit keyed by their respective names.
 int getSize()
          Returns the number of currently deployed GatewayProcessingUnits.
 boolean isEmpty()
          Returns true if there are no currently deployed processing units.
 void removeLifecycleListener(GatewayProcessingUnitLifecycleEventListener eventListener)
          Allows to remove a GatewayProcessingUnitLifecycleEventListener.
 GatewayProcessingUnit waitFor(String gatewayProcessingUnitName)
          Waits indefinitely till the gateway processing unit is identified as deployed.
 GatewayProcessingUnit waitFor(String gatewaysProcessingUnitName, 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
iterator
 
Methods inherited from interface org.openspaces.admin.AdminAware
getAdmin
 

Method Detail

getSize

int getSize()
Returns the number of currently deployed GatewayProcessingUnits.


isEmpty

boolean isEmpty()
Returns true if there are no currently deployed processing units.


getGatewayProcessingUnits

GatewayProcessingUnit[] getGatewayProcessingUnits()
Returns the GatewayProcessingUnits currently deployed.


getGatewayProcessingUnit

GatewayProcessingUnit getGatewayProcessingUnit(String uid)
Returns the GatewayProcessingUnit for the given gateway processing unit name.


getNames

Map<String,GatewayProcessingUnit> getNames()
Returns a map of GatewayProcessingUnit keyed by their respective names.


waitFor

GatewayProcessingUnit waitFor(String gatewayProcessingUnitName)
Waits indefinitely till the gateway processing unit is identified as deployed. Returns the GatewayProcessingUnit.


waitFor

GatewayProcessingUnit waitFor(String gatewaysProcessingUnitName,
                              long timeout,
                              TimeUnit timeUnit)
Waits for the specified timeout (in time interval) till the processing unit is identified as deployed. Returns the GatewayProcessingUnit. Return null if the gateway processing unit is not deployed within the specified timeout.


getGatewayProcessingUnitAdded

GatewayProcessingUnitAddedEventManager getGatewayProcessingUnitAdded()
Returns an event manager allowing to register GatewayProcessingUnitAddedEventListeners.


getGatewayProcessingUnitRemoved

GatewayProcessingUnitRemovedEventManager getGatewayProcessingUnitRemoved()
Returns an event manager allowing to register GatewayProcessingUnitRemovedEventListeners.


addLifecycleListener

void addLifecycleListener(GatewayProcessingUnitLifecycleEventListener eventListener)
Allows to add a GatewayProcessingUnitLifecycleEventListener.


removeLifecycleListener

void removeLifecycleListener(GatewayProcessingUnitLifecycleEventListener eventListener)
Allows to remove a GatewayProcessingUnitLifecycleEventListener.


GigaSpaces XAP 9.7.2 API

Copyright © GigaSpaces.