com.sleepycat.je.rep.arbiter

Class ArbiterConfig

java.lang.Object

com.sleepycat.je.rep.arbiter.ArbiterMutableConfig

com.sleepycat.je.rep.arbiter.ArbiterConfig

All Implemented Interfaces:

java.lang.Cloneable

public class ArbiterConfig
extends ArbiterMutableConfig
implements java.lang.Cloneable

The configuration parameters for an Arbiter.

See Also:

Arbiter.Arbiter(ArbiterConfig)

Constructor Summary

Constructors

Constructor and Description
ArbiterConfig() Arbiter configuration.
ArbiterConfig(java.util.Properties props) Arbiter configuration.

Method Summary

Modifier and Type	Method and Description
ArbiterConfig	clone()
java.lang.String	getArbiterHome() Gets the Arbiter home directory.
java.lang.String	getGroupName() Gets the name associated with the replication group.
int	getHeartbeatInterval() Gets the heartbeat interval in milliseconds.
java.util.logging.Handler	getLoggingHandler() Returns the custom java.util.logging.Handler specified by the application.
java.lang.String	getNodeHostPort() Returns the hostname and port associated with this node.
java.lang.String	getNodeName() Returns the unique name associated with this Arbiter.
long	getUnknownStateTimeout(java.util.concurrent.TimeUnit unit) Returns the Unknown state timeout.
void	setArbiterHome(java.lang.String arbiterHome) Sets the Arbiter Home directory
ArbiterConfig	setConfigParam(java.lang.String paramName, java.lang.String value) Documentation inherited from ArbiterMutableConfig.setConfigParam.
ArbiterConfig	setGroupName(java.lang.String groupName) Sets the name for the replication group.
ArbiterConfig	setHeartbeatInterval(int millis) Sets the heartbeat interval.
ArbiterConfig	setLoggingHandler(java.util.logging.Handler handler)
ArbiterConfig	setNodeHostPort(java.lang.String hostPort) Sets the hostname and port associated with this arbiter.
ArbiterConfig	setNodeName(java.lang.String nodeName) Sets the name to be associated with this Arbiter.
ArbiterConfig	setUnknownStateTimeout(long timeout, java.util.concurrent.TimeUnit unit) Time to wait for the discovery of the Master during the instantiation of the Arbiter.
java.lang.String	toString() Display configuration values.

Methods inherited from class com.sleepycat.je.rep.arbiter.ArbiterMutableConfig

copy, getConsoleLoggingLevel, getFileLoggingLevel, getHelperHosts, getProps, setConsoleLoggingLevel, setFileLoggingLevel, setHelperHosts

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArbiterConfig

public ArbiterConfig()

Arbiter configuration.

ArbiterConfig

public ArbiterConfig(java.util.Properties props)

Arbiter configuration.

Parameters:

props - to initialize configuration object.

Method Detail

getArbiterHome

public java.lang.String getArbiterHome()

Gets the Arbiter home directory.

Returns:

Path of the Arbiter home directory.

setArbiterHome

public void setArbiterHome(java.lang.String arbiterHome)

Sets the Arbiter Home directory

Parameters:

arbiterHome - Path of the Arbiter home directory.

setNodeName

public ArbiterConfig setNodeName(java.lang.String nodeName)
                          throws java.lang.IllegalArgumentException

Sets the name to be associated with this Arbiter. It must be unique within the group. When the Arbiter is instantiated and joins the replication group, a check is done to ensure that the name is unique, and a RestartRequiredException is thrown if it is not.

Parameters:

nodeName - the name of this arbiter.

Throws:

java.lang.IllegalArgumentException

getNodeName

public java.lang.String getNodeName()

Returns the unique name associated with this Arbiter.

Returns:

the Arbiter name

setGroupName

public ArbiterConfig setGroupName(java.lang.String groupName)
                           throws java.lang.IllegalArgumentException

Sets the name for the replication group. The name must be made up of just alpha numeric characters and must not be zero length.

Parameters:

groupName - the alpha numeric string representing the name.

Throws:

java.lang.IllegalArgumentException - if the string name is not valid.

getGroupName

public java.lang.String getGroupName()

Gets the name associated with the replication group.

Returns:

the name of this replication group.

setNodeHostPort

public ArbiterConfig setNodeHostPort(java.lang.String hostPort)

Sets the hostname and port associated with this arbiter. The hostname and port combination are denoted by a string of the form:

  hostname[:port]
 

The port must be outside the range of "Well Known Ports" (zero through 1023).

Parameters:

hostPort - the string containing the hostname and port as above.

getNodeHostPort

public java.lang.String getNodeHostPort()

Returns the hostname and port associated with this node. The hostname and port combination are denoted by a string of the form:

  hostname:port
 

Returns:

the hostname and port string of this Arbiter.

setUnknownStateTimeout

public ArbiterConfig setUnknownStateTimeout(long timeout,
                                            java.util.concurrent.TimeUnit unit)
                                     throws java.lang.IllegalArgumentException

Time to wait for the discovery of the Master during the instantiation of the Arbiter. If no Master is found with in the timeout period, the Arbiter constructor return with the Arbiter in the UNKNOWN state.

Parameters:

timeout - The unknown state timeout. A value of 0 turns off Unknown state timeouts. The creation of the Arbiter will wait until a Master is found.

unit - the TimeUnit of the timeout value. May be null only if timeout is zero.

Returns:

this

Throws:

java.lang.IllegalArgumentException - If the value of timeout is negative

getUnknownStateTimeout

public long getUnknownStateTimeout(java.util.concurrent.TimeUnit unit)

Returns the Unknown state timeout.

A value of 0 means Unknown state timeouts are not configured.

Parameters:

unit - the TimeUnit of the returned value. May not be null.

Returns:

The transaction timeout.

setHeartbeatInterval

public ArbiterConfig setHeartbeatInterval(int millis)

Sets the heartbeat interval.

Parameters:

millis - Interval in milliseconds.

Returns:

this

getHeartbeatInterval

public int getHeartbeatInterval()

Gets the heartbeat interval in milliseconds.

Returns:

Heartbeat interval.

setConfigParam

public ArbiterConfig setConfigParam(java.lang.String paramName,
                                    java.lang.String value)
                             throws java.lang.IllegalArgumentException

Documentation inherited from ArbiterMutableConfig.setConfigParam.

Throws:

java.lang.IllegalArgumentException

clone

public ArbiterConfig clone()

Overrides:

clone in class ArbiterMutableConfig

setLoggingHandler

public ArbiterConfig setLoggingHandler(java.util.logging.Handler handler)

getLoggingHandler

public java.util.logging.Handler getLoggingHandler()

Returns the custom java.util.logging.Handler specified by the application.

toString

public java.lang.String toString()

Display configuration values.

Overrides:

toString in class ArbiterMutableConfig