CNCore (DataONE_Common_Java 2.3.0 API)

```
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

Fields
Modifier and Type	Field and Description
`static String`	`SERVICE_VERSION`

Method Summary

Methods
Modifier and Type	Method and Description
`Identifier`	`archive(Identifier pid)`
`Identifier`	`archive(Session session, Identifier pid)` Deprecated.
`Identifier`	`create(Identifier pid, InputStream object, SystemMetadata sysmeta)`
`Identifier`	`create(Session session, Identifier pid, InputStream object, SystemMetadata sysmeta)` Deprecated.
`Identifier`	`delete(Identifier pid)`
`Identifier`	`delete(Session session, Identifier pid)` Deprecated.
`Identifier`	`generateIdentifier(Session session, String scheme, String fragment)` Deprecated.
`Identifier`	`generateIdentifier(String scheme, String fragment)`
`ObjectFormat`	`getFormat(ObjectFormatIdentifier formatid)`
`Log`	`getLogRecords(Date fromDate, Date toDate, Event event, String pidFilter, Integer start, Integer count)`
`Log`	`getLogRecords(Session session, Date fromDate, Date toDate, Event event, String pidFilter, Integer start, Integer count)` Deprecated.
`boolean`	`hasReservation(Session session, Subject subject, Identifier pid)` Deprecated.
`boolean`	`hasReservation(Subject subject, Identifier pid)`
`ChecksumAlgorithmList`	`listChecksumAlgorithms()`
`ObjectFormatList`	`listFormats()`
`NodeList`	`listNodes()`
`Date`	`ping()`
`Identifier`	`registerSystemMetadata(Identifier pid, SystemMetadata sysmeta)`
`Identifier`	`registerSystemMetadata(Session session, Identifier pid, SystemMetadata sysmeta)` Deprecated.
`Identifier`	`reserveIdentifier(Identifier pid)`
`Identifier`	`reserveIdentifier(Session session, Identifier pid)` Deprecated.
`boolean`	`setObsoletedBy(Identifier pid, Identifier obsoletedByPid, long serialVersion)`
`boolean`	`setObsoletedBy(Session session, Identifier pid, Identifier obsoletedByPid, long serialVersion)` Deprecated.

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:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CN_core.ping

listFormats

ObjectFormatList listFormats()
                             throws ServiceFailure,
                                    NotImplemented

Throws:: ServiceFailure; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.listFormats

getFormat

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

Throws:: ServiceFailure; NotFound; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getFormat

listChecksumAlgorithms

ChecksumAlgorithmList listChecksumAlgorithms()
                                             throws ServiceFailure,
                                                    NotImplemented

Throws:: ServiceFailure; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getChecksumAlgorithms

getLogRecords

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

Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getLogRecords

listNodes

NodeList listNodes()
                   throws NotImplemented,
                          ServiceFailure

Throws:: NotImplemented; ServiceFailure
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.listNodes

reserveIdentifier

Identifier reserveIdentifier(Identifier pid)
                             throws InvalidToken,
                                    ServiceFailure,
                                    NotAuthorized,
                                    IdentifierNotUnique,
                                    NotImplemented,
                                    InvalidRequest

Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.reserveIdentifier

generateIdentifier

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

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.generateIdentifier

hasReservation

boolean hasReservation(Subject subject,
                     Identifier pid)
                       throws InvalidToken,
                              ServiceFailure,
                              NotFound,
                              NotAuthorized,
                              NotImplemented,
                              InvalidRequest

Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.hasReservation

create

Identifier create(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:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.create

registerSystemMetadata

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

Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.registerSystemMetadata

setObsoletedBy

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

Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.setObsoletedBy

delete

Identifier delete(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#CNCore.delete

getLogRecords

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

Deprecated.

Throws:: InvalidToken; InvalidRequest; ServiceFailure; NotAuthorized; NotImplemented; InsufficientResources
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.getLogRecords

reserveIdentifier

@Deprecated
Identifier reserveIdentifier(Session session,
                                      Identifier pid)
                             throws InvalidToken,
                                    ServiceFailure,
                                    NotAuthorized,
                                    IdentifierNotUnique,
                                    NotImplemented,
                                    InvalidRequest

Deprecated.

Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.reserveIdentifier

generateIdentifier

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

Deprecated.

Throws:: InvalidToken; ServiceFailure; NotAuthorized; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.generateIdentifier

hasReservation

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

Deprecated.

Throws:: InvalidToken; ServiceFailure; NotFound; NotAuthorized; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.hasReservation

create

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

Deprecated.

Throws:: InvalidToken; ServiceFailure; NotAuthorized; IdentifierNotUnique; UnsupportedType; InsufficientResources; InvalidSystemMetadata; NotImplemented; InvalidRequest
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.create

registerSystemMetadata

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

Deprecated.

Throws:: NotImplemented; NotAuthorized; ServiceFailure; InvalidRequest; InvalidSystemMetadata; InvalidToken
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.registerSystemMetadata

setObsoletedBy

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

Deprecated.

Throws:: NotImplemented; NotFound; NotAuthorized; ServiceFailure; InvalidRequest; InvalidToken; VersionMismatch
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.setObsoletedBy

delete

@Deprecated
Identifier delete(Session session,
                           Identifier pid)
                  throws InvalidToken,
                         ServiceFailure,
                         InvalidRequest,
                         NotAuthorized,
                         NotFound,
                         NotImplemented

Deprecated.

Throws:: InvalidToken; ServiceFailure; InvalidRequest; NotAuthorized; NotFound; NotImplemented
See Also:: https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNCore.delete

Interface CNCore

Field Summary

Method Summary

Field Detail

SERVICE_VERSION

Method Detail

ping

listFormats

getFormat

listChecksumAlgorithms

getLogRecords

listNodes

reserveIdentifier

generateIdentifier

hasReservation

create

registerSystemMetadata

setObsoletedBy

delete

archive

getLogRecords

reserveIdentifier

generateIdentifier

hasReservation

create

registerSystemMetadata

setObsoletedBy

delete

archive