edu.umass.cs.nio.nioutils

Class SampleNodeConfig<NodeIDType>

java.lang.Object

edu.umass.cs.nio.nioutils.SampleNodeConfig<NodeIDType>

Type Parameters:

NodeIDType - This class is a simple utility to quickly set up a simple node config object when port numbers can take "don't care" values. It is also especially convenient for a local (single-machine) setup. This class is mainly useful for quick testing.

All Implemented Interfaces:

NodeConfig<NodeIDType>, Stringifiable<NodeIDType>

Direct Known Subclasses:

ReconfigurableSampleNodeConfig

public class SampleNodeConfig<NodeIDType>
extends java.lang.Object
implements NodeConfig<NodeIDType>

Author:

V. Arun

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_START_PORT The default starting port number beyond which nodes automatically get port numbers assigned.

Constructor Summary

Constructors

Constructor and Description
SampleNodeConfig()
SampleNodeConfig(int defaultPort)
SampleNodeConfig(int defaultPort, int startNodeID, int numLocalNodes)

Method Summary

Modifier and Type	Method and Description
void	add(NodeIDType id, java.net.InetAddress IP) Add node with id mapped to IP and an auto-selected port number.
void	addLocal(NodeIDType id)
void	clear()
java.net.InetAddress	getBindAddress(NodeIDType ID)
static java.net.InetAddress	getLocalAddress()
java.net.InetAddress	getNodeAddress(NodeIDType ID)
java.util.Set<NodeIDType>	getNodeIDs()
int	getNodePort(NodeIDType ID) Maps each node ID to a port number.
java.util.Set<NodeIDType>	getNodes()
static int	getPort(int ID)
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.
void	localSetup(int nNodes)
void	localSetup(int startNodeID, int nNodes) The caller can either specify the number of nodes, nNodes, or specify a set of integer node IDs explicitly.
void	localSetup(java.util.Set<NodeIDType> members) Maps each element in members to the local IP address.
boolean	nodeExists(NodeIDType ID)
java.lang.String	toString() Pretty prints this node config information.
NodeIDType	valueOf(java.lang.String nodeAsString) Converts a string representation of a node id into the appropriate node id type.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_START_PORT

public static final int DEFAULT_START_PORT

The default starting port number beyond which nodes automatically get port numbers assigned.

See Also:

Constant Field Values

Constructor Detail

SampleNodeConfig

public SampleNodeConfig(int defaultPort)

Parameters:

defaultPort - Assigns port numbers to nodes starting from defaultPort

SampleNodeConfig

public SampleNodeConfig(int defaultPort,
                        int startNodeID,
                        int numLocalNodes)

Parameters:

defaultPort -

startNodeID -

numLocalNodes -

SampleNodeConfig

public SampleNodeConfig()

Method Detail

localSetup

public void localSetup(java.util.Set<NodeIDType> members)

Maps each element in members to the local IP address.

Parameters:

members -

localSetup

public void localSetup(int startNodeID,
                       int nNodes)

The caller can either specify the number of nodes, nNodes, or specify a set of integer node IDs explicitly. In the former case, nNodes from 0 to nNodes-1 will the node IDs. In the latter case, the explicit set of node IDs will be used.

Parameters:

startNodeID -

nNodes - Number of nodes created.

localSetup

public void localSetup(int nNodes)

Parameters:

nNodes -

nodeExists

public boolean nodeExists(NodeIDType ID)

Specified by:

nodeExists in interface NodeConfig<NodeIDType>

Returns:

Whether the node id exists in the node config.

getNodeIDs

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

Specified by:

getNodeIDs in interface NodeConfig<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.

getNodeAddress

public java.net.InetAddress getNodeAddress(NodeIDType ID)

Specified by:

getNodeAddress in interface NodeConfig<NodeIDType>

Returns:

InetAddress corresponding to id.

getBindAddress

public java.net.InetAddress getBindAddress(NodeIDType ID)

Specified by:

getBindAddress in interface NodeConfig<NodeIDType>

Returns:

Locally bindable InetAddress corresponding to id.

getNodePort

public int getNodePort(NodeIDType ID)

Maps each node ID to a port number. If ID is an integer, then the port number is calculated as defaultport + ID, else it is defaultPort + ID.hashCode(). The port calculated above modulo 65536 is returned in order to ensure legitimate port numbers.

Specified by:

getNodePort in interface NodeConfig<NodeIDType>

Returns:

Port number corresponding to id.

getPort

public static int getPort(int ID)

Parameters:

ID -

Returns:

Port + default offset.

getNodes

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

Returns:

Set of all nodes.

add

public void add(NodeIDType id,
                java.net.InetAddress IP)

Add node with id mapped to IP and an auto-selected port number.

Parameters:

id - Node id.

IP - IP address.

addLocal

public void addLocal(NodeIDType id)

Parameters:

id -

toString

public java.lang.String toString()

Pretty prints this node config information.

Overrides:

toString in class java.lang.Object

valueOf

public NodeIDType valueOf(java.lang.String nodeAsString)

Description copied from interface: Stringifiable

Converts a string representation of a node id into the appropriate node id type. Put another way, this performs the reverse of the toString() method for things that are Stringifiable.

Specified by:

valueOf in interface Stringifiable<NodeIDType>

Returns:

Returns the object constructed from strValue.

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>

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>

Returns:

Returns an ObjectType set constructed from a JSONObject array.

Throws:

org.json.JSONException

getLocalAddress

public static java.net.InetAddress getLocalAddress()

Returns:

Local host address.

clear

public void clear()