org.dataone.service.mn.tier1.v2

Interface MNRead

All Known Subinterfaces:

MNode

All Known Implementing Classes:

MultipartMNode

public interface MNRead

The DataONE Member Node Tier 1 Read interface. This defines an implementation interface for Member Nodes that wish to build an implementation that is compliant with the DataONE service definitions.

Author:

Matthew Jones

Method Summary

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, String checksumAlgorithm)
InputStream	getReplica(Session session, Identifier pid)
SystemMetadata	getSystemMetadata(Session session, Identifier id)
ObjectList	listObjects(Session session, Date fromDate, Date toDate, ObjectFormatIdentifier formatid, Identifier identifier, Boolean replicaStatus, Integer start, Integer count)
boolean	synchronizationFailed(Session session, SynchronizationFailed message)
boolean	systemMetadataChanged(Session session, Identifier id, long serialVersion, Date dateSystemMetadataLastModified)

Method Detail

get

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

InputStream is the Java native version of D1's OctetStream

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources

See Also:

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

getSystemMetadata

SystemMetadata getSystemMetadata(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.getSystemMetadata

systemMetadataChanged

boolean systemMetadataChanged(Session session,
                              Identifier id,
                              long serialVersion,
                              Date dateSystemMetadataLastModified)
                       throws InvalidToken,
                              ServiceFailure,
                              NotAuthorized,
                              NotFound,
                              NotImplemented,
                              InvalidRequest

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_auth.systemMetadataChanged

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

getChecksum

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

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

See Also:

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

listObjects

ObjectList listObjects(Session session,
                       Date fromDate,
                       Date toDate,
                       ObjectFormatIdentifier formatid,
                       Identifier identifier,
                       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/MN_APIs.html#MN_read.listObjects

synchronizationFailed

boolean synchronizationFailed(Session session,
                              SynchronizationFailed message)
                       throws InvalidToken,
                              NotAuthorized,
                              NotImplemented,
                              ServiceFailure

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

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

getReplica

InputStream getReplica(Session session,
                       Identifier pid)
                throws InvalidToken,
                       NotAuthorized,
                       NotImplemented,
                       ServiceFailure,
                       NotFound,
                       InsufficientResources

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNRead.getReplica