HttpCNode (DataONE Java Client Library 1.4.0-SNAPSHOT API)

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

All Implemented Interfaces:

CNode, D1Node, CNAuthorization, CNCore, CNIdentity, CNRead, CNRegister, CNReplication
```
public class HttpCNode
extends MultipartCNode
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.impl.rest.MultipartD1Node
  nodeType, restClient, 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
`HttpCNode(MultipartRestClient mrc, String nodeBaseServiceUrl)` Construct a Coordinating Node, passing in the base url for node services.
`HttpCNode(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`	`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
`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
`InputStream`	`get(Identifier pid)` Get the resource with the specified pid.
`InputStream`	`get(Session session, Identifier pid)` Get the resource with the specified pid.
`Integer`	`getDefaultSoTimeout()`
`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
`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.
`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
`NodeReference`	`register(Node node)` 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
`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.
`void`	`setDefaultSoTimeout(Integer defaultSoTimeout)`
`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
`protected org.apache.http.client.config.RequestConfig`	`setTimeouts(Integer milliseconds)`
`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

Methods inherited from class org.dataone.client.impl.rest.MultipartCNode
archive, archive, confirmMapIdentity, confirmMapIdentity, createGroup, createGroup, delete, delete, denyMapIdentity, denyMapIdentity, describe, describe, generateIdentifier, generateIdentifier, getChecksum, getChecksum, getFormat, getNodeBaseServiceUrl, getPendingMapIdentity, getPendingMapIdentity, getQueryEngineDescription, getSubjectInfo, getSubjectInfo, hasReservation, hasReservation, isAuthorized, isAuthorized, isNodeAuthorized, isNodeAuthorized, listChecksumAlgorithms, listFormats, listNodeIds, listNodes, listQueryEngines, listSubjects, listSubjects, lookupNodeBaseUrl, lookupNodeBaseUrl, lookupNodeId, mapIdentity, mapIdentity, ping, query, query, register, registerAccount, registerAccount, removeMapIdentity, removeMapIdentity, requestMapIdentity, requestMapIdentity, setAccessPolicy, setAccessPolicy, setObsoletedBy, setObsoletedBy, setRightsHolder, setRightsHolder, updateAccount, updateAccount, updateGroup, updateGroup, updateNodeCapabilities, updateNodeCapabilities, verifyAccount, verifyAccount

Methods inherited from class org.dataone.client.impl.rest.MultipartD1Node
deserializeServiceType, getChecksum, getChecksum, getLatestRequestUrl, getNodeId, getNodeType, getSystemMetadata, getSystemMetadata, localizeInputStream, setNodeBaseServiceUrl, setNodeId, setNodeType

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, getNodeBaseServiceUrl, getNodeId, getNodeType, setNodeId, setNodeType

Methods inherited from interface org.dataone.service.cn.v1.CNCore
archive, archive, delete, delete, generateIdentifier, generateIdentifier, getFormat, hasReservation, hasReservation, listChecksumAlgorithms, listFormats, listNodes, ping, setObsoletedBy, setObsoletedBy

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

Methods inherited from interface org.dataone.service.cn.v1.CNAuthorization
isAuthorized, isAuthorized, setAccessPolicy, setAccessPolicy, setRightsHolder, setRightsHolder

Methods inherited from interface org.dataone.service.cn.v1.CNIdentity
confirmMapIdentity, confirmMapIdentity, createGroup, createGroup, denyMapIdentity, denyMapIdentity, getPendingMapIdentity, getPendingMapIdentity, getSubjectInfo, getSubjectInfo, listSubjects, listSubjects, mapIdentity, mapIdentity, registerAccount, registerAccount, removeMapIdentity, removeMapIdentity, requestMapIdentity, requestMapIdentity, updateAccount, updateAccount, updateGroup, updateGroup, verifyAccount, verifyAccount

Methods inherited from interface org.dataone.service.cn.v1.CNRegister
register, updateNodeCapabilities, updateNodeCapabilities

Methods inherited from interface org.dataone.service.cn.v1.CNReplication
isNodeAuthorized, isNodeAuthorized

Field Detail

log

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

Constructor Detail
- HttpCNode
```
public HttpCNode(MultipartRestClient mrc,
         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.
- HttpCNode
```
public HttpCNode(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

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 MultipartCNode
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 MultipartCNode
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 MultipartCNode
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 MultipartCNode
Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getLogRecords

reserveIdentifier

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

see DataONE API Reference

Specified by:: reserveIdentifier in interface CNCore
Overrides:: reserveIdentifier in class MultipartCNode
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
Overrides:: reserveIdentifier in class MultipartCNode
Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; NotImplemented; InvalidRequest
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.reserveIdentifier

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
Overrides:: create in class MultipartCNode
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
Overrides:: create in class MultipartCNode
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
Overrides:: registerSystemMetadata in class MultipartCNode
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
Overrides:: registerSystemMetadata in class MultipartCNode
Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.registerSystemMetadata

listObjects

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

see DataONE API Reference

Overrides:: listObjects in class MultipartCNode
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 MultipartCNode
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 MultipartCNode
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 MultipartCNode
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: MultipartD1Node

Get the resource with the specified pid. Used by both the CNode and MultipartMNode 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 MultipartD1Node was created. Otherwise InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface CNRead

Overrides:

get in class MultipartCNode

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. 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 MultipartD1Node was created. Otherwise InputStream is the Java native version of D1's OctetStream

Specified by:

get in interface CNRead

Overrides:

get in class MultipartCNode

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

Get the system metadata from a resource with the specified guid. Used by both the CNode and MultipartMNode 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 MultipartCNode

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

Get the system metadata from a resource with the specified guid. Used by both the CNode and MultipartMNode 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 MultipartCNode

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

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

resolve

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

see DataONE API Reference

Specified by:: resolve in interface CNRead
Overrides:: resolve in class MultipartCNode
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
Overrides:: resolve in class MultipartCNode
Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNRead.resolve

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

Overrides:

search in class MultipartCNode

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

Overrides:

search in class MultipartCNode

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

Overrides:

search in class MultipartCNode

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

Overrides:

search in class MultipartCNode

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

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

register

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

see DataONE API Reference

Specified by:: register in interface CNRegister
Overrides:: register in class MultipartCNode
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
Overrides:: setReplicationStatus in class MultipartCNode
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
Overrides:: setReplicationStatus in class MultipartCNode
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
Overrides:: setReplicationPolicy in class MultipartCNode
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
Overrides:: setReplicationPolicy in class MultipartCNode
Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.setReplicationPolicy

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
Overrides:: updateReplicationMetadata in class MultipartCNode
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
Overrides:: updateReplicationMetadata in class MultipartCNode
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
Overrides:: deleteReplicationMetadata in class MultipartCNode
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
Overrides:: deleteReplicationMetadata in class MultipartCNode
Throws:: InvalidRequest; InvalidToken; ServiceFailure; NotAuthorized; NotFound; NotImplemented; VersionMismatch
See Also:: http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNReplication.deleteReplicationMetadata

setTimeouts

protected org.apache.http.client.config.RequestConfig setTimeouts(Integer milliseconds)

getDefaultSoTimeout
```
public Integer getDefaultSoTimeout()
```

setDefaultSoTimeout

public void setDefaultSoTimeout(Integer defaultSoTimeout)

Class HttpCNode

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class org.dataone.client.impl.rest.MultipartCNode

Methods inherited from class org.dataone.client.impl.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.v1.CNCore

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

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

Methods inherited from interface org.dataone.service.cn.v1.CNIdentity

Methods inherited from interface org.dataone.service.cn.v1.CNRegister

Methods inherited from interface org.dataone.service.cn.v1.CNReplication

Field Detail

log

Constructor Detail

HttpCNode

HttpCNode

Method Detail

getLogRecords

getLogRecords

getLogRecords

getLogRecords

reserveIdentifier

reserveIdentifier

create

create

registerSystemMetadata

registerSystemMetadata

listObjects

listObjects

listObjects

listObjects

get

get

getSystemMetadata

getSystemMetadata

resolve

resolve

search

search

search

search

register

setReplicationStatus

setReplicationStatus

setReplicationPolicy

setReplicationPolicy

updateReplicationMetadata

updateReplicationMetadata

deleteReplicationMetadata

deleteReplicationMetadata

setTimeouts

getDefaultSoTimeout

setDefaultSoTimeout