org.dataone.client

Class NodeLocator

java.lang.Object

org.dataone.client.NodeLocator

Direct Known Subclasses:

NodeListNodeLocator

public abstract class NodeLocator
extends Object

An abstract Service Locator class to resolve NodeReferences into MNode or CNode objects. In the standard implementation, the NodeLocator would populate its nodes from a cn.NodeList call.

Author:

rnahf

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<NodeReference,D1Node>	nodeMap this property can be re-initialized by concrete subclasses

Constructor Summary

Constructors

Constructor and Description
NodeLocator()

Method Summary

Methods

Modifier and Type	Method and Description
abstract CNode	getCNode() This method should return the favored CNode, so that a CN can be obtained without NodeReference or serviceBaseUrl.
CNode	getCNode(NodeReference nodeReference) Return a CNode associated with the nodeReference parameter, or throw a ClientSideException.
CNode	getCNode(String baseUrl) Return a CNode associated with the baseUrl parameter, or throw a ClientSideException
MNode	getMNode(NodeReference nodeReference) Return an MNode associated with the nodeReference parameter, or throw a ClientSideException
MNode	getMNode(String baseUrl) Return an MNode associated with the baseUrl parameter, or throw a ClientSideException
Set<NodeReference>	listD1Nodes() Returns the set of NodeReferences in the NodeLocator
Set<NodeReference>	listD1Nodes(NodeType nodeType) Returns the set of NodeReferences of D1Nodes matching the nodeType parameter
void	putCNode(NodeReference nodeRef, CNode cnode) Puts a constructed CNode into the NodeLocator.
void	putMNode(NodeReference nodeRef, MNode mnode) Puts a constructed MNode into the NodeLocator.

Methods inherited from class java.lang.Object

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

Field Detail

nodeMap

protected Map<NodeReference,D1Node> nodeMap

this property can be re-initialized by concrete subclasses

Constructor Detail

NodeLocator

public NodeLocator()

Method Detail

putMNode

public void putMNode(NodeReference nodeRef,
            MNode mnode)

Puts a constructed MNode into the NodeLocator.

Parameters:

nodeRef -

mnode -

putCNode

public void putCNode(NodeReference nodeRef,
            CNode cnode)

Puts a constructed CNode into the NodeLocator.

Parameters:

nodeRef -

cnode -

getMNode

public MNode getMNode(NodeReference nodeReference)
               throws ClientSideException

Return an MNode associated with the nodeReference parameter, or throw a ClientSideException

Parameters:

nodeReference -

Returns:

Throws:

ClientSideException

getCNode

public CNode getCNode(NodeReference nodeReference)
               throws ClientSideException

Return a CNode associated with the nodeReference parameter, or throw a ClientSideException.

Parameters:

nodeReference -

Returns:

Throws:

ClientSideException

getMNode

public MNode getMNode(String baseUrl)
               throws ClientSideException

Return an MNode associated with the baseUrl parameter, or throw a ClientSideException

Parameters:

baseUrl -

Returns:

Throws:

ClientSideException

getCNode

public CNode getCNode(String baseUrl)
               throws ClientSideException

Return a CNode associated with the baseUrl parameter, or throw a ClientSideException

Parameters:

baseUrl -

Returns:

Throws:

ClientSideException

listD1Nodes

public Set<NodeReference> listD1Nodes()

Returns the set of NodeReferences in the NodeLocator

Returns:

listD1Nodes

public Set<NodeReference> listD1Nodes(NodeType nodeType)

Returns the set of NodeReferences of D1Nodes matching the nodeType parameter

Parameters:

nodeType -

Returns:

getCNode

public abstract CNode getCNode()
                        throws ClientSideException

This method should return the favored CNode, so that a CN can be obtained without NodeReference or serviceBaseUrl. If none can be determined, a ClientSideException should be thrown.

Returns:

Throws:

ClientSideException