org.dataone.service.cn.v2

Interface CNCore

All Known Subinterfaces:

CNode

All Known Implementing Classes:

MultipartCNode

public interface CNCore

The DataONE CoordinatingNode Tier1 Core 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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
ObjectFormatIdentifier	addFormat(Session session, ObjectFormatIdentifier formatid, ObjectFormat format)
Identifier	archive(Session session, Identifier id) Deprecated. the Authoritative Member Node is responsible for archiving content using SystemMetadata modifications
Identifier	create(Session session, Identifier pid, InputStream object, SystemMetadata sysmeta)
Identifier	delete(Session session, Identifier id)
Identifier	generateIdentifier(Session session, String scheme, String fragment)
Node	getCapabilities()
ObjectFormat	getFormat(ObjectFormatIdentifier formatid)
Log	getLogRecords(Session session, Date fromDate, Date toDate, String event, String pidFilter, Integer start, Integer count)
boolean	hasReservation(Session session, Subject subject, Identifier id)
ChecksumAlgorithmList	listChecksumAlgorithms()
ObjectFormatList	listFormats()
NodeList	listNodes()
Date	ping()
Identifier	registerSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)
Identifier	reserveIdentifier(Session session, Identifier id)
boolean	setObsoletedBy(Session session, Identifier pid, Identifier obsoletedByPid, long serialVersion) Deprecated. the Authoritative Member Node is responsible for obsoleting content using SystemMetadata modifications
boolean	synchronize(Session session, Identifier pid)
boolean	updateSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)

Field Detail

SERVICE_VERSION

static final String SERVICE_VERSION

See Also:

Constant Field Values

Method Detail

ping

Date ping()
          throws NotImplemented,
                 ServiceFailure,
                 InsufficientResources

Throws:

NotImplemented

ServiceFailure

InsufficientResources

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CN_core.ping

listFormats

ObjectFormatList listFormats()
                             throws ServiceFailure,
                                    NotImplemented

Throws:

ServiceFailure

NotImplemented

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.listFormats

getFormat

ObjectFormat getFormat(ObjectFormatIdentifier formatid)
                       throws ServiceFailure,
                              NotFound,
                              NotImplemented,
                              InvalidRequest

Throws:

ServiceFailure

NotFound

NotImplemented

InvalidRequest

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getFormat

addFormat

ObjectFormatIdentifier addFormat(Session session,
                               ObjectFormatIdentifier formatid,
                               ObjectFormat format)
                                 throws ServiceFailure,
                                        NotFound,
                                        NotImplemented,
                                        InvalidRequest,
                                        NotAuthorized,
                                        InvalidToken

Throws:

ServiceFailure

NotFound

NotImplemented

InvalidRequest

NotAuthorized

InvalidToken

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getFormat

listChecksumAlgorithms

ChecksumAlgorithmList listChecksumAlgorithms()
                                             throws ServiceFailure,
                                                    NotImplemented

Throws:

ServiceFailure

NotImplemented

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getChecksumAlgorithms

getLogRecords

Log getLogRecords(Session session,
                Date fromDate,
                Date toDate,
                String event,
                String pidFilter,
                Integer start,
                Integer count)
                  throws InvalidToken,
                         InvalidRequest,
                         ServiceFailure,
                         NotAuthorized,
                         NotImplemented,
                         InsufficientResources

Throws:

InvalidToken

InvalidRequest

ServiceFailure

NotAuthorized

NotImplemented

InsufficientResources

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getLogRecords

listNodes

NodeList listNodes()
                   throws NotImplemented,
                          ServiceFailure

Throws:

NotImplemented

ServiceFailure

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.listNodes

reserveIdentifier

Identifier reserveIdentifier(Session session,
                           Identifier id)
                             throws InvalidToken,
                                    ServiceFailure,
                                    NotAuthorized,
                                    IdentifierNotUnique,
                                    NotImplemented,
                                    InvalidRequest

Throws:

InvalidToken

ServiceFailure

NotAuthorized

IdentifierNotUnique

NotImplemented

InvalidRequest

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.reserveIdentifier

getCapabilities

Node getCapabilities()
                     throws NotImplemented,
                            ServiceFailure

Throws:

NotImplemented

ServiceFailure

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.getCapabilities

generateIdentifier

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotImplemented

InvalidRequest

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.generateIdentifier

hasReservation

boolean hasReservation(Session session,
                     Subject subject,
                     Identifier id)
                       throws InvalidToken,
                              ServiceFailure,
                              NotFound,
                              NotAuthorized,
                              NotImplemented,
                              InvalidRequest

Throws:

InvalidToken

ServiceFailure

NotFound

NotAuthorized

NotImplemented

InvalidRequest

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.hasReservation

create

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

IdentifierNotUnique

UnsupportedType

InsufficientResources

InvalidSystemMetadata

NotImplemented

InvalidRequest

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.create

registerSystemMetadata

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

Throws:

NotImplemented

NotAuthorized

ServiceFailure

InvalidRequest

InvalidSystemMetadata

InvalidToken

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.registerSystemMetadata

synchronize

boolean synchronize(Session session,
                  Identifier pid)
                    throws NotImplemented,
                           NotAuthorized,
                           ServiceFailure,
                           InvalidRequest,
                           InvalidSystemMetadata,
                           InvalidToken

Throws:

NotImplemented

NotAuthorized

ServiceFailure

InvalidRequest

InvalidSystemMetadata

InvalidToken

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.synchronize

updateSystemMetadata

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

Throws:

NotImplemented

NotAuthorized

ServiceFailure

InvalidRequest

InvalidSystemMetadata

InvalidToken

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.updateSystemMetadata

setObsoletedBy

boolean setObsoletedBy(Session session,
                     Identifier pid,
                     Identifier obsoletedByPid,
                     long serialVersion)
                       throws NotImplemented,
                              NotFound,
                              NotAuthorized,
                              ServiceFailure,
                              InvalidRequest,
                              InvalidToken,
                              VersionMismatch

Deprecated. the Authoritative Member Node is responsible for obsoleting content using SystemMetadata modifications

Throws:

NotImplemented

NotFound

NotAuthorized

ServiceFailure

InvalidRequest

InvalidToken

VersionMismatch

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.setObsoletedBy

delete

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

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.delete

archive

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

Deprecated. the Authoritative Member Node is responsible for archiving content using SystemMetadata modifications

Throws:

InvalidToken

ServiceFailure

NotAuthorized

NotFound

NotImplemented

See Also:

http://mule1.dataone.org/ArchitectureDocs-current/apis/CN_APIs.html#CNCore.archive