org.dataone.service.mn.tier3.v2

Interface MNStorage

public interface MNStorage

The DataONE Member Node Tier 3 Storage 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
Identifier	archive(Session session, Identifier id) Deprecated. use updateSystemMetadata() to mark content as archived
Identifier	create(Session session, Identifier pid, InputStream object, SystemMetadata sysmeta)
Identifier	delete(Session session, Identifier id)
Identifier	generateIdentifier(Session session, String scheme, String fragment)
Identifier	update(Session session, Identifier pid, InputStream object, Identifier newPid, SystemMetadata sysmeta)
boolean	updateSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)

Method Detail

create

Identifier create(Session session,
                  Identifier pid,
                  InputStream object,
                  SystemMetadata sysmeta)
           throws IdentifierNotUnique,
                  InsufficientResources,
                  InvalidRequest,
                  InvalidSystemMetadata,
                  InvalidToken,
                  NotAuthorized,
                  NotImplemented,
                  ServiceFailure,
                  UnsupportedType

Throws:

IdentifierNotUnique

InsufficientResources

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

UnsupportedType

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.create

update

Identifier update(Session session,
                  Identifier pid,
                  InputStream object,
                  Identifier newPid,
                  SystemMetadata sysmeta)
           throws IdentifierNotUnique,
                  InsufficientResources,
                  InvalidRequest,
                  InvalidSystemMetadata,
                  InvalidToken,
                  NotAuthorized,
                  NotImplemented,
                  ServiceFailure,
                  UnsupportedType,
                  NotFound

Throws:

IdentifierNotUnique

InsufficientResources

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotImplemented

ServiceFailure

UnsupportedType

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.update

updateSystemMetadata

boolean updateSystemMetadata(Session session,
                             Identifier pid,
                             SystemMetadata sysmeta)
                      throws NotImplemented,
                             NotAuthorized,
                             NotFound,
                             ServiceFailure,
                             InvalidRequest,
                             InvalidSystemMetadata,
                             InvalidToken

Throws:

NotImplemented

NotAuthorized

NotFound

ServiceFailure

InvalidRequest

InvalidSystemMetadata

InvalidToken

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.updateSystemMetadata

delete

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.delete

archive

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

Deprecated. use updateSystemMetadata() to mark content as archived

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MN_storage.archive

generateIdentifier

Identifier generateIdentifier(Session session,
                              String scheme,
                              String fragment)
                       throws InvalidToken,
                              ServiceFailure,
                              NotAuthorized,
                              NotImplemented,
                              InvalidRequest

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/MN_APIs.html#MNStorage.generateIdentifier