org.lockss.daemon.TitleConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lockss-core Show documentation
Show all versions of lockss-core Show documentation
The Slimmed Down LOCKSS Daemon Core
The newest version!
/*
* $Id$
*/
/*
Copyright (c) 2000-2005 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.daemon;
import java.util.*;
import org.lockss.util.*;
import org.lockss.config.ConfigManager;
import org.lockss.config.Configuration;
import org.lockss.config.TdbAu;
import org.lockss.plugin.*;
/**
* An entry in the title database, specifying a title name, plugin and list
* of {@link ConfigParamAssignment}s.
*/
public class TitleConfig {
static Logger log = Logger.getLogger();
private String displayName;
private String journalTitle;
private String pluginName;
private String pluginVersion = null;
private long estSize = 0;
/**
* TitleConfig params, corresponding to params in the TdbAu
*/
private List params = null;
/**
* TitleConfig properties. These correspond to properties in the TdbAu
*/
private Map props = null;
/**
* TitleConfig attributes, corresponding to properties in the TdbAu
*/
private Map attrs = Collections.emptyMap();
/**
* The TdbAu used to construct the TitleConfig
*/
private TdbAu tdbAu = null;
/**
* Create a TitleConfig associating a title with a plugin.
* @param displayName the title string
* @param plugin the plugin that handles the title.
*/
public TitleConfig(String displayName, Plugin plugin) {
this(displayName, plugin.getPluginId());
}
/**
* Create a TitleConfig associating a title with a plugin name.
* @param displayName the title string
* @param pluginName the name of the plugin that handles the title
*/
public TitleConfig(String displayName, String pluginName) {
this.displayName = displayName;
this.pluginName = pluginName;
}
/**
* Create a TitleConfig associating a TdbAu and plugin.
* @param tdbAu the TdbAu
* @param plugin the plugin
*/
public TitleConfig(TdbAu tdbAu, Plugin plugin) {
this(tdbAu.getName(), tdbAu.getPluginId());
// save the underlying TdbAu
this.tdbAu = tdbAu;
setJournalTitle(tdbAu.getTdbTitle().getName());
long estSize = tdbAu.getEstimatedSize();
if (estSize > 0) {
setEstimatedSize(estSize);
}
String pluginVersion = tdbAu.getPluginVersion();
if (pluginVersion != null) {
setPluginVersion(pluginVersion);
}
// set attributes -- OK to have TdbAu share attributes?
Map attrMap = tdbAu.getAttrs();
if (!attrMap.isEmpty()) {
setAttributes(attrMap);
}
// set properties -- OK to have TdbAu share properties?
Map propMap = tdbAu.getProperties();
if (!propMap.isEmpty()) {
setProperties(propMap);
}
// set params
ArrayList params = new ArrayList();
for (Map.Entry param : tdbAu.getParams().entrySet()) {
String key = param.getKey();
String val = param.getValue();
ConfigParamDescr descr = plugin.findAuConfigDescr(key);
if (descr != null) {
ConfigParamAssignment cpa = new ConfigParamAssignment(descr, val);
params.add(cpa);
} else {
log.warning("Unknown parameter key: " + key + " in title: " + displayName);
log.debug(" au: " + tdbAu.getName());
}
}
// This list is kept permanently, so trim array to size
if (!params.isEmpty()) {
params.trimToSize();
setParams(params);
}
}
/**
* Returns the TdbAu on which this TitleConfig was based
* @return the TdbAu or null if not created from a TdbAu
*/
public TdbAu getTdbAu() {
return tdbAu;
}
/**
* Set the required plugin version
* @param pluginVersion the plugin version
*/
public void setPluginVersion(String pluginVersion) {
this.pluginVersion = pluginVersion;
}
/**
* Set the journal title string. This must be the same across all
* instances (volumes) of the same journal.
* @param journalTitle the journal title
*/
public void setJournalTitle(String journalTitle) {
this.journalTitle = journalTitle;
}
/**
* Set the property list.
* @param props the map of property names and values.
*/
public void setProperties(Map props) {
this.props = props;
}
/**
* Return the property map assignment.
* @return
*/
public MapgetProperties() {
return (props == null) ? Collections.emptyMap() : props;
}
/**
* Set the parameter value list
* @param params List of {@link ConfigParamAssignment}s
*/
public void setParams(List params) {
this.params = params;
}
/**
* @return the parameter assignments
*/
public List getParams() {
return (params == null) ? Collections.emptyList() : params;
}
/**
* Set the attributes
*/
public void setAttributes(Map attrs) {
this.attrs =
(attrs == null) ? Collections.emptyMap() : attrs;
}
/**
* @return the attributes
*/
public Map getAttributes() {
return attrs;
}
/**
* Return the title string
*/
public String getDisplayName() {
return displayName;
}
/**
* Return the journal title string. This must be the same across all
* instances (volumes) of the same journal
*/
public String getJournalTitle() {
return journalTitle;
}
/**
* Return the plugin name
*/
public String getPluginName() {
return pluginName;
}
/**
* Return the minimum plugin version
*/
public String getPluginVersion() {
return pluginVersion;
}
private String auid = null;
public String getAuId(PluginManager pluginMgr) {
if (auid != null) {
return auid;
}
Plugin plugin =
pluginMgr.getPlugin(PluginManager.pluginKeyFromId(getPluginName()));
return getAuId(pluginMgr, plugin);
}
public String getAuId(PluginManager pluginMgr, Plugin plugin) {
if (auid == null) {
if (plugin == null) {
throw new RuntimeException("No such plugin " + getPluginName());
}
auid = PluginManager.generateAuId(plugin, getConfig());
}
return auid;
}
/**
* Set the estimated size
* @param size estimated size in bytes
*/
public void setEstimatedSize(long size) {
this.estSize = size;
}
/**
* @return the estimated size
*/
public long getEstimatedSize() {
return estSize;
}
/** Temporary until clients fixed */
public Configuration getConfig() {
if (params == null) {
return ConfigManager.EMPTY_CONFIGURATION;
}
Configuration config = ConfigManager.newConfiguration();
for (ConfigParamAssignment cpa : params) {
ConfigParamDescr cpd = cpa.getParamDescr();
if (!cpd.isDefaultOnly()) {
config.put(cpd.getKey(), cpa.getValue());
}
}
return config;
}
// AuConfig hasn't been fully converted to use TitleConfig. These
// methods provide the info it needs to do things mostly the old way
public Collection getUnEditableKeys() {
if (params == null) {
return Collections.emptyList();
}
List res = new ArrayList();
for (ConfigParamAssignment cpa : params) {
ConfigParamDescr cpd = cpa.getParamDescr();
if (!cpa.isEditable()) {
res.add(cpd.getKey());
}
}
return res;
}
/** Return true if the supplied config is consistent with this title,
* and there are no editable definitional params.
* @param config an AU config tree
*/
public boolean matchesConfig(Configuration config) {
if (params == null || config == null) {
return false;
}
for (ConfigParamAssignment cpa : params) {
ConfigParamDescr cpd = cpa.getParamDescr();
if (cpd.isDefinitional()) {
if (cpa.isEditable() ||
!StringUtil.equalStrings(cpa.getValue(),
config.get(cpd.getKey()))) {
return false;
}
}
}
return true;
}
/** Return true if this titleConfig completely defines an Au (ie,
* all definitional parameters have non editable values).
* @param plugin
*/
public boolean isSingleAu(Plugin plugin) {
if (params == null) {
return false;
}
for (ConfigParamDescr reqd : plugin.getAuConfigDescrs()) {
if (reqd.isDefinitional()) {
if (!assignsDescr(reqd)) {
return false;
}
}
}
return true;
}
/** Return true if the AU named by this TitleConfig is a suitable target
* for the action
* @param action the action that would be applied to the AU
*/
public boolean isActionable(PluginManager pluginMgr, int action) {
try {
switch (action) {
case TitleSet.SET_ADDABLE:
// addable if doesn't exist and pub not down and not deactivated
return (pluginMgr.getAuFromIdIfExists(getAuId(pluginMgr)) == null
&& !pluginMgr.isInactiveAuId(getAuId(pluginMgr))
&& !AuUtil.isPubDown(this));
case TitleSet.SET_REACTABLE:
return pluginMgr.isInactiveAuId(getAuId(pluginMgr));
case TitleSet.SET_DELABLE:
return pluginMgr.getAuFromIdIfExists(getAuId(pluginMgr)) != null;
}
} catch (RuntimeException e) {
log.error("TC: " + displayName, e);
return false;
}
return false;
}
public ConfigParamAssignment findCpa(ConfigParamDescr descr) {
for (ConfigParamAssignment cpa : params) {
ConfigParamDescr cpd = cpa.getParamDescr();
if (descr.equals(cpd)) {
return cpa;
}
}
return null;
}
private boolean assignsDescr(ConfigParamDescr descr) {
ConfigParamAssignment cpa = findCpa(descr);
if (cpa != null) {
return !cpa.isEditable();
}
return false;
}
/** Generate Properties that will result in this TitleConfig when loaded
* by BasePlugin */
public Properties toProperties(String propAbbr) {
return toPropertiesWithPrefix("org.lockss.title." + propAbbr + ".");
}
/** Generate Property subtree for this TitleConfig */
public Properties toProperties() {
return toPropertiesWithPrefix("");
}
/** Generate Property subtree below prefix for this TitleConfig
* @param prefix the root of the Property tree (should end with ".")
*/
private Properties toPropertiesWithPrefix(String prefix) {
Properties p = new OrderedProperties();
p.put(prefix+"title", getDisplayName());
p.put(prefix+"plugin", getPluginName());
if (pluginVersion != null) {
p.put(prefix+"pluginVersion", getPluginVersion());
}
if (journalTitle != null) {
p.put(prefix+"journalTitle", getJournalTitle());
}
if (params != null) {
for (int ix = 0; ix < params.size(); ix++) {
ConfigParamAssignment cpa = (ConfigParamAssignment)params.get(ix);
String ppre = prefix + "param." + (ix+1) + ".";
p.put(ppre + "key", cpa.getParamDescr().getKey());
p.put(ppre + "value", cpa.getValue());
}
}
return p;
}
public boolean equals(Object obj) {
if (! (obj instanceof TitleConfig)) {
return false;
}
TitleConfig o = (TitleConfig)obj;
return
StringUtil.equalStrings(displayName, o.getDisplayName()) &&
StringUtil.equalStrings(journalTitle, o.getJournalTitle()) &&
StringUtil.equalStrings(pluginName, o.getPluginName()) &&
StringUtil.equalStrings(pluginVersion, o.getPluginVersion()) &&
estSize == o.getEstimatedSize() &&
// params is order-independent, can't call List.equals()
(params == null ?
o.getParams().isEmpty() : (params.size() == o.getParams().size() &&
params.containsAll(o.getParams())));
}
public int hashCode() {
int hash = 0x6620704;
if (displayName != null) hash += displayName.hashCode();
if (journalTitle != null) hash += journalTitle.hashCode();
if (pluginName != null) hash += pluginName.hashCode();
if (pluginVersion != null) hash += pluginVersion.hashCode();
hash += getEstimatedSize();
// params is order-independent, can't call List.hashCode()
if (params != null) {
for (ConfigParamAssignment cpa : params) {
if (cpa != null)
hash += cpa.hashCode();
}
}
return hash;
}
public String toString() {
StringBuffer sb = new StringBuffer(40);
sb.append("[Title: ");
sb.append(displayName);
sb.append(", journal: ");
sb.append(journalTitle);
sb.append(", plugin: ");
sb.append(pluginName);
if (pluginVersion != null) {
sb.append(" v");
sb.append(pluginVersion);
}
sb.append(", params: ");
sb.append(params);
if (!attrs.isEmpty()) {
sb.append(", attrs: ");
sb.append(attrs);
}
sb.append("]");
return sb.toString();
}
}