com.gemstone.gemfire.management
package insteadpublic interface AdminDistributedSystem
DistributedSystem
that represents a connection to a GemFire
distributed system.AdminDistributedSystemFactory
Modifier and Type | Method and Description |
---|---|
void |
addAlertListener(AlertListener listener)
Deprecated.
Registers an
AlertListener that will receive all
alerts that are at or above the alert
level. |
void |
addCacheListener(SystemMemberCacheListener listener)
Deprecated.
Registers a cache event listener.
|
CacheServer |
addCacheServer()
Deprecated.
as of 5.7 use
addCacheVm() instead. |
CacheVm |
addCacheVm()
Deprecated.
|
DistributionLocator |
addDistributionLocator()
Deprecated.
|
void |
addMembershipListener(SystemMembershipListener listener)
Deprecated.
Registers a listener that receives callbacks when a member joins
or leaves the distributed system.
|
BackupStatus |
backupAllMembers(File targetDir)
Deprecated.
Backup the persistent files for all of the members of the distributed
system that the admin member is connected to.
|
BackupStatus |
backupAllMembers(File targetDir,
File baselineDir)
Deprecated.
Incrementally backup the persistent files for all of the members of the distributed
system that the admin member is connected to.
|
Map<DistributedMember,Set<PersistentID>> |
compactAllDiskStores()
Deprecated.
Compact the persistent files for all of the members of the distributed
system that the admin member connected to.
|
void |
connect()
Deprecated.
Connects to the distributed system.
|
void |
disconnect()
Deprecated.
Disconnects from the distributed system.
|
String |
displayMergedLogs()
Deprecated.
Merges and returns all system logs as a single formatted log.
|
AlertLevel |
getAlertLevel()
Deprecated.
Returns the lowest level of alerts that should be delivered to
the
AlertListener s registered on this
AdminDistributedSystem . |
String |
getAlertLevelAsString()
Deprecated.
Returns the lowest level of alerts that should be delivered to
the
AlertListener s registered on this
AdminDistributedSystem . |
CacheServer[] |
getCacheServers()
Deprecated.
as of 5.7 use
getCacheVms() instead. |
CacheServer[] |
getCacheServers(String durableClientId)
Deprecated.
Returns all the cache server members of the distributed system which are
hosting a client queue for the particular durable-client having the given
durableClientId
|
CacheVm[] |
getCacheVms()
Deprecated.
Returns all of the dedicated cache server vm members of the
distributed system.
|
DistributedSystemConfig |
getConfig()
Deprecated.
Returns this system's configuration .
|
DistributionLocator[] |
getDistributionLocators()
Deprecated.
Returns array of
DistributionLocator s administered
by this AdminDistributedSystem . |
GemFireHealth |
getGemFireHealth()
Deprecated.
Returns an object for monitoring the health of GemFire.
|
String |
getId()
Deprecated.
Retrieves the unique id for this system.
|
String |
getLatestAlert()
Deprecated.
Display in readable format the latest Alert in this distributed system.
|
Properties |
getLicense()
Deprecated.
Retrieves the license information for this installation of GemFire.
|
String |
getLocators()
Deprecated.
Retrieves comma-delimited list locators to be used if multi-cast port is
zero.
|
String |
getMcastAddress()
Deprecated.
Retrieves the multicast address in use by this system.
|
int |
getMcastPort()
Deprecated.
Retrieves the multicast port in use by this system.
|
Set<PersistentID> |
getMissingPersistentMembers()
Deprecated.
Retrieve the set of persistent files that the existing members are waiting
for.
|
String |
getName()
Deprecated.
Retrieves display friendly name for this system.
|
String |
getRemoteCommand()
Deprecated.
Retrieves the remote command and formatting this system should use to
access and/or manipulate resources on remote machines.
|
SystemMember[] |
getSystemMemberApplications()
Deprecated.
Retrieves SystemMember instances for every
application that is running and currently connection to this
system.
|
boolean |
isConnected()
Deprecated.
Returns
true if this is currently connected to the
system. |
boolean |
isMcastDiscovery()
Deprecated.
Returns true if this system is using multicast instead of locators for discovery
|
boolean |
isMcastEnabled()
Deprecated.
Returns true if this system has enabled the use of multicast for communications
|
boolean |
isRunning()
Deprecated.
Returns true if any members of this system are currently running.
|
SystemMember |
lookupSystemMember(DistributedMember distributedMember)
Deprecated.
Returns the administrative SystemMember specified by the
DistributedMember . |
void |
removeAlertListener(AlertListener listener)
Deprecated.
Unregisters an
AlertListener |
void |
removeCacheListener(SystemMemberCacheListener listener)
Deprecated.
Unregisters a cache listener.
|
void |
removeMembershipListener(SystemMembershipListener listener)
Deprecated.
Unregisters a membership listener
|
void |
revokePersistentMember(InetAddress host,
String directory)
Deprecated.
use
revokePersistentMember(UUID) instead |
void |
revokePersistentMember(UUID diskStoreID)
Deprecated.
Indicate to the distributed system that persistent files have been lost.
|
void |
setAlertLevel(AlertLevel level)
Deprecated.
Sets the lowest level of alert that should be delivered to the
AlertListener s registered on this
AdminDistributedSystem . |
void |
setAlertLevelAsString(String level)
Deprecated.
Sets the lowest level of alert that should be delivered to the
AlertListener s registered on this
AdminDistributedSystem . |
void |
setRemoteCommand(String remoteCommand)
Deprecated.
Sets the remote command and formatting this system should use to access
and/or manipulate resources on remote machines.
|
Set<DistributedMember> |
shutDownAllMembers()
Deprecated.
Shuts down all the members of the distributed system with a cache that the admin
member is connected to, excluding the stand-alone locators.
|
Set<DistributedMember> |
shutDownAllMembers(long timeout)
Deprecated.
Shuts down all the members of the distributed system with a cache that the
admin member is connected to, excluding the stand-alone locators.
|
void |
start()
Deprecated.
Starts all managed entities that are not currently running.
|
void |
stop()
Deprecated.
Stops all managed entities that are currently running.
|
boolean |
waitToBeConnected(long timeout)
Deprecated.
Wait for up to a given number of milliseconds for the connection
to the distributed system to be made.
|
String getId()
String getName()
getId()
.String getRemoteCommand()
void setRemoteCommand(String remoteCommand)
void setAlertLevel(AlertLevel level)
AlertListener
s registered on this
AdminDistributedSystem
. The default level is AlertLevel.WARNING
.AlertLevel getAlertLevel()
AlertListener
s registered on this
AdminDistributedSystem
.void setAlertLevelAsString(String level)
AlertListener
s registered on this
AdminDistributedSystem
. The default level is AlertLevel.WARNING
.String getAlertLevelAsString()
AlertListener
s registered on this
AdminDistributedSystem
.void addAlertListener(AlertListener listener)
AlertListener
that will receive all
alerts that are at or above the alert
level.void removeAlertListener(AlertListener listener)
AlertListener
String getMcastAddress()
int getMcastPort()
String getLocators()
boolean isMcastDiscovery()
boolean isMcastEnabled()
boolean isRunning()
boolean isConnected()
true
if this is currently connected to the
system.void start() throws AdminException
AdminException
- If a problem is encountered while starting the managed
entities.void stop() throws AdminException
AdminException
- If a problem is encountered while starting the managed
entities.String displayMergedLogs()
Properties getLicense()
DistributionLocator addDistributionLocator()
DistributionLocator[] getDistributionLocators()
DistributionLocator
s administered
by this AdminDistributedSystem
.SystemMember[] getSystemMemberApplications() throws AdminException
AdminException
String getLatestAlert()
GemFireHealth getGemFireHealth()
void connect()
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.isConnected()
,
isRunning()
,
waitToBeConnected(long)
boolean waitToBeConnected(long timeout) throws InterruptedException
timeout
- The number of milliseconds to wait for the connection to
to be made.false
, if the method times outInterruptedException
- If the thread invoking this method is interrupted while
waiting.IllegalStateException
- If connect()
has not yet been called.void disconnect()
DistributedSystemConfig getConfig()
void addMembershipListener(SystemMembershipListener listener)
void removeMembershipListener(SystemMembershipListener listener)
void addCacheListener(SystemMemberCacheListener listener)
listener
- the listener to register.void removeCacheListener(SystemMemberCacheListener listener)
listener
- the listener to unregister.@Deprecated CacheServer addCacheServer() throws AdminException
addCacheVm()
instead.AdminException
@Deprecated CacheServer[] getCacheServers() throws AdminException
getCacheVms()
instead.AdminException
CacheServer[] getCacheServers(String durableClientId) throws AdminException
durableClientId
- -
durable-id of the clientAdminException
CacheVm addCacheVm() throws AdminException
AdminException
CacheVm[] getCacheVms() throws AdminException
AdminException
SystemMember lookupSystemMember(DistributedMember distributedMember) throws AdminException
DistributedMember
.distributedMember
- the distributed member to lookupAdminException
void revokePersistentMember(InetAddress host, String directory) throws AdminException
revokePersistentMember(UUID)
insteadhost
- The host of the member whose files were lost.directory
- The directory where those files resided.RevokeFailedException
- if the persistent files are in fact
currently running on one of the members of the distributed system.AdminException
void revokePersistentMember(UUID diskStoreID) throws AdminException
diskStoreID
- The unique id of the disk store which you are revoking. The unique
id can be discovered from getMissingPersistentMembers()
RevokeFailedException
- if the persistent files are in fact
currently running on one of the members of the distributed system.AdminException
Set<PersistentID> getMissingPersistentMembers() throws AdminException
revokePersistentMember(InetAddress, String)
AdminException
Set<DistributedMember> shutDownAllMembers() throws AdminException
DataPolicy.PERSISTENT_PARTITION
to
be shutdown in a way which allows for a faster recovery when the members are
restarted.
Killing individual members can lead to inconsistencies in the members persistent
data, which gemfire repairs on startup. Calling shutDownAllMembers makes sure
that the persistent files are consistent on shutdown, which makes recovery faster.
This is equivalent to calling shutDownAllMembers(0);AdminException
Set<DistributedMember> shutDownAllMembers(long timeout) throws AdminException
DataPolicy.PERSISTENT_PARTITION
to be shutdown in a way which
allows for a faster recovery when the members are restarted.
Killing individual members can lead to inconsistencies in the members
persistent data, which gemfire repairs on startup. Calling
shutDownAllMembers makes sure that the persistent files are consistent on
shutdown, which makes recovery faster.timeout
- The amount of time to wait (in milliseconds) for the shutdown all to
complete.AdminException
BackupStatus backupAllMembers(File targetDir) throws AdminException
targetDir
- The directory where each member's backup should be placed.AdminException
BackupStatus backupAllMembers(File targetDir, File baselineDir) throws AdminException
targetDir
- The directory where each member's backup should be placed.baselineDir
- The directory of a previous backup.
If this parameter is null or the directory does not exist (on a member by member basis)
a full backup will be performed for the member.AdminException
Map<DistributedMember,Set<PersistentID>> compactAllDiskStores() throws AdminException
AdminException
Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.