org.openspaces.admin.gateway
Interface Gateways

All Superinterfaces:

AdminAware, Iterable<Gateway>

All Known Subinterfaces:

InternalGateways

public interface Gateways
extends AdminAware, Iterable<Gateway>

Gateways holds all the different Gateways that are currently discovered.

Since:

8.0.4

Author:

eitany

Method Summary

void	addLifecycleListener(GatewayLifecycleEventListener eventListener) Allows to add a GatewayLifecycleEventListener.
Gateway	getGateway(String gatewayName) Returns the Gateway for the given gateway name.
GatewayAddedEventManager	getGatewayAdded() Returns an event manager allowing to register GatewayAddedEventListeners.
GatewayRemovedEventManager	getGatewayRemoved() Returns an event manager allowing to register GatewayRemovedEventListeners.
Gateway[]	getGateways() Returns all the currently discovered gateways.
Map<String,Gateway>	getNames() Returns a map of Gateway keyed by their respective names.
int	getSize() Returns the number of gateways currently discovered.
boolean	isEmpty() Returns true if there are no gateways, false otherwise.
void	removeLifecycleListener(GatewayLifecycleEventListener eventListener) Allows to remove a GatewayLifecycleEventListener.
Gateway	waitFor(String gatewayName) Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the gateway is identified as deployed.
Gateway	waitFor(String gatewayName, long timeout, TimeUnit timeUnit) Waits for the specified timeout (in time interval) till the gateway is identified as deployed.

Methods inherited from interface org.openspaces.admin.AdminAware

getAdmin

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getGateways

Gateway[] getGateways()

Returns all the currently discovered gateways.

getGateway

Gateway getGateway(String gatewayName)

Returns the Gateway for the given gateway name. Returns null if the gateway is not currently discovered.

getNames

Map<String,Gateway> getNames()

Returns a map of Gateway keyed by their respective names.

waitFor

Gateway waitFor(String gatewayName)

Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the gateway is identified as deployed. Return null if the gateway is not deployed within the specified timeout.

waitFor

Gateway waitFor(String gatewayName,
                long timeout,
                TimeUnit timeUnit)

Waits for the specified timeout (in time interval) till the gateway is identified as deployed. Returns the Gateway. Return null if the gateway is not deployed within the specified timeout.

getSize

int getSize()

Returns the number of gateways currently discovered.

isEmpty

boolean isEmpty()

Returns true if there are no gateways, false otherwise.

getGatewayAdded

GatewayAddedEventManager getGatewayAdded()

Returns an event manager allowing to register GatewayAddedEventListeners.

getGatewayRemoved

GatewayRemovedEventManager getGatewayRemoved()

Returns an event manager allowing to register GatewayRemovedEventListeners.

addLifecycleListener

void addLifecycleListener(GatewayLifecycleEventListener eventListener)

Allows to add a GatewayLifecycleEventListener.

removeLifecycleListener

void removeLifecycleListener(GatewayLifecycleEventListener eventListener)

Allows to remove a GatewayLifecycleEventListener.