CNode (DataONE Java Client Library 1.3.0-SNAPSHOT API)

java.lang.Object
- org.dataone.client.D1Node
- - org.dataone.client.CNode

All Implemented Interfaces:

CNAuthorization, CNCore, CNIdentity, CNRead, CNRegister, CNReplication
```
public class CNode
extends D1Node
implements CNCore, CNRead, CNAuthorization, CNIdentity, CNRegister, CNReplication
```
CNode represents a DataONE Coordinating Node, and allows calling classes to execute CN services. The additional methods lookupNodeBaseUrl(..) and lookupNodeId(..) cache nodelist information for performing baseUrl lookups and the reverse. The cache expiration is controlled by the property "CNode.nodemap.cache.refresh.interval.seconds" and is configured to 1 hour Various methods may set their own timeouts by use of Settings.Configuration properties or by calling setDefaultSoTimeout. Settings.Configuration properties override any value of the DefaultSoTimeout. Timeouts are always represented in milliseconds timeout properties recognized: D1Client.CNode.reserveIdentifier.timeout D1Client.CNode.create.timeout D1Client.CNode.registerSystemMetadata.timeout D1Client.CNode.search.timeout D1Client.CNode.replication.timeout D1Client.D1Node.listObjects.timeout D1Client.D1Node.getLogRecords.timeout D1Client.D1Node.get.timeout D1Client.D1Node.getSystemMetadata.timeout

Field Summary

Fields
Modifier and Type Field and Description

protected static org.apache.commons.logging.Log log
- Fields inherited from class org.dataone.client.D1Node
  session
- Fields inherited from interface org.dataone.service.cn.v1.CNCore
  SERVICE_VERSION

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log`

Constructor Summary

Constructors
Constructor and Description
`CNode(String nodeBaseServiceUrl)` Construct a Coordinating Node, passing in the base url for node services.
`CNode(String nodeBaseServiceUrl, Session session)` Construct a Coordinating Node, passing in the base url for node services, and the Session to use for connections to that node.

Method Summary

Methods
Modifier and Type	Method and Description
`Identifier`	`archive(Identifier pid)` see DataONE API Reference
`Identifier`	`archive(Session session, Identifier pid)` see DataONE API Reference
`boolean`	`confirmMapIdentity(Session session, Subject subject)` see DataONE API Reference
`boolean`	`confirmMapIdentity(Subject subject)` see DataONE API Reference
`Identifier`	`create(Identifier pid, InputStream object, SystemMetadata sysmeta)` see DataONE API Reference
`Identifier`	`create(Session session, Identifier pid, InputStream object, SystemMetadata sysmeta)` see DataONE API Reference
`Subject`	`createGroup(Group group)` see DataONE API Reference
`Subject`	`createGroup(Session session, Group group)` see DataONE API Reference
`Identifier`	`delete(Identifier pid)`
`Identifier`	`delete(Session session, Identifier pid)`
`boolean`	`deleteReplicationMetadata(Identifier pid, NodeReference nodeId, long serialVersion)` see DataONE API Reference
`boolean`	`deleteReplicationMetadata(Session session, Identifier pid, NodeReference nodeId, long serialVersion)` see DataONE API Reference
`boolean`	`denyMapIdentity(Session session, Subject subject)` see DataONE API Reference
`boolean`	`denyMapIdentity(Subject subject)` see DataONE API Reference
`DescribeResponse`	`describe(Identifier pid)` see DataONE API Reference
`DescribeResponse`	`describe(Session session, Identifier pid)` see DataONE API Reference
`Identifier`	`generateIdentifier(Session session, String scheme, String fragment)` see DataONE API Reference
`Identifier`	`generateIdentifier(String scheme, String fragment)` see DataONE API Reference
`InputStream`	`get(Identifier pid)` Get the resource with the specified pid.
`InputStream`	`get(Session session, Identifier pid)` Get the resource with the specified pid.
`Checksum`	`getChecksum(Identifier pid)` see DataONE API Reference
`Checksum`	`getChecksum(Session session, Identifier pid)` see DataONE API Reference
`ObjectFormat`	`getFormat(ObjectFormatIdentifier formatid)` Return the ObjectFormat for the given ObjectFormatIdentifier, obtained either from a client-cached ObjectFormatList from the ObjectFormatCache, or from a call to the CN.
`Log`	`getLogRecords()` A convenience method for getLogRecords using no filtering parameters see DataONE API Reference
`Log`	`getLogRecords(Date fromDate, Date toDate, Event event, String pidFilter, Integer start, Integer count)` see DataONE API Reference
`Log`	`getLogRecords(Session session)` A convenience method for getLogRecords using no filtering parameters see DataONE API Reference
`Log`	`getLogRecords(Session session, Date fromDate, Date toDate, Event event, String pidFilter, Integer start, Integer count)` see DataONE API Reference
`String`	`getNodeBaseServiceUrl()` Retrieve the service URL for this node.
`SubjectInfo`	`getPendingMapIdentity(Session session, Subject subject)` see DataONE API Reference
`SubjectInfo`	`getPendingMapIdentity(Subject subject)` see DataONE API Reference
`QueryEngineDescription`	`getQueryEngineDescription(String queryEngine)` see DataONE API Reference
`SubjectInfo`	`getSubjectInfo(Session session, Subject subject)` see DataONE API Reference
`SubjectInfo`	`getSubjectInfo(Subject subject)` see DataONE API Reference
`SystemMetadata`	`getSystemMetadata(Identifier pid)` Get the system metadata from a resource with the specified guid.
`SystemMetadata`	`getSystemMetadata(Session session, Identifier pid)` Get the system metadata from a resource with the specified guid.
`boolean`	`hasReservation(Session session, Subject subject, Identifier pid)` see DataONE API Reference
`boolean`	`hasReservation(Subject subject, Identifier pid)` see DataONE API Reference
`boolean`	`isAuthorized(Identifier pid, Permission permission)` see DataONE API Reference
`boolean`	`isAuthorized(Session session, Identifier pid, Permission permission)` see DataONE API Reference
`boolean`	`isNodeAuthorized(Session session, Subject targetNodeSubject, Identifier pid)` see DataONE API Reference
`boolean`	`isNodeAuthorized(Subject targetNodeSubject, Identifier pid)` see DataONE API Reference
`ChecksumAlgorithmList`	`listChecksumAlgorithms()` see DataONE API Reference
`ObjectFormatList`	`listFormats()` see DataONE API Reference
`Set<String>`	`listNodeIds()` Return the set of Node IDs for all of the nodes registered to the CN
`NodeList`	`listNodes()` see DataONE API Reference
`ObjectList`	`listObjects()` see DataONE API Reference
`ObjectList`	`listObjects(Date fromDate, Date toDate, ObjectFormatIdentifier formatid, Boolean replicaStatus, Integer start, Integer count)` see DataONE API Reference
`ObjectList`	`listObjects(Session session)` see DataONE API Reference
`ObjectList`	`listObjects(Session session, Date fromDate, Date toDate, ObjectFormatIdentifier formatid, Boolean replicaStatus, Integer start, Integer count)` see DataONE API Reference
`QueryEngineList`	`listQueryEngines()` see DataONE API Reference
`SubjectInfo`	`listSubjects(Session session, String query, String status, Integer start, Integer count)` see DataONE API Reference
`SubjectInfo`	`listSubjects(String query, String status, Integer start, Integer count)` see DataONE API Reference
`String`	`lookupNodeBaseUrl(NodeReference nodeRef)` Find the base URL for a Node based on the Node's identifier as it was registered with the Coordinating Node.
`String`	`lookupNodeBaseUrl(String nodeId)` Find the base URL for a Node based on the Node's identifier as it was registered with the Coordinating Node.
`String`	`lookupNodeId(String nodeBaseUrl)` Find the node identifier for a Node based on the base URL that is used to access its services by looking up the registration for the node at the Coordinating Node.
`boolean`	`mapIdentity(Session session, Subject primarySubject, Subject secondarySubject)` see DataONE API Reference
`boolean`	`mapIdentity(Subject primarySubject, Subject secondarySubject)` see DataONE API Reference
`Date`	`ping()` see DataONE API Reference
`InputStream`	`query(String queryEngine, D1Url queryD1Url)` see DataONE API Reference
`InputStream`	`query(String queryEngine, String query)` see DataONE API Reference
`NodeReference`	`register(Node node)` see DataONE API Reference
`NodeReference`	`register(Session session, Node node)` see DataONE API Reference
`Subject`	`registerAccount(Person person)` see DataONE API Reference
`Subject`	`registerAccount(Session session, Person person)` see DataONE API Reference
`Identifier`	`registerSystemMetadata(Identifier pid, SystemMetadata sysmeta)` see DataONE API Reference
`Identifier`	`registerSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)` see DataONE API Reference
`boolean`	`removeMapIdentity(Session session, Subject subject)` see DataONE API Reference
`boolean`	`removeMapIdentity(Subject subject)` see DataONE API Reference
`boolean`	`requestMapIdentity(Session session, Subject subject)` see DataONE API Reference
`boolean`	`requestMapIdentity(Subject subject)` see DataONE API Reference
`Identifier`	`reserveIdentifier(Identifier pid)` see DataONE API Reference
`Identifier`	`reserveIdentifier(Session session, Identifier pid)` see DataONE API Reference
`ObjectLocationList`	`resolve(Identifier pid)` see DataONE API Reference
`ObjectLocationList`	`resolve(Session session, Identifier pid)` see DataONE API Reference
`ObjectList`	`search(Session session, String queryType, D1Url queryD1url)` A convenience method for creating a search command utilizing the D1Url class for building the value for the query parameter.
`ObjectList`	`search(Session session, String queryType, String query)` see DataONE API Reference This implementation handles URL-escaping for only the "queryType" parameter, and always places a slash ('/') character after it.
`ObjectList`	`search(String queryType, D1Url queryD1url)` A convenience method for creating a search command utilizing the D1Url class for building the value for the query parameter.
`ObjectList`	`search(String queryType, String query)` see DataONE API Reference This implementation handles URL-escaping for only the "queryType" parameter, and always places a slash ('/') character after it.
`boolean`	`setAccessPolicy(Identifier pid, AccessPolicy accessPolicy, long serialVersion)` see DataONE API Reference
`boolean`	`setAccessPolicy(Session session, Identifier pid, AccessPolicy accessPolicy, long serialVersion)` see DataONE API Reference
`boolean`	`setObsoletedBy(Identifier pid, Identifier obsoletedByPid, long serialVersion)` see DataONE API Reference
`boolean`	`setObsoletedBy(Session session, Identifier pid, Identifier obsoletedByPid, long serialVersion)` see DataONE API Reference
`boolean`	`setReplicationPolicy(Identifier pid, ReplicationPolicy policy, long serialVersion)` see DataONE API Reference
`boolean`	`setReplicationPolicy(Session session, Identifier pid, ReplicationPolicy policy, long serialVersion)` see DataONE API Reference
`boolean`	`setReplicationStatus(Identifier pid, NodeReference nodeRef, ReplicationStatus status, BaseException failure)` see DataONE API Reference
`boolean`	`setReplicationStatus(Session session, Identifier pid, NodeReference nodeRef, ReplicationStatus status, BaseException failure)` see DataONE API Reference
`Identifier`	`setRightsHolder(Identifier pid, Subject userId, long serialVersion)` see DataONE API Reference
`Identifier`	`setRightsHolder(Session session, Identifier pid, Subject userId, long serialVersion)` see DataONE API Reference
`Subject`	`updateAccount(Person person)` see DataONE API Reference
`Subject`	`updateAccount(Session session, Person person)` see DataONE API Reference
`boolean`	`updateGroup(Group group)` see DataONE API Reference
`boolean`	`updateGroup(Session session, Group group)` see DataONE API Reference
`boolean`	`updateNodeCapabilities(NodeReference nodeid, Node node)` see DataONE API Reference
`boolean`	`updateNodeCapabilities(Session session, NodeReference nodeid, Node node)` see DataONE API Reference
`boolean`	`updateReplicationMetadata(Identifier pid, Replica replicaMetadata, long serialVersion)` see DataONE API Reference
`boolean`	`updateReplicationMetadata(Session session, Identifier pid, Replica replicaMetadata, long serialVersion)` see DataONE API Reference
`boolean`	`verifyAccount(Session session, Subject subject)` see DataONE API Reference
`boolean`	`verifyAccount(Subject subject)` see DataONE API Reference

Methods inherited from class org.dataone.client.D1Node
deserializeServiceType, getChecksum, getChecksum, getDefaultSoTimeout, getLatestRequestUrl, getNodeId, getSystemMetadata, getSystemMetadata, recastClientSideExceptionToServiceFailure, recastDataONEExceptionToServiceFailure, setDefaultSoTimeout, setLatestRequestUrl, setNodeBaseServiceUrl, setNodeId

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

Field Detail

log

protected static org.apache.commons.logging.Log log

Constructor Detail
- CNode
```
public CNode(String nodeBaseServiceUrl)
```
  Construct a Coordinating Node, passing in the base url for node services. The CN first retrieves a list of other nodes that can be used to look up node identifiers and base urls for further service invocations.
  
  Parameters:
  nodeBaseServiceUrl - base url for constructing service endpoints.
- CNode
```
public CNode(String nodeBaseServiceUrl,
     Session session)
```
  Construct a Coordinating Node, passing in the base url for node services, and the Session to use for connections to that node. The CN first retrieves a list of other nodes that can be used to look up node identifiers and base urls for further service invocations.
  
  Parameters:
  nodeBaseServiceUrl - base url for constructing service endpoints.
  session - - the Session object passed to the CertificateManager to be used for establishing connections

Method Detail

getNodeBaseServiceUrl
```
public String getNodeBaseServiceUrl()
```
Description copied from class: D1Node

Retrieve the service URL for this node. The service URL can be used with knowledge of the DataONE REST API to construct endpoints for each of the DataONE REST services that are available on the node.

Overrides:

getNodeBaseServiceUrl in class D1Node

Returns:
String representing the service URL

lookupNodeBaseUrl
```
public String lookupNodeBaseUrl(String nodeId)
                         throws ServiceFailure,
                                NotImplemented
```
Find the base URL for a Node based on the Node's identifier as it was registered with the Coordinating Node. This method does the lookup on cached NodeList information. The cache is refreshed periodically.

Parameters:
nodeId - the identifier value of the node to look up

Returns:
the base URL of the node's service endpoints

Throws:

ServiceFailure

NotImplemented

lookupNodeBaseUrl
```
public String lookupNodeBaseUrl(NodeReference nodeRef)
                         throws ServiceFailure,
                                NotImplemented
```
Find the base URL for a Node based on the Node's identifier as it was registered with the Coordinating Node. This method does the lookup on cached NodeList information.

Parameters:
nodeRef - a NodeReference for the node to look up

Returns:
the base URL of the node's service endpoints

Throws:

ServiceFailure

NotImplemented

lookupNodeId
```
public String lookupNodeId(String nodeBaseUrl)
                    throws ServiceFailure,
                           NotImplemented
```
Find the node identifier for a Node based on the base URL that is used to access its services by looking up the registration for the node at the Coordinating Node. This method does the lookup on cached NodeList information.

Parameters:
nodeBaseUrl - the base url for Node service access

Returns:
the identifier of the Node

Throws:

NotImplemented

ServiceFailure

listNodeIds

public Set<String> listNodeIds()
                        throws ServiceFailure,
                               NotImplemented

Return the set of Node IDs for all of the nodes registered to the CN

Returns:
Throws:: NotImplemented; ServiceFailure

ping
```
public Date ping()
          throws NotImplemented,
                 ServiceFailure,
                 InsufficientResources
```
see DataONE API Reference

Specified by:

ping in interface CNCore

Overrides:

ping in class D1Node

Throws:

NotImplemented

ServiceFailure

InsufficientResources
See Also:
http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CN_core.ping

listFormats
```
public ObjectFormatList listFormats()
                             throws ServiceFailure,
                                    NotImplemented
```
see DataONE API Reference

Specified by:

listFormats in interface CNCore

Throws:

ServiceFailure

NotImplemented
See Also:
http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.listFormats

getFormat
```
public ObjectFormat getFormat(ObjectFormatIdentifier formatid)
                       throws ServiceFailure,
                              NotFound,
                              NotImplemented
```
Return the ObjectFormat for the given ObjectFormatIdentifier, obtained either from a client-cached ObjectFormatList from the ObjectFormatCache, or from a call to the CN. Caching is enabled by default in production via the property "CNode.useObjectFormatCache" accessed via org.dataone.configuration.Settings and the cn baseURL found in D1Client.CN_URL is used for the connection, not the one held by this instance of CNode. see DataONE API Reference

Specified by:

getFormat in interface CNCore

Throws:

ServiceFailure

NotFound

NotImplemented
See Also:
http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getFormat

listChecksumAlgorithms

public ChecksumAlgorithmList listChecksumAlgorithms()
                                             throws ServiceFailure,
                                                    NotImplemented

see DataONE API Reference

Specified by:: listChecksumAlgorithms in interface CNCore
Throws:: ServiceFailure; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getChecksumAlgorithms

getLogRecords

public Log getLogRecords()
                  throws InvalidToken,
                         InvalidRequest,
                         ServiceFailure,
                         NotAuthorized,
                         NotImplemented,
                         InsufficientResources

A convenience method for getLogRecords using no filtering parameters see DataONE API Reference

Overrides:: getLogRecords in class D1Node
Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources

getLogRecords

public Log getLogRecords(Session session)
                  throws InvalidToken,
                         InvalidRequest,
                         ServiceFailure,
                         NotAuthorized,
                         NotImplemented,
                         InsufficientResources

A convenience method for getLogRecords using no filtering parameters see DataONE API Reference

Overrides:: getLogRecords in class D1Node
Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources

getLogRecords

public Log getLogRecords(Date fromDate,
                Date toDate,
                Event event,
                String pidFilter,
                Integer start,
                Integer count)
                  throws InvalidToken,
                         InvalidRequest,
                         ServiceFailure,
                         NotAuthorized,
                         NotImplemented,
                         InsufficientResources

see DataONE API Reference

Specified by:: getLogRecords in interface CNCore
Overrides:: getLogRecords in class D1Node
Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getLogRecords

getLogRecords

public Log getLogRecords(Session session,
                Date fromDate,
                Date toDate,
                Event event,
                String pidFilter,
                Integer start,
                Integer count)
                  throws InvalidToken,
                         InvalidRequest,
                         ServiceFailure,
                         NotAuthorized,
                         NotImplemented,
                         InsufficientResources

see DataONE API Reference

Specified by:: getLogRecords in interface CNCore
Overrides:: getLogRecords in class D1Node
Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getLogRecords

listNodes
```
public NodeList listNodes()
                   throws NotImplemented,
                          ServiceFailure
```
see DataONE API Reference

Specified by:

listNodes in interface CNCore

Throws:

NotImplemented

ServiceFailure
See Also:
http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.listNodes

reserveIdentifier

public Identifier reserveIdentifier(Identifier pid)
                             throws InvalidToken,
                                    ServiceFailure,
                                    NotAuthorized,
                                    IdentifierNotUnique,
                                    NotImplemented,
                                    InvalidRequest

see DataONE API Reference

Specified by:: reserveIdentifier in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.reserveIdentifier

reserveIdentifier

public Identifier reserveIdentifier(Session session,
                           Identifier pid)
                             throws InvalidToken,
                                    ServiceFailure,
                                    NotAuthorized,
                                    IdentifierNotUnique,
                                    NotImplemented,
                                    InvalidRequest

see DataONE API Reference

Specified by:: reserveIdentifier in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.reserveIdentifier

generateIdentifier

public Identifier generateIdentifier(String scheme,
                            String fragment)
                              throws InvalidToken,
                                     ServiceFailure,
                                     NotAuthorized,
                                     NotImplemented,
                                     InvalidRequest

see DataONE API Reference

Specified by:: generateIdentifier in interface CNCore
Overrides:: generateIdentifier in class D1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.generateIdentifier

generateIdentifier

public Identifier generateIdentifier(Session session,
                            String scheme,
                            String fragment)
                              throws InvalidToken,
                                     ServiceFailure,
                                     NotAuthorized,
                                     NotImplemented,
                                     InvalidRequest

see DataONE API Reference

Specified by:: generateIdentifier in interface CNCore
Overrides:: generateIdentifier in class D1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.generateIdentifier

hasReservation

public boolean hasReservation(Subject subject,
                     Identifier pid)
                       throws InvalidToken,
                              ServiceFailure,
                              NotFound,
                              NotAuthorized,
                              NotImplemented,
                              IdentifierNotUnique

see DataONE API Reference

Specified by:: hasReservation in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; NotImplemented; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.hasReservation

hasReservation

public boolean hasReservation(Session session,
                     Subject subject,
                     Identifier pid)
                       throws InvalidToken,
                              ServiceFailure,
                              NotFound,
                              NotAuthorized,
                              NotImplemented,
                              IdentifierNotUnique

see DataONE API Reference

Specified by:: hasReservation in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; NotImplemented; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.hasReservation

create

public Identifier create(Identifier pid,
                InputStream object,
                SystemMetadata sysmeta)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         IdentifierNotUnique,
                         UnsupportedType,
                         InsufficientResources,
                         InvalidSystemMetadata,
                         NotImplemented,
                         InvalidRequest

see DataONE API Reference

Specified by:: create in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; UnsupportedType; InsufficientResources; InvalidSystemMetadata; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.create

create

public Identifier create(Session session,
                Identifier pid,
                InputStream object,
                SystemMetadata sysmeta)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         IdentifierNotUnique,
                         UnsupportedType,
                         InsufficientResources,
                         InvalidSystemMetadata,
                         NotImplemented,
                         InvalidRequest

see DataONE API Reference

Specified by:: create in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; UnsupportedType; InsufficientResources; InvalidSystemMetadata; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.create

registerSystemMetadata

public Identifier registerSystemMetadata(Identifier pid,
                                SystemMetadata sysmeta)
                                  throws NotImplemented,
                                         NotAuthorized,
                                         ServiceFailure,
                                         InvalidRequest,
                                         InvalidSystemMetadata,
                                         InvalidToken

see DataONE API Reference

Specified by:: registerSystemMetadata in interface CNCore
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.registerSystemMetadata

registerSystemMetadata

public Identifier registerSystemMetadata(Session session,
                                Identifier pid,
                                SystemMetadata sysmeta)
                                  throws NotImplemented,
                                         NotAuthorized,
                                         ServiceFailure,
                                         InvalidRequest,
                                         InvalidSystemMetadata,
                                         InvalidToken

see DataONE API Reference

Specified by:: registerSystemMetadata in interface CNCore
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.registerSystemMetadata

setObsoletedBy

public boolean setObsoletedBy(Identifier pid,
                     Identifier obsoletedByPid,
                     long serialVersion)
                       throws NotImplemented,
                              NotFound,
                              NotAuthorized,
                              ServiceFailure,
                              InvalidRequest,
                              InvalidToken,
                              VersionMismatch

see DataONE API Reference

Specified by:: setObsoletedBy in interface CNCore
Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.setObsoletedBy

setObsoletedBy

public boolean setObsoletedBy(Session session,
                     Identifier pid,
                     Identifier obsoletedByPid,
                     long serialVersion)
                       throws NotImplemented,
                              NotFound,
                              NotAuthorized,
                              ServiceFailure,
                              InvalidRequest,
                              InvalidToken,
                              VersionMismatch

see DataONE API Reference

Specified by:: setObsoletedBy in interface CNCore
Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.setObsoletedBy

listObjects

public ObjectList listObjects()
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Overrides:: listObjects in class D1Node
Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure

listObjects

public ObjectList listObjects(Session session)
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Overrides:: listObjects in class D1Node
Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure

listObjects

public ObjectList listObjects(Date fromDate,
                     Date toDate,
                     ObjectFormatIdentifier formatid,
                     Boolean replicaStatus,
                     Integer start,
                     Integer count)
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Specified by:: listObjects in interface CNRead
Overrides:: listObjects in class D1Node
Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.listObjects

listObjects

public ObjectList listObjects(Session session,
                     Date fromDate,
                     Date toDate,
                     ObjectFormatIdentifier formatid,
                     Boolean replicaStatus,
                     Integer start,
                     Integer count)
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

see DataONE API Reference

Specified by:: listObjects in interface CNRead
Overrides:: listObjects in class D1Node
Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.listObjects

get
```
public InputStream get(Identifier pid)
                throws InvalidToken,
                       ServiceFailure,
                       NotAuthorized,
                       NotFound,
                       NotImplemented
```
Description copied from class: D1Node

Get the resource with the specified pid. Used by both the CNode and MNode subclasses. A LocalCache is used to cache objects in memory and in a local disk cache if the "D1Client.useLocalCache" configuration property was set to true when the D1Node was created. Otherwise InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface CNRead

Overrides:

get in class D1Node

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented
See Also:
see DataONE API Reference (MemberNode API), see DataONE API Reference (CoordinatingNode API)

get
```
public InputStream get(Session session,
              Identifier pid)
                throws InvalidToken,
                       ServiceFailure,
                       NotAuthorized,
                       NotFound,
                       NotImplemented
```
Description copied from class: D1Node

Get the resource with the specified pid. Used by both the CNode and MNode subclasses. A LocalCache is used to cache objects in memory and in a local disk cache if the "D1Client.useLocalCache" configuration property was set to true when the D1Node was created. Otherwise InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface CNRead

Overrides:

get in class D1Node

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented
See Also:
see DataONE API Reference (MemberNode API), see DataONE API Reference (CoordinatingNode API)

getSystemMetadata
```
public SystemMetadata getSystemMetadata(Identifier pid)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotFound,
                                        NotImplemented
```
Description copied from class: D1Node

Get the system metadata from a resource with the specified guid. Used by both the CNode and MNode implementations. Note that this method defaults to not using the local system metadata cache provided by the client, as SystemMetadata is mutable and so caching can lead to issues. In specific cases where a client wants to utilize the same system metadata in rapid succession, it may make sense to temporarily use the local cache by calling @see #getSystemMetadata(Session, Identifier, boolean).

Specified by:

getSystemMetadata in interface CNRead

Overrides:

getSystemMetadata in class D1Node

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented
See Also:
DataONE API Reference (MemberNode API), DataONE API Reference (CoordinatingNode API)

getSystemMetadata
```
public SystemMetadata getSystemMetadata(Session session,
                               Identifier pid)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotFound,
                                        NotImplemented
```
Description copied from class: D1Node

Get the system metadata from a resource with the specified guid. Used by both the CNode and MNode implementations. Note that this method defaults to not using the local system metadata cache provided by the client, as SystemMetadata is mutable and so caching can lead to issues. In specific cases where a client wants to utilize the same system metadata in rapid succession, it may make sense to temporarily use the local cache by calling @see #getSystemMetadata(Session, Identifier, boolean).

Specified by:

getSystemMetadata in interface CNRead

Overrides:

getSystemMetadata in class D1Node

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented
See Also:
DataONE API Reference (MemberNode API), DataONE API Reference (CoordinatingNode API)

describe

public DescribeResponse describe(Identifier pid)
                          throws InvalidToken,
                                 NotAuthorized,
                                 NotImplemented,
                                 ServiceFailure,
                                 NotFound

see DataONE API Reference

Specified by:: describe in interface CNRead
Overrides:: describe in class D1Node
Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_read.describe

describe

public DescribeResponse describe(Session session,
                        Identifier pid)
                          throws InvalidToken,
                                 NotAuthorized,
                                 NotImplemented,
                                 ServiceFailure,
                                 NotFound

see DataONE API Reference

Specified by:: describe in interface CNRead
Overrides:: describe in class D1Node
Throws:: InvalidToken; NotAuthorized; NotImplemented; ServiceFailure; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/MN_APIs.html#MN_read.describe

resolve

public ObjectLocationList resolve(Identifier pid)
                           throws InvalidToken,
                                  ServiceFailure,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented

see DataONE API Reference

Specified by:: resolve in interface CNRead
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.resolve

resolve

public ObjectLocationList resolve(Session session,
                         Identifier pid)
                           throws InvalidToken,
                                  ServiceFailure,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented

see DataONE API Reference

Specified by:: resolve in interface CNRead
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.resolve

getChecksum

public Checksum getChecksum(Identifier pid)
                     throws InvalidToken,
                            ServiceFailure,
                            NotAuthorized,
                            NotFound,
                            NotImplemented

see DataONE API Reference

Specified by:: getChecksum in interface CNRead
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.getChecksum

getChecksum

public Checksum getChecksum(Session session,
                   Identifier pid)
                     throws InvalidToken,
                            ServiceFailure,
                            NotAuthorized,
                            NotFound,
                            NotImplemented

see DataONE API Reference

Specified by:: getChecksum in interface CNRead
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.getChecksum

search
```
public ObjectList search(String queryType,
                D1Url queryD1url)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented
```
A convenience method for creating a search command utilizing the D1Url class for building the value for the query parameter. The class D1Url handles general URL escaping of individual url elements, but different search implementations, such as solr, may have extra requirements. see DataONE API Reference solr escaping: find ClientUtils

Parameters:
queryD1url - - a D1Url object containing the path and/or query elements that will be passed to the indicated queryType. BaseUrl and Resource segments contained in this object will be removed/ignored.

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented

search
```
public ObjectList search(Session session,
                String queryType,
                D1Url queryD1url)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented
```
A convenience method for creating a search command utilizing the D1Url class for building the value for the query parameter. The class D1Url handles general URL escaping of individual url elements, but different search implementations, such as solr, may have extra requirements. see DataONE API Reference solr escaping: find ClientUtils

Parameters:
queryD1url - - a D1Url object containing the path and/or query elements that will be passed to the indicated queryType.

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented

search
```
public ObjectList search(String queryType,
                String query)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented
```
see DataONE API Reference This implementation handles URL-escaping for only the "queryType" parameter, and always places a slash ('/') character after it.
For example, to invoke the following solr query:
```
"?q=id:MyStuff:*&start=0&rows=10&fl=id score"
```
one has to (1) escape appropriate characters according to the rules of the queryType employed (in this case solr):
```
  "?q=id\:MyStuff\:\*&start=0&rows=10&fl=id\ score"
```
then (2) escape according to general url rules:
```
  "?q=id%5C:MyStuff%5C:%5C*&start=0&rows=10&fl=id%5C%20score"
```
resulting in:
```
cn.search(session,"solr","?q=id%5C:MyStuff%5C:%5C*&start=0&rows=10&fl=id%5C%20score")
```
For solr queries, a list of query terms employed can be found at the DataONE documentation on Content Discovery solr escaping: find ClientUtils
Specified by:

search in interface CNRead

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented
See Also:
http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.search

search
```
public ObjectList search(Session session,
                String queryType,
                String query)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented
```
see DataONE API Reference This implementation handles URL-escaping for only the "queryType" parameter, and always places a slash ('/') character after it.
For example, to invoke the following solr query:
```
"?q=id:MyStuff:*&start=0&rows=10&fl=id score"
```
one has to (1) escape appropriate characters according to the rules of the queryType employed (in this case solr):
```
  "?q=id\:MyStuff\:\*&start=0&rows=10&fl=id\ score"
```
then (2) escape according to general url rules:
```
  "?q=id%5C:MyStuff%5C:%5C*&start=0&rows=10&fl=id%5C%20score"
```
resulting in:
```
cn.search(session,"solr","?q=id%5C:MyStuff%5C:%5C*&start=0&rows=10&fl=id%5C%20score")
```
For solr queries, a list of query terms employed can be found at the DataONE documentation on Content Discovery solr escaping: find ClientUtils
Specified by:

search in interface CNRead

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented
See Also:
http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.search

setRightsHolder

public Identifier setRightsHolder(Identifier pid,
                         Subject userId,
                         long serialVersion)
                           throws InvalidToken,
                                  ServiceFailure,
                                  NotFound,
                                  NotAuthorized,
                                  NotImplemented,
                                  InvalidRequest,
                                  VersionMismatch

see DataONE API Reference

Specified by:: setRightsHolder in interface CNAuthorization
Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; NotImplemented; InvalidRequest; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNAuthorization.setRightsHolder

setRightsHolder

public Identifier setRightsHolder(Session session,
                         Identifier pid,
                         Subject userId,
                         long serialVersion)
                           throws InvalidToken,
                                  ServiceFailure,
                                  NotFound,
                                  NotAuthorized,
                                  NotImplemented,
                                  InvalidRequest,
                                  VersionMismatch

see DataONE API Reference

Specified by:: setRightsHolder in interface CNAuthorization
Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; NotImplemented; InvalidRequest; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNAuthorization.setRightsHolder

isAuthorized

public boolean isAuthorized(Identifier pid,
                   Permission permission)
                     throws ServiceFailure,
                            InvalidToken,
                            NotFound,
                            NotAuthorized,
                            NotImplemented,
                            InvalidRequest

see DataONE API Reference

Specified by:: isAuthorized in interface CNAuthorization
Overrides:: isAuthorized in class D1Node
Throws:: ServiceFailure; InvalidToken; NotFound; NotAuthorized; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNAuthorization.isAuthorized

isAuthorized

public boolean isAuthorized(Session session,
                   Identifier pid,
                   Permission permission)
                     throws ServiceFailure,
                            InvalidToken,
                            NotFound,
                            NotAuthorized,
                            NotImplemented,
                            InvalidRequest

see DataONE API Reference

Specified by:: isAuthorized in interface CNAuthorization
Overrides:: isAuthorized in class D1Node
Throws:: ServiceFailure; InvalidToken; NotFound; NotAuthorized; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNAuthorization.isAuthorized

setAccessPolicy

public boolean setAccessPolicy(Identifier pid,
                      AccessPolicy accessPolicy,
                      long serialVersion)
                        throws InvalidToken,
                               NotFound,
                               NotImplemented,
                               NotAuthorized,
                               ServiceFailure,
                               InvalidRequest,
                               VersionMismatch

see DataONE API Reference

Specified by:: setAccessPolicy in interface CNAuthorization
Throws:: InvalidToken; NotFound; NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNAuthorization.setAccessPolicy

setAccessPolicy

public boolean setAccessPolicy(Session session,
                      Identifier pid,
                      AccessPolicy accessPolicy,
                      long serialVersion)
                        throws InvalidToken,
                               NotFound,
                               NotImplemented,
                               NotAuthorized,
                               ServiceFailure,
                               InvalidRequest,
                               VersionMismatch

see DataONE API Reference

Specified by:: setAccessPolicy in interface CNAuthorization
Throws:: InvalidToken; NotFound; NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNAuthorization.setAccessPolicy

registerAccount

public Subject registerAccount(Person person)
                        throws ServiceFailure,
                               NotAuthorized,
                               IdentifierNotUnique,
                               InvalidCredentials,
                               NotImplemented,
                               InvalidRequest,
                               InvalidToken

see DataONE API Reference

Specified by:: registerAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; IdentifierNotUnique; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.registerAccount

registerAccount

public Subject registerAccount(Session session,
                      Person person)
                        throws ServiceFailure,
                               NotAuthorized,
                               IdentifierNotUnique,
                               InvalidCredentials,
                               NotImplemented,
                               InvalidRequest,
                               InvalidToken

see DataONE API Reference

Specified by:: registerAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; IdentifierNotUnique; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.registerAccount

updateAccount

public Subject updateAccount(Person person)
                      throws ServiceFailure,
                             NotAuthorized,
                             InvalidCredentials,
                             NotImplemented,
                             InvalidRequest,
                             InvalidToken,
                             NotFound

see DataONE API Reference

Specified by:: updateAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.updateAccount

updateAccount

public Subject updateAccount(Session session,
                    Person person)
                      throws ServiceFailure,
                             NotAuthorized,
                             InvalidCredentials,
                             NotImplemented,
                             InvalidRequest,
                             InvalidToken,
                             NotFound

see DataONE API Reference

Specified by:: updateAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.updateAccount

verifyAccount

public boolean verifyAccount(Subject subject)
                      throws ServiceFailure,
                             NotAuthorized,
                             NotImplemented,
                             InvalidToken,
                             InvalidRequest

see DataONE API Reference

Specified by:: verifyAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; NotImplemented; InvalidToken; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.verifyAccount

verifyAccount

public boolean verifyAccount(Session session,
                    Subject subject)
                      throws ServiceFailure,
                             NotAuthorized,
                             NotImplemented,
                             InvalidToken,
                             InvalidRequest

see DataONE API Reference

Specified by:: verifyAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; NotImplemented; InvalidToken; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.verifyAccount

getSubjectInfo

public SubjectInfo getSubjectInfo(Subject subject)
                           throws ServiceFailure,
                                  NotAuthorized,
                                  NotImplemented,
                                  NotFound,
                                  InvalidToken

see DataONE API Reference

Specified by:: getSubjectInfo in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; NotImplemented; NotFound; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.getSubjectInfo

getSubjectInfo

public SubjectInfo getSubjectInfo(Session session,
                         Subject subject)
                           throws ServiceFailure,
                                  NotAuthorized,
                                  NotImplemented,
                                  NotFound,
                                  InvalidToken

see DataONE API Reference

Specified by:: getSubjectInfo in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; NotImplemented; NotFound; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.getSubjectInfo

listSubjects

public SubjectInfo listSubjects(String query,
                       String status,
                       Integer start,
                       Integer count)
                         throws InvalidRequest,
                                ServiceFailure,
                                InvalidToken,
                                NotAuthorized,
                                NotImplemented

see DataONE API Reference

Specified by:: listSubjects in interface CNIdentity
Throws:: InvalidRequest; ServiceFailure; InvalidToken; NotAuthorized; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.listSubjects

listSubjects

public SubjectInfo listSubjects(Session session,
                       String query,
                       String status,
                       Integer start,
                       Integer count)
                         throws InvalidRequest,
                                ServiceFailure,
                                InvalidToken,
                                NotAuthorized,
                                NotImplemented

see DataONE API Reference

Specified by:: listSubjects in interface CNIdentity
Throws:: InvalidRequest; ServiceFailure; InvalidToken; NotAuthorized; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.listSubjects

mapIdentity

public boolean mapIdentity(Subject primarySubject,
                  Subject secondarySubject)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotFound,
                           NotImplemented,
                           InvalidRequest,
                           IdentifierNotUnique

see DataONE API Reference

Specified by:: mapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.mapIdentity

mapIdentity

public boolean mapIdentity(Session session,
                  Subject primarySubject,
                  Subject secondarySubject)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotFound,
                           NotImplemented,
                           InvalidRequest,
                           IdentifierNotUnique

see DataONE API Reference

Specified by:: mapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.mapIdentity

requestMapIdentity

public boolean requestMapIdentity(Subject subject)
                           throws ServiceFailure,
                                  InvalidToken,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented,
                                  InvalidRequest,
                                  IdentifierNotUnique

see DataONE API Reference

Specified by:: requestMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.requestMapIdentity

requestMapIdentity

public boolean requestMapIdentity(Session session,
                         Subject subject)
                           throws ServiceFailure,
                                  InvalidToken,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented,
                                  InvalidRequest,
                                  IdentifierNotUnique

see DataONE API Reference

Specified by:: requestMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.requestMapIdentity

getPendingMapIdentity

public SubjectInfo getPendingMapIdentity(Subject subject)
                                  throws InvalidToken,
                                         ServiceFailure,
                                         NotAuthorized,
                                         NotFound,
                                         NotImplemented

see DataONE API Reference

Specified by:: getPendingMapIdentity in interface CNIdentity
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.getPendingMapIdentity

getPendingMapIdentity

public SubjectInfo getPendingMapIdentity(Session session,
                                Subject subject)
                                  throws InvalidToken,
                                         ServiceFailure,
                                         NotAuthorized,
                                         NotFound,
                                         NotImplemented

see DataONE API Reference

Specified by:: getPendingMapIdentity in interface CNIdentity
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.getPendingMapIdentity

confirmMapIdentity

public boolean confirmMapIdentity(Subject subject)
                           throws ServiceFailure,
                                  InvalidToken,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented

see DataONE API Reference

Specified by:: confirmMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.confirmMapIdentity

confirmMapIdentity

public boolean confirmMapIdentity(Session session,
                         Subject subject)
                           throws ServiceFailure,
                                  InvalidToken,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented

see DataONE API Reference

Specified by:: confirmMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.confirmMapIdentity

denyMapIdentity

public boolean denyMapIdentity(Subject subject)
                        throws ServiceFailure,
                               InvalidToken,
                               NotAuthorized,
                               NotFound,
                               NotImplemented

see DataONE API Reference

Specified by:: denyMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.denyMapIdentity

denyMapIdentity

public boolean denyMapIdentity(Session session,
                      Subject subject)
                        throws ServiceFailure,
                               InvalidToken,
                               NotAuthorized,
                               NotFound,
                               NotImplemented

see DataONE API Reference

Specified by:: denyMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.denyMapIdentity

removeMapIdentity

public boolean removeMapIdentity(Subject subject)
                          throws ServiceFailure,
                                 InvalidToken,
                                 NotAuthorized,
                                 NotFound,
                                 NotImplemented

see DataONE API Reference

Specified by:: removeMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.removeMapIdentity

removeMapIdentity

public boolean removeMapIdentity(Session session,
                        Subject subject)
                          throws ServiceFailure,
                                 InvalidToken,
                                 NotAuthorized,
                                 NotFound,
                                 NotImplemented

see DataONE API Reference

Specified by:: removeMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.removeMapIdentity

createGroup

public Subject createGroup(Group group)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotImplemented,
                           IdentifierNotUnique

see DataONE API Reference

Specified by:: createGroup in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotImplemented; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.createGroup

createGroup

public Subject createGroup(Session session,
                  Group group)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotImplemented,
                           IdentifierNotUnique

see DataONE API Reference

Specified by:: createGroup in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotImplemented; IdentifierNotUnique
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.createGroup

updateGroup

public boolean updateGroup(Group group)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotFound,
                           NotImplemented,
                           InvalidRequest

see DataONE API Reference

Specified by:: updateGroup in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.updateGroup

updateGroup

public boolean updateGroup(Session session,
                  Group group)
                    throws ServiceFailure,
                           InvalidToken,
                           NotAuthorized,
                           NotFound,
                           NotImplemented,
                           InvalidRequest

see DataONE API Reference

Specified by:: updateGroup in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNIdentity.updateGroup

updateNodeCapabilities

public boolean updateNodeCapabilities(NodeReference nodeid,
                             Node node)
                               throws NotImplemented,
                                      NotAuthorized,
                                      ServiceFailure,
                                      InvalidRequest,
                                      NotFound,
                                      InvalidToken

see DataONE API Reference

Specified by:: updateNodeCapabilities in interface CNRegister
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; NotFound; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRegister.updateNodeCapabilities

updateNodeCapabilities

public boolean updateNodeCapabilities(Session session,
                             NodeReference nodeid,
                             Node node)
                               throws NotImplemented,
                                      NotAuthorized,
                                      ServiceFailure,
                                      InvalidRequest,
                                      NotFound,
                                      InvalidToken

see DataONE API Reference

Specified by:: updateNodeCapabilities in interface CNRegister
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; NotFound; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRegister.updateNodeCapabilities

register

public NodeReference register(Node node)
                       throws NotImplemented,
                              NotAuthorized,
                              ServiceFailure,
                              InvalidRequest,
                              IdentifierNotUnique,
                              InvalidToken

see DataONE API Reference

Specified by:: register in interface CNRegister
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; IdentifierNotUnique; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRegister.register

register

public NodeReference register(Session session,
                     Node node)
                       throws NotImplemented,
                              NotAuthorized,
                              ServiceFailure,
                              InvalidRequest,
                              IdentifierNotUnique,
                              InvalidToken

see DataONE API Reference

Specified by:: register in interface CNRegister
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; IdentifierNotUnique; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRegister.register

setReplicationStatus

public boolean setReplicationStatus(Identifier pid,
                           NodeReference nodeRef,
                           ReplicationStatus status,
                           BaseException failure)
                             throws ServiceFailure,
                                    NotImplemented,
                                    InvalidToken,
                                    NotAuthorized,
                                    InvalidRequest,
                                    NotFound

see DataONE API Reference

Specified by:: setReplicationStatus in interface CNReplication
Throws:: ServiceFailure; NotImplemented; InvalidToken; NotAuthorized; InvalidRequest; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.setReplicationStatus

setReplicationStatus

public boolean setReplicationStatus(Session session,
                           Identifier pid,
                           NodeReference nodeRef,
                           ReplicationStatus status,
                           BaseException failure)
                             throws ServiceFailure,
                                    NotImplemented,
                                    InvalidToken,
                                    NotAuthorized,
                                    InvalidRequest,
                                    NotFound

see DataONE API Reference

Specified by:: setReplicationStatus in interface CNReplication
Throws:: ServiceFailure; NotImplemented; InvalidToken; NotAuthorized; InvalidRequest; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.setReplicationStatus

setReplicationPolicy

public boolean setReplicationPolicy(Identifier pid,
                           ReplicationPolicy policy,
                           long serialVersion)
                             throws NotImplemented,
                                    NotFound,
                                    NotAuthorized,
                                    ServiceFailure,
                                    InvalidRequest,
                                    InvalidToken,
                                    VersionMismatch

see DataONE API Reference

Specified by:: setReplicationPolicy in interface CNReplication
Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.setReplicationPolicy

setReplicationPolicy

public boolean setReplicationPolicy(Session session,
                           Identifier pid,
                           ReplicationPolicy policy,
                           long serialVersion)
                             throws NotImplemented,
                                    NotFound,
                                    NotAuthorized,
                                    ServiceFailure,
                                    InvalidRequest,
                                    InvalidToken,
                                    VersionMismatch

see DataONE API Reference

Specified by:: setReplicationPolicy in interface CNReplication
Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.setReplicationPolicy

isNodeAuthorized

public boolean isNodeAuthorized(Subject targetNodeSubject,
                       Identifier pid)
                         throws NotImplemented,
                                NotAuthorized,
                                InvalidToken,
                                ServiceFailure,
                                NotFound,
                                InvalidRequest

see DataONE API Reference

Specified by:: isNodeAuthorized in interface CNReplication
Throws:: NotImplemented; NotAuthorized; InvalidToken; ServiceFailure; NotFound; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.isNodeAuthorized

isNodeAuthorized

public boolean isNodeAuthorized(Session session,
                       Subject targetNodeSubject,
                       Identifier pid)
                         throws NotImplemented,
                                NotAuthorized,
                                InvalidToken,
                                ServiceFailure,
                                NotFound,
                                InvalidRequest

see DataONE API Reference

Specified by:: isNodeAuthorized in interface CNReplication
Throws:: NotImplemented; NotAuthorized; InvalidToken; ServiceFailure; NotFound; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.isNodeAuthorized

updateReplicationMetadata

public boolean updateReplicationMetadata(Identifier pid,
                                Replica replicaMetadata,
                                long serialVersion)
                                  throws NotImplemented,
                                         NotAuthorized,
                                         ServiceFailure,
                                         NotFound,
                                         InvalidRequest,
                                         InvalidToken,
                                         VersionMismatch

see DataONE API Reference

Specified by:: updateReplicationMetadata in interface CNReplication
Throws:: NotImplemented; NotAuthorized; ServiceFailure; NotFound; InvalidRequest; InvalidToken; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.updateReplicationMetadata

updateReplicationMetadata

public boolean updateReplicationMetadata(Session session,
                                Identifier pid,
                                Replica replicaMetadata,
                                long serialVersion)
                                  throws NotImplemented,
                                         NotAuthorized,
                                         ServiceFailure,
                                         NotFound,
                                         InvalidRequest,
                                         InvalidToken,
                                         VersionMismatch

see DataONE API Reference

Specified by:: updateReplicationMetadata in interface CNReplication
Throws:: NotImplemented; NotAuthorized; ServiceFailure; NotFound; InvalidRequest; InvalidToken; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.updateReplicationMetadata

deleteReplicationMetadata

public boolean deleteReplicationMetadata(Identifier pid,
                                NodeReference nodeId,
                                long serialVersion)
                                  throws InvalidToken,
                                         ServiceFailure,
                                         NotAuthorized,
                                         NotFound,
                                         NotImplemented,
                                         VersionMismatch,
                                         InvalidRequest

see DataONE API Reference

Specified by:: deleteReplicationMetadata in interface CNReplication
Throws:: InvalidRequest; InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.deleteReplicationMetadata

deleteReplicationMetadata

public boolean deleteReplicationMetadata(Session session,
                                Identifier pid,
                                NodeReference nodeId,
                                long serialVersion)
                                  throws InvalidToken,
                                         ServiceFailure,
                                         NotAuthorized,
                                         NotFound,
                                         NotImplemented,
                                         VersionMismatch,
                                         InvalidRequest

see DataONE API Reference

Specified by:: deleteReplicationMetadata in interface CNReplication
Throws:: InvalidRequest; InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.deleteReplicationMetadata

delete

public Identifier delete(Identifier pid)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         NotFound,
                         NotImplemented

Specified by:: delete in interface CNCore
Overrides:: delete in class D1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.delete

delete

public Identifier delete(Session session,
                Identifier pid)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         NotFound,
                         NotImplemented

Specified by:: delete in interface CNCore
Overrides:: delete in class D1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.delete

query

public InputStream query(String queryEngine,
                String query)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented,
                         NotFound

see DataONE API Reference

Specified by:: query in interface CNRead
Overrides:: query in class D1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.query

query

public InputStream query(String queryEngine,
                D1Url queryD1Url)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented,
                         NotFound

see DataONE API Reference

Overrides:: query in class D1Node; queryD1Url - a D1Url object that contains the necessary query bits
Returns:
Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented; NotFound

getQueryEngineDescription

public QueryEngineDescription getQueryEngineDescription(String queryEngine)
                                                 throws InvalidToken,
                                                        ServiceFailure,
                                                        NotAuthorized,
                                                        NotImplemented,
                                                        NotFound

see DataONE API Reference

Specified by:: getQueryEngineDescription in interface CNRead
Overrides:: getQueryEngineDescription in class D1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; NotFound
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.getQueryEngineDescription

listQueryEngines

public QueryEngineList listQueryEngines()
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotImplemented

see DataONE API Reference

Specified by:: listQueryEngines in interface CNRead
Overrides:: listQueryEngines in class D1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.listQueryEngines

Class CNode

Field Summary

Fields inherited from class org.dataone.client.D1Node

Fields inherited from interface org.dataone.service.cn.v1.CNCore

Constructor Summary

Method Summary

Methods inherited from class org.dataone.client.D1Node

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

CNode

CNode

Method Detail

getNodeBaseServiceUrl

lookupNodeBaseUrl

lookupNodeBaseUrl

lookupNodeId

listNodeIds

ping

listFormats

getFormat

listChecksumAlgorithms

getLogRecords

getLogRecords

getLogRecords

getLogRecords

listNodes

reserveIdentifier

reserveIdentifier

generateIdentifier

generateIdentifier

hasReservation

hasReservation

create

create

registerSystemMetadata

registerSystemMetadata

setObsoletedBy

setObsoletedBy

listObjects

listObjects

listObjects

listObjects

get

get

getSystemMetadata

getSystemMetadata

describe

describe

resolve

resolve

getChecksum

getChecksum

search

search

search

search

setRightsHolder

setRightsHolder

isAuthorized

isAuthorized

setAccessPolicy

setAccessPolicy

registerAccount

registerAccount

updateAccount

updateAccount

verifyAccount

verifyAccount

getSubjectInfo

getSubjectInfo

listSubjects

listSubjects

mapIdentity

mapIdentity

requestMapIdentity

requestMapIdentity

getPendingMapIdentity

getPendingMapIdentity