org.dataone.cn.dao

Interface ReplicationDao

All Known Implementing Classes:

ReplicationDaoMetacatImpl

public interface ReplicationDao

Abstract definition of a replication data access object used to identify replicas that need to be audited and replicas that are pending/queued.

Author:

sroseboo

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReplicationDao.ReplicaDto Data transfer object for replica queries.

Method Summary

Methods

Modifier and Type	Method and Description
List<org.dataone.service.types.v1.Identifier>	getCompletedCoordinatingNodeReplicasByDate(Date auditDate, int pageNumber, int pageSize) Returns paged list of distinct DataONE Identifier objects with at least one coordinating node replica with a replica verified date previous to the auditDate parameter.
List<org.dataone.service.types.v1.Identifier>	getCompletedMemberNodeReplicasByDate(Date auditDate, int pageNumber, int pageSize) Returns paged list of distinct DataONE Identifier objects with at least one member node replica with a replica verified date previous to the auditDate parameter.
Map<String,Integer>	getCountsByNodeStatus() Return a map of member node status to count entries for tracking node replica status statistics.
List<org.dataone.service.types.v1.Identifier>	getInvalidMemberNodeReplicasByDate(Date auditDate, int pageNumber, int pageSize) Returns a paged list of distinct DataONE Identifier objects with at least one invalid member node replica with a replica verified date previous to the auditDate parameter.
Collection<org.dataone.service.types.v1.NodeReference>	getMemberNodesWithQueuedReplica() Returns a Collection of NodeReference objects which have at least one queued replica object's targeted toward the node.
Map<org.dataone.service.types.v1.NodeReference,Integer>	getPendingReplicasByNode() Return a map of member node to replica count entries where the replica status is either queued or requested
int	getQueuedReplicaCountByNode(String nodeId) Returns the count of replicas in the 'queued' status that are targeted toward nodeId node.
Collection<ReplicationDao.ReplicaDto>	getQueuedReplicasByNode(String nodeId) Returns a Collection of ReplicaDto objects that represent a replica object in 'queued' status and targeted at mnId node.
Map<org.dataone.service.types.v1.NodeReference,Integer>	getRecentCompletedReplicas() Return a map of member node to replica count entries where the replica status is completed and the date_verified is within a given timeframe
Map<org.dataone.service.types.v1.NodeReference,Integer>	getRecentFailedReplicas() Return a map of member node to replica count entries where the replica status is failed and the date_verified is within a given timeframe
List<ReplicationDao.ReplicaDto>	getRequestedReplicasByDate(Date cutoffDate) Returns a List of ReplicaDto objects, which represent replica objects that are in 'Requested' status and have a verified date before cuttoffDate.
int	getRequestedReplicationCount(org.dataone.service.types.v1.NodeReference nodeReference) Returns the count of replica objects in 'requested' status and targeted to nodeReference node.
boolean	queuedReplicaExists(String identifier, String nodeId) Returns true if there is a replica object with 'queued' status for identifier targeted at nodeId.

Method Detail

getCompletedMemberNodeReplicasByDate

List<org.dataone.service.types.v1.Identifier> getCompletedMemberNodeReplicasByDate(Date auditDate,
                                                                                 int pageNumber,
                                                                                 int pageSize)
                                                                                   throws DataAccessException

Returns paged list of distinct DataONE Identifier objects with at least one member node replica with a replica verified date previous to the auditDate parameter. Results to be ordered so identifiers with oldest replica verified dates are returned first. (ascending by replica verified date). Results are filtered to only include 'completed' member node replicas.

Parameters:

auditDate - - Identifiers with one or more replica verified dates after audit date are returned.

pageSize -

pageNumber -

Returns:

distinct identifiers ordered by ascending replica verified date.

Throws:

DataAccessException

getCompletedCoordinatingNodeReplicasByDate

List<org.dataone.service.types.v1.Identifier> getCompletedCoordinatingNodeReplicasByDate(Date auditDate,
                                                                                       int pageNumber,
                                                                                       int pageSize)
                                                                                         throws DataAccessException

Returns paged list of distinct DataONE Identifier objects with at least one coordinating node replica with a replica verified date previous to the auditDate parameter. Results to be ordered so identifiers with oldest replica verified dates are returned first. (ascending by replica verified date). Results are filtered to only include 'completed' coordinating node replicas.

Parameters:

auditDate - - Identifiers with one or more replica verified dates after audit date are returned.

pageSize -

pageNumber -

Returns:

distinct identifiers ordered by ascending replica verified date.

Throws:

DataAccessException

getInvalidMemberNodeReplicasByDate

List<org.dataone.service.types.v1.Identifier> getInvalidMemberNodeReplicasByDate(Date auditDate,
                                                                               int pageNumber,
                                                                               int pageSize)
                                                                                 throws DataAccessException

Returns a paged list of distinct DataONE Identifier objects with at least one invalid member node replica with a replica verified date previous to the auditDate parameter. Results to be ordered to identifiers with oldest replica verified dates are returned first. (ascending by replica verified date).

Parameters:

auditDate -

pageNumber -

pageSize -

Returns:

Throws:

DataAccessException

getPendingReplicasByNode

Map<org.dataone.service.types.v1.NodeReference,Integer> getPendingReplicasByNode()
                                                                                 throws DataAccessException

Return a map of member node to replica count entries where the replica status is either queued or requested

Throws:

DataAccessException

getRecentFailedReplicas

Map<org.dataone.service.types.v1.NodeReference,Integer> getRecentFailedReplicas()
                                                                                throws DataAccessException

Return a map of member node to replica count entries where the replica status is failed and the date_verified is within a given timeframe

Throws:

DataAccessException

getRecentCompletedReplicas

Map<org.dataone.service.types.v1.NodeReference,Integer> getRecentCompletedReplicas()
                                                                                   throws DataAccessException

Return a map of member node to replica count entries where the replica status is completed and the date_verified is within a given timeframe

Throws:

DataAccessException

getCountsByNodeStatus

Map<String,Integer> getCountsByNodeStatus()
                                          throws DataAccessException

Return a map of member node status to count entries for tracking node replica status statistics. The key is a string of node id and status, and the value is the count of that status for the node

Throws:

DataAccessException

getRequestedReplicasByDate

List<ReplicationDao.ReplicaDto> getRequestedReplicasByDate(Date cutoffDate)
                                                           throws DataAccessException

Returns a List of ReplicaDto objects, which represent replica objects that are in 'Requested' status and have a verified date before cuttoffDate.

Parameters:

cutoffDate -

Throws:

DataAccessException

getRequestedReplicationCount

int getRequestedReplicationCount(org.dataone.service.types.v1.NodeReference nodeReference)
                                 throws DataAccessException

Returns the count of replica objects in 'requested' status and targeted to nodeReference node.

Parameters:

nodeReference -

Throws:

DataAccessException

getMemberNodesWithQueuedReplica

Collection<org.dataone.service.types.v1.NodeReference> getMemberNodesWithQueuedReplica()
                                                                                       throws DataAccessException

Returns a Collection of NodeReference objects which have at least one queued replica object's targeted toward the node.

Throws:

DataAccessException

getQueuedReplicaCountByNode

int getQueuedReplicaCountByNode(String nodeId)
                                throws DataAccessException

Returns the count of replicas in the 'queued' status that are targeted toward nodeId node.

Parameters:

nodeId -

Throws:

DataAccessException

getQueuedReplicasByNode

Collection<ReplicationDao.ReplicaDto> getQueuedReplicasByNode(String nodeId)
                                                              throws DataAccessException

Returns a Collection of ReplicaDto objects that represent a replica object in 'queued' status and targeted at mnId node.

Parameters:

nodeId -

Throws:

DataAccessException

queuedReplicaExists

boolean queuedReplicaExists(String identifier,
                          String nodeId)
                            throws DataAccessException

Returns true if there is a replica object with 'queued' status for identifier targeted at nodeId.

Parameters:

identifier -

nodeId -

Throws:

DataAccessException