org.openspaces.admin.gateway
Interface Gateway

All Superinterfaces:

Iterable<GatewayProcessingUnit>

public interface Gateway
extends Iterable<GatewayProcessingUnit>

A gateway is a composition of one or more of GatewayProcessingUnits, and it is in charge of replication between different Spaces. e.g. Replication between two sites over WAN.

Since:

8.0.4

Author:

eitany

Method Summary

GatewayDelegator	getDelegator(String targetGatewayName) Returns a gateway delegator which has a target gateway with the given name.
GatewayProcessingUnit	getGatewayProcessingUnit(String processingUnitName) Returns the gateway processing unit for the given processing unit name.
GatewayProcessingUnit[]	getGatewayProcessingUnits() Returns all the currently deployed GatewayProcessingUnits.
String	getName() Returns the name which is used by the other gateways to locate this gateway.
Map<String,GatewayProcessingUnit>	getNames() Returns a map of GatewayProcessingUnit keyed by their respective names.
GatewaySink	getSink(String sourceGatewayName) Returns a gateway sink which has a source gateway with the given name.
GatewaySinkSource	getSinkSource(String sourceGatewayName) Returns a sink source gateway with the given name.
int	getSize() Returns the number of deployed GatewayProcessingUnit which are part of this gateway.
boolean	isEmpty() Returns true if there are no deployed GatewayProcessingUnit which are part of this gateway; false otherwise.
boolean	waitFor(int numberOfGatewayProcessingUnits) Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till at least the provided number of Gateway Processing Unit Instances are up.
boolean	waitFor(int numberOfGatewayProcessingUnits, long timeout, TimeUnit timeUnit) Waits for the specified timeout (in time interval) till at least the provided number of Gateway Processing Unit Instances are up.
GatewayDelegator	waitForDelegator(String targetGatewayName) Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the gateway delegator with the given target gateway name is identified as deployed.
GatewayDelegator	waitForDelegator(String targetGatewayName, long timeout, TimeUnit timeUnit) Waits for the specified timeout (in time interval) till the gateway delegator with the given target gateway name is identified as deployed.
GatewayProcessingUnit	waitForGatewayProcessingUnit(String processingUnitName) Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the processing unit of this gateway is identified as deployed.
GatewayProcessingUnit	waitForGatewayProcessingUnit(String processingUnitName, long timeout, TimeUnit timeUnit) Waits for the specified timeout (in time interval) till the processing unit of this gateway is identified as deployed.
GatewaySink	waitForSink(String sourceGatewayName) Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the gateway sink with the given source gateway name is identified as deployed.
GatewaySink	waitForSink(String sourceGatewayName, long timeout, TimeUnit timeUnit) Waits for the specified timeout (in time interval) till the gateway sink with the given source gateway name is identified as deployed.
GatewaySinkSource	waitForSinkSource(String sourceGatewayName) Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the gateway sink with the given source gateway name is identified as deployed.
GatewaySinkSource	waitForSinkSource(String sourceGatewayName, long timeout, TimeUnit timeUnit) Waits for the specified timeout (in time interval) till the gateway sink with the given source gateway name is identified as deployed.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getGatewayProcessingUnits

GatewayProcessingUnit[] getGatewayProcessingUnits()

Returns all the currently deployed GatewayProcessingUnits.

getName

String getName()

Returns the name which is used by the other gateways to locate this gateway.

waitFor

boolean waitFor(int numberOfGatewayProcessingUnits)

Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till at least the provided number of Gateway Processing Unit Instances are up. Returns true if the specified number of gateway processing units are deployed, false otherwise;

waitFor

boolean waitFor(int numberOfGatewayProcessingUnits,
                long timeout,
                TimeUnit timeUnit)

Waits for the specified timeout (in time interval) till at least the provided number of Gateway Processing Unit Instances are up. Returns true if the specified number of gateway processing units are deployed within the specified timeout, false otherwise;

waitForGatewayProcessingUnit

GatewayProcessingUnit waitForGatewayProcessingUnit(String processingUnitName)

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

waitForGatewayProcessingUnit

GatewayProcessingUnit waitForGatewayProcessingUnit(String processingUnitName,
                                                   long timeout,
                                                   TimeUnit timeUnit)

Waits for the specified timeout (in time interval) till the processing unit of this gateway is identified as deployed. Return null if the processing unit is not deployed within the specified timeout.

getGatewayProcessingUnit

GatewayProcessingUnit getGatewayProcessingUnit(String processingUnitName)

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

getNames

Map<String,GatewayProcessingUnit> getNames()

Returns a map of GatewayProcessingUnit keyed by their respective names.

getSink

GatewaySink getSink(String sourceGatewayName)

Returns a gateway sink which has a source gateway with the given name. Returns null if the gateway sink is not currently discovered or this gateway has no sink with source gateway with the given name.

waitForSink

GatewaySink waitForSink(String sourceGatewayName)

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

waitForSink

GatewaySink waitForSink(String sourceGatewayName,
                        long timeout,
                        TimeUnit timeUnit)

Waits for the specified timeout (in time interval) till the gateway sink with the given source gateway name is identified as deployed. Return null if the sink is not deployed within the specified timeout.

getSinkSource

GatewaySinkSource getSinkSource(String sourceGatewayName)

Returns a sink source gateway with the given name. Returns null if the sink source is not currently discovered or this gateway has no sink with source gateway with the given name.

waitForSinkSource

GatewaySinkSource waitForSinkSource(String sourceGatewayName)

Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the gateway sink with the given source gateway name is identified as deployed. Returns null if the sink source is not deployed within the specified timeout.

waitForSinkSource

GatewaySinkSource waitForSinkSource(String sourceGatewayName,
                                    long timeout,
                                    TimeUnit timeUnit)

Waits for the specified timeout (in time interval) till the gateway sink with the given source gateway name is identified as deployed. Returns null if the sink source is not deployed within the specified timeout.

getDelegator

GatewayDelegator getDelegator(String targetGatewayName)

Returns a gateway delegator which has a target gateway with the given name. Returns null if the gateway delegator is not currently discovered or this gateway has no target with target gateway with the given name.

waitForDelegator

GatewayDelegator waitForDelegator(String targetGatewayName)

Waits for the default timeout specified by Admin.setDefaultTimeout(long, TimeUnit) till the gateway delegator with the given target gateway name is identified as deployed. Returns null if the delegator target is not deployed within the specified timeout.

waitForDelegator

GatewayDelegator waitForDelegator(String targetGatewayName,
                                  long timeout,
                                  TimeUnit timeUnit)

Waits for the specified timeout (in time interval) till the gateway delegator with the given target gateway name is identified as deployed. Returns null if the delegator target is not deployed within the specified timeout.

getSize

int getSize()

Returns the number of deployed GatewayProcessingUnit which are part of this gateway.

isEmpty

boolean isEmpty()

Returns true if there are no deployed GatewayProcessingUnit which are part of this gateway; false otherwise.