rice.pastry.rmi
Class RMIPastryNodeFactory

java.lang.Object
  rice.pastry.PastryNodeFactory
      rice.pastry.dist.DistPastryNodeFactory
          rice.pastry.rmi.RMIPastryNodeFactory

public class RMIPastryNodeFactory

extends DistPastryNodeFactory

Pastry node factory for RMI-linked nodes.

Field Summary

static int	DEFAULT_REGISTRY_PORT
static int	NUM_ATTEMPTS
static java.rmi.registry.Registry	rmiRegistry Instance of RMI registry ever-created when using this factory.

Fields inherited from class rice.pastry.dist.DistPastryNodeFactory

PROTOCOL_RMI, PROTOCOL_SOCKET, PROTOCOL_WIRE

Constructor Summary

RMIPastryNodeFactory(NodeIdFactory nf, int p)
Constructor.

Method Summary

NodeHandle	generateNodeHandle(java.net.InetSocketAddress address) Specified by the DistPastryNodeFactory class.
LeafSet	getLeafSet(NodeHandle handle) This method returns the remote leafset of the provided handle to the caller, in a protocol-dependent fashion.
int	getProximity(NodeHandle local, NodeHandle handle) This method determines and returns the proximity of the current local node the provided NodeHandle.
RouteSet[]	getRouteRow(NodeHandle handle, int row) This method returns the remote route row of the provided handle to the caller, in a protocol-dependent fashion.
PastryNode	newNode(NodeHandle bootstrap) Generates a new pastry node with a random NodeId using the bootstrap bootstrap.
PastryNode	newNode(NodeHandle bootstrap, NodeId nodeId) Makes many policy choices and manufactures a new RMIPastryNode.
void	pause(int ms) Pauses the current thread for ms milliseconds.

Methods inherited from class rice.pastry.dist.DistPastryNodeFactory

getFactory, getNodeHandle

Methods inherited from class rice.pastry.PastryNodeFactory

getNearest

Methods inherited from class java.lang.Object

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

Field Detail

NUM_ATTEMPTS

public static int NUM_ATTEMPTS

DEFAULT_REGISTRY_PORT

public static int DEFAULT_REGISTRY_PORT

rmiRegistry

public static java.rmi.registry.Registry rmiRegistry

Instance of RMI registry ever-created when using this factory.

Constructor Detail

RMIPastryNodeFactory

public RMIPastryNodeFactory(NodeIdFactory nf,
                            int p)

Constructor.

Parameters:

p - RMI registry port.

Method Detail

generateNodeHandle

public NodeHandle generateNodeHandle(java.net.InetSocketAddress address)

Specified by the DistPastryNodeFactory class. The first looks on the local machine (at the port p) to determine if there is an node bound there. If so, it retrieves the rmiNodeHanlde from that node. If not, this method then looks at the address address to see if there is a pastry node bound there.

Specified by:

generateNodeHandle in class DistPastryNodeFactory

Parameters:

address - The address to look for the node.

Returns:

A NodeHandle cooresponding to the remote node at address, or null if none is found.

pause

public void pause(int ms)

Pauses the current thread for ms milliseconds.

Parameters:

ms - The number of milliseconds to pause.

newNode

public PastryNode newNode(NodeHandle bootstrap)

Description copied from class: DistPastryNodeFactory

Generates a new pastry node with a random NodeId using the bootstrap bootstrap.

Specified by:

newNode in class DistPastryNodeFactory

Parameters:

bootstrap - Node handle to bootstrap from.

Returns:

DESCRIBE THE RETURN VALUE

newNode

public PastryNode newNode(NodeHandle bootstrap,
                          NodeId nodeId)

Makes many policy choices and manufactures a new RMIPastryNode. Creates a series of artifacts to adorn the node, like a security manager, a leafset, etc. with hand-picked parameters like the leaf set size. Finally calls the respective setElements to pass these on to the {,RMI,Direct}PastryNode as appropriate, and then calls node.doneNode() (which internally performs mechanisms like exporting the node and notifying applications).

Specified by:

newNode in class DistPastryNodeFactory

Parameters:

bootstrap - Node handle to bootstrap from.

nodeId - DESCRIBE THE PARAMETER

Returns:

DESCRIBE THE RETURN VALUE

getLeafSet

public LeafSet getLeafSet(NodeHandle handle)

This method returns the remote leafset of the provided handle to the caller, in a protocol-dependent fashion. Note that this method may block while sending the message across the wire.

Specified by:

getLeafSet in class PastryNodeFactory

Parameters:

handle - The node to connect to

Returns:

The leafset of the remote node

getRouteRow

public RouteSet[] getRouteRow(NodeHandle handle,
                              int row)

This method returns the remote route row of the provided handle to the caller, in a protocol-dependent fashion. Note that this method may block while sending the message across the wire.

Specified by:

getRouteRow in class PastryNodeFactory

Parameters:

handle - The node to connect to

row - The row number to retrieve

Returns:

The route row of the remote node

getProximity

public int getProximity(NodeHandle local,
                        NodeHandle handle)

This method determines and returns the proximity of the current local node the provided NodeHandle. This will need to be done in a protocol- dependent fashion and may need to be done in a special way.

Specified by:

getProximity in class PastryNodeFactory

Parameters:

handle - The handle to determine the proximity of

Returns:

The proximity of the provided handle