Node (DataONE Java Client Library 1.3.0-SNAPSHOT API)

java.lang.Object
- org.dataone.service.types.v1.Node

All Implemented Interfaces:: Serializable

public class Node
extends Object
implements Serializable

A set of values that describe a member or coordinating node, its Internet location, and the services it supports. Several nodes may exist on a single physical device or hostname. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Node">
   <xs:sequence>
     <xs:element type="ns:NodeReference" name="identifier" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="name" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="description" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="baseURL" minOccurs="1" maxOccurs="1"/>
     <xs:element type="ns:Services" name="services" minOccurs="0" maxOccurs="1"/>
     <xs:element type="ns:Synchronization" name="synchronization" minOccurs="0" maxOccurs="1"/>
     <xs:element type="ns:NodeReplicationPolicy" name="nodeReplicationPolicy" minOccurs="0" maxOccurs="1"/>
     <xs:element type="ns:Ping" name="ping" minOccurs="0" maxOccurs="1"/>
     <xs:element type="ns:Subject" name="subject" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="ns:Subject" name="contactSubject" minOccurs="1" maxOccurs="unbounded"/>
   </xs:sequence>
   <xs:attribute type="xs:boolean" use="required" name="replicate"/>
   <xs:attribute type="xs:boolean" use="required" name="synchronize"/>
   <xs:attribute type="ns:NodeType" use="required" name="type"/>
   <xs:attribute type="ns:NodeState" use="required" name="state"/>
 </xs:complexType>

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Node()

Constructors
Constructor and Description
`Node()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addContactSubject(Subject item)` Add a 'contactSubject' element item.
`void`	`addSubject(Subject item)` Add a 'subject' element item.
`void`	`clearContactSubjectList()` Remove all 'contactSubject' element items.
`void`	`clearSubjectList()` Remove all 'subject' element items.
`String`	`getBaseURL()` Get the 'baseURL' element value.
`Subject`	`getContactSubject(int index)` Get 'contactSubject' element item by position.
`List<Subject>`	`getContactSubjectList()` Get the list of 'contactSubject' element items.
`String`	`getDescription()` Get the 'description' element value.
`NodeReference`	`getIdentifier()` Get the 'identifier' element value.
`String`	`getName()` Get the 'name' element value.
`NodeReplicationPolicy`	`getNodeReplicationPolicy()` Get the 'nodeReplicationPolicy' element value.
`Ping`	`getPing()` Get the 'ping' element value.
`Services`	`getServices()` Get the 'services' element value.
`NodeState`	`getState()` Get the 'state' attribute value.
`Subject`	`getSubject(int index)` Get 'subject' element item by position.
`List<Subject>`	`getSubjectList()` Get the list of 'subject' element items.
`Synchronization`	`getSynchronization()` Get the 'synchronization' element value.
`NodeType`	`getType()` Get the 'type' attribute value.
`boolean`	`isReplicate()` Get the 'replicate' attribute value.
`boolean`	`isSynchronize()` Get the 'synchronize' attribute value.
`void`	`setBaseURL(String baseURL)` Set the 'baseURL' element value.
`void`	`setContactSubjectList(List<Subject> list)` Set the list of 'contactSubject' element items.
`void`	`setDescription(String description)` Set the 'description' element value.
`void`	`setIdentifier(NodeReference identifier)` Set the 'identifier' element value.
`void`	`setName(String name)` Set the 'name' element value.
`void`	`setNodeReplicationPolicy(NodeReplicationPolicy nodeReplicationPolicy)` Set the 'nodeReplicationPolicy' element value.
`void`	`setPing(Ping ping)` Set the 'ping' element value.
`void`	`setReplicate(boolean replicate)` Set the 'replicate' attribute value.
`void`	`setServices(Services services)` Set the 'services' element value.
`void`	`setState(NodeState state)` Set the 'state' attribute value.
`void`	`setSubjectList(List<Subject> list)` Set the list of 'subject' element items.
`void`	`setSynchronization(Synchronization synchronization)` Set the 'synchronization' element value.
`void`	`setSynchronize(boolean synchronize)` Set the 'synchronize' attribute value.
`void`	`setType(NodeType type)` Set the 'type' attribute value.
`int`	`sizeContactSubjectList()` Get the number of 'contactSubject' element items.
`int`	`sizeSubjectList()` Get the number of 'subject' element items.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Node
```
public Node()
```
- Method Detail
  - getIdentifier
```
public NodeReference getIdentifier()
```
    Get the 'identifier' element value. A unique identifier for the node of the form ``urn:node:NODEID`` where NODEID is the node specific identifier. This value MUST NOT change for future implementations of the same node, whereas the *baseURL* may change in the future.
    
    Returns:
    value
  - setIdentifier
```
public void setIdentifier(NodeReference identifier)
```
    Set the 'identifier' element value. A unique identifier for the node of the form ``urn:node:NODEID`` where NODEID is the node specific identifier. This value MUST NOT change for future implementations of the same node, whereas the *baseURL* may change in the future.
    
    Parameters:
    identifier -
  - getName
```
public String getName()
```
    Get the 'name' element value. A human readable name of the Node. This name can be used as a label in many systems to represent the node, and thus should be short, but understandable.
    
    Returns:
    value
  - setName
```
public void setName(String name)
```
    Set the 'name' element value. A human readable name of the Node. This name can be used as a label in many systems to represent the node, and thus should be short, but understandable.
    
    Parameters:
    name -
  - getDescription
```
public String getDescription()
```
    Get the 'description' element value. Description of a Node, explaining the community it serves and other relevant information about the node, such as what content is maintained by this node and any other free style notes.
    
    Returns:
    value
  - setDescription
```
public void setDescription(String description)
```
    Set the 'description' element value. Description of a Node, explaining the community it serves and other relevant information about the node, such as what content is maintained by this node and any other free style notes.
    
    Parameters:
    description -
  - getBaseURL
```
public String getBaseURL()
```
    Get the 'baseURL' element value. The base URL of the node, indicating the protocol, fully qualified domain name, and path to the implementing service, excluding the version of the API. e.g. ``https://server.example.edu/app/d1/mn`` rather than ``https://server.example.edu/app/d1/mn/v1``
    
    Returns:
    value
  - setBaseURL
```
public void setBaseURL(String baseURL)
```
    Set the 'baseURL' element value. The base URL of the node, indicating the protocol, fully qualified domain name, and path to the implementing service, excluding the version of the API. e.g. ``https://server.example.edu/app/d1/mn`` rather than ``https://server.example.edu/app/d1/mn/v1``
    
    Parameters:
    baseURL -
  - getServices
```
public Services getServices()
```
    Get the 'services' element value. A list of services that are provided by this node. Used in node descriptions so that nodes can provide metadata about each service they implement and support.
    
    Returns:
    value
  - setServices
```
public void setServices(Services services)
```
    Set the 'services' element value. A list of services that are provided by this node. Used in node descriptions so that nodes can provide metadata about each service they implement and support.
    
    Parameters:
    services -
  - getSynchronization
```
public Synchronization getSynchronization()
```
    Get the 'synchronization' element value. Configuration information for the process by which content is harvested from Member Nodes to Coordinating Nodes. This includes the schedule on which harvesting should occur, and metadata about the last synchronization attempts for the node.
    
    Returns:
    value
  - setSynchronization
```
public void setSynchronization(Synchronization synchronization)
```
    Set the 'synchronization' element value. Configuration information for the process by which content is harvested from Member Nodes to Coordinating Nodes. This includes the schedule on which harvesting should occur, and metadata about the last synchronization attempts for the node.
    
    Parameters:
    synchronization -
  - getNodeReplicationPolicy
```
public NodeReplicationPolicy getNodeReplicationPolicy()
```
    Get the 'nodeReplicationPolicy' element value. The replication policy for this node that expresses constraints on object size, total objects, source nodes, and object format types. A node may want to restrict replication from only certain peer nodes, may have file size limits, total allocated size limits, or may want to focus on being a replica target for domain-specific object formats.
    
    Returns:
    value
  - setNodeReplicationPolicy
```
public void setNodeReplicationPolicy(NodeReplicationPolicy nodeReplicationPolicy)
```
    Set the 'nodeReplicationPolicy' element value. The replication policy for this node that expresses constraints on object size, total objects, source nodes, and object format types. A node may want to restrict replication from only certain peer nodes, may have file size limits, total allocated size limits, or may want to focus on being a replica target for domain-specific object formats.
    
    Parameters:
    nodeReplicationPolicy -
  - getPing
```
public Ping getPing()
```
    Get the 'ping' element value. Stored results from the :func:`MNCore.ping` and :func:`CNCore.ping` methods.
    
    Returns:
    value
  - setPing
```
public void setPing(Ping ping)
```
    Set the 'ping' element value. Stored results from the :func:`MNCore.ping` and :func:`CNCore.ping` methods.
    
    Parameters:
    ping -
  - getSubjectList
```
public List<Subject> getSubjectList()
```
    Get the list of 'subject' element items. The :term:`Subject` of this node, which can be repeated as needed. The *Node.subject* represents the identifier of the node that would be found in X.509 certificates used to securely communicate with this node. Thus, it is an :term:`X.509 Distinguished Name` that applies to the host on which the Node is operating. When (and if) this hostname changes the new subject for the node would be added to the Node to track the subject that has been used in various access control rules over time.
    
    Returns:
    list
  - setSubjectList
```
public void setSubjectList(List<Subject> list)
```
    Set the list of 'subject' element items. The :term:`Subject` of this node, which can be repeated as needed. The *Node.subject* represents the identifier of the node that would be found in X.509 certificates used to securely communicate with this node. Thus, it is an :term:`X.509 Distinguished Name` that applies to the host on which the Node is operating. When (and if) this hostname changes the new subject for the node would be added to the Node to track the subject that has been used in various access control rules over time.
    
    Parameters:
    list -
  - sizeSubjectList
```
public int sizeSubjectList()
```
    Get the number of 'subject' element items.
    
    Returns:
    count
  - addSubject
```
public void addSubject(Subject item)
```
    Add a 'subject' element item.
    
    Parameters:
    item -
  - getSubject
```
public Subject getSubject(int index)
```
    Get 'subject' element item by position.
    
    Parameters:
    index -
    
    Returns:
    item
  - clearSubjectList
```
public void clearSubjectList()
```
    Remove all 'subject' element items.
  - getContactSubjectList
```
public List<Subject> getContactSubjectList()
```
    Get the list of 'contactSubject' element items. The appropriate person or group to contact regarding the disposition, management, and status of this Member Node. The *Node.contactSubject* is an :term:`X.509 Distinguished Name` for a person or group that can be used to look up current contact details (e.g., name, email address) for the contact in the DataONE Identity service. DataONE uses the *contactSubject* to provide notices of interest to DataONE nodes, including information such as policy changes, maintenance updates, node outage notifications, among other information useful for administering a node. Each node that is registered with DataONE must provide at least one *contactSubject* that has been :term:`verified` with DataONE.
    
    Returns:
    list
  - setContactSubjectList
```
public void setContactSubjectList(List<Subject> list)
```
    Set the list of 'contactSubject' element items. The appropriate person or group to contact regarding the disposition, management, and status of this Member Node. The *Node.contactSubject* is an :term:`X.509 Distinguished Name` for a person or group that can be used to look up current contact details (e.g., name, email address) for the contact in the DataONE Identity service. DataONE uses the *contactSubject* to provide notices of interest to DataONE nodes, including information such as policy changes, maintenance updates, node outage notifications, among other information useful for administering a node. Each node that is registered with DataONE must provide at least one *contactSubject* that has been :term:`verified` with DataONE.
    
    Parameters:
    list -
  - sizeContactSubjectList
```
public int sizeContactSubjectList()
```
    Get the number of 'contactSubject' element items.
    
    Returns:
    count
  - addContactSubject
```
public void addContactSubject(Subject item)
```
    Add a 'contactSubject' element item.
    
    Parameters:
    item -
  - getContactSubject
```
public Subject getContactSubject(int index)
```
    Get 'contactSubject' element item by position.
    
    Parameters:
    index -
    
    Returns:
    item
  - clearContactSubjectList
```
public void clearContactSubjectList()
```
    Remove all 'contactSubject' element items.
  - isReplicate
```
public boolean isReplicate()
```
    Get the 'replicate' attribute value. Set to *true* if the node is willing to be a :term:`replication target`, otherwise *false*.
    
    Returns:
    value
  - setReplicate
```
public void setReplicate(boolean replicate)
```
    Set the 'replicate' attribute value. Set to *true* if the node is willing to be a :term:`replication target`, otherwise *false*.
    
    Parameters:
    replicate -
  - isSynchronize
```
public boolean isSynchronize()
```
    Get the 'synchronize' attribute value. Set to *true* if the node should be :term:`synchronized` by a Coordinating Node, otherwise false*.
    
    Returns:
    value
  - setSynchronize
```
public void setSynchronize(boolean synchronize)
```
    Set the 'synchronize' attribute value. Set to *true* if the node should be :term:`synchronized` by a Coordinating Node, otherwise false*.
    
    Parameters:
    synchronize -
  - getType
```
public NodeType getType()
```
    Get the 'type' attribute value. The type of the node (Coordinating, Member), chosen from the :class:`Types.NodeType` type.
    
    Returns:
    value
  - setType
```
public void setType(NodeType type)
```
    Set the 'type' attribute value. The type of the node (Coordinating, Member), chosen from the :class:`Types.NodeType` type.
    
    Parameters:
    type -
  - getState
```
public NodeState getState()
```
    Get the 'state' attribute value. The state of the node (*up*, *down*), chosen from the :class:`Types.NodeState` type.
    
    Returns:
    value
  - setState
```
public void setState(NodeState state)
```
    Set the 'state' attribute value. The state of the node (*up*, *down*), chosen from the :class:`Types.NodeState` type.
    
    Parameters:
    state -

Class Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Method Detail

getIdentifier

setIdentifier

getName

setName

getDescription

setDescription

getBaseURL

setBaseURL

getServices

setServices

getSynchronization

setSynchronization

getNodeReplicationPolicy

setNodeReplicationPolicy

getPing

setPing

getSubjectList

setSubjectList

sizeSubjectList

addSubject

getSubject

clearSubjectList

getContactSubjectList

setContactSubjectList

sizeContactSubjectList

addContactSubject

getContactSubject

clearContactSubjectList

isReplicate

setReplicate

isSynchronize

setSynchronize

getType

setType

getState

setState