MultipartCNode (DataONE Java Client Library 2.3.0 API)

java.lang.Object
- org.dataone.client.rest.MultipartD1Node
- - org.dataone.client.v2.impl.MultipartD1Node
  - - org.dataone.client.v2.impl.MultipartCNode

All Implemented Interfaces:

D1Node, CNode, CNAuthorization, CNCore, CNDiagnostic, CNIdentity, CNRead, CNRegister, CNReplication, CNView
```
public class MultipartCNode
extends MultipartD1Node
implements CNode
```
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.rest.MultipartD1Node
  defaultRestClient, defaultSession, latestRestClient, latestSession, nodeType
- Fields inherited from interface org.dataone.service.cn.v2.CNCore
  SERVICE_VERSION

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

Constructor Summary

Constructors
Constructor and Description
`MultipartCNode(MultipartRestClient mrc, String nodeBaseServiceUrl)` Construct a new client-side MultipartCNode (Coordinating Node) object, passing in the base url of the member node for calling its services.
`MultipartCNode(MultipartRestClient mrc, String nodeBaseServiceUrl, Session session)` Construct a new client-side MultipartCNode (Coordinating Node) object, passing in the base url of the member node for calling its services, and the Session to use for connections to that node.
`MultipartCNode(String nodeBaseServiceUrl)` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`ObjectFormatIdentifier`	`addFormat(Session session, ObjectFormatIdentifier formatid, ObjectFormat format)`
`boolean`	`confirmMapIdentity(Session session, Subject subject)`
`Identifier`	`create(Session session, Identifier pid, InputStream object, SystemMetadata sysmeta)`
`Subject`	`createGroup(Session session, Group group)`
`boolean`	`deleteReplicationMetadata(Session session, Identifier pid, NodeReference nodeId, long serialVersion)`
`boolean`	`denyMapIdentity(Session session, Subject subject)`
`SubjectInfo`	`echoCredentials(Session session)`
`InputStream`	`echoIndexedObject(Session session, String queryEngine, SystemMetadata sysmeta, InputStream object)`
`SystemMetadata`	`echoSystemMetadata(Session session, SystemMetadata sysmeta)`
`InputStream`	`get(Identifier pid)` Get the resource with the specified pid.
`InputStream`	`get(Session session, Identifier pid)` Get the resource with the specified pid.
`Node`	`getCapabilities()`
`Checksum`	`getChecksum(Session session, Identifier pid)`
`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(Session session, Date fromDate, Date toDate, String event, String idFilter, Integer start, Integer count)`
`String`	`getNodeBaseServiceUrl()` Retrieve the service URL for this node.
`Node`	`getNodeCapabilities(NodeReference nodeRef)`
`SubjectInfo`	`getPendingMapIdentity(Session session, Subject subject)`
`SubjectInfo`	`getSubjectInfo(Session session, Subject subject)`
`SystemMetadata`	`getSystemMetadata(Session session, Identifier id)` Get the system metadata from a resource with the specified guid, potentially using the local system metadata cache if specified to do so.
`boolean`	`hasReservation(Session session, Subject subject, Identifier pid)`
`boolean`	`isNodeAuthorized(Session session, Subject targetNodeSubject, Identifier pid)`
`ChecksumAlgorithmList`	`listChecksumAlgorithms()`
`ObjectFormatList`	`listFormats()`
`NodeList`	`listNodes()`
`ObjectList`	`listObjects(Session session, Date fromDate, Date toDate, ObjectFormatIdentifier formatid, NodeReference nodeId, Identifier identifier, Integer start, Integer count)`
`SubjectInfo`	`listSubjects(Session session, String query, String status, Integer start, Integer count)`
`OptionList`	`listViews()`
`boolean`	`mapIdentity(Session session, Subject primarySubject, Subject secondarySubject)`
`NodeReference`	`register(Session session, Node node)`
`Subject`	`registerAccount(Session session, Person person)`
`Identifier`	`registerSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)`
`boolean`	`removeMapIdentity(Session session, Subject subject)`
`boolean`	`requestMapIdentity(Session session, Subject subject)`
`Identifier`	`reserveIdentifier(Session session, Identifier pid)`
`ObjectLocationList`	`resolve(Session session, Identifier pid)`
`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.
`boolean`	`setAccessPolicy(Session session, Identifier pid, AccessPolicy accessPolicy, long serialVersion)`
`boolean`	`setObsoletedBy(Session session, Identifier pid, Identifier obsoletedByPid, long serialVersion)`
`boolean`	`setReplicationPolicy(Session session, Identifier pid, ReplicationPolicy policy, long serialVersion)`
`boolean`	`setReplicationStatus(Session session, Identifier pid, NodeReference nodeRef, ReplicationStatus status, BaseException failure)`
`Identifier`	`setRightsHolder(Session session, Identifier pid, Subject userId, long serialVersion)`
`boolean`	`synchronize(Session session, Identifier pid)`
`Subject`	`updateAccount(Session session, Person person)`
`boolean`	`updateGroup(Session session, Group group)`
`boolean`	`updateNodeCapabilities(Session session, NodeReference nodeid, Node node)`
`boolean`	`updateReplicationMetadata(Session session, Identifier pid, Replica replicaMetadata, long serialVersion)`
`boolean`	`updateSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)`
`boolean`	`verifyAccount(Session session, Subject subject)`
`InputStream`	`view(Session session, String theme, Identifier id)`

Methods inherited from class org.dataone.client.rest.MultipartD1Node
archive, archive, closeLoudly, delete, delete, describe, describe, deserializeServiceType, generateIdentifier, generateIdentifier, getChecksum, getChecksum, getLatestRequestUrl, getNodeId, getNodeType, getQueryEngineDescription, getRestClient, isAuthorized, isAuthorized, listQueryEngines, listViews, ping, query, setNodeBaseServiceUrl, setNodeId, setNodeType, systemMetadataChanged

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

Methods inherited from interface org.dataone.client.D1Node
getLatestRequestUrl, getNodeId, getNodeType, setNodeId, setNodeType

Methods inherited from interface org.dataone.service.cn.v2.CNCore
archive, delete, generateIdentifier, ping

Methods inherited from interface org.dataone.service.cn.v2.CNRead
describe, getQueryEngineDescription, listQueryEngines, query

Methods inherited from interface org.dataone.service.cn.v2.CNAuthorization
isAuthorized

Field Detail

log

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

Constructor Detail
- MultipartCNode
```
@Deprecated
public MultipartCNode(String nodeBaseServiceUrl)
               throws IOException,
                      ClientSideException
```
  Deprecated.
  
  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.
  
  Throws:
  
  ClientSideException
  
  IOException
- MultipartCNode
```
public MultipartCNode(MultipartRestClient mrc,
              String nodeBaseServiceUrl)
```
  Construct a new client-side MultipartCNode (Coordinating Node) object, passing in the base url of the member node for calling its services.
  
  Parameters:
  nodeBaseServiceUrl - base url for constructing service endpoints.
- MultipartCNode
```
public MultipartCNode(MultipartRestClient mrc,
              String nodeBaseServiceUrl,
              Session session)
```
  Construct a new client-side MultipartCNode (Coordinating Node) object, passing in the base url of the member node for calling its services, and the Session to use for connections to that node.
  
  Parameters:
  nodeBaseServiceUrl - base url for constructing service endpoints.
  defaultSession - - the Session object passed to the CertificateManager to be used for establishing connections

Method Detail

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

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.

Specified by:

getNodeBaseServiceUrl in interface D1Node

Overrides:

getNodeBaseServiceUrl in class MultipartD1Node

Returns:
String representing the service URL

listFormats

public ObjectFormatList listFormats()
                             throws ServiceFailure,
                                    NotImplemented

Specified by:: listFormats in interface CNCore
Throws:: ServiceFailure; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.listFormats

addFormat

public ObjectFormatIdentifier addFormat(Session session,
                               ObjectFormatIdentifier formatid,
                               ObjectFormat format)
                                 throws ServiceFailure,
                                        NotFound,
                                        NotImplemented,
                                        InvalidRequest,
                                        NotAuthorized,
                                        InvalidToken

Specified by:: addFormat in interface CNCore
Throws:: ServiceFailure; NotFound; NotImplemented; InvalidRequest; NotAuthorized; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getFormat

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:
https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getFormat

listObjects

public ObjectList listObjects(Session session,
                     Date fromDate,
                     Date toDate,
                     ObjectFormatIdentifier formatid,
                     NodeReference nodeId,
                     Identifier identifier,
                     Integer start,
                     Integer count)
                       throws InvalidRequest,
                              InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

Specified by:: listObjects in interface CNRead
Throws:: InvalidRequest; InvalidToken; NotAuthorized; NotImplemented; ServiceFailure
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.listObjects

listChecksumAlgorithms

public ChecksumAlgorithmList listChecksumAlgorithms()
                                             throws ServiceFailure,
                                                    NotImplemented

Specified by:: listChecksumAlgorithms in interface CNCore
Throws:: ServiceFailure; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getChecksumAlgorithms

getLogRecords

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

Specified by:: getLogRecords in interface CNCore
Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getLogRecords

getCapabilities
```
public Node getCapabilities()
                     throws NotImplemented,
                            ServiceFailure
```
Specified by:

getCapabilities in interface CNCore

Overrides:

getCapabilities in class MultipartD1Node

Throws:

NotImplemented

ServiceFailure
See Also:
https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getCapabilities

listNodes
```
public NodeList listNodes()
                   throws NotImplemented,
                          ServiceFailure
```
Specified by:

listNodes in interface CNCore

Throws:

NotImplemented

ServiceFailure
See Also:
https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.listNodes

getNodeCapabilities
```
public Node getNodeCapabilities(NodeReference nodeRef)
                         throws NotImplemented,
                                ServiceFailure
```
Specified by:

getNodeCapabilities in interface CNRegister

Throws:

NotImplemented

ServiceFailure
See Also:
https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRegister.getNodeCapabilities

reserveIdentifier

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

Specified by:: reserveIdentifier in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.reserveIdentifier

hasReservation

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

Specified by:: hasReservation in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; InvalidRequest; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.hasReservation

create

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

Specified by:: create in interface CNCore
Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; UnsupportedType; InsufficientResources; InvalidSystemMetadata; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.create

updateSystemMetadata

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

Specified by:: updateSystemMetadata in interface CNCore
Overrides:: updateSystemMetadata in class MultipartD1Node
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.updateSystemMetadata

registerSystemMetadata

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

Specified by:: registerSystemMetadata in interface CNCore
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.registerSystemMetadata

synchronize

public boolean synchronize(Session session,
                  Identifier pid)
                    throws NotImplemented,
                           NotAuthorized,
                           ServiceFailure,
                           InvalidRequest,
                           InvalidSystemMetadata,
                           InvalidToken

Specified by:: synchronize in interface CNCore
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.synchronize

setObsoletedBy

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

Specified by:: setObsoletedBy in interface CNCore
Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.setObsoletedBy

getSystemMetadata
```
public SystemMetadata getSystemMetadata(Session session,
                               Identifier id)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotFound,
                                        NotImplemented
```
Get the system metadata from a resource with the specified guid, potentially using the local system metadata cache if specified to do so. Used by both the CNode and MultipartMNode implementations. Because SystemMetadata is mutable, caching can lead to currency 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 setting useSystemMetadadataCache to true.

Specified by:

getSystemMetadata in interface CNRead

Overrides:

getSystemMetadata in class MultipartD1Node

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

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

resolve

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

Specified by:: resolve in interface CNRead
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.resolve

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

Get the resource with the specified pid. Used by both the CNode and MultipartMNode subclasses. InputStream is the Java native version of D1's OctetStream

Overrides:

get in class MultipartD1Node

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: MultipartD1Node

Get the resource with the specified pid. Used by both the CNode and MultipartMNode subclasses. InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface CNRead

Overrides:

get in class MultipartD1Node

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

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

getChecksum

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

Specified by:: getChecksum in interface CNRead
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/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(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(defaultSession,"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:
https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.search

setRightsHolder

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

Specified by:: setRightsHolder in interface CNAuthorization
Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; NotImplemented; InvalidRequest; VersionMismatch
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.setRightsHolder

setAccessPolicy

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

Specified by:: setAccessPolicy in interface CNAuthorization
Throws:: InvalidToken; NotFound; NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; VersionMismatch
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNAuthorization.setAccessPolicy

registerAccount

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

Specified by:: registerAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; IdentifierNotUnique; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.registerAccount

updateAccount

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

Specified by:: updateAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; InvalidCredentials; NotImplemented; InvalidRequest; InvalidToken; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.updateAccount

verifyAccount

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

Specified by:: verifyAccount in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; NotImplemented; InvalidToken; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.verifyAccount

getSubjectInfo

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

Specified by:: getSubjectInfo in interface CNIdentity
Throws:: ServiceFailure; NotAuthorized; NotImplemented; NotFound; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.getSubjectInfo

listSubjects

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

Specified by:: listSubjects in interface CNIdentity
Throws:: InvalidRequest; ServiceFailure; InvalidToken; NotAuthorized; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.listSubjects

mapIdentity

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

Specified by:: mapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.mapIdentity

requestMapIdentity

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

Specified by:: requestMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest; IdentifierNotUnique
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.requestMapIdentity

getPendingMapIdentity

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

Specified by:: getPendingMapIdentity in interface CNIdentity
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.getPendingMapIdentity

confirmMapIdentity

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

Specified by:: confirmMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.confirmMapIdentity

denyMapIdentity

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

Specified by:: denyMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.denyMapIdentity

removeMapIdentity

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

Specified by:: removeMapIdentity in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.removeMapIdentity

createGroup

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

Specified by:: createGroup in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotImplemented; IdentifierNotUnique
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.createGroup

updateGroup

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

Specified by:: updateGroup in interface CNIdentity
Throws:: ServiceFailure; InvalidToken; NotAuthorized; NotFound; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNIdentity.updateGroup

updateNodeCapabilities

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

Specified by:: updateNodeCapabilities in interface CNRegister
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; NotFound; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRegister.updateNodeCapabilities

register

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

Specified by:: register in interface CNRegister
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; IdentifierNotUnique; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRegister.register

setReplicationStatus

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

Specified by:: setReplicationStatus in interface CNReplication
Throws:: ServiceFailure; NotImplemented; InvalidToken; NotAuthorized; InvalidRequest; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.setReplicationStatus

setReplicationPolicy

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

Specified by:: setReplicationPolicy in interface CNReplication
Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.setReplicationPolicy

isNodeAuthorized

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

Specified by:: isNodeAuthorized in interface CNReplication
Throws:: NotImplemented; NotAuthorized; InvalidToken; ServiceFailure; NotFound; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.isNodeAuthorized

updateReplicationMetadata

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

Specified by:: updateReplicationMetadata in interface CNReplication
Throws:: NotImplemented; NotAuthorized; ServiceFailure; NotFound; InvalidRequest; InvalidToken; VersionMismatch
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.updateReplicationMetadata

deleteReplicationMetadata

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

Specified by:: deleteReplicationMetadata in interface CNReplication
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented; VersionMismatch; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.deleteReplicationMetadata

view

public InputStream view(Session session,
               String theme,
               Identifier id)
                 throws InvalidToken,
                        ServiceFailure,
                        NotAuthorized,
                        InvalidRequest,
                        NotImplemented,
                        NotFound

Specified by:: view in interface CNView
Overrides:: view in class MultipartD1Node
Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented; NotFound
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNView.view

listViews

public OptionList listViews()
                     throws InvalidToken,
                            ServiceFailure,
                            NotAuthorized,
                            InvalidRequest,
                            NotImplemented

Specified by:: listViews in interface CNView
Throws:: InvalidToken; ServiceFailure; NotAuthorized; InvalidRequest; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNView.listViews

echoCredentials

public SubjectInfo echoCredentials(Session session)
                            throws NotImplemented,
                                   ServiceFailure,
                                   InvalidToken

Specified by:: echoCredentials in interface CNDiagnostic
Throws:: NotImplemented; ServiceFailure; InvalidToken

echoSystemMetadata

public SystemMetadata echoSystemMetadata(Session session,
                                SystemMetadata sysmeta)
                                  throws NotImplemented,
                                         ServiceFailure,
                                         NotAuthorized,
                                         InvalidToken,
                                         InvalidRequest,
                                         IdentifierNotUnique,
                                         InvalidSystemMetadata

Specified by:: echoSystemMetadata in interface CNDiagnostic
Throws:: NotImplemented; ServiceFailure; NotAuthorized; InvalidToken; InvalidRequest; IdentifierNotUnique; InvalidSystemMetadata

echoIndexedObject

public InputStream echoIndexedObject(Session session,
                            String queryEngine,
                            SystemMetadata sysmeta,
                            InputStream object)
                              throws NotImplemented,
                                     ServiceFailure,
                                     NotAuthorized,
                                     InvalidToken,
                                     InvalidRequest,
                                     InvalidSystemMetadata,
                                     UnsupportedType,
                                     UnsupportedMetadataType,
                                     InsufficientResources

Specified by:: echoIndexedObject in interface CNDiagnostic
Throws:: NotImplemented; ServiceFailure; NotAuthorized; InvalidToken; InvalidRequest; InvalidSystemMetadata; UnsupportedType; UnsupportedMetadataType; InsufficientResources

Class MultipartCNode

Field Summary

Fields inherited from class org.dataone.client.rest.MultipartD1Node

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

Constructor Summary

Method Summary

Methods inherited from class org.dataone.client.rest.MultipartD1Node

Methods inherited from class java.lang.Object

Methods inherited from interface org.dataone.client.D1Node

Methods inherited from interface org.dataone.service.cn.v2.CNCore

Methods inherited from interface org.dataone.service.cn.v2.CNRead

Methods inherited from interface org.dataone.service.cn.v2.CNAuthorization

Field Detail

log

Constructor Detail

MultipartCNode

MultipartCNode

MultipartCNode

Method Detail

getNodeBaseServiceUrl

listFormats

addFormat

getFormat

listObjects

listChecksumAlgorithms

getLogRecords

getCapabilities

listNodes

getNodeCapabilities

reserveIdentifier

hasReservation

create

updateSystemMetadata

registerSystemMetadata

synchronize

setObsoletedBy

getSystemMetadata

resolve

get

get

getChecksum

search

search

search

setRightsHolder

setAccessPolicy

registerAccount

updateAccount

verifyAccount

getSubjectInfo

listSubjects

mapIdentity

requestMapIdentity

getPendingMapIdentity

confirmMapIdentity

denyMapIdentity

removeMapIdentity

createGroup

updateGroup

updateNodeCapabilities

register

setReplicationStatus

setReplicationPolicy

isNodeAuthorized

updateReplicationMetadata

deleteReplicationMetadata

view

listViews

echoCredentials

echoSystemMetadata

echoIndexedObject