org.opencadc.inventory.db.ArtifactDAO Maven / Gradle / Ivy
Show all versions of cadc-inventory-db Show documentation
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2021. (c) 2021.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* {
private static final Logger log = Logger.getLogger(ArtifactDAO.class);
public ArtifactDAO() {
super(true);
}
public ArtifactDAO(boolean origin) {
super(origin);
}
public ArtifactDAO(AbstractDAO dao) {
super(dao);
}
public Artifact get(UUID id) {
return super.get(Artifact.class, id);
}
public Artifact get(URI uri) {
if (uri == null) {
throw new IllegalArgumentException("uri cannot be null");
}
checkInit();
log.debug("get: " + uri);
long t = System.currentTimeMillis();
try {
JdbcTemplate jdbc = new JdbcTemplate(dataSource);
SQLGenerator.ArtifactGet get = (SQLGenerator.ArtifactGet) gen.getEntityGet(Artifact.class);
get.setURI(uri);
Artifact a = get.execute(jdbc);
return a;
} catch (BadSqlGrammarException ex) {
handleInternalFail(ex);
} finally {
long dt = System.currentTimeMillis() - t;
log.debug("get: " + uri + " " + dt + "ms");
}
throw new RuntimeException("BUG: should be unreachable");
}
// delete an artifact, all SiteLocation(s), and StorageLocation
// caller must also fire an appropriate event via DeletedEventDAO in same txn
// unless performing this delete in reaction to such an event
public void delete(UUID id) {
super.delete(Artifact.class, id);
}
public void setStorageLocation(Artifact a, StorageLocation loc) {
if (!origin) {
throw new IllegalStateException("cannot update Artifact.storageLocation with origin=false");
}
a.storageLocation = loc;
boolean timestampUpdate = loc != null;
put(a, true, timestampUpdate);
}
public void addSiteLocation(Artifact a, SiteLocation loc) {
if (origin) {
throw new IllegalStateException("cannot update Artifact.siteLocation(s) with origin=true");
}
if (!a.siteLocations.contains(loc)) {
a.siteLocations.add(loc);
put(a, true, false);
}
}
public void removeSiteLocation(Artifact a, SiteLocation loc) {
if (origin) {
throw new IllegalStateException("cannot update Artifact.siteLocation(s) with origin=true");
}
if (a.siteLocations.contains(loc)) {
a.siteLocations.remove(loc);
put(a, true, false);
}
}
/**
* Iterate over Artifacts in StorageLocation order. This only shows artifacts with
* a storageLocation value. The iteration is ordered by StorageLocation.
*
* Use case: implement file-validate (inventory vs storage).
*
* @param storageBucketPrefix null, prefix, or complete storageBucket string
* @return iterator over artifacts with a StorageLocation
*/
public ResourceIterator storedIterator(String storageBucketPrefix) {
checkInit();
long t = System.currentTimeMillis();
try {
SQLGenerator.ArtifactIteratorQuery iter = (SQLGenerator.ArtifactIteratorQuery) gen.getEntityIteratorQuery(Artifact.class);
iter.setStorageLocationRequired(true);
iter.setOrderedOutput(true);
iter.setPrefix(storageBucketPrefix);
return iter.query(dataSource);
} catch (BadSqlGrammarException ex) {
handleInternalFail(ex);
} finally {
long dt = System.currentTimeMillis() - t;
log.debug("iterator: " + storageBucketPrefix + " " + dt + "ms");
}
throw new RuntimeException("BUG: should be unreachable");
}
/**
* Iterate over Artifacts with no StorageLocation. This only returns artifacts with
* no storageLocation value. The result is currently not ordered.
*
*
Use case: implement file-sync where content can be downloaded and stored locally
*
* @param uriBucketPrefix null, prefix, or complete Artifact.uriBucket string
* @return iterator over artifacts without a StorageLocation
*/
public ResourceIterator unstoredIterator(String uriBucketPrefix) {
checkInit();
long t = System.currentTimeMillis();
try {
SQLGenerator.ArtifactIteratorQuery iter = (SQLGenerator.ArtifactIteratorQuery) gen.getEntityIteratorQuery(Artifact.class);
iter.setStorageLocationRequired(false);
iter.setOrderedOutput(true);
iter.setPrefix(uriBucketPrefix);
return iter.query(dataSource);
} catch (BadSqlGrammarException ex) {
handleInternalFail(ex);
} finally {
long dt = System.currentTimeMillis() - t;
log.debug("iterator: " + dt + "ms");
}
throw new RuntimeException("BUG: should be unreachable");
}
/**
* Iterate over Artifacts.
*
* @param uriBucketPrefix null, prefix, or complete Artifact.uriBucket string
* @param ordered order by Artifact.uri (true) or not ordered (false)
* @return iterator over artifacts
*/
public ResourceIterator iterator(String uriBucketPrefix, boolean ordered) {
return iterator((String) null, uriBucketPrefix, ordered);
}
/**
* Iterate over Artifacts that match criteria. The criteria are expressed as SQL
* conditions on fields of the Artifact using the field names for column references.
* Example: uri like 'ad:bar/%'. The result is currently not ordered.
*
*
Use case: local cleanup by arbitrary criteria
*
* @param criteria conditions for selecting artifacts
* @param uriBucketPrefix null, prefix, or complete Artifact.uriBucket string
* @param ordered order by Artifact.uri (true) or not ordered (false)
* @return iterator over artifacts matching criteria
*/
public ResourceIterator iterator(String criteria, String uriBucketPrefix, boolean ordered) {
checkInit();
long t = System.currentTimeMillis();
try {
SQLGenerator.ArtifactIteratorQuery iter = (SQLGenerator.ArtifactIteratorQuery) gen.getEntityIteratorQuery(Artifact.class);
iter.setPrefix(uriBucketPrefix);
iter.setCriteria(criteria);
iter.setOrderedOutput(ordered);
return iter.query(dataSource);
} catch (BadSqlGrammarException ex) {
handleInternalFail(ex);
} finally {
long dt = System.currentTimeMillis() - t;
log.debug("iterator: " + dt + "ms");
}
throw new RuntimeException("BUG: should be unreachable");
}
/**
* Iterate over Artifacts from a specific site. If a siteID is specified, only artifacts where
* artifact.siteLocations includes that siteID are returned; this is only applicable in a global
* inventory that tracks site locations.
*
*
Use case: to implement metadata-validate
*
* @param siteID null or siteID to select only artifacts from the specified site (validate global vs site)
* @param uriBucketPrefix null, prefix, or complete Artifact.uriBucket string
* @param ordered order by Artifact.uri (true) or not ordered (false)
* @return iterator over artifacts matching criteria
*/
public ResourceIterator iterator(UUID siteID, String uriBucketPrefix, boolean ordered) {
checkInit();
long t = System.currentTimeMillis();
try {
SQLGenerator.ArtifactIteratorQuery iter = (SQLGenerator.ArtifactIteratorQuery) gen.getEntityIteratorQuery(Artifact.class);
iter.setPrefix(uriBucketPrefix);
iter.setSiteID(siteID);
iter.setOrderedOutput(ordered);
return iter.query(dataSource);
} catch (BadSqlGrammarException ex) {
handleInternalFail(ex);
} finally {
long dt = System.currentTimeMillis() - t;
log.debug("iterator: " + dt + "ms");
}
throw new RuntimeException("BUG: should be unreachable");
}
}