com.gemstone.gemfire.admin
Interface ManagedEntityConfig

All Superinterfaces:

Cloneable

All Known Subinterfaces:

CacheServerConfig, CacheVmConfig, DistributionLocatorConfig

public interface ManagedEntityConfig
extends Cloneable

Common configuration for all entities that can be managed using the GemFire administration API. Note that once a managed entity has been started, attempts to modify its configuration will cause an IllegalStateException to be thrown.

Since:

4.0

See Also:

ManagedEntity

Method Summary

Object	clone() Returns a new ManagedEntityConfig with the same configuration as this ManagedEntityConfig.
String	getHost() Returns the name of the host on which the managed entity runs or will run.
String	getProductDirectory() Returns the name of the GemFire product directory to use when administering the managed entity.
String	getRemoteCommand() Returns the command prefix used to administer a managed entity that is hosted on a remote machine.
String	getWorkingDirectory() Returns the name of the working directory in which the managed entity runs or will run.
void	setHost(String host) Sets the name of the host on which the managed entity will run.
void	setProductDirectory(String dir) Sets the name of the GemFire product directory to use when administering the managed entity.
void	setRemoteCommand(String remoteCommand) Sets the command prefix used to administer a managed entity that is hosted on a remote machine.
void	setWorkingDirectory(String dir) Sets the name of the working directory in which the managed entity will run.
void	validate() Validates this configuration.

Method Detail

getHost

String getHost()

Returns the name of the host on which the managed entity runs or will run.

setHost

void setHost(String host)

Sets the name of the host on which the managed entity will run.

getWorkingDirectory

String getWorkingDirectory()

Returns the name of the working directory in which the managed entity runs or will run.

setWorkingDirectory

void setWorkingDirectory(String dir)

Sets the name of the working directory in which the managed entity will run.

getProductDirectory

String getProductDirectory()

Returns the name of the GemFire product directory to use when administering the managed entity.

setProductDirectory

void setProductDirectory(String dir)

Sets the name of the GemFire product directory to use when administering the managed entity.

getRemoteCommand

String getRemoteCommand()

Returns the command prefix used to administer a managed entity that is hosted on a remote machine. If the remote command is null (the default value), then the remote command associated with the distributed system will be used.

setRemoteCommand

void setRemoteCommand(String remoteCommand)

Sets the command prefix used to administer a managed entity that is hosted on a remote machine.

validate

void validate()

Validates this configuration.

Throws:

IllegalStateException - If a managed entity cannot be administered using this configuration

clone

Object clone()
             throws CloneNotSupportedException

Returns a new ManagedEntityConfig with the same configuration as this ManagedEntityConfig.

Throws:

CloneNotSupportedException