com.gemstone.gemfire.admin
Interface AdminDistributedSystem

public interface AdminDistributedSystem

Administrative interface for managing an entire GemFire distributed system. This interface should not be confused with DistributedSystem that represents a connection to a GemFire distributed system.

Since:

3.5

See Also:

AdminDistributedSystemFactory

Method Summary

void	addAlertListener(AlertListener listener) Registers an AlertListener that will receive all alerts that are at or above the alert level.
void	addCacheListener(SystemMemberCacheListener listener) Registers a cache event listener.
CacheServer	addCacheServer() Creates a new cache server that is ready to configure and start.
DistributionLocator	addDistributionLocator() Creates a new DistributionLocator that is ready to configure and start.
void	addMembershipListener(SystemMembershipListener listener) Registers a listener that receives callbacks when a member joins or leaves the distributed system.
void	connect() Connects to the distributed system.
void	disconnect() Disconnects from the distributed system.
String	displayMergedLogs() Merges and returns all system logs as a single formatted log.
AlertLevel	getAlertLevel() Returns the lowest level of alerts that should be delivered to the AlertListeners registered on this AdminDistributedSystem.
CacheServer[]	getCacheServers() Returns all of the dedicated cache server members of the distributed system.
DistributedSystemConfig	getConfig() Returns this system's configuration .
DistributionLocator[]	getDistributionLocators() Returns array of DistributionLocators administered by this AdminDistributedSystem.
GemFireHealth	getGemFireHealth() Returns an object for monitoring the health of GemFire.
String	getId() Retrieves the unique id for this system.
String	getLatestAlert() Display in readable format the latest Alert in this distributed system.
Properties	getLicense() Retrieves the license information for this installation of GemFire.
String	getLocators() Retrieves comma-delimited list locators to be used if multi-cast port is zero.
LogWriter	getLogWriter() Returns this connection's LogWriter; null if not connected.
String	getMcastAddress() Retrieves the multicast address in use by this system.
int	getMcastPort() Retrieves the multicast port in use by this system.
String	getName() Retrieves display friendly name for this system.
String	getRemoteCommand() Retrieves the remote command and formatting this system should use to access and/or manipulate resources on remote machines.
SystemMember[]	getSystemMemberApplications() Retrieves SystemMember instances for every application that is running and currently connection to this system.
boolean	isConnected() Returns true if this is currently connected to the system.
boolean	isMcastDiscovery() Returns true if this system is using multicast instead of locators for discovery
boolean	isMcastEnabled() Returns true if this system has enabled the use of multicast for communications
boolean	isRunning() Returns true if any members of this system are currently running.
SystemMember	lookupSystemMember(DistributedMember distributedMember) Returns the administrative SystemMember specified by the DistributedMember.
void	removeAlertListener(AlertListener listener) Unregisters an AlertListener
void	removeCacheListener(SystemMemberCacheListener listener) Unregisters a cache listener.
void	removeMembershipListener(SystemMembershipListener listener) Unregisters a membership listener
void	setAlertLevel(AlertLevel level) Sets the lowest level of alert that should be delivered to the AlertListeners registered on this AdminDistributedSystem.
void	setRemoteCommand(String remoteCommand) Sets the remote command and formatting this system should use to access and/or manipulate resources on remote machines.
void	start() Starts all managed entities that are not currently running.
void	stop() Stops all managed entities that are currently running.
boolean	waitToBeConnected(long timeout) Wait for up to a given number of milliseconds for the connection to the distributed system to be made.

Method Detail

getId

String getId()

Retrieves the unique id for this system.

getName

String getName()

Retrieves display friendly name for this system. If this administrative VM defined an optional name for its connection to the distributed system, that name will be returned. Otherwise the returned value will be getId().

getRemoteCommand

String getRemoteCommand()

Retrieves the remote command and formatting this system should use to access and/or manipulate resources on remote machines.

setRemoteCommand

void setRemoteCommand(String remoteCommand)

Sets the remote command and formatting this system should use to access and/or manipulate resources on remote machines.

setAlertLevel

void setAlertLevel(AlertLevel level)

Sets the lowest level of alert that should be delivered to the AlertListeners registered on this AdminDistributedSystem. The default level is AlertLevel.WARNING.

getAlertLevel

AlertLevel getAlertLevel()

Returns the lowest level of alerts that should be delivered to the AlertListeners registered on this AdminDistributedSystem.

See Also:

setAlertLevel(com.gemstone.gemfire.admin.AlertLevel)

addAlertListener

void addAlertListener(AlertListener listener)

Registers an AlertListener that will receive all alerts that are at or above the alert level.

removeAlertListener

void removeAlertListener(AlertListener listener)

Unregisters an AlertListener

getMcastAddress

String getMcastAddress()

Retrieves the multicast address in use by this system.

getMcastPort

int getMcastPort()

Retrieves the multicast port in use by this system.

getLocators

String getLocators()

Retrieves comma-delimited list locators to be used if multi-cast port is zero. Format of each locators must be host[port].

isMcastDiscovery

boolean isMcastDiscovery()

Returns true if this system is using multicast instead of locators for discovery

isMcastEnabled

boolean isMcastEnabled()

Returns true if this system has enabled the use of multicast for communications

isRunning

boolean isRunning()

Returns true if any members of this system are currently running.

isConnected

boolean isConnected()

Returns true if this is currently connected to the system.

start

void start()
           throws AdminException

Starts all managed entities that are not currently running.

Throws:

AdminException - If a problem is encountered while starting the managed entities.

stop

void stop()
          throws AdminException

Stops all managed entities that are currently running.

Throws:

AdminException - If a problem is encountered while starting the managed entities.

displayMergedLogs

String displayMergedLogs()

Merges and returns all system logs as a single formatted log.

getLicense

Properties getLicense()

Retrieves the license information for this installation of GemFire.

addDistributionLocator

DistributionLocator addDistributionLocator()

Creates a new DistributionLocator that is ready to configure and start.

It is presumed that the newly-added locator is used to discover members of the distributed system. That is, the host/port of the new locator is appended to the locators attribute of this AdminDistributedSystem.

getDistributionLocators

DistributionLocator[] getDistributionLocators()

Returns array of DistributionLocators administered by this AdminDistributedSystem.

getSystemMemberApplications

SystemMember[] getSystemMemberApplications()
                                           throws AdminException

Retrieves SystemMember instances for every application that is running and currently connection to this system. Note that this list does not include dedicated cache servers.

Throws:

AdminException

getLatestAlert

String getLatestAlert()

Display in readable format the latest Alert in this distributed system.

getGemFireHealth

GemFireHealth getGemFireHealth()

Returns an object for monitoring the health of GemFire.

connect

void connect()

Connects to the distributed system. This method will return immediately after spawning a background thread that connects to the distributed system. As a result, a AdminDistributedSystem can be "connected" to before any members of the system have been started or have been seen. The waitToBeConnected(long) method will wait for the connection to be made.

See Also:

isConnected(), isRunning(), waitToBeConnected(long)

waitToBeConnected

boolean waitToBeConnected(long timeout)
                          throws InterruptedException

Wait for up to a given number of milliseconds for the connection to the distributed system to be made.

Parameters:

timeout - The number of milliseconds to wait for the connection to to be made.

Returns:

Whether or not the connection was made. false, if the method times out

Throws:

InterruptedException - If the thread invoking this method is interrupted while waiting.

IllegalStateException - If connect() has not yet been called.

disconnect

void disconnect()

Disconnects from the distributed system.

getConfig

DistributedSystemConfig getConfig()

Returns this system's configuration .

getLogWriter

LogWriter getLogWriter()

Returns this connection's LogWriter; null if not connected.

addMembershipListener

void addMembershipListener(SystemMembershipListener listener)

Registers a listener that receives callbacks when a member joins or leaves the distributed system.

removeMembershipListener

void removeMembershipListener(SystemMembershipListener listener)

Unregisters a membership listener

See Also:

addMembershipListener(com.gemstone.gemfire.admin.SystemMembershipListener)

addCacheListener

void addCacheListener(SystemMemberCacheListener listener)

Registers a cache event listener. Does nothing if the listener is already registered. The listeners are called in the order they are registered.

Parameters:

listener - the listener to register.

Since:

5.0

removeCacheListener

void removeCacheListener(SystemMemberCacheListener listener)

Unregisters a cache listener. Does nothing if the listener is not registered.

Parameters:

listener - the listener to unregister.

Since:

5.0

addCacheServer

CacheServer addCacheServer()
                           throws AdminException

Creates a new cache server that is ready to configure and start.

Throws:

AdminException

Since:

4.0

getCacheServers

CacheServer[] getCacheServers()
                              throws AdminException

Returns all of the dedicated cache server members of the distributed system. Because they are not managed entities, application VMs that host a server cache are not included in the array.

Throws:

AdminException

Since:

4.0

lookupSystemMember

SystemMember lookupSystemMember(DistributedMember distributedMember)
                                throws AdminException

Returns the administrative SystemMember specified by the DistributedMember.

Parameters:

distributedMember - the distributed member to lookup

Returns:

administrative SystemMember for that distributed member

Throws:

AdminException

Since:

5.0