com.sleepycat.je.rep.utilint

Class RepUtils

java.lang.Object

com.sleepycat.je.rep.utilint.RepUtils

public class RepUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepUtils.Clock
static interface	RepUtils.ConsistencyPolicyFormat<T extends ReplicaConsistencyPolicy> ReplicaConsistencyPolicy must be stored as a String for use with ReplicationConfig and je.properties.
static class	RepUtils.ExceptionAwareBlockingQueue<T> Like LinkedBlockingQueue, but provides a pollOrException() method that should be used instead of poll(), so that callers don't have to treat exception cases specially.
static class	RepUtils.ExceptionAwareCountDownLatch Like CountDownLatch, but makes provision in the await for the await, or more specifically the new awaitOrException method to be exited via an exception.

Field Summary

Fields

Modifier and Type	Field and Description
static DataChannel	CHANNEL_EOF_MARKER
static boolean	DEBUG_PRINT_THREAD
static boolean	DEBUG_PRINT_TIME
static TestHook<DataChannelFactory.ConnectOptions>	openSocketChannelHook If not null, called by openSocketChannel with the connect options before opening the socket -- for unit testing.

Constructor Summary

Constructors

Constructor and Description
RepUtils()

Method Summary

Modifier and Type	Method and Description
static void	addConsistencyPolicyFormat(String name, RepUtils.ConsistencyPolicyFormat<?> format) Define a new ConsistencyPolicyFormat.
static Throwable	chainExceptionCause(Throwable newt, Throwable oldt) Chains an old outstanding exception to the tail of a new one, so it's not lost.
static String	exec(String... args) A simple debugging utility used to obtain information about the execution environment that's only available through some system utility, like netstat, or jps, etc.
static String	getPropertyString(ReplicaConsistencyPolicy policy) Converts a policy into a string suitable for use as a property value in a je.properties file or elsewhere.
static ReplicaConsistencyPolicy	getReplicaConsistencyPolicy(String propertyValue) Converts a property string into a policy instance.
static DataChannel	openBlockingChannel(InetSocketAddress addr, DataChannelFactory factory, DataChannelFactory.ConnectOptions connectOpts) Create a Data channel with the designated properties
static SocketChannel	openSocketChannel(InetSocketAddress addr, InetSocketAddress localAddr, DataChannelFactory.ConnectOptions connectOpts) Create a socket channel with the designated properties.
static Properties	populateNetProps(Properties props, File accessPropsFile) Read replication access properties from a property file.
static void	shutdownChannel(DataChannel channel)
static void	shutdownChannel(NamedChannel namedChannel) Forces a shutdown of a blocking channel ignoring any errors that may be encountered in the process.
static String	writeTimesString(StatGroup stats)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG_PRINT_THREAD

public static final boolean DEBUG_PRINT_THREAD

See Also:

Constant Field Values

DEBUG_PRINT_TIME

public static final boolean DEBUG_PRINT_TIME

See Also:

Constant Field Values

CHANNEL_EOF_MARKER

public static final DataChannel CHANNEL_EOF_MARKER

openSocketChannelHook

public static volatile TestHook<DataChannelFactory.ConnectOptions> openSocketChannelHook

If not null, called by openSocketChannel with the connect options before opening the socket -- for unit testing.

Constructor Detail

RepUtils

public RepUtils()

Method Detail

addConsistencyPolicyFormat

public static void addConsistencyPolicyFormat(String name,
                                              RepUtils.ConsistencyPolicyFormat<?> format)

Define a new ConsistencyPolicyFormat. Should only be called outside of this class to add support custom policies for testing. Must be called when the system is quiescent, since the map is unsynchronized.

Parameters:

name - must be the first part of the policy string with a non-letter delimiter following it, or must be the entire policy string.

format - to register.

getPropertyString

public static String getPropertyString(ReplicaConsistencyPolicy policy)
                                throws IllegalArgumentException

Converts a policy into a string suitable for use as a property value in a je.properties file or elsewhere.

Parameters:

policy - the policy being converted.

Returns:

the formatted string representing the policy.

Throws:

IllegalArgumentException - if the specific policy does not have a property value format, via ReplicationConfig(Properties) ctor and setter.

See Also:

getReplicaConsistencyPolicy(String)

getReplicaConsistencyPolicy

public static ReplicaConsistencyPolicy getReplicaConsistencyPolicy(String propertyValue)
                                                            throws IllegalArgumentException

Converts a property string into a policy instance.

Parameters:

propertyValue - the formatted string representing the policy.

Returns:

the policy computed from the string

Throws:

IllegalArgumentException - via ReplicationConfig(Properties) ctor and setter.

shutdownChannel

public static void shutdownChannel(NamedChannel namedChannel)

Forces a shutdown of a blocking channel ignoring any errors that may be encountered in the process.

Parameters:

namedChannel - the channel to be shutdown

shutdownChannel

public static void shutdownChannel(DataChannel channel)

openSocketChannel

public static SocketChannel openSocketChannel(InetSocketAddress addr,
                                              InetSocketAddress localAddr,
                                              DataChannelFactory.ConnectOptions connectOpts)
                                       throws IOException

Create a socket channel with the designated properties. The motivation and use of the localAddr parameter bears some explanation. Explicit specification of the localAddr is not necessary when the two nics are on separate subnets and the routing rules will automatically choose the correct nic. In fact routing rules, could even be used for such communication even when they are on the same subnet, but such configuration can be brittle and hard to maintain. Consider the following illustrative example with two nodes n1, n2, with two nics each labeled 0 and 1. We would like to constrain all HA traffic between n1 and n2 to nics n1(1) and n2(1) leaving the other two nics for application use, e.g. KV RMI requests. If n1 is the master and its ReplicationConfig.NODE_HOST_PORT specified n1(1) it would listen on n1(1) for all HA traffic. n2 (the replica) has two choices for sending traffic over to n2: n2(0) or n2(1), depending on the routing rules that were set up. By binding conections locally (as is done with this change) on the replica to n2(1) we guarantee that the traffic to n1 will go over n2(1), so that connections always have the desired endpoints n2(1) -> n1(1).

Parameters:

addr - the remote endpoint socket address

localAddr - the local address the socket is bound to it may be null

connectOpts - connect options to be applied to the channel

Returns:

the connected channel

Throws:

IOException

openBlockingChannel

public static DataChannel openBlockingChannel(InetSocketAddress addr,
                                              DataChannelFactory factory,
                                              DataChannelFactory.ConnectOptions connectOpts)
                                       throws IOException

Create a Data channel with the designated properties

Parameters:

addr - the remote endpoint socket address

factory - DataChannel factory for channel creation

connectOpts - connect options to be applied to the channel

Returns:

the connected channel

Throws:

IOException

chainExceptionCause

public static Throwable chainExceptionCause(Throwable newt,
                                            Throwable oldt)

Chains an old outstanding exception to the tail of a new one, so it's not lost.

Parameters:

newt - the new throwable

oldt - the old throwable

Returns:

the new throwable extended with the old cause

writeTimesString

public static String writeTimesString(StatGroup stats)

populateNetProps

public static Properties populateNetProps(Properties props,
                                          File accessPropsFile)

Read replication access properties from a property file.

Parameters:

props - a Properties object into which the properties will be stored

accessPropsFile - an abstract File naming a file containing property settings.

Returns:

the input properties object, updated with the property settings found in the file.

Throws:

IllegalArgumentException - if the accessPropsFile contains invalid settings.

exec

public static String exec(String... args)

A simple debugging utility used to obtain information about the execution environment that's only available through some system utility, like netstat, or jps, etc. It's up to the caller to ensure the availability of the utility and ensure that it's on the search path.

Parameters:

args - the arguments to a ProcessBuilder with args[0] being the command and args[1-...] being its args

Returns:

a string denoting the output from the command. Or a string prefixed by the word EXCEPTION, if an exception was encountered, followed by the exception class name and exception message.