org.dataone.service.cn.v1

Interface CNRead

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(Identifier pid)
DescribeResponse	describe(Session session, Identifier pid) Deprecated.
InputStream	get(Identifier pid) InputStream is the Java native version of D1's OctetStream
InputStream	get(Session session, Identifier pid) Deprecated.
Checksum	getChecksum(Identifier pid)
Checksum	getChecksum(Session session, Identifier pid) Deprecated.
QueryEngineDescription	getQueryEngineDescription(String queryEngine)
SystemMetadata	getSystemMetadata(Identifier pid)
SystemMetadata	getSystemMetadata(Session session, Identifier pid) Deprecated.
ObjectList	listObjects(Date fromDate, Date toDate, ObjectFormatIdentifier formatId, Boolean replicaStatus, Integer start, Integer count)
ObjectList	listObjects(Session session, Date fromDate, Date toDate, ObjectFormatIdentifier formatId, Boolean replicaStatus, Integer start, Integer count) Deprecated.
QueryEngineList	listQueryEngines()
InputStream	query(String queryEngine, String query)
ObjectLocationList	resolve(Identifier pid)
ObjectLocationList	resolve(Session session, Identifier pid) Deprecated.
ObjectList	search(Session session, String queryType, String query) Deprecated.
ObjectList	search(String queryType, String query)

Method Detail

get

InputStream get(Identifier pid)
                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(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.getSystemMetadata

describe

DescribeResponse describe(Identifier pid)
                          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(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.resolve

getChecksum

Checksum getChecksum(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(Date fromDate,
                     Date toDate,
                     ObjectFormatIdentifier formatId,
                     Boolean replicaStatus,
                     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(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(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(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()
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotImplemented

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

See Also:

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

get

@Deprecated
InputStream get(Session session,
                         Identifier pid)
                throws InvalidToken,
                       ServiceFailure,
                       NotAuthorized,
                       NotFound,
                       NotImplemented

Deprecated.

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

@Deprecated
SystemMetadata getSystemMetadata(Session session,
                                          Identifier pid)
                                 throws InvalidToken,
                                        ServiceFailure,
                                        NotAuthorized,
                                        NotFound,
                                        NotImplemented

Deprecated.

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

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

describe

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

Deprecated.

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

See Also:

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

resolve

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

Deprecated.

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

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

getChecksum

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

Deprecated.

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

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

listObjects

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

Deprecated.

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

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

search

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

Deprecated.

Throws:

InvalidToken

ServiceFailure

NotAuthorized

InvalidRequest

NotImplemented

See Also:

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