GemFire 5.8

com.gemstone.gemfire.admin
Interface DistributionLocatorConfig

All Superinterfaces:
Cloneable, ManagedEntityConfig

public interface DistributionLocatorConfig
extends ManagedEntityConfig

Describes the configuration of a DistributionLocator managed by the GemFire administration APIs.

A DistributionLocatorConfig can be modified using a number of mutator methods until the DistributionLocator configured by this object is started. After that, attempts to modify most attributes in the DistributionLocatorConfig will result in an IllegalStateException being thrown. If you wish to use the same DistributionLocatorConfig to configure another DistributionLocators, a copy of the DistributionLocatorConfig object can be made by invoking the Object.clone() method.

Since:
4.0
See Also:
AdminDistributedSystem.addDistributionLocator(), Locator

Method Summary
 String getBindAddress()
          Returns the address to which the distribution locator's port is (or will be) bound.
 Properties getDistributedSystemProperties()
          Retrieves the properties used to configure the locator's DistributedSystem.
 int getPort()
          Returns the port on which ths distribution locator listens for members to connect.
 void setBindAddress(String bindAddress)
          Sets the address to which the distribution locator's port is (or will be) bound.
 void setDistributedSystemProperties(Properties props)
          Sets the properties used to configure the locator's DistributedSystem.
 void setPort(int port)
          Sets the port on which the distribution locator listens for members to connect.
 
Methods inherited from interface com.gemstone.gemfire.admin.ManagedEntityConfig
clone, getHost, getProductDirectory, getRemoteCommand, getWorkingDirectory, setHost, setProductDirectory, setRemoteCommand, setWorkingDirectory, validate
 

Method Detail

getPort

int getPort()
Returns the port on which ths distribution locator listens for members to connect. There is no default locator port, so a non-default port must be specified.


setPort

void setPort(int port)
Sets the port on which the distribution locator listens for members to connect.


getBindAddress

String getBindAddress()
Returns the address to which the distribution locator's port is (or will be) bound. By default, the bind address is null meaning that the port will be bound to all network addresses on the host.


setBindAddress

void setBindAddress(String bindAddress)
Sets the address to which the distribution locator's port is (or will be) bound.


setDistributedSystemProperties

void setDistributedSystemProperties(Properties props)
Sets the properties used to configure the locator's DistributedSystem.

Since:
5.0

getDistributedSystemProperties

Properties getDistributedSystemProperties()
Retrieves the properties used to configure the locator's DistributedSystem.

Since:
5.0

GemFire 5.8

Copyright © 2002-2008 GemStone Systems, Inc. All Rights Reserved.