org.dataone.cn.dao

Class ReplicationDaoMetacatImpl

java.lang.Object

org.dataone.cn.dao.ReplicationDaoMetacatImpl

All Implemented Interfaces:

ReplicationDao

public class ReplicationDaoMetacatImpl
extends Object
implements ReplicationDao

ReplicationDao implementation based on the metacat products database schema. Uses metacat's relational database to implement sql queries to satisfy ReplicationDao. ReplicationDaoMetacatImpl uses a postgres configured BasicDataSource to connect to the metacat postgres instance. This class should not be used directly, rather the DaoFactory should be used to obtain a handle on the current ReplicationDao implementation.

Author:

sroseboo

Nested Class Summary

Nested classes/interfaces inherited from interface org.dataone.cn.dao.ReplicationDao

ReplicationDao.ReplicaDto

Constructor Summary

Constructors

Constructor and Description
ReplicationDaoMetacatImpl()

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() Get a map of replica counts by node-status in order to support instrumentation of system wide MN to MN replication functionality.
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() Retrieve the count of pending replica requests per target node listed in the Coordinating Node's smreplicationstatus table.
int	getQueuedReplicaCountByNode(String nodeId) Returns the count of replicas in the 'queued' status that are targeted toward nodeId node.
Collection<ReplicationDao.ReplicaDto>	getQueuedReplicasByNode(String mnId) 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() Retrieve the count of recently completed replica requests per target node listed in the Coordinating Node's systemetadatareplicationstatus table.
Map<org.dataone.service.types.v1.NodeReference,Integer>	getRecentFailedReplicas() Retrieve the count of recently failed replica requests per target node listed in the Coordinating Node's systemetadatareplicationstatus table.
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 nodeRef) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplicationDaoMetacatImpl

public ReplicationDaoMetacatImpl()

Method Detail

getMemberNodesWithQueuedReplica

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

Description copied from interface: ReplicationDao

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

Specified by:

getMemberNodesWithQueuedReplica in interface ReplicationDao

Throws:

DataAccessException

getQueuedReplicaCountByNode

public int getQueuedReplicaCountByNode(String nodeId)
                                throws DataAccessException

Description copied from interface: ReplicationDao

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

Specified by:

getQueuedReplicaCountByNode in interface ReplicationDao

Throws:

DataAccessException

getQueuedReplicasByNode

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

Description copied from interface: ReplicationDao

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

Specified by:

getQueuedReplicasByNode in interface ReplicationDao

Throws:

DataAccessException

queuedReplicaExists

public boolean queuedReplicaExists(String identifier,
                          String nodeId)
                            throws DataAccessException

Description copied from interface: ReplicationDao

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

Specified by:

queuedReplicaExists in interface ReplicationDao

Throws:

DataAccessException

getInvalidMemberNodeReplicasByDate

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

Description copied from interface: ReplicationDao

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).

Specified by:

getInvalidMemberNodeReplicasByDate in interface ReplicationDao

Returns:

Throws:

DataAccessException

getCompletedMemberNodeReplicasByDate

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

Description copied from interface: ReplicationDao

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.

Specified by:

getCompletedMemberNodeReplicasByDate in interface ReplicationDao

Parameters:

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

Returns:

distinct identifiers ordered by ascending replica verified date.

Throws:

DataAccessException

getCompletedCoordinatingNodeReplicasByDate

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

Description copied from interface: ReplicationDao

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.

Specified by:

getCompletedCoordinatingNodeReplicasByDate in interface ReplicationDao

Parameters:

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

Returns:

distinct identifiers ordered by ascending replica verified date.

Throws:

DataAccessException

getRequestedReplicasByDate

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

Description copied from interface: ReplicationDao

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

Specified by:

getRequestedReplicasByDate in interface ReplicationDao

Throws:

DataAccessException

getRequestedReplicationCount

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

Description copied from interface: ReplicationDao

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

Specified by:

getRequestedReplicationCount in interface ReplicationDao

Throws:

DataAccessException

getPendingReplicasByNode

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

Retrieve the count of pending replica requests per target node listed in the Coordinating Node's smreplicationstatus table. The result is used to determine the current request load for a given Member Node

Specified by:

getPendingReplicasByNode in interface ReplicationDao

Returns:

pendingReplicasByNodeMap - the map of nodeId/count pairs

Throws:

DataAccessException

getRecentFailedReplicas

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

Retrieve the count of recently failed replica requests per target node listed in the Coordinating Node's systemetadatareplicationstatus table. The result is used to determine the current failure rate for a given Member Node

Specified by:

getRecentFailedReplicas in interface ReplicationDao

Returns:

recentFailedReplicasByNodeMap - the map of nodeId/count pairs

Throws:

DataAccessException

getRecentCompletedReplicas

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

Retrieve the count of recently completed replica requests per target node listed in the Coordinating Node's systemetadatareplicationstatus table. The result is used to determine the current failure rate for a given Member Node

Specified by:

getRecentCompletedReplicas in interface ReplicationDao

Returns:

recentCompletedReplicasByNodeMap - the map of nodeId/count pairs

Throws:

DataAccessException

getCountsByNodeStatus

public Map<String,Integer> getCountsByNodeStatus()
                                          throws DataAccessException

Get a map of replica counts by node-status in order to support instrumentation of system wide MN to MN replication functionality. Summary counts of of each status type (QUEUED, REQUESTED, COMPLETED, FAILED, INVALIDATED) are given for each node. E.g.,

Specified by:

getCountsByNodeStatus in interface ReplicationDao

Returns:

replicaCountsByNodeStatus the map of node-status/count K/V pairs

Throws:

DataAccessException