org.lockss.laaws.config.impl.AuWsSource Maven / Gradle / Ivy
The newest version!
/*
Copyright (c) 2014-2020 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.lockss.laaws.config.impl;
import java.util.*;
import org.lockss.app.LockssDaemon;
import org.lockss.config.CurrentConfig;
import org.lockss.crawler.CrawlManagerStatus;
import org.lockss.daemon.ConfigParamDescr;
import org.lockss.daemon.CrawlWindow;
import org.lockss.daemon.RangeCachedUrlSetSpec;
import org.lockss.daemon.TitleConfig;
import org.lockss.extractor.MetadataTarget;
import org.lockss.plugin.ArchivalUnit;
import org.lockss.plugin.ArticleFiles;
import org.lockss.plugin.AuUtil;
import org.lockss.plugin.CachedUrl;
import org.lockss.plugin.CachedUrlSet;
import org.lockss.plugin.CachedUrlSetNode;
import org.lockss.plugin.CuIterator;
import org.lockss.plugin.Plugin;
import org.lockss.poller.Poll;
import org.lockss.poller.ReputationTransfers;
import org.lockss.protocol.AgreementType;
import org.lockss.protocol.IdentityManager;
import org.lockss.protocol.PeerAgreement;
import org.lockss.protocol.PeerIdentity;
import org.lockss.state.*;
import org.lockss.util.Logger;
import org.lockss.util.StringUtil;
import org.lockss.util.TypedEntryMap;
import org.lockss.util.UrlUtil;
import org.lockss.util.PatternFloatMap;
import org.lockss.ws.entities.AgreementTypeWsResult;
import org.lockss.ws.entities.AuConfigurationWsResult;
import org.lockss.ws.entities.AuWsResult;
import org.lockss.ws.entities.PeerAgreementWsResult;
import org.lockss.ws.entities.PeerAgreementsWsResult;
import org.lockss.ws.entities.UrlWsResult;
/**
* Container for the information that is used as the source for a query related
* to Archival Units.
*/
public class AuWsSource extends AuWsResult {
private static Logger log = Logger.getLogger();
private ArchivalUnit au;
private boolean auIdPopulated = false;
private boolean namePopulated = false;
private boolean volumePopulated = false;
private boolean pluginNamePopulated = false;
private boolean tdbYearPopulated = false;
private boolean accessTypePopulated = false;
private boolean contentSizePopulated = false;
private boolean diskUsagePopulated = false;
private boolean repositoryPathPopulated = false;
private boolean recentPollAgreementPopulated = false;
private boolean highestPollAgreementPopulated = false;
private boolean publishingPlatformPopulated = false;
private boolean tdbPublisherPopulated = false;
private boolean availableFromPublisherPopulated = false;
private boolean substanceStatePopulated = false;
private boolean creationTimePopulated = false;
private boolean crawlProxyPopulated = false;
private boolean crawlWindowPopulated = false;
private boolean crawlPoolPopulated = false;
private boolean lastCompletedCrawlPopulated = false;
private boolean lastCrawlPopulated = false;
private boolean lastCrawlResultPopulated = false;
private boolean lastDeepCrawlPopulated = false;
private boolean lastCompletedDeepCrawlPopulated = false;
private boolean lastDeepCrawlResultPopulated = false;
private boolean lastCompletedDeepCrawlDepthPopulated = false;
private boolean lastMetadataIndexPopulated = false;
private boolean lastCompletedPollPopulated = false;
private boolean lastPollPopulated = false;
private boolean lastPollResultPopulated = false;
private boolean currentlyCrawlingPopulated = false;
private boolean currentlyPollingPopulated = false;
private boolean subscriptionStatusPopulated = false;
private boolean auConfigurationPopulated = false;
private boolean newContentCrawlUrlsPopulated = false;
private boolean urlStemsPopulated = false;
private boolean isBulkContentPopulated = false;
private boolean peerAgreementsPopulated = false;
private boolean urlsPopulated = false;
private boolean accessUrlsPopulated = false;
private boolean substanceUrlsPopulated = false;
private boolean articleUrlsPopulated = false;
private boolean journalTitlePopulated;
private boolean tdbProviderPopulated = false;
private LockssDaemon theDaemon = null;
private Plugin plugin = null;
private StateManager stateMgr = null;
private AuState state = null;
private CachedUrlSet auCachedUrlSet = null;
private PatternFloatMap resultWeightMap = null;
private boolean includePollWeight = false;
/**
* Constructor.
*
* @param au An ArchivalUnit with the archival unit information.
*/
public AuWsSource(ArchivalUnit au) {
this.au = au;
}
@Override
public String getAuId() {
if (!auIdPopulated) {
setAuId(au.getAuId());
auIdPopulated = true;
}
return super.getAuId();
}
@Override
public String getName() {
if (!namePopulated) {
setName(au.getName());
namePopulated = true;
}
return super.getName();
}
@Override
public String getVolume() {
if (!volumePopulated) {
setVolume(au.getName());
volumePopulated = true;
}
return super.getVolume();
}
@Override
public String getPluginName() {
if (!pluginNamePopulated) {
setPluginName(getPlugin().getPluginId());
pluginNamePopulated = true;
}
return super.getPluginName();
}
@Override
public String getTdbYear() {
if (!tdbYearPopulated) {
setTdbYear(AuUtil.getTitleAttribute(au, "year"));
tdbYearPopulated = true;
}
return super.getTdbYear();
}
@Override
public String getAccessType() {
if (!accessTypePopulated) {
AuState.AccessType atype = getState().getAccessType();
if (atype != null) {
setAccessType(atype.toString());
}
accessTypePopulated = true;
}
return super.getAccessType();
}
@Override
public Long getContentSize() {
if (!contentSizePopulated) {
long auContentSize = AuUtil.getAuContentSize(au, true);
if (auContentSize != -1) {
setContentSize(Long.valueOf(auContentSize));
}
contentSizePopulated = true;
}
return super.getContentSize();
}
@Override
public Long getDiskUsage() {
if (!diskUsagePopulated) {
long auDiskUsage = AuUtil.getAuDiskUsage(au, true);
if (auDiskUsage != -1) {
setDiskUsage(Long.valueOf(auDiskUsage));
}
diskUsagePopulated = true;
}
return super.getDiskUsage();
}
@Override
public String getRepositoryPath() {
if (!repositoryPathPopulated) {
setRepositoryPath("XXXREPO");
repositoryPathPopulated = true;
}
return super.getRepositoryPath();
}
@Override
public Double getRecentPollAgreement() {
if (!recentPollAgreementPopulated) {
if (AuUtil.getProtocolVersion(au) == Poll.V3_PROTOCOL
&& getState().getV3Agreement() >= 0) {
setRecentPollAgreement(Double.valueOf(state.getV3Agreement()));
}
recentPollAgreementPopulated = true;
}
return super.getRecentPollAgreement();
}
@Override
public Double getHighestPollAgreement() {
if (!highestPollAgreementPopulated) {
if (AuUtil.getProtocolVersion(au) == Poll.V3_PROTOCOL
&& getState().getHighestV3Agreement() >= 0) {
setHighestPollAgreement(Double.valueOf(state.getHighestV3Agreement()));
}
highestPollAgreementPopulated = true;
}
return super.getHighestPollAgreement();
}
@Override
public String getPublishingPlatform() {
if (!publishingPlatformPopulated) {
String platform = getPlugin().getPublishingPlatform();
if (!StringUtil.isNullString(platform)) {
setPublishingPlatform(platform);
}
publishingPlatformPopulated = true;
}
return super.getPublishingPlatform();
}
@Override
public String getTdbPublisher() {
if (!tdbPublisherPopulated) {
String publisherName = AuUtil.getTitleAttribute(au, "publisher");
if (!StringUtil.isNullString(publisherName)) {
setTdbPublisher(publisherName);
}
tdbPublisherPopulated = true;
}
return super.getTdbPublisher();
}
@Override
public Boolean getAvailableFromPublisher() {
if (!availableFromPublisherPopulated) {
setAvailableFromPublisher(Boolean.valueOf(!AuUtil.isPubDown(au)));
availableFromPublisherPopulated = true;
}
return super.getAvailableFromPublisher();
}
@Override
public String getSubstanceState() {
if (!substanceStatePopulated) {
setSubstanceState(getState().getSubstanceState().toString());
substanceStatePopulated = true;
}
return super.getSubstanceState();
}
@Override
public Long getCreationTime() {
if (!creationTimePopulated) {
setCreationTime(Long.valueOf(getState().getAuCreationTime()));
creationTimePopulated = true;
}
return super.getCreationTime();
}
@Override
public String getCrawlProxy() {
if (!crawlProxyPopulated) {
AuUtil.AuProxyInfo aupinfo = AuUtil.getAuProxyInfo(au);
if (aupinfo.isInvalidAuOverride()) {
setCrawlProxy("Invalid AU proxy spec: " + aupinfo.getAuSpec());
} else if (aupinfo.isAuOverride()) {
setCrawlProxy((aupinfo.getHost() == null ? "Direct connection"
: aupinfo.getHost() + ":" + aupinfo.getPort()));
}
crawlProxyPopulated = true;
}
return super.getCrawlProxy();
}
@Override
public String getCrawlWindow() {
if (!crawlWindowPopulated) {
CrawlWindow window = au.getCrawlWindow();
if (window != null) {
String wmsg = window.toString();
if (wmsg.length() > 140) {
wmsg = "(not displayable)";
}
if (!window.canCrawl()) {
wmsg = "Currently closed: " + wmsg;
}
setCrawlWindow(wmsg);
}
crawlWindowPopulated = true;
}
return super.getCrawlWindow();
}
@Override
public String getCrawlPool() {
if (!crawlPoolPopulated) {
String frlk = au.getFetchRateLimiterKey();
if (frlk == null) {
setCrawlPool("(none)");
} else {
setCrawlPool(frlk);
}
crawlPoolPopulated = true;
}
return super.getCrawlPool();
}
@Override
public Long getLastCompletedCrawl() {
if (!lastCompletedCrawlPopulated) {
setLastCompletedCrawl(Long.valueOf(getState().getLastCrawlTime()));
lastCompletedCrawlPopulated = true;
}
return super.getLastCompletedCrawl();
}
@Override
public Long getLastCrawl() {
if (!lastCrawlPopulated) {
long lastCrawlAttempt = getState().getLastCrawlAttempt();
if (lastCrawlAttempt > 0) {
setLastCrawl(Long.valueOf(lastCrawlAttempt));
}
lastCrawlPopulated = true;
}
return super.getLastCrawl();
}
@Override
public String getLastCrawlResult() {
if (!lastCrawlResultPopulated) {
long lastCrawlAttempt = getState().getLastCrawlAttempt();
if (lastCrawlAttempt > 0) {
setLastCrawlResult(state.getLastCrawlResultMsg());
}
lastCrawlResultPopulated = true;
}
return super.getLastCrawlResult();
}
@Override
public Long getLastDeepCrawl() {
if (!lastDeepCrawlPopulated) {
long lastDeepCrawl = getState().getLastDeepCrawlAttempt();
if (lastDeepCrawl > 0) {
setLastDeepCrawl(Long.valueOf(lastDeepCrawl));
}
lastDeepCrawlPopulated = true;
}
return super.getLastDeepCrawl();
}
@Override
public Long getLastCompletedDeepCrawl() {
if (!lastCompletedDeepCrawlPopulated) {
long lastCompletedDeepCrawl = getState().getLastDeepCrawlTime();
if (lastCompletedDeepCrawl > 0) {
setLastCompletedDeepCrawl(Long.valueOf(lastCompletedDeepCrawl));
}
lastCompletedDeepCrawlPopulated = true;
}
return super.getLastCompletedDeepCrawl();
}
@Override
public String getLastDeepCrawlResult() {
if (!lastDeepCrawlResultPopulated) {
long lastDeepCrawlAttempt = getState().getLastDeepCrawlAttempt();
if (lastDeepCrawlAttempt > 0) {
setLastDeepCrawlResult(state.getLastDeepCrawlResultMsg());
}
lastDeepCrawlResultPopulated = true;
}
return super.getLastDeepCrawlResult();
}
@Override
public Integer getLastCompletedDeepCrawlDepth() {
if (!lastCompletedDeepCrawlDepthPopulated) {
int lastCompletedDeepCrawlDepth = getState().getLastDeepCrawlDepth();
if (lastCompletedDeepCrawlDepth > 0) {
setLastCompletedDeepCrawlDepth(Integer.valueOf(lastCompletedDeepCrawlDepth));
}
lastCompletedDeepCrawlDepthPopulated = true;
}
return super.getLastCompletedDeepCrawlDepth();
}
@Override
public Long getLastMetadataIndex() {
if (!lastMetadataIndexPopulated) {
long lastMetadataIndex = getState().getLastMetadataIndex();
if (lastMetadataIndex > 0) {
setLastMetadataIndex(Long.valueOf(lastMetadataIndex));
}
lastMetadataIndexPopulated = true;
}
return super.getLastMetadataIndex();
}
@Override
public Long getLastCompletedPoll() {
if (!lastCompletedPollPopulated) {
long lastTopLevelPollTime = getState().getLastTopLevelPollTime();
if (lastTopLevelPollTime > 0) {
setLastCompletedPoll(Long.valueOf(lastTopLevelPollTime));
}
lastCompletedPollPopulated = true;
}
return super.getLastCompletedPoll();
}
@Override
public Long getLastPoll() {
if (!lastPollPopulated) {
long lastPollStart = getState().getLastPollStart();
if (lastPollStart > 0) {
setLastPoll(Long.valueOf(lastPollStart));
}
lastPollPopulated = true;
}
return super.getLastPoll();
}
@Override
public String getLastPollResult() {
if (!lastPollResultPopulated) {
long lastPollStart = getState().getLastPollStart();
if (lastPollStart > 0) {
String pollResult = state.getLastPollResultMsg();
if (!StringUtil.isNullString(pollResult)) {
setLastPollResult(state.getLastPollResultMsg());
}
}
lastPollResultPopulated = true;
}
return super.getLastPollResult();
}
@Override
public Boolean getCurrentlyCrawling() {
if (!currentlyCrawlingPopulated) {
CrawlManagerStatus cms =
getTheDaemon().getCrawlManager().getStatusSource().getStatus();
if (cms != null) {
setCurrentlyCrawling(Boolean.valueOf(cms.isRunningNCCrawl(au)));
}
currentlyCrawlingPopulated = true;
}
return super.getCurrentlyCrawling();
}
@Override
public Boolean getCurrentlyPolling() {
if (!currentlyPollingPopulated) {
// TBD: Implement when there is a way to get the information.
// setCurrentlyPolling(Boolean.valueOf(getTheDaemon().getPollManager()
// .isPollRunning(au)));
currentlyPollingPopulated = true;
}
return super.getCurrentlyPolling();
}
@Override
public String getSubscriptionStatus() {
if (!subscriptionStatusPopulated) {
if (getTheDaemon().isDetectClockssSubscription()) {
setSubscriptionStatus(AuUtil.getAuState(au)
.getClockssSubscriptionStatusString());
}
subscriptionStatusPopulated = true;
}
return super.getSubscriptionStatus();
}
@Override
public AuConfigurationWsResult getAuConfiguration() {
if (!auConfigurationPopulated) {
// Get the properties of the Archival Unit.
TypedEntryMap auProperties = au.getProperties();
if (auProperties.size() > 0) {
// Initialize the result.
AuConfigurationWsResult result = new AuConfigurationWsResult();
Map defParams = new HashMap();
result.setDefParams(defParams);
Map nonDefParams = new HashMap();
result.setNonDefParams(nonDefParams);
// Loop through all the properties of the Archival Unit.
for (Map.Entry entry : auProperties.entrySet()) {
// Get the key and value of this property.
String key = (String)entry.getKey();
Object val = entry.getValue();
// Find the property type from the Archival Unit configuration.
ConfigParamDescr descr = getPlugin().findAuConfigDescr(key);
// Check whether the property is not in the configuration.
if (descr == null || !au.getConfiguration().containsKey(key)) {
// Yes: Ignore it.
// No: Check whether the property is definitional.
} else if (descr.isDefinitional()) {
// Yes: Place it in the appropriate list.
defParams.put(key, valString(val, descr));
} else {
// No: Place it in the appropriate list.
nonDefParams.put(key, valString(val, descr));
}
}
setAuConfiguration(result);
}
auConfigurationPopulated = true;
}
return super.getAuConfiguration();
}
/** Return an appropriate string representation of the config value */
String valString(Object val, ConfigParamDescr descr) {
if (val == null) {
return null;
} else if (val instanceof org.apache.oro.text.regex.Perl5Pattern) {
return ((org.apache.oro.text.regex.Perl5Pattern)val).getPattern();
} else if (descr == null) {
return val.toString();
} else {
switch (descr.getType()) {
case ConfigParamDescr.TYPE_USER_PASSWD:
if (val instanceof List) {
List l = (List)val;
return l.get(0) + ":******";
}
break;
default:
return val.toString();
}
}
return val.toString();
}
@Override
public List getNewContentCrawlUrls() {
if (!newContentCrawlUrlsPopulated) {
setNewContentCrawlUrls(new ArrayList(au.getStartUrls()));
newContentCrawlUrlsPopulated = true;
}
return super.getNewContentCrawlUrls();
}
@Override
public List getUrlStems() {
if (!urlStemsPopulated) {
setUrlStems((List)au.getUrlStems());
urlStemsPopulated = true;
}
return super.getUrlStems();
}
@Override
public Boolean getIsBulkContent() {
if (!isBulkContentPopulated) {
setIsBulkContent(au.isBulkContent());
isBulkContentPopulated = true;
}
return super.getIsBulkContent();
}
@Override
public List getPeerAgreements() {
if (!peerAgreementsPopulated) {
IdentityManager idManager = getTheDaemon().getIdentityManager();
ReputationTransfers repXfer = null;
if (CurrentConfig.getBooleanParam(ArchivalUnitStatus.PARAM_PEER_ARGEEMENTS_USE_REPUTATION_TRANSFERS,
ArchivalUnitStatus. DEFAULT_PEER_ARGEEMENTS_USE_REPUTATION_TRANSFERS)) {
repXfer = new ReputationTransfers(idManager);
}
// Initialize the the map of agreements by type by peer.
Map>
allAgreementsByPeer =
new HashMap>();
// Loop through all the types of agreements.
for (AgreementType type : AgreementType.values()) {
// Get the agreements for this type.
Map agreementsByPeer =
idManager.getAgreements(au, type);
// Loop through the peers for the agreements.
for (PeerIdentity pid : agreementsByPeer.keySet()) {
// Get the agreement of this type for this peer.
PeerAgreement agreement = agreementsByPeer.get(pid);
// Check whether there has been an agreement at some point in the
// past.
if (agreement != null
&& agreement.getHighestPercentAgreement() >= 0.0) {
if (repXfer != null) {
// If this peer's reputation has been transferred, report
// this agreement for the transferred-to peer
pid = repXfer.getPeerInheritingReputation(pid);
}
// Yes: Create the map of agreements for this peer in the map of
// agreements by type by peer if it does not exist already.
Map typeMap =
allAgreementsByPeer.get(pid.getIdString());
if (typeMap == null) {
typeMap = new HashMap();
allAgreementsByPeer.put(pid.getIdString(), typeMap);
}
// Add this type of agreement to the map of agreements for this peer
// in the map of by type by peer.
// allAgreementsByPeer.get(pid.getIdString()).put(type, agreement);
typeMap.put(type, agreement.mergeWith(typeMap.get(type)));
}
}
}
// Initialize the results.
List results =
new ArrayList();
// Loop through all the peer identifiers.
for (String pidid : allAgreementsByPeer.keySet()) {
// Create the result agreements by type for this peer identifier.
Map resultAgreements =
new HashMap();
// Loop through all the types for this peer identifier.
for (AgreementType type : allAgreementsByPeer.get(pidid).keySet()) {
// Get the corresponding result type.
AgreementTypeWsResult resultType =
AgreementTypeWsResult.values()[type.ordinal()];
// Get the agreement for this type for this peer identifier.
PeerAgreement agreement = allAgreementsByPeer.get(pidid).get(type);
// Get the corresponding result agreement.
PeerAgreementWsResult resultAgreement = new PeerAgreementWsResult(
Float.valueOf(agreement.getPercentAgreement()),
Long.valueOf(agreement.getPercentAgreementTime()),
Float.valueOf(agreement.getHighestPercentAgreement()),
Long.valueOf(agreement.getHighestPercentAgreementTime()));
// Save this type/agreement pair for this peer identifier.
resultAgreements.put(resultType, resultAgreement);
}
// Save the result for this peer identifier.
PeerAgreementsWsResult result = new PeerAgreementsWsResult();
result.setPeerId(pidid);
result.setAgreements(resultAgreements);
results.add(result);
}
setPeerAgreements(results);
peerAgreementsPopulated = true;
}
return super.getPeerAgreements();
}
@Override
public List getUrls() {
if (!urlsPopulated) {
// Initialize the results.
List results = new ArrayList();
try {
resultWeightMap = au.makeUrlPollResultWeightMap();
includePollWeight = true;
} catch (ArchivalUnit.ConfigurationException e) {
log.warning("Error building urlResultWeightMap, disabling",
e);
}
// Loop through all the URL nodes.
for (CachedUrlSetNode cusn : getAuCachedUrlSet().getCuIterable()) {
CachedUrlSet cus;
CachedUrl cu = null;
if (cusn.getType() == CachedUrlSetNode.TYPE_CACHED_URL_SET) {
cus = (CachedUrlSet)cusn;
} else {
cus = au.makeCachedUrlSet(new RangeCachedUrlSetSpec(cusn.getUrl()));
}
// Get the URL.
String url = cus.getUrl();
// XXXREPO didn't change this; don't know why it's needed
if (url.endsWith(UrlUtil.URL_PATH_SEPARATOR)) {
url = url.substring(0, url.length() - 1);
}
try {
// Get the URLproperties.
UrlWsResult urlResult = new UrlWsResult();
urlResult.setUrl(url);
cu = au.makeCachedUrl(url);
urlResult.setVersionCount(cu.getCuVersions().length);
try {
urlResult.setCurrentVersionSize(Long.valueOf(cu.getContentSize()));
} catch (UnsupportedOperationException uoe) {
if (log.isDebug())
log.debug("getUrls(): Ignored content size for no-content URL '"
+ url + "'");
}
if (includePollWeight) {
urlResult.setPollWeight(getUrlResultWeight(url));
}
// Add it to the results.
results.add(urlResult);
} finally {
AuUtil.safeRelease(cu);
}
}
setUrls(results);
urlsPopulated = true;
}
return super.getUrls();
}
protected float getUrlResultWeight(String url) {
if (resultWeightMap == null || resultWeightMap.isEmpty()) {
return 1.0f;
}
return resultWeightMap.getMatch(url, 1.0f);
}
@Override
public Collection getAccessUrls() {
if (!accessUrlsPopulated) {
setAccessUrls(au.getAccessUrls());
accessUrlsPopulated = true;
}
return super.getAccessUrls();
}
@Override
public List getSubstanceUrls() {
if (!substanceUrlsPopulated) {
// Initialize the results.
List results = new ArrayList();
if (AuUtil.hasSubstancePatterns(au)) {
int logException = 3;
CuIterator iterator = getAuCachedUrlSet().getCuIterator();
CachedUrl cu = null;
SubstanceChecker subChecker = new SubstanceChecker(au);
// Loop through all the cached URLs.
while (iterator.hasNext()) {
try {
cu = iterator.next();
// Check whether the cached URL has content.
if (cu.hasContent()) {
// Yes: Get the URL.
String url = cu.getUrl();
// Check whether the URL has substance.
if (subChecker.isSubstanceUrl(url)) {
// Yes: Add it to the results.
results.add(url);
}
}
} catch (Exception e) {
// It shouldn't happen, but, if it does, it will likely happen many
// times, so avoid cluttering the log.
if (logException-- > 0) {
log.warning("getSubstanceUrls() threw for cu " + cu, e);
}
} finally {
AuUtil.safeRelease(cu);
}
}
}
setSubstanceUrls(results);
substanceUrlsPopulated = true;
}
return super.getSubstanceUrls();
}
@Override
public List getArticleUrls() {
if (!articleUrlsPopulated) {
// Initialize the results.
List results = new ArrayList();
int logEmpty = 3;
int logException = 3;
int logMissing = 3;
// Loop through all the article files.
Iterator iter =
au.getArticleIterator(MetadataTarget.Article());
while (iter.hasNext()) {
ArticleFiles af = iter.next();
// Check whether it is empty.
if (af.isEmpty()) {
// Yes: It is probably a plugin error that shouldn't happen; but, if
// it does, it will likely happen many times, so avoid cluttering the
// log.
if (logEmpty-- > 0) {
log.error("ArticleIterator generated empty ArticleFiles");
}
} else {
// No.
CachedUrl cu = null;
try {
// Get the full text cached URL.
cu = af.getFullTextCu();
// Check whether it exists.
if (cu != null) {
// Yes: Add it to the results.
results.add(cu.getUrl());
} else {
// No: It shouldn't happen, but, if it does, it will likely happen
// many times, so avoid cluttering the log.
if (logMissing-- > 0) {
log.error("ArticleIterator generated ArticleFiles with no full "
+ "text CU: " + af);
}
}
} catch (Exception e) {
// It shouldn't happen, but, if it does, it will likely happen many
// times, so avoid cluttering the log.
if (logException-- > 0) {
log.warning("getArticleUrls() threw", e);
}
} finally {
AuUtil.safeRelease(cu);
}
}
}
setArticleUrls(results);
articleUrlsPopulated = true;
}
return super.getArticleUrls();
}
/**
* Provides the Archival Unit journal title.
*
* @return a String with the journal title.
*/
public String getJournalTitle() {
if (!journalTitlePopulated) {
TitleConfig tc = au.getTitleConfig();
if (tc != null) {
setJournalTitle(tc.getJournalTitle());
}
journalTitlePopulated = true;
}
return super.getJournalTitle();
}
@Override
public String getTdbProvider() {
if (!tdbProviderPopulated) {
String providerName = AuUtil.getTitleAttribute(au, "provider");
if (!StringUtil.isNullString(providerName)) {
setTdbProvider(providerName);
}
tdbProviderPopulated = true;
}
return super.getTdbProvider();
}
/**
* Provides the daemon, initializing it if necessary.
*
* @return a LockssDaemon with the daemon.
*/
private LockssDaemon getTheDaemon() {
if (theDaemon == null) {
theDaemon = LockssDaemon.getLockssDaemon();
}
return theDaemon;
}
/**
* Provides the plugin, initializing it if necessary.
*
* @return a Plugin with the plugin.
*/
private Plugin getPlugin() {
if (plugin == null) {
plugin = au.getPlugin();
}
return plugin;
}
/**
* Provides the StateManager, initializing it if necessary.
*
* @return the StateManager
*/
private StateManager getStateManager() {
if (stateMgr == null) {
stateMgr = getTheDaemon().getManagerByType(StateManager.class);
}
return stateMgr;
}
/**
* Provides the Archival Unit state, initializing it if necessary.
*
* @return a AuState with the Archival Unit state.
*/
private AuState getState() {
if (state == null) {
state = getStateManager().getAuState(au);
}
return state;
}
/**
* Provides the Archival Unit cached URL set, initializing it if necessary.
*
* @return a CachedUrlSet with the Archival Unit cached URL set.
*/
private CachedUrlSet getAuCachedUrlSet() {
if (auCachedUrlSet == null) {
auCachedUrlSet = au.getAuCachedUrlSet();
}
return auCachedUrlSet;
}
}