Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.solr.core.PluginInfo Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.core;
import static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableMap;
import static org.apache.solr.common.params.CoreAdminParams.NAME;
import static org.apache.solr.schema.FieldType.CLASS_NAME;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.apache.solr.common.ConfigNode;
import org.apache.solr.common.MapSerializable;
import org.apache.solr.common.util.DOMUtil;
import org.apache.solr.common.util.NamedList;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/** An Object which represents a Plugin of any type */
public class PluginInfo implements MapSerializable {
public final String name, className, type, pkgName;
public final ClassName cName;
public final NamedList initArgs;
public final Map attributes;
public final List children;
private boolean isFromSolrConfig;
public PluginInfo(
String type, Map attrs, NamedList initArgs, List children) {
this.type = type;
this.name = attrs.get(NAME);
cName = parseClassName(attrs.get(CLASS_NAME));
this.className = cName.className;
this.pkgName = cName.pkg;
// Make a shallow copy for type safety
this.initArgs = new NamedList<>();
if (initArgs != null) {
for (Map.Entry entry : initArgs) {
this.initArgs.add(entry.getKey(), entry.getValue());
}
}
attributes = unmodifiableMap(attrs);
this.children = children == null ? Collections.emptyList() : unmodifiableList(children);
isFromSolrConfig = false;
}
/**
* class names can be prefixed with package name e.g: my_package:my.pkg.Class This checks if it is
* a package name prefixed classname. the return value has first = package name and second = class
* name
*/
public static ClassName parseClassName(String name) {
return new ClassName(name);
}
public static class ClassName {
public final String pkg;
public final String className;
public final String original;
public ClassName(String name) {
this.original = name;
if (name == null) {
pkg = null;
className = null;
return;
}
int colonIdx = name.indexOf(':');
if (colonIdx > -1) {
pkg = name.substring(0, colonIdx);
className = name.substring(colonIdx + 1);
} else {
pkg = null;
className = name;
}
}
@Override
public String toString() {
return original;
}
}
public PluginInfo(ConfigNode node, String err, boolean requireName, boolean requireClass) {
type = node.name();
name =
node.requiredStrAttr(
NAME,
requireName
? () -> new RuntimeException(err + ": missing mandatory attribute 'name'")
: null);
cName =
parseClassName(
node.requiredStrAttr(
CLASS_NAME,
requireClass
? () -> new RuntimeException(err + ": missing mandatory attribute 'class'")
: null));
className = cName.className;
pkgName = cName.pkg;
initArgs = DOMUtil.childNodesToNamedList(node);
attributes = node.attributes().asMap();
children = loadSubPlugins(node);
isFromSolrConfig = true;
}
public PluginInfo(Node node, String err, boolean requireName, boolean requireClass) {
type = node.getNodeName();
name = DOMUtil.getAttr(node, NAME, requireName ? err : null);
cName = parseClassName(DOMUtil.getAttr(node, CLASS_NAME, requireClass ? err : null));
className = cName.className;
pkgName = cName.pkg;
initArgs = DOMUtil.childNodesToNamedList(node);
attributes = unmodifiableMap(DOMUtil.toMap(node.getAttributes()));
children = loadSubPlugins(node);
isFromSolrConfig = true;
}
@SuppressWarnings({"unchecked", "rawtypes"})
public PluginInfo(String type, Map map) {
LinkedHashMap m = new LinkedHashMap<>(map);
initArgs = new NamedList<>();
for (Map.Entry entry : map.entrySet()) {
if (NAME.equals(entry.getKey()) || CLASS_NAME.equals(entry.getKey())) continue;
Object value = entry.getValue();
if (value instanceof List) {
List list = (List) value;
if (!list.isEmpty() && list.get(0) instanceof Map) { // this is a subcomponent
for (Object o : list) {
if (o instanceof Map) o = new NamedList<>((Map) o);
initArgs.add(entry.getKey(), o);
}
} else {
initArgs.add(entry.getKey(), value);
}
} else {
if (value instanceof Map) value = new NamedList((Map) value);
initArgs.add(entry.getKey(), value);
}
}
this.type = type;
this.name = (String) m.get(NAME);
cName = parseClassName((String) m.get(CLASS_NAME));
this.className = cName.className;
this.pkgName = cName.pkg;
// TODO This is not type-safe and needs to be fixed -
// https://issues.apache.org/jira/browse/SOLR-14696
attributes = unmodifiableMap(m);
this.children = Collections.emptyList();
isFromSolrConfig = true;
}
private List loadSubPlugins(ConfigNode node) {
List children = new ArrayList<>();
// if there is another sub tag with a non namedlist tag that has to be another plugin
node.forEachChild(
nd -> {
if (NL_TAGS.contains(nd.name())) return null;
PluginInfo pluginInfo = new PluginInfo(nd, null, false, false);
if (pluginInfo.isEnabled()) children.add(pluginInfo);
return null;
});
return children.isEmpty() ? Collections.emptyList() : unmodifiableList(children);
}
private List loadSubPlugins(Node node) {
List children = new ArrayList<>();
// if there is another sub tag with a non namedlist tag that has to be another plugin
NodeList nlst = node.getChildNodes();
for (int i = 0; i < nlst.getLength(); i++) {
Node nd = nlst.item(i);
if (nd.getNodeType() != Node.ELEMENT_NODE) continue;
if (NL_TAGS.contains(nd.getNodeName())) continue;
PluginInfo pluginInfo = new PluginInfo(nd, null, false, false);
if (pluginInfo.isEnabled()) children.add(pluginInfo);
}
return children.isEmpty() ? Collections.emptyList() : unmodifiableList(children);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder("{");
if (type != null) sb.append("type = ").append(type).append(',');
if (name != null) sb.append("name = ").append(name).append(',');
if (className != null) sb.append("class = ").append(className).append(',');
if (attributes != null && attributes.size() > 0)
sb.append("attributes = ").append(attributes).append(',');
if (initArgs != null && initArgs.size() > 0) sb.append("args = ").append(initArgs);
sb.append("}");
return sb.toString();
}
public boolean isEnabled() {
String enable = attributes.get("enable");
return enable == null || Boolean.parseBoolean(enable);
}
public boolean isDefault() {
return Boolean.parseBoolean(attributes.get("default"));
}
public PluginInfo getChild(String type) {
List l = getChildren(type);
return l.isEmpty() ? null : l.get(0);
}
@Override
@SuppressWarnings({"unchecked", "rawtypes"})
public Map toMap(Map map) {
map.putAll(attributes);
Map m = map;
if (initArgs != null) m.putAll(initArgs.asMap(3));
if (children != null) {
for (PluginInfo child : children) {
Object old = m.get(child.name);
if (old == null) {
m.put(child.name, child.toMap(new LinkedHashMap<>()));
} else if (old instanceof List) {
List list = (List) old;
list.add(child.toMap(new LinkedHashMap<>()));
} else {
ArrayList l = new ArrayList();
l.add(old);
l.add(child.toMap(new LinkedHashMap<>()));
m.put(child.name, l);
}
}
}
return m;
}
/**
* Filter children by type
*
* @param type The type name. must not be null
* @return The matching children
*/
public List getChildren(String type) {
if (children.isEmpty()) return children;
List result = new ArrayList<>();
for (PluginInfo child : children) if (type.equals(child.type)) result.add(child);
return result;
}
public static final PluginInfo EMPTY_INFO =
new PluginInfo("", Collections.emptyMap(), new NamedList<>(), Collections.emptyList());
private static final HashSet NL_TAGS =
new HashSet<>(asList("lst", "arr", "bool", "str", "int", "long", "float", "double"));
public static final String DEFAULTS = "defaults";
public static final String APPENDS = "appends";
public static final String INVARIANTS = "invariants";
public boolean isFromSolrConfig() {
return isFromSolrConfig;
}
public PluginInfo copy() {
PluginInfo result =
new PluginInfo(type, attributes, initArgs != null ? initArgs.clone() : null, children);
result.isFromSolrConfig = isFromSolrConfig;
return result;
}
}
