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:

Cloneable

public class ArbiterConfig
extends ArbiterMutableConfig
implements Cloneable

The configuration parameters for an Arbiter.

See Also:

Arbiter.Arbiter(ArbiterConfig)

Constructor Summary

Constructors

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

Method Summary

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

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

copy, getConfigParam, getConsoleLoggingLevel, getFileLoggingLevel, getHelperHosts, getProps, isConfigParamSet, 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(Properties props)

Arbiter configuration.

Parameters:

props - to initialize configuration object.

Method Detail

getArbiterHome

public String getArbiterHome()

Gets the Arbiter home directory.

Returns:

Path of the Arbiter home directory.

setArbiterHome

public void setArbiterHome(String arbiterHome)

Sets the Arbiter Home directory

Parameters:

arbiterHome - Path of the Arbiter home directory.

setNodeName

public ArbiterConfig setNodeName(String nodeName)
                          throws 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:

IllegalArgumentException

getNodeName

public String getNodeName()

Returns the unique name associated with this Arbiter.

Returns:

the Arbiter name

setGroupName

public ArbiterConfig setGroupName(String groupName)
                           throws 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:

IllegalArgumentException - if the string name is not valid.

getGroupName

public String getGroupName()

Gets the name associated with the replication group.

Returns:

the name of this replication group.

setNodeHostPort

public ArbiterConfig setNodeHostPort(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 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,
                                            TimeUnit unit)
                                     throws 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:

IllegalArgumentException - If the value of timeout is negative

getUnknownStateTimeout

public long getUnknownStateTimeout(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.

setMessageQueueSize

public ArbiterConfig setMessageQueueSize(int val)

Parameters:

val - size of the queue

Returns:

this

setEnableGroupAcks

public ArbiterConfig setEnableGroupAcks(boolean val)

Parameters:

val - Boolean value.

Returns:

this

getEnableGroupAcks

public boolean getEnableGroupAcks()

Returns:

boolean

getMessageQueueSize

public int getMessageQueueSize()

Returns:

size of the message queue.

setChannelTimeout

public ArbiterConfig setChannelTimeout(long timeout,
                                       TimeUnit unit)
                                throws IllegalArgumentException

Parameters:

timeout - Timeout value

unit - time unit

Returns:

this

Throws:

IllegalArgumentException

getChannelTimeout

public long getChannelTimeout(TimeUnit unit)

Parameters:

unit - TimeUnit

Returns:

timeout value.

setPreHeartbeatTimeout

public ArbiterConfig setPreHeartbeatTimeout(long timeout,
                                            TimeUnit unit)
                                     throws IllegalArgumentException

Parameters:

timeout - Maximum time to wait.

unit - TimeUnit

Returns:

this

Throws:

IllegalArgumentException

getPreHeartbeatTimeout

public long getPreHeartbeatTimeout(TimeUnit unit)

Parameters:

unit - TimeUnit

Returns:

timeout

setFeederTimeout

public ArbiterConfig setFeederTimeout(long timeout,
                                      TimeUnit unit)
                               throws IllegalArgumentException

Parameters:

timeout - Timeout value

unit - time unit

Returns:

this

Throws:

IllegalArgumentException

getFeederTimeout

public long getFeederTimeout(TimeUnit unit)

Parameters:

unit - TimeUnit

Returns:

timeout value.

setReceiveBufferSize

public ArbiterConfig setReceiveBufferSize(int val)

Parameters:

val - size of the buffer

Returns:

this

getReceiveBufferSize

public int getReceiveBufferSize()

Returns:

buffer size.

setStreamOpenTimeout

public ArbiterConfig setStreamOpenTimeout(long timeout,
                                          TimeUnit unit)
                                   throws IllegalArgumentException

Parameters:

timeout - maximum time to wait

unit - TimeUnit

Returns:

this

Throws:

IllegalArgumentException

getStreamOpenTimeout

public long getStreamOpenTimeout(TimeUnit unit)

Parameters:

unit - TimeUnit

Returns:

Timeout value.

getRepNetConfig

public ReplicationNetworkConfig getRepNetConfig()

setRepNetConfig

public ArbiterConfig setRepNetConfig(ReplicationNetworkConfig netConfig)

Parameters:

netConfig - the new ReplicationNetworkConfig to be associated with this MonitorConfig. This must not be null.

Throws:

IllegalArgumentException - if the netConfig is null

setConfigParam

public ArbiterConfig setConfigParam(String paramName,
                                    String value)
                             throws IllegalArgumentException

Documentation inherited from ArbiterMutableConfig.setConfigParam.

Overrides:

setConfigParam in class ArbiterMutableConfig

Parameters:

paramName - the configuration parameter name, one of the String constants in this class

value - The configuration value

Returns:

this

Throws:

IllegalArgumentException - if the paramName or value is invalid.

setRepNetConfigVoid

public void setRepNetConfigVoid(ReplicationNetworkConfig netConfig)

clone

public ArbiterConfig clone()

Overrides:

clone in class ArbiterMutableConfig

setLoggingHandler

public ArbiterConfig setLoggingHandler(Handler handler)

getLoggingHandler

public Handler getLoggingHandler()

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

toString

public String toString()

Display configuration values.

Overrides:

toString in class ArbiterMutableConfig