org.dataone.service.cn.v2

Interface CNRead

All Known Subinterfaces:

CNode

All Known Implementing Classes:

MultipartCNode

public interface CNRead

The DataONE CoordinatingNode Tier1 Read interface. This defines an implementation interface for Coordinating Nodes that wish to build an implementation that is compliant with the DataONE service definitions.

Author:

Matthew Jones

Method Summary

Methods

Modifier and Type	Method and Description
DescribeResponse	describe(Session session, Identifier id)
InputStream	get(Session session, Identifier id) InputStream is the Java native version of D1's OctetStream
Checksum	getChecksum(Session session, Identifier pid)
QueryEngineDescription	getQueryEngineDescription(Session session, String queryEngine)
SystemMetadata	getSystemMetadata(Session session, Identifier id)
ObjectList	listObjects(Session session, Date fromDate, Date toDate, ObjectFormatIdentifier formatId, NodeReference nodeId, Identifier identifier, Integer start, Integer count)
QueryEngineList	listQueryEngines(Session session)
InputStream	query(Session session, String queryEngine, String query)
ObjectLocationList	resolve(Session session, Identifier id)
ObjectList	search(Session session, String queryType, String query)

Method Detail

get

InputStream get(Session session,
              Identifier id)
                throws InvalidToken,
                       ServiceFailure,
                       NotAuthorized,
                       NotFound,
                       NotImplemented

InputStream is the Java native version of D1's OctetStream

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.get

getSystemMetadata

SystemMetadata getSystemMetadata(Session session,
                               Identifier id)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotFound,
                                        NotImplemented

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.getSystemMetadata

describe

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

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_read.describe

resolve

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.resolve

getChecksum

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.getChecksum

listObjects

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

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.listObjects

search

ObjectList search(Session session,
                String queryType,
                String query)
                  throws InvalidToken,
                         ServiceFailure,
                         NotAuthorized,
                         InvalidRequest,
                         NotImplemented

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.search

query

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.query

getQueryEngineDescription

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.getQueryEngineDescription

listQueryEngines

QueryEngineList listQueryEngines(Session session)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotImplemented

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNRead.listQueryEngines