edu.umass.cs.reconfiguration.reconfigurationutils

Class ConsistentReconfigurableNodeConfig<NodeIDType>

java.lang.Object

edu.umass.cs.reconfiguration.reconfigurationutils.ConsistentNodeConfig<NodeIDType>

edu.umass.cs.reconfiguration.reconfigurationutils.ConsistentReconfigurableNodeConfig<NodeIDType>

Type Parameters:

NodeIDType - * This class is a wrapper around NodeConfig to ensure that it is consistent, i.e., it returns consistent results even if it changes midway. In particular, it does not allow the use of a method like getNodeIDs(). It also has consistent hashing utility methods.

All Implemented Interfaces:

NodeConfig<NodeIDType>, Stringifiable<NodeIDType>, ModifiableActiveConfig<NodeIDType>, ModifiableRCConfig<NodeIDType>, ReconfigurableNodeConfig<NodeIDType>

public class ConsistentReconfigurableNodeConfig<NodeIDType>
extends ConsistentNodeConfig<NodeIDType>
implements ModifiableActiveConfig<NodeIDType>, ModifiableRCConfig<NodeIDType>

Author:

arun

Constructor Summary

Constructors

Constructor and Description
ConsistentReconfigurableNodeConfig(ReconfigurableNodeConfig<NodeIDType> nc)

Method Summary

Modifier and Type	Method and Description
java.net.InetSocketAddress	addActiveReplica(NodeIDType id, java.net.InetSocketAddress sockAddr)
java.net.InetSocketAddress	addReconfigurator(NodeIDType id, java.net.InetSocketAddress sockAddr)
boolean	checkSameGroup(java.util.Set<java.lang.String> names)
java.util.Set<NodeIDType>	getActiveReplicas()
java.util.Set<java.net.InetSocketAddress>	getActiveReplicaSocketAddresses()
java.util.Set<java.net.InetSocketAddress>	getActiveReplicaSocketAddresses(int limit) This method tries to return a limited number of active replica socket addresses that to the extent possible have distinct IPs.
java.util.Map<java.lang.String,java.net.InetSocketAddress>	getAllActiveReplicas()
java.net.InetSocketAddress	getBindSocketAddress(NodeIDType id) Returns the bindable socket address of the public host corresponding to this id.
NodeIDType	getFirstReconfigurator(java.lang.String name)
java.util.Set<NodeIDType>	getIPToActiveReplicaIDs(java.util.ArrayList<java.net.InetAddress> newAddresses, java.util.Set<NodeIDType> oldNodes) This method maps a set of addresses, newAddresses, to a set of nodes such that there is maximal overlap with the specified set of nodes, oldNodes.
java.util.Set<NodeIDType>	getNodeIDs()
java.util.Set<NodeIDType>	getNodeIDs(java.util.Set<java.lang.String> newActives)
java.util.ArrayList<java.net.InetAddress>	getNodeIPs(java.util.Set<NodeIDType> nodeIDs) Consistent coz it always consults nodeConfig.
java.net.InetSocketAddress	getNodeSocketAddress(NodeIDType id) Returns the socket address of the public host corresponding to this id.
java.util.Set<java.net.InetSocketAddress>	getRandomActiveReplica()
NodeIDType	getReconfiguratorHash(java.lang.String name) Deprecated.
java.util.Set<NodeIDType>	getReconfigurators()
java.util.Set<java.net.InetSocketAddress>	getReconfiguratorsAsAddresses(java.lang.String name)
java.util.Set<NodeIDType>	getReplicatedActives(java.lang.String name)
java.util.ArrayList<java.net.InetAddress>	getReplicatedActivesIPs(java.lang.String name)
java.util.Set<NodeIDType>	getReplicatedReconfigurators(java.lang.String name)
ReconfigurableNodeConfig<NodeIDType>	getUnderlyingNodeConfig() This method should not be used.
java.util.Set<NodeIDType>	getValuesFromJSONArray(org.json.JSONArray array)
java.util.Set<NodeIDType>	getValuesFromStringSet(java.util.Set<java.lang.String> strNodes) Converts a set of string node ids using valueOf.
long	getVersion() Unused.
java.net.InetSocketAddress	removeActiveReplica(NodeIDType id)
boolean	removeActivesSlatedForRemoval()
java.net.InetSocketAddress	removeReconfigurator(NodeIDType id)
boolean	removeReconfiguratorsSlatedForRemoval()
java.net.InetSocketAddress	slateForRemovalActive(NodeIDType id)
java.net.InetSocketAddress	slateForRemovalReconfigurator(NodeIDType id)
static java.util.Collection<java.util.Set<java.lang.String>>	splitIntoRCGroups(java.util.Set<java.lang.String> names, java.util.Set<?> reconfigurators) A utility method to split a collection of names into batches wherein names in each batch map to the same reconfigurator group.
java.lang.String	toString()

Methods inherited from class edu.umass.cs.reconfiguration.reconfigurationutils.ConsistentNodeConfig

getBindAddress, getNodeAddress, getNodePort, getReplicatedServers, nodeExists, valueOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.umass.cs.reconfiguration.interfaces.ModifiableActiveConfig

getActiveReplicasMap

Methods inherited from interface edu.umass.cs.reconfiguration.interfaces.ReconfigurableNodeConfig

getActiveReplicasReadOnly, getReconfiguratorsReadOnly

Methods inherited from interface edu.umass.cs.nio.interfaces.NodeConfig

getBindAddress, getNodeAddress, getNodePort, nodeExists

Methods inherited from interface edu.umass.cs.nio.interfaces.Stringifiable

valueOf

Constructor Detail

ConsistentReconfigurableNodeConfig

public ConsistentReconfigurableNodeConfig(ReconfigurableNodeConfig<NodeIDType> nc)

Parameters:

nc -

Method Detail

getValuesFromStringSet

public java.util.Set<NodeIDType> getValuesFromStringSet(java.util.Set<java.lang.String> strNodes)

Description copied from interface: Stringifiable

Converts a set of string node ids using valueOf.

Specified by:

getValuesFromStringSet in interface Stringifiable<NodeIDType>

Overrides:

getValuesFromStringSet in class ConsistentNodeConfig<NodeIDType>

Returns:

Returns an ObjectType set constructed from a String set.

getValuesFromJSONArray

public java.util.Set<NodeIDType> getValuesFromJSONArray(org.json.JSONArray array)
                                                 throws org.json.JSONException

Specified by:

getValuesFromJSONArray in interface Stringifiable<NodeIDType>

Overrides:

getValuesFromJSONArray in class ConsistentNodeConfig<NodeIDType>

Returns:

Returns an ObjectType set constructed from a JSONObject array.

Throws:

org.json.JSONException

getNodeIDs

public java.util.Set<NodeIDType> getNodeIDs()

Specified by:

getNodeIDs in interface NodeConfig<NodeIDType>

Overrides:

getNodeIDs in class ConsistentNodeConfig<NodeIDType>

Returns:

Set of all node IDs. Avoid using this method or at least avoid reusing the result of this method if the underlying set of nodes can change.

getActiveReplicas

public java.util.Set<NodeIDType> getActiveReplicas()

Specified by:

getActiveReplicas in interface ReconfigurableNodeConfig<NodeIDType>

Returns:

Set of all active replicas.

getActiveReplicaSocketAddresses

public java.util.Set<java.net.InetSocketAddress> getActiveReplicaSocketAddresses()

Returns:

Socket addresses of active replicas. Used by reconfigurator to respond to broadcast queries.

getActiveReplicaSocketAddresses

public java.util.Set<java.net.InetSocketAddress> getActiveReplicaSocketAddresses(int limit)

This method tries to return a limited number of active replica socket addresses that to the extent possible have distinct IPs. The socket addresses are a randomly chosen subset of size up to limit from the set of all active replicas.

Parameters:

limit -

Returns:

Socket addresses of active replicas. Used by reconfigurator to respond to broadcast queries.

getReconfigurators

public java.util.Set<NodeIDType> getReconfigurators()

Specified by:

getReconfigurators in interface ReconfigurableNodeConfig<NodeIDType>

Returns:

Set of all reconfigurators.

getNodeIPs

public java.util.ArrayList<java.net.InetAddress> getNodeIPs(java.util.Set<NodeIDType> nodeIDs)

Consistent coz it always consults nodeConfig.

Parameters:

nodeIDs -

Returns:

Array of IP addresses corresponding to nodeIDs.

getReplicatedReconfigurators

public java.util.Set<NodeIDType> getReplicatedReconfigurators(java.lang.String name)

Parameters:

name -

Returns:

Set of consecutive reconfigurators to which name hashes on the consistent hash ring.

getReconfiguratorsAsAddresses

public java.util.Set<java.net.InetSocketAddress> getReconfiguratorsAsAddresses(java.lang.String name)

Parameters:

name -

Returns:

Reconfigurator addresses responsible for name.

getFirstReconfigurator

public NodeIDType getFirstReconfigurator(java.lang.String name)

Parameters:

name -

Returns:

First reconfigurator to which name hashes on the consistent hash ring.

getReconfiguratorHash

@Deprecated
public NodeIDType getReconfiguratorHash(java.lang.String name)

Deprecated.

Returns the hash for this name.

Parameters:

name -

Returns:

Returns the node id to which name consistent-hashes.

getReplicatedActives

public java.util.Set<NodeIDType> getReplicatedActives(java.lang.String name)

Parameters:

name -

Returns:

Set of active replica nodes to which name hashes on the consistent hash ring of all active replica nodes.

getReplicatedActivesIPs

public java.util.ArrayList<java.net.InetAddress> getReplicatedActivesIPs(java.lang.String name)

Parameters:

name -

Returns:

Set of active replica IPs to which name hashes on the consistent hash ring of all active replica nodes.

getRandomActiveReplica

public java.util.Set<java.net.InetSocketAddress> getRandomActiveReplica()

Returns:

Random active replica address.

getIPToActiveReplicaIDs

public java.util.Set<NodeIDType> getIPToActiveReplicaIDs(java.util.ArrayList<java.net.InetAddress> newAddresses,
                                                         java.util.Set<NodeIDType> oldNodes)

This method maps a set of addresses, newAddresses, to a set of nodes such that there is maximal overlap with the specified set of nodes, oldNodes. It is somewhat nontrivial only because there is a many-to-one mapping from nodes to addresses, so a simple reverse lookup is not meaningful.

Parameters:

newAddresses -

oldNodes -

Returns:

Set of active replica IPs corresponding to newAddresses that have high overlap with the set of old active replica nodes oldNodes.

getUnderlyingNodeConfig

public ReconfigurableNodeConfig<NodeIDType> getUnderlyingNodeConfig()

This method should not be used. Reconfigurator uses this at exactly one place, namely, to encapsulate itself inside ActiveReplica so as to be itself reconfigurable.

Returns:

Underlying node config object.

addReconfigurator

public java.net.InetSocketAddress addReconfigurator(NodeIDType id,
                                                    java.net.InetSocketAddress sockAddr)

Specified by:

addReconfigurator in interface ModifiableRCConfig<NodeIDType>

Returns:

Socket address of previous mapping if any. FIXME: We really shouldn't be allowing remapping via an add method.

getNodeSocketAddress

public java.net.InetSocketAddress getNodeSocketAddress(NodeIDType id)

Returns the socket address of the public host corresponding to this id.

Overrides:

getNodeSocketAddress in class ConsistentNodeConfig<NodeIDType>

Parameters:

id -

Returns:

Socket address corresponding to node id.

getBindSocketAddress

public java.net.InetSocketAddress getBindSocketAddress(NodeIDType id)

Returns the bindable socket address of the public host corresponding to this id. This code be a private address in the case of where we are inside a NAT.

Parameters:

id -

Returns:

Bind socket address.

removeReconfigurator

public java.net.InetSocketAddress removeReconfigurator(NodeIDType id)

Specified by:

removeReconfigurator in interface ModifiableRCConfig<NodeIDType>

Returns:

Socket address to which id was mapped.

splitIntoRCGroups

public static java.util.Collection<java.util.Set<java.lang.String>> splitIntoRCGroups(java.util.Set<java.lang.String> names,
                                                                                      java.util.Set<?> reconfigurators)

A utility method to split a collection of names into batches wherein names in each batch map to the same reconfigurator group. The set of reconfigurators can be specified either as a NodeIDType or a String set but not as an InetSocketAddress set (unless NodeIDType is InetSocketAddress).

Parameters:

names -

reconfigurators -

Returns:

A set of batches of names wherein names in each batch map to the same reconfigurator group.

checkSameGroup

public boolean checkSameGroup(java.util.Set<java.lang.String> names)

Parameters:

names -

Returns:

True if all names map to the same reconfigurator group.

slateForRemovalReconfigurator

public java.net.InetSocketAddress slateForRemovalReconfigurator(NodeIDType id)

Parameters:

id -

Returns:

IP address of id being slated for removal.

slateForRemovalActive

public java.net.InetSocketAddress slateForRemovalActive(NodeIDType id)

Parameters:

id -

Returns:

IP address of id being slated for removal.

removeReconfiguratorsSlatedForRemoval

public boolean removeReconfiguratorsSlatedForRemoval()

Returns:

True if all nodes slated for removal have been successfully removed.

removeActivesSlatedForRemoval

public boolean removeActivesSlatedForRemoval()

Returns:

True if all nodes slated for removal have been successfully removed.

addActiveReplica

public java.net.InetSocketAddress addActiveReplica(NodeIDType id,
                                                   java.net.InetSocketAddress sockAddr)

Specified by:

addActiveReplica in interface ModifiableActiveConfig<NodeIDType>

Returns:

Socket address previously mapped to this id. But we really should not allow mappings to be changed via an add method.

removeActiveReplica

public java.net.InetSocketAddress removeActiveReplica(NodeIDType id)

Specified by:

removeActiveReplica in interface ModifiableActiveConfig<NodeIDType>

Returns:

Socket address to which id was mapped.

getVersion

public long getVersion()

Description copied from interface: ModifiableActiveConfig

Unused.

Specified by:

getVersion in interface ModifiableActiveConfig<NodeIDType>

Returns:

Version number of node config.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAllActiveReplicas

public java.util.Map<java.lang.String,java.net.InetSocketAddress> getAllActiveReplicas()

Returns:

Map of all active replica names and addresses.

getNodeIDs

public java.util.Set<NodeIDType> getNodeIDs(java.util.Set<java.lang.String> newActives)

Parameters:

newActives -

Returns:

Set of node IDs from a string set.