org.lockss.subscription.SubscriptionManager Maven / Gradle / Ivy
Show all versions of lockss-core Show documentation
/*
Copyright (c) 2013-2019 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.
*/
package org.lockss.subscription;
import static org.lockss.metadata.SqlConstants.*;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.Reader;
import java.nio.charset.Charset;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import org.apache.commons.collections4.map.MultiValueMap;
import org.lockss.app.BaseLockssDaemonManager;
import org.lockss.app.ConfigurableManager;
import org.lockss.config.ConfigManager;
import org.lockss.config.Configuration;
import org.lockss.config.TdbAu;
import org.lockss.config.TdbProvider;
import org.lockss.config.TdbPublisher;
import org.lockss.config.TdbTitle;
import org.lockss.config.TdbUtil;
import org.lockss.db.DbException;
import org.lockss.extractor.MetadataField;
import org.lockss.metadata.MetadataDbManager;
import org.lockss.metadata.MetadataDbManagerSql;
import org.lockss.metadata.MetadataManager;
import org.lockss.metadata.MetadataManagerSql;
import org.lockss.plugin.ArchivalUnit;
import org.lockss.plugin.AuEvent;
import org.lockss.plugin.AuEventHandler;
import org.lockss.plugin.PluginManager;
import org.lockss.remote.RemoteApi;
import org.lockss.remote.RemoteApi.BatchAuStatus;
import org.lockss.util.*;
import org.lockss.util.os.PlatformUtil;
/**
* Manager of serial publication subscriptions.
*
* @author Fernando Garcia-Loygorri
*/
public class SubscriptionManager extends BaseLockssDaemonManager implements
ConfigurableManager {
private static final Logger log = Logger.getLogger();
// Prefix for the subscription manager configuration entries.
private static final String PREFIX = Configuration.PREFIX + "subscription.";
/**
* Indication of whether the subscription subsystem should be enabled.
*
* Defaults to false. Changes require daemon restart.
*/
public static final String PARAM_SUBSCRIPTION_ENABLED = PREFIX + "enabled";
/**
* Default value of subscription subsystem operation configuration parameter.
*
* false to disable, true to enable.
*/
public static final boolean DEFAULT_SUBSCRIPTION_ENABLED = true;
/**
* If true, SubscriptionManager won't create AUs, even if it's enabled.
*/
public static final String PARAM_SUBSCRIPTION_DEFERRED = PREFIX + "deferred";
public static final boolean DEFAULT_SUBSCRIPTION_DEFERRED = false;
/**
* Repository available space threshold.
*
* Defaults to 0.
*/
public static final String PARAM_REPOSITORY_AVAIL_SPACE_THRESHOLD =
PREFIX + "repositoryAvailSpaceThreshold";
/**
* Default value of the repository available space threshold configuration
* parameter.
*/
public static final int DEFAULT_REPOSITORY_AVAIL_SPACE_THRESHOLD = 0;
/**
* Batch size to configure archival units.
*
* Defaults to 1000.
*/
public static final String PARAM_SUBSCRIPTION_AU_CONFIGURATION_BATCH_SIZE =
PREFIX + "auConfigurationBatchSize";
/**
* Default value of the configuration parameter with the batch size used to
* configure archival units.
*/
public static final int DEFAULT_SUBSCRIPTION_AU_CONFIGURATION_BATCH_SIZE =
1000;
/**
* Maximum rate at which we will configure archival units.
*
* Defaults to 1000/1m.
*/
public static final String PARAM_SUBSCRIPTION_AU_CONFIGURATION_RATE =
PREFIX + "auConfigurationRate";
/**
* Default value of the configuration parameter with the maximum rate at which
* we will configure archival units.
*/
public static final String DEFAULT_SUBSCRIPTION_AU_CONFIGURATION_RATE =
"1000/1m";
/**
* Indication of whether the Total Subscription option is enabled.
*
* Defaults to false.
*/
public static final String PARAM_TOTAL_SUBSCRIPTION_ENABLED =
PREFIX + "totalSubscriptionEnabled";
/**
* Default value of Total Subscription configuration parameter.
*
* false to disable, true to enable.
*/
public static final boolean DEFAULT_TOTAL_SUBSCRIPTION_ENABLED = false;
/**
* Indication of whether a title is subscribable even if all of its Archival
* Units are down.
*
* Defaults to false.
*/
public static final String PARAM_DOWN_TITLE_IS_SUBSCRIBABLE =
PREFIX + "downTitleIsSubscribable";
/**
* Default value of subscribable down title configuration parameter.
*
* false to disable, true to enable.
*/
public static final boolean DEFAULT_DOWN_TITLE_IS_SUBSCRIBABLE = false;
/**
* Indication of whether subscription synchronization will result in whole
* title subscriptions instead of range subscriptions.
*
* Defaults to false.
*/
public static final String PARAM_SYNCHRONIZE_WHOLE_TITLE =
PREFIX + "synchronizeWholeTitle";
/**
* Default value of whole title synchronization configuration parameter.
*
* false to disable, true to enable.
*/
public static final boolean DEFAULT_SYNCHRONIZE_WHOLE_TITLE = false;
private static final String CANNOT_CONNECT_TO_DB_ERROR_MESSAGE =
"Cannot connect to the database";
private static final String CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE =
"Cannot rollback the connection";
private static final String CANNOT_DELETE_TOTAL_SUBSCRIPTION_ERROR_MESSAGE =
"Cannot delete Total Subscription";
private static final String CANNOT_UPDATE_TOTAL_SUBSCRIPTION_ERROR_MESSAGE =
"Cannot update Total Subscription";
// The name of the file used to back-up publisher subscriptions.
private static final String PUBLISHER_SUBSCRIPTION_BACKUP_FILENAME =
"pubsubscriptions.bak";
// The name of the file used for back-up purposes.
private static final String SUBSCRIPTION_BACKUP_FILENAME =
"subscriptions.bak";
// The field separator in the subscription backup file.
private static final String BACKUP_FIELD_SEPARATOR = "\t";
static final String ALL_PUBLISHERS_NAME = "SUBSCRIPTIONS ALL PUBLISHERS";
// The database manager.
private MetadataDbManager dbManager = null;
// The metadata manager.
private MetadataManager mdManager = null;
// The plugin manager.
private PluginManager pluginManager = null;
// The remote API.
private RemoteApi remoteApi;
// An indication of whether this object is ready to be used.
private boolean ready = false;
private boolean subscriptionsDeferred = DEFAULT_SUBSCRIPTION_DEFERRED;
// The list of repositories to use when configuring AUs.
private List repositories = null;
// The index of the next repository to be used when configuring AUs.
private int repositoryIndex = 0;
// The handler for Archival Unit events.
private AuEventHandler auEventHandler;
// The size of the batch used to configure archival units.
private int configureAuBatchSize = 1000;
// Pacer used to limit the rate at which archival units are configured.
private RateLimiter configureAuRateLimiter;
private boolean isTotalSubscriptionEnabled = false;
// The setting of the Total Subscription feature.
private Boolean isTotalSubscription = null;
// The thread that processes archival units in a collection to configure them
// or not depending on subscription settings.
private SubscriptionStarter starter = null;
private Thread starterThread = null;
// The thread that processes archival units in a collection to configure them
// regardless of other considerations.
private SubscriptionStarter mustConfigureStarter = null;
private Thread mustConfigureStarterThread = null;
private boolean isDownTitleSubscribable = false;
private boolean isWholeTitleSynchronization = false;
// Sorter of publications.
private static Comparator PUBLICATION_COMPARATOR =
new Comparator() {
public int compare(SerialPublication o1, SerialPublication o2) {
// Sort by publication name first.
int nameComparison = o1.getPublicationName().compareTo(
o2.getPublicationName());
if (nameComparison != 0) {
return nameComparison;
}
// Sort by provider name if the publication name is the same.
return o1.getProviderName().compareTo(o2.getProviderName());
}
};
// Sorter of subscriptions by their publications.
private static Comparator
SUBSCRIPTION_BY_PUBLICATION_COMPARATOR = new Comparator() {
public int compare(Subscription o1, Subscription o2) {
// Sort by publication name first.
SerialPublication p1 = o1.getPublication();
SerialPublication p2 = o2.getPublication();
int nameComparison = p1.getPublicationName().compareTo(
p2.getPublicationName());
if (nameComparison != 0) {
return nameComparison;
}
// Sort by provider name if the publication name is the same.
return p1.getProviderName().compareTo(p2.getProviderName());
}
};
// The SQL code executor.
private SubscriptionManagerSql subManagerSql;
/**
* Starts the SubscriptionManager service.
*/
@Override
public void startService() {
final String DEBUG_HEADER = "startService(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
// Do nothing more if subscriptions are disabled.
if (!ConfigManager.getCurrentConfig()
.getBoolean(PARAM_SUBSCRIPTION_ENABLED, DEFAULT_SUBSCRIPTION_ENABLED)) {
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "Subscriptions are disabled.");
ready = false;
return;
}
// Do nothing more if it is already initialized.
if (ready) {
return;
}
dbManager = getDaemon().getMetadataDbManager();
pluginManager = getDaemon().getPluginManager();
mdManager = getDaemon().getMetadataManager();
remoteApi = getDaemon().getRemoteApi();
subManagerSql = new SubscriptionManagerSql(dbManager);
// Register the event handler to receive Archival Unit removal notifications
// and to be able to unsubscribe such Archival Units, if necessary.
auEventHandler = new AuEventHandler.Base() {
@Override
public void auDeleted(AuEvent event, ArchivalUnit au) {
Connection conn = null;
try {
// Get a connection to the database.
conn = dbManager.getConnection();
} catch (DbException dbe) {
log.error(CANNOT_CONNECT_TO_DB_ERROR_MESSAGE, dbe);
return;
}
try {
// Unsubscribe the Archival Unit, if necessary and possible.
try {
unsubscribeAu(conn, au);
MetadataDbManager.commitOrRollback(conn, log);
} catch (DbException dbe) {
log.error("Error unsubscribing deleted AU " + au, dbe);
} finally {
try {
MetadataDbManager.rollback(conn, log);
} catch (DbException dbe2) {
log.error("Error rolling back unsubscribing deleted AU " + au
+ " transaction", dbe2);
}
}
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
}
};
Connection conn;
// Get a connection to the database.
try {
conn = dbManager.getConnection();
} catch (DbException ex) {
log.error(CANNOT_CONNECT_TO_DB_ERROR_MESSAGE, ex);
return;
}
try {
// Check whether the Total Subscription feature is enabled.
if (isTotalSubscriptionEnabled) {
// Yes: Determine the Total Subscription setting.
try {
isTotalSubscription = findTotalSubscription(conn);
} catch (DbException dbe) {
String errorMessage = "Cannot find the Total Subscription setting";
log.error(errorMessage, dbe);
return;
}
} else {
// No: Remove any old setting from the database.
try {
Long publisherSeq = mdManager.findPublisher(conn, ALL_PUBLISHERS_NAME);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherSeq = " + publisherSeq);
if (publisherSeq != null) {
int deletedCount =
subManagerSql.deletePublisherSubscription(conn, publisherSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "deletedCount = " + deletedCount);
MetadataDbManager.commitOrRollback(conn, log);
}
} catch (DbException dbe) {
log.error(CANNOT_DELETE_TOTAL_SUBSCRIPTION_ERROR_MESSAGE, dbe);
}
}
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
pluginManager.registerAuEventHandler(auEventHandler);
ready = true;
if (log.isDebug()) log.debug(DEBUG_HEADER
+ "SubscriptionManager service successfully started");
}
/**
* Handler of configuration changes.
*
* @param newConfig
* A Configuration with the new configuration.
* @param prevConfig
* A Configuration with the previous configuration.
* @param changedKeys
* A Configuration.Differences with the keys of the configuration
* elements that have changed.
*/
public void setConfig(Configuration newConfig, Configuration prevConfig,
Configuration.Differences changedKeys) {
final String DEBUG_HEADER = "setConfig(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
// Do nothing more if subscriptions are disabled.
if (!newConfig.getBoolean(PARAM_SUBSCRIPTION_ENABLED,
DEFAULT_SUBSCRIPTION_ENABLED)) {
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "Subscriptions are disabled.");
ready = false;
return;
}
subscriptionsDeferred = newConfig.getBoolean(PARAM_SUBSCRIPTION_DEFERRED,
DEFAULT_SUBSCRIPTION_DEFERRED);
// Force a re-calculation of the relative weights of the repositories.
repositories = null;
if (changedKeys.contains(PARAM_SUBSCRIPTION_AU_CONFIGURATION_BATCH_SIZE)) {
configureAuBatchSize =
newConfig.getInt(PARAM_SUBSCRIPTION_AU_CONFIGURATION_BATCH_SIZE,
DEFAULT_SUBSCRIPTION_AU_CONFIGURATION_BATCH_SIZE);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "configureAuBatchSize = "
+ configureAuBatchSize);
}
if (changedKeys.contains(PARAM_SUBSCRIPTION_AU_CONFIGURATION_RATE)) {
configureAuRateLimiter = RateLimiter.getConfiguredRateLimiter(newConfig,
configureAuRateLimiter, PARAM_SUBSCRIPTION_AU_CONFIGURATION_RATE,
DEFAULT_SUBSCRIPTION_AU_CONFIGURATION_RATE);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "configureAuRateLimiter = "
+ configureAuRateLimiter);
}
if (changedKeys.contains(PARAM_TOTAL_SUBSCRIPTION_ENABLED)) {
isTotalSubscriptionEnabled =
newConfig.getBoolean(PARAM_TOTAL_SUBSCRIPTION_ENABLED,
DEFAULT_TOTAL_SUBSCRIPTION_ENABLED);
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "isTotalSubscriptionEnabled = " + isTotalSubscriptionEnabled);
isTotalSubscription = null;
if (!isTotalSubscriptionEnabled && dbManager != null
&& dbManager.isReady()) {
updateTotalSubscription(null, new SubscriptionOperationStatus());
}
}
if (changedKeys.contains(PARAM_DOWN_TITLE_IS_SUBSCRIBABLE)) {
isDownTitleSubscribable =
newConfig.getBoolean(PARAM_DOWN_TITLE_IS_SUBSCRIBABLE,
DEFAULT_DOWN_TITLE_IS_SUBSCRIBABLE);
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "isDownTitleSubscribable = " + isDownTitleSubscribable);
}
if (changedKeys.contains(PARAM_SYNCHRONIZE_WHOLE_TITLE)) {
isWholeTitleSynchronization =
newConfig.getBoolean(PARAM_SYNCHRONIZE_WHOLE_TITLE,
DEFAULT_SYNCHRONIZE_WHOLE_TITLE);
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "isWholeTitleSynchronization = " + isWholeTitleSynchronization);
}
// Check whether the handling of configuration changes should be done in a
// new thread.
if (!isReady() || starter == null || starterThread == null
|| !starterThread.isAlive()) {
// Yes: Create it and start it.
starter = new SubscriptionStarter(this, configureAuBatchSize,
configureAuRateLimiter,
changedKeys.getTdbDifferences().newTdbAuIterator(), false);
starterThread = new Thread(starter);
starterThread.start();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Created new SubscriptionStarter.");
} else {
// No: Reuse the existing thread.
if (changedKeys.contains(PARAM_SUBSCRIPTION_AU_CONFIGURATION_BATCH_SIZE))
{
starter.setConfigureAuBatchSize(configureAuBatchSize);
}
if (changedKeys.contains(PARAM_SUBSCRIPTION_AU_CONFIGURATION_RATE)) {
starter.setConfigureAuRateLimiter(configureAuRateLimiter);
}
// Add the new workload to the existing thread.
boolean added = starter.addTdbAuIterator(
changedKeys.getTdbDifferences().newTdbAuIterator());
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "added = " + added);
// Check whether the new workload was successfully added.
if (added) {
// Yes.
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Reused existing SubscriptionStarter.");
} else {
// No: Create a new thread and start it.
starter = new SubscriptionStarter(this, configureAuBatchSize,
configureAuRateLimiter,
changedKeys.getTdbDifferences().newTdbAuIterator(),false);
starterThread = new Thread(starter);
starterThread.start();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Created new SubscriptionStarter.");
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
return;
}
/**
* Provides an indication of whether this object is ready to be used.
*
* @return true if this object is ready to be used,
* false otherwise.
*/
public boolean isReady() {
return ready;
}
/**
* Populates the sets of subscribed and unsubscribed ranges for a title.
*
* @param conn
* A Connection with the database connection to be used.
* @param title
* A TdbTitle with the title.
* @param subscribedRanges
* A List to be populated with the title
* subscribed ranges, if any.
* @param unsubscribedRanges
* A List to be populated with the title
* unsubscribed ranges, if any.
* @return a Set with the database subscription identifiers to which the
* populated ranges belong.
* @throws DbException
* if any problem occurred accessing the database.
*/
Set populateTitleSubscriptionRanges(Connection conn,
TdbTitle title, List subscribedRanges,
List unsubscribedRanges) throws DbException {
final String DEBUG_HEADER = "populateTitleSubscriptionRanges(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "title = " + title);
log.debug2(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
log.debug2(DEBUG_HEADER + "unsubscribedRanges = " + unsubscribedRanges);
}
// Get the title identifier.
String titleId = title.getId();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "titleId = " + titleId);
// Get the title publisher.
String publisher = title.getTdbPublisher().getName();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "publisher = " + publisher);
// Locate the publisher database identifier.
Long publisherSeq = mdManager.findPublisher(conn, publisher);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherSeq = " + publisherSeq);
// Check whether the publisher does not exist in the database.
if (publisherSeq == null) {
// Yes: There are no title subscription definitions.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
return null;
}
// Get the title name.
String name = title.getName();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "name = " + name);
// Get the unpunctuated title print ISSN.
String pIssn = MetadataUtil.toUnpunctuatedIssn(title.getPrintIssn());
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "pIssn = " + pIssn);
// Get the unpunctuated title electronic ISSN.
String eIssn = MetadataUtil.toUnpunctuatedIssn(title.getEissn());
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "eIssn = " + eIssn);
// Get the publication type.
String pubType = title.getPublicationType();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "pubType = " + pubType);
// Check whether it's not a serial publication type.
if (!isSerialPublicationType(pubType)) {
// Yes: Report the problem.
log.error("Unexpected publication type '" + pubType
+ "' for subscription to title '" + name + "'");
return null;
}
// Locate the title publication in the database (bookSeries or other)
Long publicationSeq = null;
if (MetadataField.PUBLICATION_TYPE_BOOKSERIES.equals(pubType)) {
// Find the book series, where name is series title
publicationSeq =
mdManager.findBookSeries(conn, publisherSeq, pIssn, eIssn, name);
} else if (MetadataField.PUBLICATION_TYPE_JOURNAL.equals(pubType)) {
// name is journal title
publicationSeq =
mdManager.findJournal(conn, publisherSeq, pIssn, eIssn, name);
} else if (MetadataField.PUBLICATION_TYPE_PROCEEDINGS.equals(pubType)) {
// Name is proceedings publication title.
publicationSeq =
mdManager.findProceedings(conn, publisherSeq, pIssn, eIssn, name);
}
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publicationSeq = " + publicationSeq);
// Check whether the publication does not exist in the database.
if (publicationSeq == null) {
// Yes: There are no title subscription definitions.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
return null;
}
Set result = new HashSet();
Long providerSeq;
Long subscriptionSeq = null;
// Loop through all the title providers.
for (TdbProvider provider : title.getTdbProviders()) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "provider = " + provider);
// Find the provider in the database.
// TODO: Replace the second argument with provider.getLid() when
// available.
providerSeq = mdManager.findProvider(conn, null, provider.getName());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerSeq = " + providerSeq);
// Check whether the provider exists in the database.
if (providerSeq != null) {
// Yes: Find in the database the publication subscription for the
// provider.
subscriptionSeq =
subManagerSql.findSubscription(conn, publicationSeq, providerSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscriptionSeq = " + subscriptionSeq);
// Check whether the subscription exists in the database.
if (subscriptionSeq != null) {
// Yes: Find in the database the subscribed ranges and add them to the
// results.
subscribedRanges.addAll(subManagerSql.findSubscriptionRanges(conn,
subscriptionSeq, true));
// Find in the database the unsubscribed ranges and add them to the
// results.
unsubscribedRanges.addAll(subManagerSql.findSubscriptionRanges(conn,
subscriptionSeq, false));
// Add this subscription identifier to the results.
result.add(subscriptionSeq);
}
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
/**
* Provides the archival units of a title that are covered by a passed list of
* subscribed ranges and they are not covered by a passed list of unsubscribed
* ranges.
*
* @param title
* A TdbTitle with the title involved.
* @param subscribedRanges
* A List with the list of subscribed ranges.
* @param unsubscribedRanges
* A List with the list of un subscribed ranges.
* @return a Set with the archival units covered by the subscribed
* ranges and not covered by the unsubscribed ranges.
*/
Set getCoveredTdbAus(TdbTitle title,
List subscribedRanges,
List unsubscribedRanges) {
final String DEBUG_HEADER = "getCoveredTdbAus(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "title = " + title);
log.debug2(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
log.debug2(DEBUG_HEADER + "unsubscribedRanges = " + unsubscribedRanges);
}
// Initialize the result.
Set result = new HashSet();
// Get the publication archival units.
List tdbAus = title.getSortedTdbAus();
// Do nothing more if the publication has no archival units.
if (tdbAus == null || tdbAus.size() < 1) {
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "tdbAus.size() = " + tdbAus.size());
// Loop through all the subscribed ranges.
for (BibliographicPeriod range : subscribedRanges) {
// Add to the result all the archival units covered by the subscribed
// range.
result.addAll(getRangeCoveredTdbAus(range, tdbAus));
}
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "result = " + result);
// Do nothing more if there are no unsubscribed ranges.
if (unsubscribedRanges != null && unsubscribedRanges.size() > 0) {
// Loop through all the unsubscribed ranges.
for (BibliographicPeriod range : unsubscribedRanges) {
// remove from the result all the archival units covered by the
// unsubscribed range.
result.removeAll(getRangeCoveredTdbAus(range, tdbAus));
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
/**
* Provides the subset of archival units from a passed superset of archival
* units that are covered by a passed publication range.
*
* @param range
* A BibliographicPeriod with the publication range.
* @param tdbAus
* A List with the TdbAu objects to check for coverage.
* @return a List with the archival units covered by the range.
*/
private List getRangeCoveredTdbAus(BibliographicPeriod range,
List tdbAus) {
final String DEBUG_HEADER = "getRangeCoveredTdbAus(): ";
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "range = " + range.toDisplayableString());
List result = new ArrayList();
// Check whether the range covers nothing.
if (range == null || range.isEmpty()) {
// Yes: Return an empty result.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
// Check whether the range covers everything.
if (range.isAllTime()) {
// Yes: Return all the passed archival units.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + tdbAus);
return tdbAus;
}
int firstIndex = -1;
int lastIndex = -1;
// Check whether the range start is in the far past.
if (range.getStartEdge().isInfinity()) {
// Yes: The first archival unit to be returned is the first one passed.
firstIndex = 0;
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "firstIndex = " + firstIndex);
// No: Check whether the range end is in the far future.
} else if (range.getEndEdge().isInfinity()) {
// Yes: The last archival unit to be returned is the last one passed.
lastIndex = tdbAus.size() - 1;
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "lastIndex = " + lastIndex);
}
int currentIndex = 0;
// Loop through all the passed archival units.
for (TdbAu tdbAu : tdbAus) {
if (log.isDebug3()) {
log.debug3(DEBUG_HEADER + "tdbAu = " + tdbAu);
log.debug3(DEBUG_HEADER + "tdbAu.getPublicationRanges() = "
+ tdbAu.getPublicationRanges());
}
// Check whether the range matches any of the publication ranges of the
// archival unit.
if (range.matches(tdbAu.getPublicationRanges())) {
// Yes: Check whether this is the first AU covered by the range.
if (firstIndex == -1) {
// Yes: Remember it.
firstIndex = currentIndex;
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "firstIndex = " + firstIndex);
}
// Check whether the last AU covered by the range is known.
if (lastIndex == tdbAus.size() - 1) {
// Yes: The subsset is now known.
break;
} else {
// No: This AU is a candidate to be the last one.
lastIndex = currentIndex;
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "lastIndex = " + lastIndex);
}
}
// Point to the next archival unit.
currentIndex++;
}
// Check whether any archival units are covered by the range.
if (firstIndex != -1) {
// Yes: Add to the result the archival units covered by the range.
for (int index = firstIndex; index <= lastIndex; index++) {
result.add(tdbAus.get(index));
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
/**
* Configures a batch of archival units into the system.
*
* @param config
* A Configuration with the configuration of the archival units to be
* configured into the system.
* @return a BatchAuStatus with the status of the operation.
* @throws IOException
* if there are problems configuring the batch of archival units.
*/
BatchAuStatus configureAuBatch(Configuration config)
throws IOException {
final String DEBUG_HEADER = "configureAuBatch(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "config.isEmpty = "
+ config.isEmpty());
BatchAuStatus status = null;
// Check whether there are archival units to configure.
if (!config.isEmpty()) {
// Yes.
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "config.keySet().size() = "
+ config.keySet().size());
// Perform the actual configuration into the system of the archival units
// in the configuration.
status = remoteApi.batchAddAus(RemoteApi.BATCH_ADD_ADD, config, null);
log.info("Successful configuration of " + status.getOkCnt() + " AUs.");
// Check whether there are any errors.
if (status.hasNotOk()) {
// Yes: Report them.
for (BatchAuStatus.Entry stat : status.getStatusList()) {
if (!stat.isOk() && stat.getExplanation() != null) {
log.error("Error configuring AU '" + stat.getName() + "': "
+ stat.getExplanation());
}
}
}
} else {
// No.
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "No AUs to configure.");
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "status = " + status);
return status;
}
/**
* Adds the current configuration of an archival unit to a passed
* configuration.
*
* @param tdbAu
* A TdbAu with the archival unit.
* @param auId
* A String with the archival unit identifier.
* @param config
* A Configuration to which to add the archival unit configuration.
* @return a Configuration with the archival unit configuration added to the
* passed configuration.
*/
Configuration addAuConfiguration(TdbAu tdbAu, String auId,
Configuration config) {
final String DEBUG_HEADER = "addAuConfiguration(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "tdbAu = " + tdbAu);
log.debug2(DEBUG_HEADER + "auId = " + auId);
//log.debug2(DEBUG_HEADER + "config = " + config);
}
Properties props = new Properties();
props.putAll(tdbAu.getParams());
Configuration auConfig = ConfigManager.fromPropertiesUnsealed(props);
// Specify the repository.
auConfig.put(PluginManager.AU_PARAM_REPOSITORY, getRepository());
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "auConfig = " + auConfig);
// Get the sub-tree prefix.
String prefix = PluginManager.auConfigPrefix(auId);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "prefix = " + prefix);
// Add the archival unit configuration to the passed configuration.
config.addAsSubTree(auConfig, prefix);
//if (log.isDebug2()) log.debug2(DEBUG_HEADER + "config = " + config);
return config;
}
/**
* Provides an indication of whether a publication type corresponds to a
* serial publication.
*
* @param pubType
* A String with the publication type.
* @return a boolean with true if this publication type
* corresponds to a serial publication, false otherwise.
*/
private boolean isSerialPublicationType(String pubType) {
return (MetadataField.PUBLICATION_TYPE_BOOKSERIES.equals(pubType) ||
MetadataField.PUBLICATION_TYPE_JOURNAL.equals(pubType) ||
MetadataField.PUBLICATION_TYPE_PROCEEDINGS.equals(pubType));
}
/**
* Creates subscriptions for all the archival units configured in the system.
*
* @return a SubscriptionOperationStatus with a summary of the status of the
* operation.
*/
public SubscriptionOperationStatus subscribeAllConfiguredAus() {
final String DEBUG_HEADER = "subscribeAllConfiguredAus(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
SubscriptionOperationStatus status = new SubscriptionOperationStatus();
// Get a connection to the database.
Connection conn = null;
try {
conn = dbManager.getConnection();
} catch (DbException dbe) {
log.error(CANNOT_CONNECT_TO_DB_ERROR_MESSAGE, dbe);
status.addStatusEntry(null, false, dbe.getMessage(), null);
return status;
}
// Get the configured Archival Units.
List configuredAus = TdbUtil.getConfiguredTdbAus();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "configuredAus.size() = "
+ configuredAus.size());
// Get the titles with configured Archival Units.
Collection configuredTitles = TdbUtil.getConfiguredTdbTitles();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "configuredTitles.size() = "
+ configuredTitles.size());
try {
// Loop through all the titles with configured archival units.
for (TdbTitle title : configuredTitles) {
// Skip any titles that are not subscribable.
if (!isSubscribable(title)) {
continue;
}
// Create subscriptions for all the configured archival units of this
// title.
subscribePublicationConfiguredAus(title, conn, configuredAus, status);
// Check whether the subscription needs to be for the whole title, not
// subscription ranges.
if (isWholeTitleSynchronization) {
// Yes: Configure any needed AUs covered by the subscription.
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Creating new 'must configure' SubscriptionStarter for title '"
+ title + "'...");
mustConfigureStarter = new SubscriptionStarter(this,
configureAuBatchSize, configureAuRateLimiter,
title.tdbAuIterator(), true);
mustConfigureStarterThread = new Thread(mustConfigureStarter);
mustConfigureStarterThread.start();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Created new 'must configure' SubscriptionStarter.");
} else {
// No: If the subscription is forthe already configured AUs, no new
// AUs will have to be added by definition.
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Not configured any new AUs for title '" + title + "'.");
}
}
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "status = " + status);
return status;
}
/**
* Creates subscriptions for the archival units of a title configured in the
* system.
*
* @param title
* A TdbTitle with the title.
* @param conn
* A Connection with the database connection to be used.
* @param configuredAus
* A List with the archival units already configured in the
* system.
* @param status
* A SubscriptionOperationStatus through which to provide a summary
* of the status of the operation.
*/
private void subscribePublicationConfiguredAus(TdbTitle title,
Connection conn, List configuredAus,
SubscriptionOperationStatus status) {
final String DEBUG_HEADER = "subscribePublicationConfiguredAus(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "title = " + title);
// Get the title publisher.
String publisher = title.getTdbPublisher().getName();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "publisher = " + publisher);
// Get the title name.
String publicationName = title.getName();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "name = " + publicationName);
// Get the unpunctuated title print ISSN.
String pIssn = MetadataUtil.toUnpunctuatedIssn(title.getPrintIssn());
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "pIssn = " + pIssn);
// Get the unpunctuated title electronic ISSN.
String eIssn = MetadataUtil.toUnpunctuatedIssn(title.getEissn());
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "eIssn = " + eIssn);
// Get the title proprietary identifiers.
String[] proprietaryIds = title.getProprietaryIds();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "proprietaryIds = "
+ StringUtil.toString(proprietaryIds));
// Get the first proprietary identifier, if any.
String firstProprietaryId = null;
if (proprietaryIds != null && proprietaryIds.length > 0) {
firstProprietaryId = proprietaryIds[0];
}
// Get the AUs of the title, sorted chronologically.
List sortedTdbAus = title.getSortedTdbAus();
// Get the periods covered by the title currently configured archival units,
// indexed by provider.
Map> periodsByProvider =
getTitleConfiguredCoveragePeriodsByProvider(sortedTdbAus,
configuredAus);
// Get the last periods of any archival units in the title, indexed by
// provider.
Map lastPeriodByProvider =
getLastPeriodbyProvider(sortedTdbAus);
try {
// Find the publisher in the database or create it.
Long publisherSeq = mdManager.findOrCreatePublisher(conn, publisher);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherSeq = " + publisherSeq);
String pubType = title.getPublicationType();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "pubType = " + pubType);
// Check whether it's not a serial publication type.
if (!isSerialPublicationType(pubType)) {
// Yes: Report the problem.
String msg = "Cannot subscribe to publication type '" + pubType + "'";
log.error(msg);
status.addStatusEntry(publicationName, false, msg, null);
}
Long publicationSeq = null;
if (MetadataField.PUBLICATION_TYPE_BOOKSERIES.equals(pubType)) {
publicationSeq = mdManager.findOrCreateBookSeries(conn, publisherSeq,
pIssn, eIssn, publicationName, firstProprietaryId);
} else if (MetadataField.PUBLICATION_TYPE_JOURNAL.equals(pubType)) {
publicationSeq = mdManager.findOrCreateJournal(conn, publisherSeq,
pIssn, eIssn, publicationName, firstProprietaryId);
} else if (MetadataField.PUBLICATION_TYPE_PROCEEDINGS.equals(pubType)) {
publicationSeq = mdManager.findOrCreateProceedings(conn, publisherSeq,
pIssn, eIssn, publicationName, firstProprietaryId);
}
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publicationSeq = " + publicationSeq);
// Check whether there are additional proprietary identifiers.
if (proprietaryIds != null && proprietaryIds.length > 1) {
// Yes: Get the publication metadata item identifier.
Long mdItemSeq =
mdManager.findPublicationMetadataItem(conn, publicationSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "mdItemSeq = " + mdItemSeq);
Collection otherPropIds = new LinkedHashSet();
// Loop through the remaining proprietary identifiers.
for (int i = 1; i < proprietaryIds.length; i++) {
// Check whether this proprietary identifier exists.
if (proprietaryIds[i] != null) {
// Yes: Add it to the collection, if not there already.
otherPropIds.add(proprietaryIds[i]);
}
}
// Persist the remaining proprietary identifiers in the database.
mdManager.addNewMdItemProprietaryIds(conn, mdItemSeq, otherPropIds);
}
// Loop through all the providers for which the title has archival units
// currently configured.
for (TdbProvider provider : periodsByProvider.keySet()) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "provider = " + provider);
List periods = periodsByProvider.get(provider);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "periods = " + periods);
// Get the start edge of the last period of any archival unit.
BibliographicPeriodEdge lastTitlePeriodStartEdge =
lastPeriodByProvider.get(provider).getStartEdge();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "lastTitlePeriodStartEdge = " + lastTitlePeriodStartEdge);
// Get the end edge of the last period of any configured archival unit.
BibliographicPeriodEdge lastConfiguredPeriodEndEdge =
periods.get(periods.size() - 1).getEndEdge();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "lastConfiguredPeriodEndEdge = " + lastConfiguredPeriodEndEdge);
// The archival Units in the future of all the currently configured
// archival units cannot be included in the subscription if the last
// known period is not already configured. Otherwise, extend the
// subscription to the future.
boolean extendFuture =
lastTitlePeriodStartEdge.equals(lastConfiguredPeriodEndEdge);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "extendFuture = " + extendFuture);
// Create the subscriptions for the configured archival units for the
// publication and provider.
subscribePublicationProviderConfiguredAus(publicationSeq, provider,
periods, extendFuture, conn);
}
// Finalize all the subscription changes for this title.
MetadataDbManager.commitOrRollback(conn, log);
// Report the success back to the caller.
status.addStatusEntry(publicationName, null);
} catch (DbException dbe) {
// Report the failure back to the caller.
log.error("Cannot add/update subscription to title with Id = "
+ title.getId(), dbe);
status.addStatusEntry(publicationName, false, dbe.getMessage(), null);
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Provides the periods covered by the currently configured archival units of
* a title, indexed by provider.
*
* @param titleAus
* A list of TdbAus with the title
* @param configuredAus
* A List with the archival units already configured in the
* system.
* @return a Map> with the periods
* covered by the currently configured archival units of the title,
* indexed by provider.
*/
private Map>
getTitleConfiguredCoveragePeriodsByProvider(List titleAus,
List configuredAus) {
final String DEBUG_HEADER =
"getTitleConfiguredCoveragePeriodsByProvider(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "titleAus = " + titleAus);
Map> periodsByProvider =
new HashMap>();
TdbProvider provider = null;
TdbProvider lastProvider = null;
List periods = null;
BibliographicPeriod period = null;
// Loop through all the title archival units.
for (TdbAu au : titleAus) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "au = " + au);
try {
// Check whether the archival unit is not down and it is configured.
if ((isDownTitleSubscribable || !au.isDown())
&& configuredAus.contains(au)) {
// Yes: Get the provider.
provider = au.getTdbProvider();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "provider = " + provider);
// Check whether the subscription needs to be for the whole title, not
// subscription ranges.
if (isWholeTitleSynchronization) {
// Yes: Specify a period that covers any time.
periodsByProvider.put(provider,
Collections.singletonList(BibliographicPeriod.ALL_TIME_PERIOD));
// No more processing to do for this Archival Unit.
continue;
}
// Check whether there is a provider change.
if (lastProvider != null && !lastProvider.equals(provider)) {
// Check whether there is a period defined by the previous archival
// unit that needs to be saved.
if (period != null) {
// Yes: Add it to the list of periods.
periods.add(period);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "periods.size() = " + periods.size());
period = null;
// Add the list of periods to the result map.
periodsByProvider.put(lastProvider, periods);
lastProvider = provider;
}
}
// Check whether this provider already exists in the result map.
if (periodsByProvider.containsKey(provider)) {
// Yes: Get the list of periods for this provider already in the
// result map.
periods = periodsByProvider.get(provider);
} else {
// No: Initialize the list of periods.
periods = new ArrayList();
}
List auRanges = au.getPublicationRanges();
int auRangesLastIndex = auRanges.size() - 1;
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "auRangesLastIndex = "
+ auRangesLastIndex);
// Check whether this configured archival unit follows another
// configured archival unit for the same provider.
if (period != null) {
// Yes: Check whether the end edge of the last publication range of
// the archival unit exists.
if (auRanges.get(auRangesLastIndex).getEndEdge() != null) {
// Yes: Extend the period to the end edge of the last publication
// range of the archival unit.
period = new BibliographicPeriod(period.getStartEdge(),
auRanges.get(auRangesLastIndex).getEndEdge());
} else {
// No: report the problem.
log.warning("Skipped invalid last range "
+ auRanges.get(auRangesLastIndex) + " for AU = " + au
+ ", provider = " + provider);
}
} else {
// No: Check whether both the start edge of the first publication
// range of the archival unit and the end edge of the last
// publication range of the archival unit exist.
if (auRanges.get(0).getStartEdge() != null
&& auRanges.get(auRangesLastIndex).getEndEdge() != null) {
// Yes: Initialize the subscription period with the start edge of
// the first publication range of the archival unit and the end
// edge of the last publication range of the archival unit.
period = new BibliographicPeriod(auRanges.get(0).getStartEdge(),
auRanges.get(auRangesLastIndex).getEndEdge());
} else {
// No: report the problem.
log.warning("Skipped invalid first range "
+ auRanges.get(0) + " and/or last range "
+ auRanges.get(auRangesLastIndex) + " for AU = " + au
+ ", provider = " + provider);
}
}
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "period = " + period);
} else {
// No: Nothing more to do with this archival unit.
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Unconfigured au = " + au);
// Check whether there is a period defined by the previous archival
// unit that needs to be saved.
if (period != null) {
// Yes: Add it to the list of periods.
periods.add(period);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "periods.size() = " + periods.size());
period = null;
// Add the list of periods to the result map.
periodsByProvider.put(provider, periods);
}
}
} catch (RuntimeException re) {
log.error("Cannot find the periods for AU " + au, re);
}
}
// Check whether there is a period defined by the last archival unit that
// needs to be saved.
if (period != null) {
// Yes: Add it to the list of periods.
periods.add(period);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "periods.size() = " + periods.size());
// Add the list of periods to the result map.
periodsByProvider.put(provider, periods);
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
return periodsByProvider;
}
/**
* Provides the last periods covered by the archival units of a title,
* indexed by provider.
*
* @param titleAus
* A list of TdbAus with the title
* @return a Map with the last periods
* covered by the archival units of the title, indexed by provider.
*/
private Map getLastPeriodbyProvider(
List titleAus) {
final String DEBUG_HEADER = "getLastPeriodbyProvider(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "titleAus = " + titleAus);
Map lastPeriodByProvider =
new HashMap();
TdbProvider provider = null;
BibliographicPeriod period = null;
// Loop through all the title archival units.
for (TdbAu au : titleAus) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "au = " + au);
try {
// Get the provider.
provider = au.getTdbProvider();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "provider = " + provider);
// Check whether the subscription needs to be for the whole title, not
// subscription ranges.
if (isWholeTitleSynchronization) {
// Yes: Specify a period that covers any time.
lastPeriodByProvider.put(provider,
BibliographicPeriod.ALL_TIME_PERIOD);
// No more processing to do for this Archival Unit.
continue;
}
List auRanges = au.getPublicationRanges();
int auRangesLastIndex = auRanges.size() - 1;
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "auRangesLastIndex = "
+ auRangesLastIndex);
period = auRanges.get(auRangesLastIndex);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "period = " + period);
// Add this period to the map.
lastPeriodByProvider.put(provider, period);
} catch (RuntimeException re) {
log.error("Cannot find the periods for AU " + au, re);
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
return lastPeriodByProvider;
}
/**
* Creates subscriptions for the archival units of a title for a provider
* that are configured in the system.
*
* @param publicationSeq
* A Long with the publication identifier.
* @param provider
* A Map with the provider information.
* @param periods
* A List with the periods of the archival
* units.
* @param extendFuture
* A boolean with the indication of whether future archival units
* need to be included in the subscription.
* @param conn
* A Connection with the database connection to be used.
* @throws DbException
* if any problem occurred accessing the database.
*/
private void subscribePublicationProviderConfiguredAus(Long publicationSeq,
TdbProvider provider, List periods,
boolean extendFuture, Connection conn) throws DbException {
final String DEBUG_HEADER = "subscribePublicationProviderConfiguredAus(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "publicationSeq = " + publicationSeq);
log.debug2(DEBUG_HEADER + "provider = " + provider);
log.debug2(DEBUG_HEADER + "periods = " + periods);
log.debug2(DEBUG_HEADER + "extendFuture = " + extendFuture);
}
// Find the provider in the database or create it.
// TODO: Replace the second argument with provider().getLid() when
// available.
Long providerSeq =
mdManager.findOrCreateProvider(conn, null, provider.getName());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerSeq = " + providerSeq);
// Find the subscription in the database or create it.
Long subscriptionSeq =
findOrCreateSubscription(conn, publicationSeq, providerSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscriptionSeq = " + subscriptionSeq);
// Delete all the subscription ranges.
int deletedRangesCount =
subManagerSql.deleteAllSubscriptionRanges(conn, subscriptionSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "deletedRangesCount = " + deletedRangesCount);
// Get the count of periods to persist.
int periodCount = periods.size();
// Loop through all the coalesced subscribed ranges covered by the title
// currently configured archival units for this provider.
for (BibliographicPeriod period : periods) {
if (log.isDebug3()) {
log.debug3(DEBUG_HEADER + "period = " + period);
log.debug3(DEBUG_HEADER + "periodCount = " + periodCount);
}
// Check whether this is the last period and the subscription needs to be
// extended to the future.
if (periodCount-- == 1 && extendFuture) {
// Yes: Extend it to the far future and persist it.
BibliographicPeriod extendedPeriod =
new BibliographicPeriod(period.getStartEdge(),
BibliographicPeriodEdge.INFINITY_EDGE);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "extendedPeriod = " + extendedPeriod);
subManagerSql.persistSubscriptionRange(conn, subscriptionSeq,
extendedPeriod, true);
} else {
// No: Just persist it.
subManagerSql.persistSubscriptionRange(conn, subscriptionSeq, period,
true);
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Provides the identifier of a subscription if existing or after creating it
* otherwise.
*
* @param conn
* A Connection with the database connection to be used.
* @param publicationSeq
* A Long with the identifier of the publication.
* @param providerSeq
* A Long with the identifier of the provider.
* @return a Long with the identifier of the subscription.
* @throws DbException
* if any problem occurred accessing the database.
*/
private Long findOrCreateSubscription(Connection conn, Long publicationSeq,
Long providerSeq) throws DbException {
final String DEBUG_HEADER = "findOrCreateSubscription(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "publicationSeq = " + publicationSeq);
log.debug2(DEBUG_HEADER + "providerSeq = " + providerSeq);
}
// Locate the subscription in the database.
Long subscriptionSeq =
subManagerSql.findSubscription(conn, publicationSeq, providerSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "old subscriptionSeq = " + subscriptionSeq);
// Check whether it is a new subscription.
if (subscriptionSeq == null) {
// Yes: Add to the database the new subscription.
subscriptionSeq =
subManagerSql.persistSubscription(conn, publicationSeq, providerSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "new subscriptionSeq = " + subscriptionSeq);
}
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "subscriptionSeq = " + subscriptionSeq);
return subscriptionSeq;
}
/**
* Provides all the subscriptions in the system and their ranges.
*
* @param subscribedPublishers
* A Map with the subscribed
* publishers keyed by the publisher name.
* @return a List with all the subscriptions and their ranges in
* the system.
* @throws DbException
* if any problem occurred accessing the database.
*/
public List findAllSubscriptionsAndRanges(
Map subscribedPublishers)
throws DbException {
return subManagerSql.findAllSubscriptionsAndRanges(subscribedPublishers);
}
/**
* Provides an indication of whether there are subscription ranges.
*
* @return a boolean with true if there are subscribed
* publications, false otherwise.
* @throws DbException
* if any problem occurred accessing the database.
*/
public boolean hasSubscriptionRanges() throws DbException {
boolean response = false;
Connection conn = null;
try {
// Get a connection to the database.
conn = dbManager.getConnection();
response = subManagerSql.hasSubscriptionRanges(conn);
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
return response;
}
/**
* Provides an indication of whether there are publisher subscriptions.
*
* @return a boolean with true if there are publisher
* subscriptions, false otherwise.
* @throws DbException
* if any problem occurred accessing the database.
*/
public boolean hasPublisherSubscriptions() throws DbException {
boolean response = false;
Connection conn = null;
try {
// Get a connection to the database.
conn = dbManager.getConnection();
response = subManagerSql.hasPublisherSubscriptions(conn);
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
return response;
}
/**
* Provides the publications for which subscription decisions have not been
* made yet and populates their publishers.
*
* @param undecidedPublicationsPublishers
* A Map with the undecided publishers keyed by
* the publisher name.
* @return A List with the publications for which
* subscription decisions have not been made yet.
* @throws DbException
* if any problem occurred accessing the database.
*/
public List getUndecidedPublications(
Map undecidedPublicationsPublishers)
throws DbException {
final String DEBUG_HEADER = "getUndecidedPublications(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
// Get the publishers for which a subscription decision has been made.
Map subscribedPublishers =
subManagerSql.findAllSubscribedPublishers();
List unsubscribedPublications =
new ArrayList();
// Get the existing subscriptions with publisher names.
MultiValueMap subscriptionMap = mapSubscriptionsByPublisher(subManagerSql
.findAllSubscriptionsAndPublishers());
Collection publisherSubscriptions = null;
String publisherName;
String titleName;
SerialPublication publication;
long publisherNumber = 1;
long publicationNumber = 1;
// Loop through all the publishers.
for (TdbPublisher publisher :
TdbUtil.getTdb().getAllTdbPublishers().values()) {
publisherName = publisher.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
// Check whether a decision has been made regarding the subscription to
// all the publications of this publisher.
if (subscribedPublishers.containsKey(publisherName)) {
// Yes: Skip all the publications from this publisher.
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "publisher = '"
+ publisherName + "' has subscription: "
+ subscribedPublishers.get(publisherName));
continue;
}
// No: Get the subscribed publications that belong to the publisher.
publisherSubscriptions =
(Collection)subscriptionMap.get(publisherName);
if (log.isDebug3()) {
if (publisherSubscriptions != null) {
log.debug3(DEBUG_HEADER + "publisherSubscriptions.size() = "
+ publisherSubscriptions.size());
} else {
log.debug3(DEBUG_HEADER + "publisherSubscriptions is null.");
}
}
// Loop through all the titles (subscribed or not) of the publisher.
for (TdbTitle title : publisher.getTdbTitles()) {
// Skip any titles that are not subscribable.
if (!isSubscribable(title)) {
continue;
}
titleName = title.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "titleName = " + titleName);
// Loop through all the title providers.
for (TdbProvider provider : title.getTdbProviders()) {
String providerName = provider.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerName = " + providerName);
// TODO: Replace with provider.getLid() when available.
String providerLid = null;
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerLid = " + providerLid);
// Check whether there is no subscription defined for this title and
// this provider.
if (publisherSubscriptions == null
|| !matchSubscriptionTitleAndProvider(publisherSubscriptions,
titleName, providerLid, providerName)) {
// Yes: Add the publication to the list of publications with no
// subscriptions.
publication = new SerialPublication();
publication.setPublicationNumber(publicationNumber++);
publication.setPublicationName(titleName);
publication.setProviderLid(providerLid);
publication.setProviderName(providerName);
publication.setPublisherName(publisherName);
publication.setPissn(title.getPrintIssn());
publication.setEissn(title.getEissn());
publication.setProprietaryIds(new LinkedHashSet(Arrays
.asList(title.getProprietaryIds())));
publication.setTdbTitle(title);
publication.setAvailableAuCount(title.getTdbAvailableAuCount());
publication.setAuCount(title.getTdbAuCount());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publication = " + publication);
unsubscribedPublications.add(normalizePublication(publication));
// Check whether this publisher is not already among the publishers
// of undecided publications.
if (!undecidedPublicationsPublishers.containsKey(publisherName)) {
// Yes: Add this publication publisher to the list of publishers
// for which no decision has been made.
Publisher undecidedPublicationPublisher = new Publisher();
undecidedPublicationPublisher
.setAuCount(publisher.getTdbAuCount());
undecidedPublicationPublisher
.setAvailableAuCount(publisher.getTdbAvailableAuCount());
undecidedPublicationPublisher.setPublisherName(publisherName);
undecidedPublicationPublisher
.setPublisherNumber(publisherNumber++);
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "undecidedPublicationPublisher = "
+ undecidedPublicationPublisher);
undecidedPublicationsPublishers.put(publisherName,
undecidedPublicationPublisher);
}
}
}
}
}
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "unsubscribedPublications.size() = "
+ unsubscribedPublications.size());
// Sort the publications for displaying purposes.
Collections.sort(unsubscribedPublications, PUBLICATION_COMPARATOR);
if (log.isDebug2()) log.debug2(DEBUG_HEADER
+ "unsubscribedPublications.size() = "
+ unsubscribedPublications.size());
return unsubscribedPublications;
}
/**
* Provides the subscriptions in the system keyed by their publisher.
*
* @param subscriptions
* A List with the subscriptions in the system.
* @return a MultivalueMap with the subscriptions in the system keyed by their
* publisher.
*/
private MultiValueMap mapSubscriptionsByPublisher(
List subscriptions) {
final String DEBUG_HEADER = "mapSubscriptionsByPublisher(): ";
if (log.isDebug2()) {
if (subscriptions != null) {
log.debug2(DEBUG_HEADER + "subscriptions.size() = "
+ subscriptions.size());
} else {
log.debug2(DEBUG_HEADER + "subscriptions is null");
}
}
MultiValueMap mapByPublisher = new MultiValueMap();
// Loop through all the subscriptions.
for (Subscription subscription : subscriptions) {
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscription = " + subscription);
// Get the subscription publication.
SerialPublication publication = subscription.getPublication();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publication = " + publication);
// Get the publication publisher name.
String publisherName = publication.getPublisherName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
// Save the publisher subscription.
mapByPublisher.put(publisherName, subscription);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "Added subscription "
+ subscription + " for publisher " + publisherName);
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "mapByPublisher.size() = "
+ mapByPublisher.size());
return mapByPublisher;
}
/**
* Provides an indication of whether a TdbTitle can be the subject of a
* subscription.
*
* @return true if the TdbTitle can be the subject of a
* subscription, false otherwise.
*/
boolean isSubscribable(TdbTitle tdbTitle) {
final String DEBUG_HEADER = "isSubscribable(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "tdbTitle = " + tdbTitle);
boolean result = false;
// Check whether the TdbTitle exists.
if (tdbTitle != null) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "tdbTitle = " + tdbTitle);
// Yes: Check whether the TdbTitle is marked as a serial title.
if (tdbTitle.isSerial()) {
// Yes: Check whether subscriptions may be specified even for titles
// that are down.
if (isDownTitleSubscribable) {
// Yes.
result = true;
} else {
// No: Loop through the title archival units.
for (TdbAu tdbAu : tdbTitle.getTdbAus()) {
// Check whether this archival unit is not down.
if (!tdbAu.isDown()) {
// Yes: The TdbTitle is subscribable; no need to do anything more.
result = true;
break;
}
}
}
if (log.isDebug3() && !result) {
log.debug3(DEBUG_HEADER + "tdbTitle '" + tdbTitle
+ "' is not subscribable because all of its AUs are down.");
}
} else {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "title '" + tdbTitle
+ "' is not subscribable because it's not a serial publication.");
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
/**
* Provides an indication of whether there is a subscription defined for this
* title and this provider.
*
* @param subscriptions
* A Collection with all the subscriptions.
* @param titleName
* A String with the name of the title.
* @param providerLid
* A String with the LOCKSS identifier of the provider.
* @param providerName
* A String with the name of the provider.
* @return a boolean with true if the subscription for the title
* and provider exists, false otherwise.
*/
private boolean matchSubscriptionTitleAndProvider(
Collection subscriptions, String titleName,
String providerLid, String providerName) {
final String DEBUG_HEADER = "matchSubscriptionTitleAndProvider(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "subscriptions = " + subscriptions);
log.debug2(DEBUG_HEADER + "titleName = " + titleName);
log.debug2(DEBUG_HEADER + "providerLid = " + providerLid);
log.debug2(DEBUG_HEADER + "providerName = " + providerName);
}
// Handle the case when there are no subscriptions.
if (subscriptions == null || subscriptions.size() < 1) {
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Did not find match.");
return false;
}
SerialPublication publication;
// Loop through all the subscriptions.
for (Subscription subscription : subscriptions) {
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscription = " + subscription);
// Get the subscription publication.
publication = subscription.getPublication();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publication = " + publication);
// Check whether there is a match.
if (publication.getPublicationName().equals(titleName)
&& (publication.getProviderLid() == null
|| publication.getProviderLid().equals(providerLid))
&& publication.getProviderName().equals(providerName)) {
// Yes: No need for further checking.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Found match.");
return true;
}
}
// No match was found.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Did not find match.");
return false;
}
/**
* Normalizes publication data.
*
* @param publication
* A SerialPublication with the publication data.
* @return a SerialPublication with the normalized publication data.
*/
private SerialPublication normalizePublication(
SerialPublication publication) {
final String DEBUG_HEADER = "normalizePublication(): ";
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "publication = " + publication);
// Normalize the provider LOCKSS identifier, if necessary.
if (!StringUtil.isNullString(publication.getProviderLid())) {
if (publication.getProviderLid().length() > MAX_LID_COLUMN) {
log.warning("provider LOCKSS ID too long '"
+ publication.getProviderLid() + "' for title: '"
+ publication.getPublicationName() + "' publisher: "
+ publication.getPublisherName() + "'");
publication.setProviderLid(MetadataDbManager.truncateVarchar(
publication.getProviderLid(), MAX_LID_COLUMN));
}
}
// Normalize the provider name, if necessary.
if (!StringUtil.isNullString(publication.getProviderName())) {
if (publication.getProviderName().length() > MAX_NAME_COLUMN) {
log.warning("provider name too long '" + publication.getProviderName()
+ "' for title: '" + publication.getPublicationName()
+ "' publisher: " + publication.getPublisherName() + "'");
publication.setProviderName(MetadataDbManager.truncateVarchar(
publication.getProviderName(), MAX_NAME_COLUMN));
}
}
// Normalize the print ISSN, if necessary.
if (!StringUtil.isNullString(publication.getPissn())) {
String issn = publication.getPissn().replaceAll("-", "");
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "issn = '" + issn + "'.");
if (issn.length() > MAX_ISSN_COLUMN) {
log.warning("issn too long '" + publication.getPissn()
+ "' for title: '" + publication.getPublicationName()
+ "' publisher: " + publication.getPublisherName() + "'");
publication.setPissn(MetadataDbManager.truncateVarchar(issn, MAX_ISSN_COLUMN));
} else {
publication.setPissn(issn);
}
}
// Normalize the electronic ISSN, if necessary.
if (!StringUtil.isNullString(publication.getEissn())) {
String issn = publication.getEissn().replaceAll("-", "");
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "issn = '" + issn + "'.");
if (issn.length() > MAX_ISSN_COLUMN) {
log.warning("issn too long '" + publication.getEissn()
+ "' for title: '" + publication.getPublicationName()
+ "' publisher: " + publication.getPublisherName() + "'");
publication.setEissn(MetadataDbManager.truncateVarchar(issn, MAX_ISSN_COLUMN));
} else {
publication.setEissn(issn);
}
}
// Normalize the proprietary identifiers, if necessary.
if (publication.getProprietaryIds() != null) {
Set normalizedPropIds = new LinkedHashSet();
for (String proprietaryId : publication.getProprietaryIds()) {
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "proprietaryId = " + proprietaryId);
String normalizedPropId = proprietaryId;
if (!StringUtil.isNullString(proprietaryId)) {
if (proprietaryId.length() > MAX_PROPRIETARY_ID_COLUMN) {
log.warning("proprietaryId too long '" + proprietaryId
+ "' for title: '" + publication.getPublicationName()
+ "' publisher: " + publication.getPublisherName() + "'");
normalizedPropId = MetadataDbManager.truncateVarchar(proprietaryId,
MAX_PROPRIETARY_ID_COLUMN);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "normalizedPropId = "
+ normalizedPropId);
}
}
normalizedPropIds.add(normalizedPropId);
}
publication.setProprietaryIds(normalizedPropIds);
}
// Normalize the publisher name, if necessary.
if (!StringUtil.isNullString(publication.getPublisherName())) {
if (publication.getPublisherName().length() > MAX_NAME_COLUMN) {
log.warning("publisher too long '" + publication.getPublisherName()
+ "' for title: '" + publication.getPublicationName() + "'");
publication.setPublisherName(MetadataDbManager.truncateVarchar(
publication.getPublisherName(), MAX_NAME_COLUMN));
}
}
// Normalize the publication name, if necessary.
if (!StringUtil.isNullString(publication.getPublicationName())) {
if (publication.getPublicationName().length() > MAX_NAME_COLUMN) {
log.warning("title too long '" + publication.getPublicationName()
+ "' for publisher: " + publication.getPublisherName() + "'");
publication.setPublicationName(MetadataDbManager.truncateVarchar(
publication.getPublicationName(), MAX_NAME_COLUMN));
}
}
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "publication = " + publication);
return publication;
}
/**
* Validates subscription ranges.
*
* @param subscriptionRanges
* A List with the subscription ranges to be
* validated.
* @param publication
* A SerialPublication with the publication data.
* @return a List with the subscription ranges that are
* not valid.
*/
public List validateRanges(
List subscriptionRanges,
SerialPublication publication) {
final String DEBUG_HEADER = "validateRanges(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "subscriptionRanges = " + subscriptionRanges);
log.debug2(DEBUG_HEADER + "publication = " + publication);
}
List invalidRanges =
new ArrayList();
// Loop through all the subscription ranges.
for (BibliographicPeriod range : subscriptionRanges) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "range = " + range);
// Check whether this range is not valid.
if (range.isEmpty() || !isRangeValid(range, publication)) {
// Yes: Add it to the result.
invalidRanges.add(range);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Range '" + range + "' is not valid.");
}
}
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "invalidRanges = " + invalidRanges);
return invalidRanges;
}
/**
* Provides an indication of whether the passed subscription range is valid.
*
* @param range
* A BibliographicPeriod with the subscription range to be validated.
* @param publication
* A SerialPublication with the publication data.
* @return a boolean with true if the passed subscription range
* is valid, false otherwise.
*/
boolean isRangeValid(BibliographicPeriod range,
SerialPublication publication) {
final String DEBUG_HEADER = "isRangeValid(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "range = " + range);
log.debug2(DEBUG_HEADER + "publication = " + publication);
}
// Get the range textual definition.
String text = range.toDisplayableString();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "text = " + text);
// Check whether the range textual definition is too long for the database.
if (text.length() > MAX_RANGE_COLUMN) {
// Yes: Report the problem.
log.error("Invalid length (" + text.length() + ") for range '" + text
+ "'.");
return false;
}
// Check whether the range does not involve volumes or issues.
if (range.includesFullYears()) {
// Yes: Year-only ranges are always valid.
return true;
}
// No: Determine whether the range matches any TdbAu of the publication.
boolean result = matchesTitleTdbAu(range, publication);
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
/**
* Provides an indication of whether the passed range matches any Archival
* Unit of a publication.
*
* @param range
* A BibliographicPeriod with the publication range to be matched.
* @param publication
* A SerialPublication with the publication data.
* @return a boolean with true if the passed range matches any
* Archival Unit of this publication, false otherwise.
*/
boolean matchesTitleTdbAu(BibliographicPeriod range,
SerialPublication publication) {
final String DEBUG_HEADER = "matchesTitleTdbAu(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "range = " + range);
log.debug2(DEBUG_HEADER + "publication = " + publication);
}
// Loop through the publication archival units.
for (TdbAu tdbAu : publication.getTdbTitle().getTdbAus()) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "tdbAu = " + tdbAu);
// Check whether the range matches any of the publication ranges of the
// current archival unit.
if (range.matches(tdbAu.getPublicationRanges())) {
// Yes: No need to check any further.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result is true");
return true;
}
}
// No: The range does not match any Archival Unit of the publication.
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result is false");
return false;
}
/**
* Adds subscriptions to the system.
*
* @param totalSubscriptionChanged
* A Boolean with the indication of whether the total subscription
* setting has changed.
* @param updatedTotalSubscriptionSetting
* A Boolean with the updated total subscription setting.
* @param publisherSubscriptions
* A Collection with the publisher
* subscriptions to be added.
* @param subscriptions
* A Collection with the subscriptions to be added.
* @param status
* A SubscriptionOperationStatus where to return the status of the
* operation.
*/
public void addSubscriptions(boolean totalSubscriptionChanged,
Boolean updatedTotalSubscriptionSetting,
Collection publisherSubscriptions,
Collection subscriptions,
SubscriptionOperationStatus status) {
final String DEBUG_HEADER = "addSubscriptions(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "totalSubscriptionChanged = "
+ totalSubscriptionChanged);
log.debug2(DEBUG_HEADER + "updatedTotalSubscriptionSetting = "
+ updatedTotalSubscriptionSetting);
if (publisherSubscriptions != null) {
log.debug2(DEBUG_HEADER + "publisherSubscriptions.size() = "
+ publisherSubscriptions.size());
} else {
log.debug2(DEBUG_HEADER + "publisherSubscriptions is null");
}
if (subscriptions != null) {
log.debug2(DEBUG_HEADER + "subscriptions.size() = "
+ subscriptions.size());
} else {
log.debug2(DEBUG_HEADER + "subscriptions is null");
}
}
// Force a re-calculation of the relative weights of the repositories.
repositories = null;
Connection conn = null;
try {
// Get a connection to the database.
conn = dbManager.getConnection();
} catch (DbException dbe) {
log.error(CANNOT_CONNECT_TO_DB_ERROR_MESSAGE, dbe);
for (PublisherSubscription publisherSubscription
: publisherSubscriptions) {
status.addPublisherStatusEntry(publisherSubscription.getPublisher()
.getPublisherName(), false, dbe.getMessage(), null);
}
for (Subscription subscription : subscriptions) {
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, dbe.getMessage(), null);
}
if (log.isDebug2()) log.debug(DEBUG_HEADER + "Done.");
return;
}
try {
if (isTotalSubscriptionEnabled && totalSubscriptionChanged) {
updateTotalSubscription(conn, updatedTotalSubscriptionSetting, status);
}
BatchAuStatus bas;
// Loop through all the publisher subscriptions.
for (PublisherSubscription publisherSubscription
: publisherSubscriptions) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "publisherSubscriptions = " + publisherSubscriptions);
String publisherName =
publisherSubscription.getPublisher().getPublisherName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
Boolean subscribed = publisherSubscription.getSubscribed();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscribed = " + subscribed);
try {
// Persist the publisher subscription in the database.
persistPublisherSubscription(conn, publisherSubscription);
MetadataDbManager.commitOrRollback(conn, log);
if (subscribed != null && subscribed.booleanValue()) {
handleStartingPublisherSubscription(publisherSubscription);
}
status.addPublisherStatusEntry(publisherName, true, null, subscribed);
} catch (DbException dbe) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot add publisher subscription "
+ publisherSubscription, dbe);
status.addPublisherStatusEntry(publisherSubscription.getPublisher()
.getPublisherName(), false, dbe.getMessage(), null);
}
}
// Loop through all the subscriptions.
for (Subscription subscription : subscriptions) {
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscription = " + subscription);
try {
// Persist the subscription in the database.
persistSubscription(conn, subscription);
List subscribedRanges =
subscription.getSubscribedRanges();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
// Check whether the added subscription may imply the configuration of
// some archival unit.
if (subscribedRanges != null
&& subscribedRanges.size() > 0
&& (subscribedRanges.size() > 1
|| !subscribedRanges.iterator().next().isEmpty())) {
// Yes: Configure the archival units that correspond to this
// subscription.
bas = configureAus(subscription);
} else {
bas = null;
}
MetadataDbManager.commitOrRollback(conn, log);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), bas);
} catch (IllegalStateException ise) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot add subscription " + subscription, ise);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, ise.getMessage(), null);
} catch (IOException ioe) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot add subscription " + subscription, ioe);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, ioe.getMessage(), null);
} catch (DbException dbe) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot add subscription " + subscription, dbe);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, dbe.getMessage(), null);
} catch (SubscriptionException se) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot add subscription " + subscription, se);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, se.getMessage(), null);
}
}
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Persists a publisher subscription in the database.
*
* @param conn
* A Connection with the database connection to be used.
* @param publisherSubscription
* A PublisherSubscription with the publisher subscription to be
* persisted.
* @throws DbException
* if any problem occurred accessing the database.
*/
private Long persistPublisherSubscription(Connection conn,
PublisherSubscription publisherSubscription) throws DbException {
final String DEBUG_HEADER = "persistPublisherSubscription(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "publisherSubscription = "
+ publisherSubscription);
Long publisherSeq = mdManager.findOrCreatePublisher(conn,
publisherSubscription.getPublisher().getPublisherName());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherSeq = " + publisherSeq);
Boolean subscribed = publisherSubscription.getSubscribed();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "subscribed = " + subscribed);
Long publisherSubscriptionSeq = null;
if (subscribed == null) {
subManagerSql.deletePublisherSubscription(conn, publisherSeq);
} else {
publisherSubscriptionSeq = subManagerSql
.updateOrCreatePublisherSubscription(conn, publisherSeq, subscribed);
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "publisherSubscriptionSeq = "
+ publisherSubscriptionSeq);
return publisherSubscriptionSeq;
}
/**
* Persists a subscription in the database.
*
* @param conn
* A Connection with the database connection to be used.
* @param subscription
* A Subscription with the subscription to be persisted.
* @throws DbException
* if any problem occurred accessing the database.
* @throws SubscriptionException
* if there are problems with the subscription publication.
*/
private void persistSubscription(Connection conn, Subscription subscription)
throws DbException, SubscriptionException {
final String DEBUG_HEADER = "persistSubscription(): ";
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "subscription = " + subscription);
// Get the subscription ranges.
List subscribedRanges =
subscription.getSubscribedRanges();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
List unsubscribedRanges =
subscription.getUnsubscribedRanges();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "unsubscribedRanges = " + unsubscribedRanges);
// Do nothing more if there are no subscription ranges.
if ((subscribedRanges == null || subscribedRanges.size() < 1)
&& (unsubscribedRanges == null || unsubscribedRanges.size() < 1)) {
return;
}
// Get the subscription publication.
SerialPublication publication = subscription.getPublication();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publication = " + publication);
// Find the publisher in the database or create it.
Long publisherSeq =
mdManager.findOrCreatePublisher(conn, publication.getPublisherName());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherSeq = " + publisherSeq);
String publicationName = publication.getPublicationName();
// Get the publication TDB title.
TdbTitle title = publication.getTdbTitle();
// Check whether this publication has no TDB title.
if (title == null) {
// Yes: Report the problem.
String message = "No TdbTitle for publication '" + publicationName + "'";
log.error(message);
throw new SubscriptionException(message);
}
String pubType = title.getPublicationType();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "pubType = " + pubType);
// Check whether it's not a serial publication type.
if (!isSerialPublicationType(pubType)) {
// Yes: Report the problem.
String message = "It's not possible to subscribe to publication '"
+ publicationName + "' because it is of type'" + pubType
+ "', not a book series or a journal";
log.error(message);
throw new SubscriptionException(message);
}
String pIssn = publication.getPissn();
String eIssn = publication.getEissn();
// Get the title proprietary identifiers.
Set proprietaryIds = publication.getProprietaryIds();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "proprietaryIds = " + proprietaryIds);
// Get the first proprietary identifier, if any.
String firstProprietaryId = null;
if (proprietaryIds != null && proprietaryIds.size() > 0) {
firstProprietaryId = proprietaryIds.iterator().next();
}
// Find the publication in the database or create it.
Long publicationSeq = null;
// Check whether it is a book series.
if (MetadataField.PUBLICATION_TYPE_BOOKSERIES.equals(pubType)) {
// Yes: Find it or create it.
publicationSeq = mdManager.findOrCreateBookSeries(conn, publisherSeq,
pIssn, eIssn, publicationName, firstProprietaryId);
// No: Check whether it is a journal.
} else if (MetadataField.PUBLICATION_TYPE_JOURNAL.equals(pubType)) {
// Yes: Find it or create it.
publicationSeq = mdManager.findOrCreateJournal(conn,publisherSeq, pIssn,
eIssn, publicationName, firstProprietaryId);
} else if (MetadataField.PUBLICATION_TYPE_PROCEEDINGS.equals(pubType)) {
// Yes: Find it or create it.
publicationSeq = mdManager.findOrCreateProceedings(conn,publisherSeq,
pIssn, eIssn, publicationName, firstProprietaryId);
}
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publicationSeq = " + publicationSeq);
// Check whether there are additional proprietary identifiers.
if (proprietaryIds != null && proprietaryIds.size() > 1) {
// Yes: Get the publication metadata item identifier.
Long mdItemSeq =
mdManager.findPublicationMetadataItem(conn, publicationSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "mdItemSeq = " + mdItemSeq);
Collection otherPropIds = new LinkedHashSet();
// Loop through the remaining proprietary identifiers.
for (String proprietaryId : proprietaryIds) {
if (!proprietaryId.equals(firstProprietaryId)) {
// Add it to the collection, if not there already.
otherPropIds.add(proprietaryId);
}
}
// Persist the remaining proprietary identifiers in the database.
mdManager.addNewMdItemProprietaryIds(conn, mdItemSeq, otherPropIds);
}
// Find the provider in the database or create it.
Long providerSeq = mdManager.findOrCreateProvider(conn,
publication.getProviderLid(), publication.getProviderName());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerSeq = " + providerSeq);
// Find the subscription in the database or create it.
Long subscriptionSeq =
findOrCreateSubscription(conn, publicationSeq, providerSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscriptionSeq = " + subscriptionSeq);
// Persist the subscribed ranges.
int count =
persistSubscribedRanges(conn, subscriptionSeq, subscribedRanges);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Added " + count + " subscribed ranges.");
// Persist the unsubscribed ranges.
count =
persistUnsubscribedRanges(conn, subscriptionSeq, unsubscribedRanges);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Added " + count + " unsubscribed ranges.");
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Configures the archival units covered by a subscription.
*
* @param subscription
* A Subscription with the subscription involved.
* @return a BatchAuStatus with the status of the operation.
* @throws IOException
* if there are problems configuring the archival units.
* @throws SubscriptionException
* if there are problems with the subscription publication.
*/
BatchAuStatus configureAus(Subscription subscription)
throws IOException, SubscriptionException {
final String DEBUG_HEADER = "configureAus(): ";
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "subscription = " + subscription);
// Get the subscribed ranges.
List subscribedRanges =
subscription.getSubscribedRanges();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
// Do nothing more if there are no subscribed ranges.
if (subscribedRanges == null || subscribedRanges.size() < 1) {
return null;
}
// Get the subscription publication.
SerialPublication publication = subscription.getPublication();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publication = " + publication);
// Check whether the publication has no TdbTitle.
if (publication.getTdbTitle() == null) {
// Yes: Report the problem.
String message = "Cannot find tdbTitle with name '"
+ publication.getPublicationName() + "'.";
log.error(message);
throw new SubscriptionException(message);
}
if (subscriptionsDeferred) {
log.debug("Not creating subscribed AUs because "
+ PARAM_SUBSCRIPTION_DEFERRED + " is set");
return null;
}
// Configure the archival units.
return configureAus(publication, subscribedRanges,
subscription.getUnsubscribedRanges());
}
/**
* Persists the subscribed ranges of a subscription in the database.
*
* @param conn
* A Connection with the database connection to be used.
* @param subscriptionSeq
* A Long with the subscription identifier.
* @param subscribedRanges
* A List with the subscription subscribed
* ranges to be persisted.
* @throws DbException
* if any problem occurred accessing the database.
*/
int persistSubscribedRanges(Connection conn, Long subscriptionSeq,
List subscribedRanges) throws DbException {
int count = 0;
if (subscribedRanges != null) {
// Find the existing subscribed ranges for the subscription.
List existingRanges =
subManagerSql.findSubscriptionRanges(conn, subscriptionSeq, true);
// Loop through all the subscribed ranges to be persisted.
for (BibliographicPeriod range : subscribedRanges) {
// Check whether the range to be persisted does not exist already.
if (!existingRanges.contains(range)) {
// Yes: Persist the subscribed ranges.
count += subManagerSql.persistSubscriptionRange(conn, subscriptionSeq,
range, true);
}
}
}
return count;
}
/**
* Persists the unsubscribed ranges of a subscription in the database.
*
* @param conn
* A Connection with the database connection to be used.
* @param subscriptionSeq
* A Long with the subscription identifier.
* @param unsubscribedRanges
* A List with the subscription unsubscribed
* ranges to be persisted.
* @throws DbException
* if any problem occurred accessing the database.
*/
int persistUnsubscribedRanges(Connection conn, Long subscriptionSeq,
List unsubscribedRanges) throws DbException {
int count = 0;
if (unsubscribedRanges != null) {
// Find the existing unsubscribed ranges for the subscription.
List existingRanges =
subManagerSql.findSubscriptionRanges(conn, subscriptionSeq, false);
// Loop through all the unsubscribed ranges to be persisted.
for (BibliographicPeriod range : unsubscribedRanges) {
// Check whether the range to be persisted does not exist already.
if (!existingRanges.contains(range)) {
// Persist the unsubscribed range.
count += subManagerSql.persistSubscriptionRange(conn, subscriptionSeq,
range, false);
}
}
}
return count;
}
/**
* Configures the archival units covered by the subscribed ranges of a
* publication and not covered by the unsubscribed ranges.
*
* @param publication
* A SerialPublication with the publication involved.
* @param subscribedRanges
* A List with the subscribed ranges of the
* publication.
* @param unsubscribedRanges
* A List with the unsubscribed ranges of the
* publication.
* @return a BatchAuStatus with the status of the operation.
* @throws IOException
* if there are problems configuring the archival units.
*/
private BatchAuStatus configureAus(SerialPublication publication,
List subscribedRanges,
List unsubscribedRanges) throws IOException {
final String DEBUG_HEADER = "configureAus(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "publication = " + publication);
log.debug2(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
log.debug2(DEBUG_HEADER + "unsubscribedRanges = " + unsubscribedRanges);
}
// Get the publication archival units covered by the subscription.
Set coveredTdbAus = getCoveredTdbAus(publication.getTdbTitle(),
subscribedRanges, unsubscribedRanges);
// Initialize the configuration used to configure the archival units.
Configuration config = ConfigManager.newConfiguration();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "config = " + config);
// Loop through all the covered publication archival units.
for (TdbAu tdbAu : coveredTdbAus) {
// Skip those archival units that are down.
if (tdbAu.isDown()) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "TdbAu '" + tdbAu
+ "' is marked down.");
continue;
}
// Get the archival unit identifier.
String auId = tdbAu.getAuId(pluginManager);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "auId = " + auId);
// Get the archival unit.
ArchivalUnit au = pluginManager.getAuFromIdIfExists(auId);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "au = " + au);
// Check whether the archival unit is not active.
if (au == null || (!pluginManager.isActiveAu(au))) {
// Yes: Add the archival unit to the configuration of those to be
// configured.
config = addAuConfiguration(tdbAu, auId, config);
//if (log.isDebug3()) log.debug3(DEBUG_HEADER + "config = " + config);
} else {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "TdbAu '" + tdbAu
+ "' is already configured.");
}
}
// Configure the unconfigured archival units that are covered by the
// subscription.
return configureAuBatch(config);
}
/**
* Updates existing subscriptions.
*
* @param totalSubscriptionChanged
* A Boolean with the indication of whether the total subscription
* setting has changed.
* @param updatedTotalSubscriptionSetting
* A Boolean with the updated total subscription setting.
* @param publisherSubscriptions
* A Collection with the publisher
* subscriptions to be updated.
* @param subscriptions
* A Collection with the subscriptions to be updated.
* @param status
* A SubscriptionOperationStatus where to return the status of the
* operation.
*/
public void updateSubscriptions(boolean totalSubscriptionChanged,
Boolean updatedTotalSubscriptionSetting,
Collection publisherSubscriptions,
Collection subscriptions,
SubscriptionOperationStatus status) {
final String DEBUG_HEADER = "updateSubscriptions(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "totalSubscriptionChanged = "
+ totalSubscriptionChanged);
log.debug2(DEBUG_HEADER + "updatedTotalSubscriptionSetting = "
+ updatedTotalSubscriptionSetting);
if (publisherSubscriptions != null) {
log.debug2(DEBUG_HEADER + "publisherSubscriptions.size() = "
+ publisherSubscriptions.size());
} else {
log.debug2(DEBUG_HEADER + "publisherSubscriptions is null");
}
if (subscriptions != null) {
log.debug2(DEBUG_HEADER + "subscriptions.size() = "
+ subscriptions.size());
} else {
log.debug2(DEBUG_HEADER + "subscriptions is null");
}
}
// Force a re-calculation of the relative weights of the repositories.
repositories = null;
Connection conn = null;
try {
// Get a connection to the database.
conn = dbManager.getConnection();
} catch (DbException dbe) {
log.error(CANNOT_CONNECT_TO_DB_ERROR_MESSAGE, dbe);
for (PublisherSubscription publisherSubscription
: publisherSubscriptions) {
status.addPublisherStatusEntry(publisherSubscription.getPublisher()
.getPublisherName(), false, dbe.getMessage(),
publisherSubscription.getSubscribed());
}
for (Subscription subscription : subscriptions) {
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, dbe.getMessage(), null);
}
if (log.isDebug2()) log.debug(DEBUG_HEADER + "Done.");
return;
}
try {
if (isTotalSubscriptionEnabled && totalSubscriptionChanged) {
updateTotalSubscription(conn, updatedTotalSubscriptionSetting, status);
}
BatchAuStatus bas;
// Loop through all the publisher subscriptions.
for (PublisherSubscription publisherSubscription
: publisherSubscriptions) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "publisherSubscription = "
+ publisherSubscription);
String publisherName =
publisherSubscription.getPublisher().getPublisherName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
Boolean subscribed = publisherSubscription.getSubscribed();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscribed = " + subscribed);
try {
// Update the publisher subscription in the database.
persistPublisherSubscription(conn, publisherSubscription);
MetadataDbManager.commitOrRollback(conn, log);
if (subscribed != null && subscribed.booleanValue()) {
handleStartingPublisherSubscription(publisherSubscription);
}
status.addPublisherStatusEntry(publisherName, true, null, subscribed);
} catch (DbException dbe) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot update publisher subscription "
+ publisherSubscription, dbe);
status.addPublisherStatusEntry(publisherName, false, dbe.getMessage(),
subscribed);
}
}
// Loop through all the subscriptions.
for (Subscription subscription : subscriptions) {
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscription = " + subscription);
try {
// Update the subscription in the database.
updateSubscription(conn, subscription);
List subscribedRanges =
subscription.getSubscribedRanges();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
// Check whether the updated subscription may imply the configuration
// of some archival unit.
if (subscribedRanges != null
&& subscribedRanges.size() > 0
&& (subscribedRanges.size() > 1
|| !subscribedRanges.iterator().next().isEmpty())) {
// Yes: Configure the archival units that correspond to this
// subscription.
bas = configureAus(subscription);
} else {
bas = null;
}
MetadataDbManager.commitOrRollback(conn, log);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), bas);
} catch (IllegalStateException ise) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot update subscription " + subscription, ise);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, ise.getMessage(), null);
} catch (IOException ioe) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot update subscription " + subscription, ioe);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, ioe.getMessage(), null);
} catch (DbException dbe) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot update subscription " + subscription, dbe);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, dbe.getMessage(), null);
} catch (SubscriptionException se) {
try {
if ((conn != null) && !conn.isClosed()) {
conn.rollback();
}
} catch (SQLException sqle) {
log.error(CANNOT_ROLL_BACK_DB_CONNECTION_ERROR_MESSAGE, sqle);
}
log.error("Cannot update subscription " + subscription, se);
status.addStatusEntry(subscription.getPublication()
.getPublicationName(), false, se.getMessage(), null);
}
}
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Updates a subscriptions in the database.
*
* @param conn
* A Connection with the database connection to be used.
* @param subscription
* A Subscription with the subscription to be persisted.
* @throws DbException
* if any problem occurred accessing the database.
*/
private void updateSubscription(Connection conn, Subscription subscription)
throws DbException {
final String DEBUG_HEADER = "updateSubscription(): ";
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "subscription = " + subscription);
// Get the subscription identifier.
Long subscriptionSeq = subscription.getSubscriptionSeq();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscriptionSeq = " + subscriptionSeq);
// Delete all the subscription ranges.
int deletedRangesCount =
subManagerSql.deleteAllSubscriptionRanges(conn, subscriptionSeq);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "deletedRangesCount = " + deletedRangesCount);
// Get the subscribed ranges.
List ranges = subscription.getSubscribedRanges();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscribedRanges = " + ranges);
// Persist in the database the updated subscribed ranges.
persistSubscriptionRanges(conn, subscriptionSeq, ranges, true);
// Get the unsubscribed ranges.
ranges = subscription.getUnsubscribedRanges();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "unsubscribedRanges = " + ranges);
// Persist in the database the updated unsubscribed ranges.
persistSubscriptionRanges(conn, subscriptionSeq, ranges, false);
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Persists ranges of a given subscription.
*
* @param conn
* A Connection with the database connection to be used.
* @param subscriptionSeq
* A Long with the identifier of the subscription.
* @param ranges
* A List with the subscription ranges.
* @param subscribed
* A boolean with the indication of whether the LOCKSS installation
* is subscribed to the publication range or not.
* @throws DbException
* if any problem occurred accessing the database.
*/
private void persistSubscriptionRanges(Connection conn, Long subscriptionSeq,
List ranges, boolean subscribed)
throws DbException {
final String DEBUG_HEADER = "persistSubscriptionRanges(): ";
if (log.isDebug2()) {
log.debug2(DEBUG_HEADER + "subscriptionSeq = " + subscriptionSeq);
log.debug2(DEBUG_HEADER + "ranges = " + ranges);
log.debug2(DEBUG_HEADER + "subscribed = " + subscribed);
}
// Loop through the ranges to be persisted.
if (ranges != null) {
for (BibliographicPeriod range : ranges) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "range = " + range);
subManagerSql.persistSubscriptionRange(conn, subscriptionSeq, range,
subscribed);
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Provides the sorter of publications.
*
* @return a Comparator with the sorter of publications.
*/
public Comparator getPublicationComparator() {
return PUBLICATION_COMPARATOR;
}
/**
* Provides the sorter of subscriptions by their publications.
*
* @return a Comparator with the sorter of subscriptions by
* their publications.
*/
public Comparator getSubscriptionByPublicationComparator() {
return SUBSCRIPTION_BY_PUBLICATION_COMPARATOR;
}
/**
* Provides the repository to be used when configuring an AU.
*
* @return a String identifying the repository to be used.
*/
private synchronized String getRepository() {
final String DEBUG_HEADER = "getRepository(): ";
// Check whether there is no list of weighted repositories.
if (repositories == null) {
// Yes: Populate the list of weighted repositories.
repositories = populateRepositories(remoteApi.getRepositoryDFMap());
// Use the first repository in the new list.
repositoryIndex = 0;
}
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "repositoryIndex = " + repositoryIndex);
// Get the repository to be used.
String repository = repositories.get(repositoryIndex);
// Point to the next repository.
repositoryIndex = ++repositoryIndex % repositories.size();
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "repository = " + repository);
return repository;
}
/**
* Populates the list of weighted repositories, to be used in a round-robin
* fashion for the subsequent AU configurations.
*
* @param repositoryMap
* A Map with the map of all distinct
* repositories available.
* @return a List with the list of weighted repositories.
*/
List populateRepositories(Map repositoryMap)
{
final String DEBUG_HEADER = "populateRepositories(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "repositoryMap.size() = "
+ repositoryMap.size());
// Initialize the list of available repositories.
List repos = new ArrayList();
// Handle an empty repository map.
if (repositoryMap.size() < 1) {
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "repos = " + repos);
return repos;
}
// Get the available repositories sorted by their available space.
TreeSet> sortedRepos =
new TreeSet>(DF_BY_AVAIL_COMPARATOR);
sortedRepos.addAll(repositoryMap.entrySet());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "sortedRepos.size() = " + sortedRepos.size());
// Handle the case of a single repository.
if (sortedRepos.size() == 1) {
repos.add(sortedRepos.first().getKey());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Added " + sortedRepos.first().getKey());
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "repos = " + repos);
return repos;
}
// Get the repository available space threshold from the configuration.
int repoThreshold = ConfigManager.getCurrentConfig()
.getInt(PARAM_REPOSITORY_AVAIL_SPACE_THRESHOLD,
DEFAULT_REPOSITORY_AVAIL_SPACE_THRESHOLD);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "repoThreshold = " + repoThreshold);
// Get the available space of the repository with the least amount of
// available space.
long minAvail = sortedRepos.first().getValue().getAvail();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "minAvail = " + minAvail);
// Remove repositories that don't have a minimum of space, except the last
// one.
while (minAvail < repoThreshold) {
sortedRepos.remove(sortedRepos.first());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "sortedRepos.size() = " + sortedRepos.size());
// If there is only one repository left, use it.
if (sortedRepos.size() == 1) {
repos.add(sortedRepos.first().getKey());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Added " + sortedRepos.first().getKey());
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "repos = " + repos);
return repos;
}
// Get the available space of the repository with the least amount of
// available space.
minAvail = sortedRepos.first().getValue().getAvail();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "minAvail = " + minAvail);
}
// Count the remaining repositories.
int repoCount = sortedRepos.size();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "repoCount = " + repoCount);
// Initialize the array of repositories and the total available space.
long totalAvailable = 0l;
int i = 0;
Entry[] repoArray = new Entry[repoCount];
for (Entry df : sortedRepos) {
totalAvailable += df.getValue().getAvail();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "totalAvailable = " + totalAvailable);
repoArray[i++] = df;
}
// For each repository, compute the target fraction and initialize the count
// of appearances in the final list.
i = 0;
double[] repoTargetFraction = new double[repoCount];
int[] repoAppearances = new int[repoCount];
for (Entry df : repoArray) {
repoTargetFraction[i] =
df.getValue().getAvail() / (double)totalAvailable;
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "i = " + i
+ ", repoTargetFraction[i] = " + repoTargetFraction[i]);
repoAppearances[i++] = 0;
}
// The first repository in the list is the one with the largest amount of
// available space.
repos.add(repoArray[repoCount - 1].getKey());
repoAppearances[repoCount - 1]++;
// An indication of whether the created list matches the target fractions of
// all the repositories.
boolean done = false;
while (!done) {
// If no differences between the target fractions and the fractions of
// appearances are found in the process below, the list is complete.
done = true;
double difference = 0;
double maxDifference = 0;
int nextRepo = -1;
// Loop through all the repositories.
for (int j = 0; j < repoCount; j++) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "j = " + j
+ ", repoAppearances[j]/(double)repos.size() = "
+ repoAppearances[j]/(double)repos.size()
+ ", repoTargetFraction[j] = " + repoTargetFraction[j]);
// Find the difference between the target fraction and the fraction of
// appearances.
difference =
repoTargetFraction[j] - repoAppearances[j]/(double)repos.size();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "difference = " + difference);
// Update the largest difference, if necessary.
if (maxDifference < difference) {
maxDifference = difference;
nextRepo = j;
}
}
// Check whether a repository with the largest difference was found.
if (nextRepo != -1) {
// Yes: Add it to the list.
repos.add(repoArray[nextRepo].getKey());
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "Added " + repoArray[nextRepo].getKey());
// Increment its appearance count.
repoAppearances[nextRepo]++;
// Check whether not all the target fractions have been achieved.
for (int k = 0; k < repoCount; k++) {
difference =
repoAppearances[k]/(double)repos.size() - repoTargetFraction[k];
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "k = " + k
+ ", difference = " + difference);
// Within one per cent is a match.
if (Math.abs(difference) > 0.01) {
done = false;
break;
}
}
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "repos = " + repos);
return repos;
}
// Sorter of repository disk information by available space.
private static Comparator>
DF_BY_AVAIL_COMPARATOR = new Comparator>() {
public int compare(Entry o1,
Entry o2) {
// Sort by available space.
return ((Long.valueOf(o1.getValue().getAvail()))
.compareTo(Long.valueOf(o2.getValue().getAvail())));
}
};
/**
* Writes to a zip file the subscription definitions.
*
* @param zipStream
* A ZipOutputStream to the zip file.
*
* @throws DbException, IOException
*/
public void writeSubscriptionsBackupToZip(ZipOutputStream zipStream)
throws DbException, IOException {
final String DEBUG_HEADER = "writeSubscriptionsBackupToZip(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
// Get the publisher subscriptions.
List publisherSubscriptions =
subManagerSql.findPublisherSubscriptionDataForBackup();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "publisherSubscriptions = "
+ publisherSubscriptions);
// Do nothing if there are no publisher subscriptions.
if (publisherSubscriptions == null || publisherSubscriptions.size() == 0) {
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "No publisher subscriptions to write.");
}
// Create the publisher subscription backup file entry.
zipStream.putNextEntry(new ZipEntry(
PUBLISHER_SUBSCRIPTION_BACKUP_FILENAME));
// Loop through all the subscription definitions to be backed up.
for (PublisherSubscription publisherSubscription : publisherSubscriptions) {
// Write this publisher subscription definition to the zip file.
writePublisherSubscriptionBackupToStream(publisherSubscription,
zipStream);
}
// Close the subscription backup file entry.
zipStream.closeEntry();
// Get the subscriptions.
List subscriptions =
subManagerSql.findSubscriptionDataForBackup();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscriptions = " + subscriptions);
// Do nothing if there are no subscriptions.
if (subscriptions == null || subscriptions.size() == 0) {
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "No subscriptions to write.");
return;
}
// Create the subscription backup file entry.
zipStream.putNextEntry(new ZipEntry(SUBSCRIPTION_BACKUP_FILENAME));
// Loop through all the subscription definitions to be backed up.
for (Subscription subscription : subscriptions) {
// Write this subscription definition to the zip file.
writeSubscriptionBackupToStream(subscription, zipStream);
}
// Close the subscription backup file entry.
zipStream.closeEntry();
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Writes to a stream the definition of a publisher subscription for backup
* purposes.
*
* @param publisherSubscription
* A PublisherSubscription with the publisher subscription
* definition.
* @param outputStream
* An OutputStream where to write the publisher subscription data.
*
* @throws IOException
*/
private void writePublisherSubscriptionBackupToStream(
PublisherSubscription publisherSubscription, OutputStream outputStream)
throws IOException {
final String DEBUG_HEADER = "writePublisherSubscriptionBackupToStream(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "publisherSubscription = "
+ publisherSubscription);
// Ignore empty subscriptions.
if (publisherSubscription == null) {
log.warning("Null publisher subscription not added to backup file.");
return;
}
// Get the publisher subscription publisher name.
String publisherName =
publisherSubscription.getPublisher().getPublisherName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
// Get the publisher subscription setting.
Boolean subscribed = publisherSubscription.getSubscribed();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "subscribed = " + subscribed);
// Ignore publisher subscriptions with no subscription setting.
if (subscribed == null) {
log.warning("Publisher subscription with null subscription setting not "
+ "added to backup file.");
return;
}
// Write the entry to the output stream.
outputStream.write((publisherName + BACKUP_FIELD_SEPARATOR + subscribed
+ "\n").getBytes(Charset.forName("UTF-8")));
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Writes to a stream the definition of a subscription for backup purposes.
*
* @param subscription
* A Subscription with the subscription definition.
* @param outputStream
* An OutputStream where to write the subscription data.
*
* @throws IOException
*/
private void writeSubscriptionBackupToStream(Subscription subscription,
OutputStream outputStream) throws IOException {
final String DEBUG_HEADER = "writeSubscriptionBackupToStream(): ";
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "subscription = " + subscription);
// Ignore empty subscriptions.
if (subscription == null) {
log.warning("Null subscription not added to backup file.");
return;
}
// Get the subscription publication.
SerialPublication publication = subscription.getPublication();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publication = " + publication);
// Ignore subscriptions with no publication.
if (publication == null) {
log.warning("Subscription with null publication not added to backup " +
"file.");
return;
}
// Write the publication data.
StringBuilder entry = new StringBuilder(StringUtil
.blankOutNlsAndTabs(publication.getPublicationName()));
entry.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(publication.getProviderLid()))
.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(publication.getProviderName()))
.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(publication.getPublisherName()))
.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(publication.getPissn()))
.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(publication.getEissn()))
.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(StringUtil
.separatedString(publication.getProprietaryIds())));
// Loop through all the subscribed ranges.
for (BibliographicPeriod range : subscription.getSubscribedRanges()) {
// Write the subscribed range.
entry.append(BACKUP_FIELD_SEPARATOR).append("true")
.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(range.toDisplayableString()));
}
// Loop through all the unsubscribed ranges.
for (BibliographicPeriod range : subscription.getUnsubscribedRanges()) {
// Write the unsubscribed range.
entry.append(BACKUP_FIELD_SEPARATOR).append("false")
.append(BACKUP_FIELD_SEPARATOR)
.append(StringUtil.blankOutNlsAndTabs(range.toDisplayableString()));
}
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "entry = " + entry);
// Write the entry to the output stream.
outputStream.write((entry.toString() + "\n")
.getBytes(Charset.forName("UTF-8")));
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Loads into the system the subscriptions defined in a backup file.
*
* @param backupDir
* A File with the directory where the backup files are stored.
*/
public void loadSubscriptionsFromBackup(File backupDir) {
final String DEBUG_HEADER = "loadSubscriptionsFromBackup(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "backupDir = " + backupDir);
boolean totalSubscriptionChanged = false;
Boolean totalSubscriptionSetting = null;
List publisherSubscriptions =
new ArrayList();
List subscriptions = new ArrayList();
// Get the publisher subscriptions backup file.
File backupFile =
new File(backupDir, PUBLISHER_SUBSCRIPTION_BACKUP_FILENAME);
// Check whether the backup file exists.
if (backupFile.exists()) {
// Yes: Get the publisher subscriptions defined in the backup file.
publisherSubscriptions =
getPublisherSubscriptionsFromBackupFile(backupFile);
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "publisherSubscriptions.size() = " + publisherSubscriptions.size());
PublisherSubscription totalSubscription = null;
// Determine the total subscription setting, if specified.
for (PublisherSubscription publisherSubscription
: publisherSubscriptions) {
if (ALL_PUBLISHERS_NAME.equals(
publisherSubscription.getPublisher().getPublisherName())) {
totalSubscription = publisherSubscription;
break;
}
}
// Check whether the total subscription setting was specified.
if (totalSubscription != null) {
// Yes: Remove it from the list of publisher subscriptions.
publisherSubscriptions.remove(totalSubscription);
// Remember the total subscription setting.
totalSubscriptionChanged = true;
totalSubscriptionSetting = totalSubscription.getSubscribed();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "totalSubscriptionSetting = " + totalSubscriptionSetting);
}
} else {
// No.
if (log.isDebug()) log.debug("No subscription backup file named '" +
PUBLISHER_SUBSCRIPTION_BACKUP_FILENAME + "' found in directory '"
+ backupDir + "'.");
}
// Get the publication subscriptions backup file.
backupFile = new File(backupDir, SUBSCRIPTION_BACKUP_FILENAME);
// Check whether the backup file exists.
if (backupFile.exists()) {
// Yes: Get the subscriptions defined in the backup file.
subscriptions = getSubscriptionsFromBackupFile(backupFile);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "subscriptions.size() = "
+ subscriptions.size());
} else {
// No.
if (log.isDebug()) log.debug("No subscription backup file named '" +
SUBSCRIPTION_BACKUP_FILENAME + "' found in directory '" + backupDir
+ "'.");
}
// Add to the system any subscriptions defined in the backup file.
if (totalSubscriptionChanged || publisherSubscriptions.size() > 0
|| subscriptions.size() > 0) {
addSubscriptions(totalSubscriptionChanged, totalSubscriptionSetting,
publisherSubscriptions, subscriptions,
new SubscriptionOperationStatus());
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Provides the publisher subscriptions defined in a backup file.
*
* @param backupFile
* A File with the backup file.
* @return a List with the publisher subscriptions
* defined in the backup file.
*/
private List getPublisherSubscriptionsFromBackupFile(
File backupFile) {
final String DEBUG_HEADER = "getPublisherSubscriptionsFromBackupFile(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "backupFile = " + backupFile);
List publisherSubscriptions =
new ArrayList();
InputStream is = null;
Reader r = null;
BufferedReader br = null;
PublisherSubscription publisherSubscription = null;
try {
String line;
is = new FileInputStream(backupFile);
r = new InputStreamReader(is, "UTF-8");
br = new BufferedReader(r);
// Loop through all the lines in the backup file.
while ((line = br.readLine()) != null) {
// Get the publisher subscription defined in the line, if any.
publisherSubscription =
getPublisherSubscriptionFromBackupFileLine(line);
// Add the defined subscription to the results.
if (publisherSubscription != null) {
publisherSubscriptions.add(publisherSubscription);
}
}
} catch (Exception e) {
log.error("Exception caught processing publisher subscription backup "
+ "file = " + backupFile, e);
} finally {
if (br != null) {
try {
br.close();
} catch(Throwable t) {
if (log.isDebug()) log.debug(DEBUG_HEADER
+ "Cound not close BufferedReader for file = " + backupFile);
}
}
if (r != null) {
try {
r.close();
} catch(Throwable t) {
if (log.isDebug()) log.debug(DEBUG_HEADER
+ "Cound not close Reader for file = " + backupFile);
}
}
if (is != null) {
try {
is.close();
} catch(Throwable t) {
if (log.isDebug()) log.debug(DEBUG_HEADER
+ "Cound not close InputStream for file = " + backupFile);
}
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "publisherSubscriptions = "
+ publisherSubscriptions);
return publisherSubscriptions;
}
/**
* Provides the publisher subscription defined in one line of a backup file.
*
* @param line
* A String with the publisher subscription definition.
* @return a PublisherSubscription with the publisher subscriptions defined in
* the line.
*/
private PublisherSubscription getPublisherSubscriptionFromBackupFileLine(
String line) {
final String DEBUG_HEADER =
"getPublisherSubscriptionFromBackupFileLine(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "line = " + line);
// Ignore empty lines.
if (line == null || line.length() == 0) {
if (log.isDebug()) log.debug("No publisher subscription definition in "
+ "line '" + line + "'.");
return null;
}
// Parse the line.
Collection items = StringUtil.breakAt(line, BACKUP_FIELD_SEPARATOR);
// Ignore lines that do not contain a complete publisher subscription
// definition.
if (items == null || items.size() < 2) {
if (log.isDebug()) log.debug("No publisher subscription definition in "
+ "line '" + line + "'.");
return null;
}
Iterator iterator = items.iterator();
// Get the publisher of the subscription.
Publisher publisher = new Publisher();
publisher.setPublisherName(iterator.next());
// Create the publisher subscription to be returned.
PublisherSubscription publisherSubscription = new PublisherSubscription();
publisherSubscription.setPublisher(publisher);
publisherSubscription.setSubscribed(Boolean.valueOf(iterator.next()));
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "publisherSubscription = "
+ publisherSubscription);
return publisherSubscription;
}
/**
* Provides the subscriptions defined in a backup file.
*
* @param backupFile
* A File with the backup file.
* @return a List with the subscriptions defined in the backup
* file.
*/
private List getSubscriptionsFromBackupFile(File backupFile) {
final String DEBUG_HEADER = "getSubscriptionsFromBackupFile(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "backupFile = " + backupFile);
List subscriptions = new ArrayList();
InputStream is = null;
Reader r = null;
BufferedReader br = null;
Subscription subscription = null;
try {
String line;
is = new FileInputStream(backupFile);
r = new InputStreamReader(is, "UTF-8");
br = new BufferedReader(r);
// Loop through all the lines in the backup file.
while ((line = br.readLine()) != null) {
// Get the subscription defined in the line, if any.
subscription = getSubscriptionFromBackupFileLine(line);
// Add the defined subscription to the results.
if (subscription != null) {
subscriptions.add(subscription);
}
}
} catch (Exception e) {
log.error("Exception caught processing subscription backup file = "
+ backupFile, e);
} finally {
if (br != null) {
try {
br.close();
} catch(Throwable t) {
if (log.isDebug()) log.debug(DEBUG_HEADER
+ "Cound not close BufferedReader for file = " + backupFile);
}
}
if (r != null) {
try {
r.close();
} catch(Throwable t) {
if (log.isDebug()) log.debug(DEBUG_HEADER
+ "Cound not close Reader for file = " + backupFile);
}
}
if (is != null) {
try {
is.close();
} catch(Throwable t) {
if (log.isDebug()) log.debug(DEBUG_HEADER
+ "Cound not close InputStream for file = " + backupFile);
}
}
}
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "subscriptions = " + subscriptions);
return subscriptions;
}
/**
* Provides the subscription defined in one line of a backup file.
*
* @param line
* A String with the subscription definition.
* @return a Subscription with the subscriptions defined in the line.
*/
private Subscription getSubscriptionFromBackupFileLine(String line) {
final String DEBUG_HEADER = "getSubscriptionFromBackupFileLine(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "line = " + line);
// Ignore empty lines.
if (line == null || line.length() == 0) {
if (log.isDebug())
log.debug("No subscription definition in line '" + line + "'.");
return null;
}
// Parse the line.
Collection items = StringUtil.breakAt(line, BACKUP_FIELD_SEPARATOR);
// Ignore lines that do not contain a complete subscription definition.
if (items == null || items.size() < 8) {
if (log.isDebug())
log.debug("No subscription definition in line '" + line + "'.");
return null;
}
Iterator iterator = items.iterator();
// Get the publication of the subscription.
SerialPublication publication = new SerialPublication();
publication.setPublicationName(iterator.next());
publication.setProviderLid(iterator.next());
publication.setProviderName(iterator.next());
publication.setPublisherName(iterator.next());
String pIssn = iterator.next();
if (!pIssn.isEmpty()) {
publication.setPissn(pIssn);
}
String eIssn = iterator.next();
if (!eIssn.isEmpty()) {
publication.setEissn(eIssn);
}
Set proprietaryIds =
new LinkedHashSet(StringUtil.breakAt(iterator.next(), ",",
true));
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "proprietaryIds = " + proprietaryIds);
if (proprietaryIds.size() > 0) {
publication.setProprietaryIds(proprietaryIds);
}
// Get the subscription ranges.
List subscribedRanges =
new ArrayList();
List unSubscribedRanges =
new ArrayList();
while (iterator.hasNext()) {
if ("true".equals(iterator.next())) {
subscribedRanges.add(new BibliographicPeriod(iterator.next()));
} else {
unSubscribedRanges.add(new BibliographicPeriod(iterator.next()));
}
}
// Create the subscription to be returned.
Subscription subscription = new Subscription();
subscription.setPublication(publication);
subscription.setSubscribedRanges(subscribedRanges);
subscription.setUnsubscribedRanges(unSubscribedRanges);
if (log.isDebug2())
log.debug2(DEBUG_HEADER + "subscription = " + subscription);
return subscription;
}
/**
* Unsubscribes an archival unit.
*
* @param conn
* A Connection with the database connection to be used.
* @param au
* An ArchivalUnit with the archival unit to be unsubscribed.
* @throws DbException
* if any problem occurred accessing the database.
*/
void unsubscribeAu(Connection conn, ArchivalUnit au) throws DbException {
final String DEBUG_HEADER = "unsubscribeAu(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "au = " + au);
// Get the archival unit title.
TdbAu tdbAu = au.getTdbAu();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "tdbAu = " + tdbAu);
if (tdbAu == null) {
return;
}
TdbTitle title = tdbAu.getTdbTitle();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "title = " + title);
if (title == null) {
return;
}
// Get the provider identifiers and the subscription identifiers and ranges
// for the archival unit title.
List subscribedRanges =
new ArrayList();
List unsubscribedRanges =
new ArrayList();
Set subscriptionSeqs = populateTitleSubscriptionRanges(conn, title,
subscribedRanges, unsubscribedRanges);
if (log.isDebug3()) {
log.debug3(DEBUG_HEADER + "subscriptionSeqs = " + subscriptionSeqs);
log.debug3(DEBUG_HEADER + "subscribedRanges = " + subscribedRanges);
log.debug3(DEBUG_HEADER + "unsubscribedRanges = " + unsubscribedRanges);
}
// Nothing to do if the publication is not covered by any subscription at
// all.
if (subscriptionSeqs == null || subscriptionSeqs.size() == 0
|| subscribedRanges == null || subscribedRanges.size() == 0) {
return;
}
// Determine whether the archival unit is currently covered by a subscribed
// range.
List tdbAus = new ArrayList(1);
tdbAus.add(tdbAu);
boolean isSubscribed = false;
// Loop through all the subscribed ranges.
for (BibliographicPeriod range : subscribedRanges) {
if (getRangeCoveredTdbAus(range, tdbAus).size() > 0) {
isSubscribed = true;
break;
}
}
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "isSubscribed = " + isSubscribed);
// Nothing to do if the archival unit is not currently covered by a
// subscribed range.
if (!isSubscribed) {
return;
}
// Determine whether the archival unit is currently covered by an
// unsubscribed range, even though it is also covered by a subscribed range.
boolean isUnsubscribed = false;
// Check whether there are unsubscribed ranges.
if (unsubscribedRanges != null && unsubscribedRanges.size() > 0) {
// Yes: Loop through all the unsubscribed ranges.
for (BibliographicPeriod range : unsubscribedRanges) {
if (getRangeCoveredTdbAus(range, tdbAus).size() > 0) {
isUnsubscribed = true;
break;
}
}
}
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "isUnsubscribed = " + isUnsubscribed);
// Nothing to do if the archival unit is currently covered by an
// unsubscribed range.
if (isUnsubscribed) {
return;
}
// Get the archival unit publication ranges.
List ranges = tdbAu.getPublicationRanges();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "ranges = " + ranges);
// Loop through all the archival unit publication ranges to be unsubscribed.
for (BibliographicPeriod range : ranges) {
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "range = " + range);
// Loop through all the publication subscriptions in the database.
for (Long subscriptionSeq : subscriptionSeqs) {
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "subscriptionSeq = " + subscriptionSeq);
// Find the existing subscribed ranges for the subscription.
List existingRanges =
subManagerSql.findSubscriptionRanges(conn, subscriptionSeq, true);
// Check whether the range to be unsubscribed is subscribed.
if (existingRanges.contains(range)) {
// Yes: Switch the range from subscribed to unsubscribed.
int count = subManagerSql.updateSubscriptionRangeType(conn,
subscriptionSeq, range, false);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "count = " + count);
if (count > 0) continue;
}
// Find the existing unsubscribed ranges for the subscription.
existingRanges =
subManagerSql.findSubscriptionRanges(conn, subscriptionSeq, false);
// Check whether the range to be persisted does not exist already.
if (!existingRanges.contains(range)) {
// Yes: Persist the unsubscribed range.
int count = subManagerSql.persistSubscriptionRange(conn,
subscriptionSeq, range, false);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "count = " + count);
}
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Provides the SQL code executor.
*
* @return a SubscriptionManagerSql with the SQL code executor.
*/
SubscriptionManagerSql getSubscriptionManagerSql() {
return subManagerSql;
}
/**
* Provides an indication of whether the Total Subscription feature is
* enabled.
*
* @return a boolean with true if the Total Subscription feature
* is enabled, false otherwise.
*/
public boolean isTotalSubscriptionEnabled() {
return isTotalSubscriptionEnabled;
}
/**
* Provides the current setting of the Total Subscription feature in the
* database.
*
* @param conn
* A Connection with the database connection to be used.
* @return a Boolean with the current setting of the Total Subscription
* feature in the database.
* @throws DbException
* if any problem occurred accessing the database.
*/
Boolean findTotalSubscription(Connection conn) throws DbException {
final String DEBUG_HEADER = "findTotalSubscription(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
String errorMessage = "Cannot get the identifier of the publisher used for "
+ "the Total Subscription feature";
Long publisherSeq =
mdManager.findOrCreatePublisher(conn, ALL_PUBLISHERS_NAME);
MetadataDbManager.commitOrRollback(conn, log);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherSeq = " + publisherSeq);
if (publisherSeq == null) {
throw new DbException(errorMessage);
}
Boolean result =
subManagerSql.findPublisherSubscription(conn, publisherSeq);
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "result = " + result);
return result;
}
/**
* Provides the current setting of the Total Subscription feature cached in
* this object.
*
* @return a Boolean with the current setting of the Total Subscription
* feature cached in this object.
*/
public Boolean isTotalSubscription() {
return isTotalSubscription;
}
/**
* Updates in the database the setting of the Total Subscription feature.
*
* @param totalSubscriptionSetting
* A Boolean with the setting of the Total Subscription feature to be
* updated in the database.
* @param status
* A SubscriptionOperationStatus with the status of the operation.
*/
private void updateTotalSubscription(Boolean totalSubscriptionSetting,
SubscriptionOperationStatus status) {
final String DEBUG_HEADER = "updateTotalSubscription(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "totalSubscriptionSetting = "
+ totalSubscriptionSetting);
Connection conn = null;
try {
// Get a connection to the database.
conn = dbManager.getConnection();
// Update the database.
updateTotalSubscription(conn, totalSubscriptionSetting, status);
} catch (DbException dbe) {
log.error(CANNOT_CONNECT_TO_DB_ERROR_MESSAGE, dbe);
status.createTotalSubscriptionStatusEntry(false, dbe.getMessage(),
totalSubscriptionSetting);
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
}
/**
* Updates in the database the setting of the Total Subscription feature.
*
* @param conn
* A Connection with the database connection to be used.
* @param totalSubscriptionSetting
* A Boolean with the setting of the Total Subscription feature to be
* updated in the database.
* @param status
* A SubscriptionOperationStatus with the status of the operation.
*/
private void updateTotalSubscription(Connection conn,
Boolean totalSubscriptionSetting, SubscriptionOperationStatus status) {
final String DEBUG_HEADER = "updateTotalSubscription(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "totalSubscriptionSetting = "
+ totalSubscriptionSetting);
try {
// Update the database.
Long publisherSeq = mdManager.findPublisher(conn, ALL_PUBLISHERS_NAME);
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherSeq = " + publisherSeq);
if (publisherSeq == null) {
String errorMessage = "Cannot get the identifier of the publisher used "
+ "for the Total Subscription feature";
log.error(errorMessage);
status.createTotalSubscriptionStatusEntry(false, errorMessage,
totalSubscriptionSetting);
return;
}
if (totalSubscriptionSetting == null) {
subManagerSql.deletePublisherSubscription(conn, publisherSeq);
} else {
subManagerSql.updateOrCreatePublisherSubscription(conn, publisherSeq,
totalSubscriptionSetting.booleanValue());
}
MetadataDbManager.commitOrRollback(conn, log);
// Update the local cached value.
isTotalSubscription = totalSubscriptionSetting;
status.createTotalSubscriptionStatusEntry(true, null,
totalSubscriptionSetting);
} catch (DbException dbe) {
log.error(CANNOT_UPDATE_TOTAL_SUBSCRIPTION_ERROR_MESSAGE, dbe);
status.createTotalSubscriptionStatusEntry(false, dbe.getMessage(),
totalSubscriptionSetting);
}
}
/**
* Provides iterators to the publications that are subscribable.
*
* @return A List> with the iterators to the publications that
* are subscribable.
*/
public List> getSubscribableTdbAuIterators() {
final String DEBUG_HEADER = "getSubscribableTdbAuIterators(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
List> subscribableTdbAuIterators =
new ArrayList>();
// Loop through all the publishers.
for (TdbPublisher publisher :
TdbUtil.getTdb().getAllTdbPublishers().values()) {
String publisherName = publisher.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
// Loop through all the titles (subscribed or not) of the publisher.
for (TdbTitle title : publisher.getTdbTitles()) {
// Skip any titles that are not subscribable.
if (!isSubscribable(title)) {
continue;
}
String titleName = title.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "titleName = " + titleName);
// Loop through all the title providers.
for (TdbProvider provider : title.getTdbProviders()) {
String providerName = provider.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerName = " + providerName);
// TODO: Replace with provider.getLid() when available.
String providerLid = null;
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerLid = " + providerLid);
subscribableTdbAuIterators.add(provider.tdbAuIterator());
}
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER
+ "subscribableTdbAuIterators.size() = "
+ subscribableTdbAuIterators.size());
return subscribableTdbAuIterators;
}
/**
* Handles the turning on of the Total Subscription feature.
*
* @param status
* A SubscriptionOperationStatus where to return the status of the
* operation.
*/
public void handleStartingTotalSubscription(SubscriptionOperationStatus
status) {
final String DEBUG_HEADER = "handleStartingTotalSubscription(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Starting...");
if (!isTotalSubscriptionEnabled) {
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
Connection conn = null;
try {
// Get a connection to the database.
conn = dbManager.getConnection();
} catch (DbException dbe) {
log.error(CANNOT_CONNECT_TO_DB_ERROR_MESSAGE, dbe);
status.createTotalSubscriptionStatusEntry(false, dbe.getMessage(), null);
if (log.isDebug2()) log.debug(DEBUG_HEADER + "Done.");
return;
}
try {
updateTotalSubscription(conn, true, status);
} finally {
MetadataDbManager.safeRollbackAndClose(conn);
}
for (Iterator tdbAuIterator : getSubscribableTdbAuIterators()) {
// Check whether this should be done in a new thread.
if (mustConfigureStarter == null || mustConfigureStarterThread == null
|| !mustConfigureStarterThread.isAlive()) {
// Yes: Create it and start it.
mustConfigureStarter = new SubscriptionStarter(this,
configureAuBatchSize, configureAuRateLimiter, tdbAuIterator, true);
mustConfigureStarterThread = new Thread(mustConfigureStarter);
mustConfigureStarterThread.start();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Created new 'must configure' SubscriptionStarter.");
} else {
// No: Reuse the existing thread.
boolean added = mustConfigureStarter.addTdbAuIterator(tdbAuIterator);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "added = " + added);
// Check whether the new workload was successfully added.
if (added) {
// Yes.
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Reused existing 'must configure' SubscriptionStarter.");
} else {
// No: Create a new thread and start it.
mustConfigureStarter = new SubscriptionStarter(this,
configureAuBatchSize, configureAuRateLimiter, tdbAuIterator,
true);
mustConfigureStarterThread = new Thread(mustConfigureStarter);
mustConfigureStarterThread.start();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Created new 'must configure' SubscriptionStarter.");
}
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Provides all the subscribed publishers.
*
* @return a Map with the subscribed publishers
* keyed by the publisher name.
* @throws DbException
* if any problem occurred accessing the database.
*/
public Map findAllSubscribedPublishers()
throws DbException {
return subManagerSql.findAllSubscribedPublishers();
}
/**
* Handles the turning on of the Total Subscription feature.
*
* @param status
* A SubscriptionOperationStatus where to return the status of the
* operation.
*/
public void handleStartingPublisherSubscription(
PublisherSubscription publisherSubscription) {
final String DEBUG_HEADER = "handleStartingPublisherSubscription(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "publisherSubscription = "
+ publisherSubscription);
String publisherName =
publisherSubscription.getPublisher().getPublisherName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
Boolean subscribed = publisherSubscription.getSubscribed();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "subscribed = " + subscribed);
List> subscribableTdbAus = null;
TdbPublisher tdbPublisher = TdbUtil.getTdb().getTdbPublisher(publisherName);
subscribableTdbAus = getSubscribableTdbAuIterators(tdbPublisher);
for (Iterator tdbAuIterator : subscribableTdbAus) {
// Check whether this should be done in a new thread.
if (mustConfigureStarter == null || mustConfigureStarterThread == null
|| !mustConfigureStarterThread.isAlive()) {
// Yes: Create it and start it.
mustConfigureStarter = new SubscriptionStarter(this,
configureAuBatchSize, configureAuRateLimiter, tdbAuIterator, true);
mustConfigureStarterThread = new Thread(mustConfigureStarter);
mustConfigureStarterThread.start();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Created new 'must configure' SubscriptionStarter.");
} else {
// No: Reuse the existing thread.
boolean added = mustConfigureStarter.addTdbAuIterator(tdbAuIterator);
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "added = " + added);
// Check whether the new workload was successfully added.
if (added) {
// Yes.
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Reused existing 'must configure' SubscriptionStarter.");
} else {
// No: Create a new thread and start it.
mustConfigureStarter = new SubscriptionStarter(this,
configureAuBatchSize, configureAuRateLimiter, tdbAuIterator,
true);
mustConfigureStarterThread = new Thread(mustConfigureStarter);
mustConfigureStarterThread.start();
if (log.isDebug3()) log.debug3(DEBUG_HEADER
+ "Created new 'must configure' SubscriptionStarter.");
}
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "Done.");
}
/**
* Provides iterators to the publications that are subscribable.
*
* @return A List> with the iterators to the publications that
* are subscribable.
*/
public List> getSubscribableTdbAuIterators(
TdbPublisher publisher) {
final String DEBUG_HEADER = "getSubscribableTdbAuIterators(): ";
if (log.isDebug2()) log.debug2(DEBUG_HEADER + "publisher = " + publisher);
List> subscribableTdbAuIterators =
new ArrayList>();
String publisherName = publisher.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "publisherName = " + publisherName);
// Loop through all the titles (subscribed or not) of the publisher.
for (TdbTitle title : publisher.getTdbTitles()) {
// Skip any titles that are not subscribable.
if (!isSubscribable(title)) {
continue;
}
String titleName = title.getName();
if (log.isDebug3()) log.debug3(DEBUG_HEADER + "titleName = " + titleName);
// Loop through all the title providers.
for (TdbProvider provider : title.getTdbProviders()) {
String providerName = provider.getName();
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerName = " + providerName);
// TODO: Replace with provider.getLid() when available.
String providerLid = null;
if (log.isDebug3())
log.debug3(DEBUG_HEADER + "providerLid = " + providerLid);
subscribableTdbAuIterators.add(provider.tdbAuIterator());
}
}
if (log.isDebug2()) log.debug2(DEBUG_HEADER
+ "subscribableTdbAuIterators.size() = "
+ subscribableTdbAuIterators.size());
return subscribableTdbAuIterators;
}
/**
* Provides the setting of a publisher subscription.
*
* @param conn
* A Connection with the database connection to be used.
* @param publisherName
* A String with the name of the publisher.
* @return a Boolean with the setting of the publisher subscription.
* @throws DbException
* if any problem occurred accessing the database.
*/
public Boolean findPublisherSubscription(Connection conn,
String publisherName) throws DbException {
return subManagerSql.findPublisherSubscription(conn, publisherName);
}
}