org.dataone.service.mn.tier1.v1

Interface MNRead

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

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, String checksumAlgorithm)
Checksum	getChecksum(Session session, Identifier pid, String checksumAlgorithm) Deprecated.
InputStream	getReplica(Identifier pid)
InputStream	getReplica(Session session, Identifier pid) Deprecated.
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.
boolean	synchronizationFailed(Session session, SynchronizationFailed message) Deprecated.
boolean	synchronizationFailed(SynchronizationFailed message)

Method Detail

get

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

getChecksum

Checksum getChecksum(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(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/MN_APIs.html#MN_read.listObjects

synchronizationFailed

boolean synchronizationFailed(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(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

get

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

Deprecated.

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

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

getChecksum

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

Deprecated.

Throws:

InvalidRequest

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_read.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/MN_APIs.html#MN_read.listObjects

synchronizationFailed

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

Deprecated.

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

See Also:

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

getReplica

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

Deprecated.

Throws:

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

NotFound

InsufficientResources

See Also:

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