org.dataone.client.v2.impl

Class NodeListNodeLocator

java.lang.Object

org.dataone.client.NodeLocator

org.dataone.client.v2.impl.NodeListNodeLocator

Direct Known Subclasses:

SettingsContextNodeLocator

public class NodeListNodeLocator
extends NodeLocator

This implementation of NodeLocator uses a NodeList document to populate the internal maps that have all of the registered MNodes and CNodes, instead of relying on the put methods. The MNode and CNode objects are instantiated the first time they are requested from the get methods. Use of the put methods will replace the current D1Node associated with the NodeReference, so should be used with care. While most applications require / desire to have only one instance of a NodeLocator, with Singleton or Monostate behavior, this class does not do that, to support applications that work across environments. See org.dataone.client.itk.D1Client for this.

Author:

rnahf

Field Summary

Fields

Modifier and Type	Field and Description
protected MultipartRestClient	client
protected Deque<CNode>	cnList
protected NodeList	nodeList

Fields inherited from class org.dataone.client.NodeLocator

nodeMap

Constructor Summary

Constructors

Constructor and Description
NodeListNodeLocator(NodeList nl, MultipartRestClient mrc)

Method Summary

Methods

Modifier and Type	Method and Description
CNode	getCNode() This method should return the favored CNode, so that a CN can be obtained without NodeReference or serviceBaseUrl.
void	initCnList() Determines which CNodes will be part of the cnList.

Methods inherited from class org.dataone.client.NodeLocator

getNode, getNode, listD1Nodes, listD1Nodes, putNode

Methods inherited from class java.lang.Object

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

Field Detail

nodeList

protected NodeList nodeList

client

protected MultipartRestClient client

cnList

protected Deque<CNode> cnList

Constructor Detail

NodeListNodeLocator

public NodeListNodeLocator(NodeList nl,
                   MultipartRestClient mrc)
                    throws ClientSideException

Throws:

ClientSideException

Method Detail

getCNode

public CNode getCNode()
               throws ClientSideException

Description copied from class: NodeLocator

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.

Specified by:

getCNode in class NodeLocator

Returns:

Throws:

ClientSideException

initCnList

public void initCnList()
                throws ClientSideException

Determines which CNodes will be part of the cnList. If there is a Round Robin CN listed in the NodeList, it will be used, otherwise, all of the other CNs listed will be used (and rotated through the getCN call).

Throws:

ClientSideException