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

Method Detail

getId

java.lang.String getId()

Deprecated.

Retrieves the unique id for this system.

getName

java.lang.String getName()

Deprecated.

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

java.lang.String getRemoteCommand()

Deprecated.

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

setRemoteCommand

void setRemoteCommand(java.lang.String remoteCommand)

Deprecated.

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

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.

getGemFireHealth

connect

void connect()

Deprecated.

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.

revokePersistentMember

Indicate to the distributed system that persistent files have been lost. When a member recovers
from a set of persistent files, it will wait for other members that were also persisting the
same region to start up. If the persistent files for those other members were lost, this method
can be used to tell the remaining members to stop waiting for the lost data.

revokePersistentMember

Indicate to the distributed system that persistent files have been lost. When a member recovers
from a set of persistent files, it will wait for other members that were also persisting the
same region to start up. If the persistent files for those other members were lost, this method
can be used to tell the remaining members to stop waiting for the lost data.

shutDownAllMembers

Shuts down all the members of the distributed system with a cache that the admin member is
connected to, excluding the stand-alone locators. Calling this method will ensure that regions
with the 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);

shutDownAllMembers

Shuts down all the members of the distributed system with a cache that the admin member is
connected to, excluding the stand-alone locators. Calling this method will ensure that regions
with the 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.

Parameters:

timeout - The amount of time to wait (in milliseconds) for the shutdown all to complete.

Returns:

The set of members that were shutdown, or null if the timeout is exceeded.

backupAllMembers

Incrementally backup the persistent files for all of the members of the distributed system that
the admin member is connected to. Only new operation log files since the previous backup will
be copied during this backup. The generated restore script will reference and copy operation
log files from the previous backup.

Parameters:

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.

Returns:

The status of the backup, which includes the set of members that were backed up and the
set of members that were known to be offline at the time of backup.