org.dataone.service.cn.v1

Interface CNReplication

public interface CNReplication

The DataONE CoordinatingNode Tier4 Replication 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

Method Summary

Modifier and Type	Method and Description
boolean	deleteReplicationMetadata(Identifier pid, NodeReference nodeId, long serialVersion)
boolean	deleteReplicationMetadata(Session session, Identifier pid, NodeReference nodeId, long serialVersion) Deprecated.
boolean	isNodeAuthorized(Session originatingNodeSession, Subject targetNodeSubject, Identifier pid) Deprecated.
boolean	isNodeAuthorized(Subject targetNodeSubject, Identifier pid)
boolean	setReplicationPolicy(Identifier pid, ReplicationPolicy policy, long serialVersion)
boolean	setReplicationPolicy(Session session, Identifier pid, ReplicationPolicy policy, long serialVersion) Deprecated.
boolean	setReplicationStatus(Identifier pid, NodeReference nodeRef, ReplicationStatus status, BaseException failure)
boolean	setReplicationStatus(Session session, Identifier pid, NodeReference nodeRef, ReplicationStatus status, BaseException failure) Deprecated.
boolean	updateReplicationMetadata(Identifier pid, Replica replicaMetadata, long serialVersion)
boolean	updateReplicationMetadata(Session targetNodeSession, Identifier pid, Replica replicaMetadata, long serialVersion) Deprecated.

Method Detail

setReplicationStatus

boolean setReplicationStatus(Identifier pid,
                             NodeReference nodeRef,
                             ReplicationStatus status,
                             BaseException failure)
                      throws ServiceFailure,
                             NotImplemented,
                             InvalidToken,
                             NotAuthorized,
                             InvalidRequest,
                             NotFound

Throws:

ServiceFailure

NotImplemented

InvalidToken

NotAuthorized

InvalidRequest

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.setReplicationStatus

setReplicationPolicy

boolean setReplicationPolicy(Identifier pid,
                             ReplicationPolicy policy,
                             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#CNReplication.setReplicationPolicy

isNodeAuthorized

boolean isNodeAuthorized(Subject targetNodeSubject,
                         Identifier pid)
                  throws NotImplemented,
                         NotAuthorized,
                         InvalidToken,
                         ServiceFailure,
                         NotFound,
                         InvalidRequest

Throws:

NotImplemented

NotAuthorized

InvalidToken

ServiceFailure

NotFound

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.isNodeAuthorized

updateReplicationMetadata

boolean updateReplicationMetadata(Identifier pid,
                                  Replica replicaMetadata,
                                  long serialVersion)
                           throws NotImplemented,
                                  NotAuthorized,
                                  ServiceFailure,
                                  NotFound,
                                  InvalidRequest,
                                  InvalidToken,
                                  VersionMismatch

Throws:

NotImplemented

NotAuthorized

ServiceFailure

NotFound

InvalidRequest

InvalidToken

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.updateReplicationMetadata

deleteReplicationMetadata

boolean deleteReplicationMetadata(Identifier pid,
                                  NodeReference nodeId,
                                  long serialVersion)
                           throws InvalidToken,
                                  InvalidRequest,
                                  ServiceFailure,
                                  NotAuthorized,
                                  NotFound,
                                  NotImplemented,
                                  VersionMismatch

Throws:

InvalidToken

InvalidRequest

ServiceFailure

NotAuthorized

NotFound

NotImplemented

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.deleteReplicationMetadata

setReplicationStatus

@Deprecated
boolean setReplicationStatus(Session session,
                                         Identifier pid,
                                         NodeReference nodeRef,
                                         ReplicationStatus status,
                                         BaseException failure)
                                  throws ServiceFailure,
                                         NotImplemented,
                                         InvalidToken,
                                         NotAuthorized,
                                         InvalidRequest,
                                         NotFound

Deprecated.

Throws:

ServiceFailure

NotImplemented

InvalidToken

NotAuthorized

InvalidRequest

NotFound

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.setReplicationStatus

setReplicationPolicy

@Deprecated
boolean setReplicationPolicy(Session session,
                                         Identifier pid,
                                         ReplicationPolicy policy,
                                         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#CNReplication.setReplicationPolicy

isNodeAuthorized

@Deprecated
boolean isNodeAuthorized(Session originatingNodeSession,
                                     Subject targetNodeSubject,
                                     Identifier pid)
                              throws NotImplemented,
                                     NotAuthorized,
                                     InvalidToken,
                                     ServiceFailure,
                                     NotFound,
                                     InvalidRequest

Deprecated.

Throws:

NotImplemented

NotAuthorized

InvalidToken

ServiceFailure

NotFound

InvalidRequest

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.isNodeAuthorized

updateReplicationMetadata

@Deprecated
boolean updateReplicationMetadata(Session targetNodeSession,
                                              Identifier pid,
                                              Replica replicaMetadata,
                                              long serialVersion)
                                       throws NotImplemented,
                                              NotAuthorized,
                                              ServiceFailure,
                                              NotFound,
                                              InvalidRequest,
                                              InvalidToken,
                                              VersionMismatch

Deprecated.

Throws:

NotImplemented

NotAuthorized

ServiceFailure

NotFound

InvalidRequest

InvalidToken

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.updateReplicationMetadata

deleteReplicationMetadata

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

Deprecated.

Throws:

InvalidToken

InvalidRequest

ServiceFailure

NotAuthorized

NotFound

NotImplemented

VersionMismatch

See Also:

https://purl.dataone.org/architecturev2/apis/CN_APIs.html#CNReplication.deleteReplicationMetadata