com.gemstone.gemfire.admin
Interface SystemMember

All Known Subinterfaces:

CacheServer, CacheVm

public interface SystemMember

Administrative interface for monitoring a GemFire system member.

Since:

3.5

Method Summary

SystemMemberCache	getCache() Returns an object that provides admin access to this member's cache.
ConfigurationParameter[]	getConfiguration() Gets the configuration parameters for this member.
DistributedMember	getDistributedMember() Returns the DistributedMember that represents this system member.
AdminDistributedSystem	getDistributedSystem() Gets the AdminDistributedSystem this member belongs to.
String	getHost() Gets host name of the machine this member resides on.
InetAddress	getHostAddress() Gets the host of this member as an java.net.InetAddress.
String	getId() Gets identifying name of this member.
Properties	getLicense() Returns the GemFire license this member is using.
String	getLog() Retrieves the log for this member.
String	getName() Retrieves display friendly name for this member.
String[]	getRoles() Returns the names of the membership roles filled by this member.
StatisticResource[]	getStat(String statisticsTypeName) Retrieves this members statistic resources.
StatisticResource[]	getStats() Retrieves this members statistic resources.
SystemMemberType	getType() Gets the type of SystemMemberType this member is.
String	getVersion() Returns this member's GemFire version information.
boolean	hasCache() Returns whether or not this system member hosts a GemFire Cache.
void	refreshConfig() Refreshes this member's configuration from the member or it's properties
ConfigurationParameter[]	setConfiguration(ConfigurationParameter[] parms) Sets the configuration of this member.

Method Detail

getDistributedSystem

AdminDistributedSystem getDistributedSystem()

Gets the AdminDistributedSystem this member belongs to.

getId

String getId()

Gets identifying name of this member. For applications this is the string form of getDistributedMember(). For cache servers it is a unique cache server string.

getName

String getName()

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

See Also:

DistributedSystem.connect(java.util.Properties), DistributedSystem.getName()

getType

SystemMemberType getType()

Gets the type of SystemMemberType this member is.

getHost

String getHost()

Gets host name of the machine this member resides on.

getHostAddress

InetAddress getHostAddress()

Gets the host of this member as an java.net.InetAddress.

getLog

String getLog()

Retrieves the log for this member.

getLicense

Properties getLicense()

Returns the GemFire license this member is using.

getVersion

String getVersion()

Returns this member's GemFire version information.

getConfiguration

ConfigurationParameter[] getConfiguration()

Gets the configuration parameters for this member.

setConfiguration

ConfigurationParameter[] setConfiguration(ConfigurationParameter[] parms)
                                          throws AdminException

Sets the configuration of this member. The argument is an array of any and all configuration parameters that are to be updated in the member.

The entire array of configuration parameters is then returned.

Parameters:

parms - subset of the configuration parameters to be changed

Returns:

all configuration parameters including those that were changed

Throws:

AdminException - if this fails to make the configuration changes

refreshConfig

void refreshConfig()
                   throws AdminException

Refreshes this member's configuration from the member or it's properties

Throws:

AdminException

getStat

StatisticResource[] getStat(String statisticsTypeName)
                            throws AdminException

Retrieves this members statistic resources. If the member is not running then an empty array is returned.

Parameters:

statisticsTypeName - String ame of the Statistics Type

Returns:

array of runtime statistic resources owned by this member

Throws:

AdminException

Since:

5.7

getStats

StatisticResource[] getStats()
                             throws AdminException

Retrieves this members statistic resources. If the member is not running then an empty array is returned. All Stats are returned

Returns:

array of runtime statistic resources owned by this member

Throws:

AdminException

hasCache

boolean hasCache()
                 throws AdminException

Returns whether or not this system member hosts a GemFire Cache.

Throws:

AdminException

See Also:

getCache()

getCache

SystemMemberCache getCache()
                           throws AdminException

Returns an object that provides admin access to this member's cache. If the member currently has no cache then null is returned.

Throws:

AdminException

getRoles

String[] getRoles()

Returns the names of the membership roles filled by this member.

Returns:

array of string membership role names

Since:

5.0

getDistributedMember

DistributedMember getDistributedMember()

Returns the DistributedMember that represents this system member.

Returns:

DistributedMember instance representing this system member

Since:

5.0