com.pivotal.gemfirexd

Interface FabricService

All Known Subinterfaces:

FabricAgent, FabricLocator, FabricServer

public interface FabricService

Base interface defining common peer services provided by FabricServer and FabricLocator.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FabricService.State Status of the service enumerating different states the service can be in.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NETSERVER_DEFAULT_PORT the default port for network server
static java.lang.String	STOP_NETWORK_SERVERS Shutdown boolean property to enable/disable shutting down of all network servers in stop(Properties).

Method Summary

Modifier and Type	Method and Description
java.util.List<NetworkInterface>	getAllNetworkServers() Get a collection of all the NetworkInterfaces started so far using startNetworkServer(String, int, Properties).
boolean	isReconnecting() Test to see whether the FabricService is in the process of reconnecting and recreating the cache after it has been removed from the system by other members.
default FabricService.State	serviceStatus() Used to display the status of this service in SYS.MEMBERS.
NetworkInterface	startDRDAServer(java.lang.String bindAddress, int port, java.util.Properties networkProperties) Start listening for DRDA clients on a given host/port address.
NetworkInterface	startNetworkServer(java.lang.String bindAddress, int port, java.util.Properties networkProperties) Start listening for network clients on a given host/port address.
NetworkInterface	startThriftServer(java.lang.String bindAddress, int port, java.util.Properties networkProperties) Start listening for Thrift clients on a given host/port address.
FabricService.State	status() Returns the status of this instance.
void	stop(java.util.Properties shutdownCredentials) Disconnect current virtual machine from distributed system.
void	stopAllNetworkServers() Stop all the NetworkInterfaces started using startNetworkServer(String, int, Properties).
void	stopReconnecting() Force the FabricService to stop reconnecting.
boolean	waitUntilReconnected(long time, java.util.concurrent.TimeUnit units) Wait for the FabricService to finish reconnecting to the distributed system.

Field Detail

NETSERVER_DEFAULT_PORT

static final int NETSERVER_DEFAULT_PORT

the default port for network server

See Also:

Constant Field Values

STOP_NETWORK_SERVERS

static final java.lang.String STOP_NETWORK_SERVERS

Shutdown boolean property to enable/disable shutting down of all network servers in stop(Properties). Default is true.

See Also:

Constant Field Values

Method Detail

startNetworkServer

NetworkInterface startNetworkServer(java.lang.String bindAddress,
                                    int port,
                                    java.util.Properties networkProperties)
                             throws java.sql.SQLException

Start listening for network clients on a given host/port address. This can be called multiple times to bind to multiple network interfaces. By default this starts DRDA server (startDRDAServer(java.lang.String, int, java.util.Properties) unless ClientSharedUtils.USE_THRIFT_AS_DEFAULT_PROP system property is set in which case it start a Thrift server startThriftServer(java.lang.String, int, java.util.Properties)

Parameters:

bindAddress - The host name or IP address to bind the network server. If this is null then use the "bind-address" GemFire property and if found listens only on that address, else binds to local loopback address.

port - The port to bind the network server. A value <= 0 will cause this to use the default port NETSERVER_DEFAULT_PORT.

networkProperties - network server properties.

Throws:

java.sql.SQLException

startThriftServer

NetworkInterface startThriftServer(java.lang.String bindAddress,
                                   int port,
                                   java.util.Properties networkProperties)
                            throws java.sql.SQLException

Start listening for Thrift clients on a given host/port address. This can be called multiple times to bind to multiple network interfaces.

Parameters:

bindAddress - The host name or IP address to bind the network server. If this is null then use the "bind-address" GemFire property and if found listens only on that address, else binds to local loopback address.

port - The port to bind the network server. A value <= 0 will cause this to use the default port NETSERVER_DEFAULT_PORT.

networkProperties - network server properties.

Throws:

java.sql.SQLException

startDRDAServer

NetworkInterface startDRDAServer(java.lang.String bindAddress,
                                 int port,
                                 java.util.Properties networkProperties)
                          throws java.sql.SQLException

Start listening for DRDA clients on a given host/port address. This can be called multiple times to bind to multiple network interfaces.

Parameters:

bindAddress - The host name or IP address to bind the DRDA server. If this is null then use the "bind-address" GemFire property and if found listens only on that address, else binds to local loopback address.

port - The port to bind the DRDA server. A value <= 0 will cause this to use the default port NETSERVER_DEFAULT_PORT.

networkProperties - network server properties.

Throws:

java.sql.SQLException

stopAllNetworkServers

void stopAllNetworkServers()

Stop all the NetworkInterfaces started using startNetworkServer(String, int, Properties).

getAllNetworkServers

java.util.List<NetworkInterface> getAllNetworkServers()

Get a collection of all the NetworkInterfaces started so far using startNetworkServer(String, int, Properties).

stop

void stop(java.util.Properties shutdownCredentials)
   throws java.sql.SQLException

Disconnect current virtual machine from distributed system. This should be called once for every startup of the service.

Parameters:

shutdownCredentials - Can optionally be null if Authentication is switched off, otherwise system user authentication credentials with which this instance was started.

Throws:

java.sql.SQLException

status

FabricService.State status()

Returns the status of this instance.

Returns:

FabricService.State

serviceStatus

default FabricService.State serviceStatus()

Used to display the status of this service in SYS.MEMBERS. Normally same as status() but can be overridden by child classes if they have other components to initialize before showing the service as running.

isReconnecting

boolean isReconnecting()

Test to see whether the FabricService is in the process of reconnecting and recreating the cache after it has been removed from the system by other members.

This will also return true if the FabricService has finished reconnecting.

Returns:

true if the FabricService is attempting to reconnect or has finished reconnecting

waitUntilReconnected

boolean waitUntilReconnected(long time,
                             java.util.concurrent.TimeUnit units)
                      throws java.lang.InterruptedException

Wait for the FabricService to finish reconnecting to the distributed system.

Parameters:

time - amount of time to wait, or -1 to wait forever

units -

Returns:

true if the cache was reconnected

Throws:

java.lang.InterruptedException - if the thread is interrupted while waiting

stopReconnecting

void stopReconnecting()

Force the FabricService to stop reconnecting. If the service is currently connected this will cause it to stop.