Added:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/impl/EmbeddedSolrPorovider.java
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/impl/EmbeddedSolrPorovider.java?rev=1144342&view=auto
==============================================================================
---
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/impl/EmbeddedSolrPorovider.java
(added)
+++
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/impl/EmbeddedSolrPorovider.java
Fri Jul 8 14:39:40 2011
@@ -0,0 +1,245 @@
+/*
+ * 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.stanbol.commons.solr.impl;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.Map;
+import java.util.Set;
+
+import javax.xml.parsers.ParserConfigurationException;
+
+import org.apache.commons.collections.map.ReferenceMap;
+import org.apache.commons.io.filefilter.NameFileFilter;
+import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Service;
+import org.apache.solr.client.solrj.SolrServer;
+import org.apache.solr.client.solrj.embedded.EmbeddedSolrServer;
+import org.apache.solr.core.CoreContainer;
+import org.apache.solr.core.CoreDescriptor;
+import org.apache.solr.core.SolrCore;
+import org.apache.stanbol.commons.solr.SolrServerProvider;
+import org.apache.stanbol.commons.solr.SolrServerProvider.Type;
+import org.apache.stanbol.commons.solr.utils.ConfigUtils;
+import org.osgi.service.component.ComponentContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.xml.sax.SAXException;
+
+/**
+ * Support for the use of {@link EmbeddedSolrPorovider} in combination with
the SolrYard implementation. This
+ * implements the {@link SolrServerProvider} interface for the {@link
Type#EMBEDDED}.
+ * <p>
+ *
+ * TODO: add functionality to lookup the internally managed {@link
CoreContainer}. Maybe this requires to add
+ * a second service
+ *
+ * @author Rupert Westenthaler
+ *
+ */
+@Component(immediate = true, metatype = true)
+@Service
+public class EmbeddedSolrPorovider implements SolrServerProvider {
+ private final Logger log =
LoggerFactory.getLogger(EmbeddedSolrPorovider.class);
+ // define the default values here because they are not accessible via the
Solr API
+ public static final String SOLR_XML_NAME = "solr.xml";
+ public static final String SOLR_CONFIG_NAME = "solrconfig.xml";
+ public static final String SOLR_SCHEMA_NAME = "schema.xml";
+
+ /**
+ * internally used to keep track of active {@link CoreContainer}s for
requested paths.
+ */
+ @SuppressWarnings("unchecked")
+ private Map<String,CoreContainer> coreContainers = new ReferenceMap();
+
+ public EmbeddedSolrPorovider() {}
+
+ @Override
+ public SolrServer getSolrServer(Type type, String uriOrPath, String...
additional) throws NullPointerException,
+
IllegalArgumentException {
+ log.debug(String.format("getSolrServer Request for %s and path %s",
type, uriOrPath));
+ if (uriOrPath == null) {
+ throw new IllegalArgumentException("The Path to the Index MUST NOT
be NULL!");
+ }
+ log.info("parsed solr server location " + uriOrPath);
+ // first try as file (but keep in mind it could also be an URI)
+ File index = ConfigUtils.toFile(uriOrPath);
+ if (!index.exists()) {
+ throw new IllegalArgumentException(String.format("The parsed Index
Path %s does not exist",
+ uriOrPath));
+ }
+ log.info("get solr server for location " + index);
+ File coreDir = null;
+ if (index.isDirectory()) {
+ File solr = getFile(index, SOLR_XML_NAME);
+ String coreName;
+ if (solr != null) {
+ // in that case we assume that this is a single core
installation
+ coreName = "";
+ } else {
+ solr = getFile(index.getParentFile(), SOLR_XML_NAME);
+ if (solr != null) {
+ // assume this is a multi core
+ coreName = index.getName();
+ coreDir = index;
+ index = index.getParentFile(); // set the index dir to the
parent
+ } else {
+ throw new IllegalArgumentException(String.format(
+ "The parsed Index Path %s is not an Solr "
+ + "Index nor a Core of an Multi Core
Configuration " + "(no \""
+ + SOLR_XML_NAME + "\" was found in this nor
the parent directory!)",
+ uriOrPath));
+ }
+ }
+ // now init the EmbeddedSolrServer
+ log.info("Create EmbeddedSolrServer for index {} and core {}",
+ index.getAbsolutePath(), coreName);
+ CoreContainer coreContainer =
getCoreContainer(index.getAbsolutePath(), solr);
+ // if we have a multi core environment and the core is not yet
registered
+ if (!coreName.isEmpty() &&
!coreContainer.getCoreNames().contains(coreName)) {
+ // register this core first
+ /*
+ * NOTE: We need to reset the ContextClassLoader to the one
used for this Bundle, because Solr
+ * uses this ClassLoader to load all the plugins configured in
the SOLR_XML_NAME and
+ * schema.xml. The finally block resets the context class
loader to the previous value.
+ * (Rupert Westenthaler 20010209)
+ */
+ ClassLoader classLoader =
Thread.currentThread().getContextClassLoader();
+
Thread.currentThread().setContextClassLoader(EmbeddedSolrPorovider.class.getClassLoader());
+ try {
+ // SolrResourceLoader solrLoader = new
SolrResourceLoader(coreDir.getAbsolutePath());
+ CoreDescriptor coreDescriptor = new
CoreDescriptor(coreContainer, coreName,
+ coreDir.getAbsolutePath());
+ SolrCore core;
+ try {
+ core = coreContainer.create(coreDescriptor);
+ } catch (Exception e) {
+ throw new IllegalStateException(String.format("Unable
to load/register Solr Core %s "
+ + "to
SolrServer %s!", coreName,
+ index.getAbsoluteFile()), e);
+ }
+ coreContainer.register(coreName, core, false);
+ // persist the new core to have it available on the next
start
+ coreContainer.persist();
+ } finally {
+ Thread.currentThread().setContextClassLoader(classLoader);
+ }
+ }
+ return (SolrServer)new EmbeddedSolrServer(coreContainer, coreName);
+ } else {
+ throw new IllegalArgumentException(String.format("The parsed Index
Path %s is no Directory",
+ uriOrPath));
+ }
+ }
+
+ protected final CoreContainer getCoreContainer(File solrDir) throws
IllegalArgumentException,
+
IllegalStateException {
+ return getCoreContainer(solrDir.getAbsolutePath(), new File(solrDir,
SOLR_XML_NAME));
+ }
+
+ protected final CoreContainer getCoreContainer(String solrDir, File
solrConf) throws IllegalArgumentException,
+
IllegalStateException {
+ CoreContainer container = coreContainers.get(solrDir);
+ if (container == null) {
+ container = new CoreContainer(solrDir);
+ /*
+ * NOTE: We need to reset the ContextClassLoader to the one used
for this Bundle, because Solr
+ * uses this ClassLoader to load all the plugins configured in the
SOLR_XML_NAME and schema.xml.
+ * The finally block resets the context class loader to the
previous value. (Rupert Westenthaler
+ * 20010209)
+ */
+ ClassLoader loader =
Thread.currentThread().getContextClassLoader();
+
Thread.currentThread().setContextClassLoader(EmbeddedSolrPorovider.class.getClassLoader());
+ try {
+ container.load(solrDir, solrConf);
+ } catch (ParserConfigurationException e) {
+ throw new IllegalStateException("Unable to parse Solr
Configuration", e);
+ } catch (IOException e) {
+ throw new IllegalStateException("Unable to access Solr
Configuration", e);
+ } catch (SAXException e) {
+ throw new IllegalStateException("Unable to parse Solr
Configuration", e);
+ } finally {
+ Thread.currentThread().setContextClassLoader(loader);
+ }
+ coreContainers.put(solrDir, container);
+ }
+ return container;
+ }
+
+ @Override
+ public Set<Type> supportedTypes() {
+ return Collections.singleton(Type.EMBEDDED);
+ }
+
+ @Activate
+ protected void activate(ComponentContext context) {
+ log.debug("activating" + EmbeddedSolrPorovider.class.getSimpleName());
+ // currently not used
+
+ }
+
+ @Deactivate
+ protected void deactivate(ComponentContext context) {
+ log.debug("deactivating" +
EmbeddedSolrPorovider.class.getSimpleName());
+ // currently not used
+ }
+
+ // Keeping for now because this might be useful when checking for required
files
+ // /**
+ // * Checks if the parsed directory contains a file that starts with the
parsed
+ // * name. Parsing "hallo" will find "hallo.all", "hallo.ween" as well as
"hallo".
+ // * @param dir the Directory. This assumes that the parsed File is not
+ // * <code>null</code>, exists and is an directory
+ // * @param name the name. If <code>null</code> any file is accepted,
meaning
+ // * that this will return true if the directory contains any file
+ // * @return the state
+ // */
+ // private boolean hasFile(File dir, String name){
+ // return dir.list(new NameFileFilter(name)).length>0;
+ // }
+ // /**
+ // * Returns the first file that matches the parsed name.
+ // * Parsing "hallo" will find "hallo.all", "hallo.ween" as well as
"hallo".
+ // * @param dir the Directory. This assumes that the parsed File is not
+ // * <code>null</code>, exists and is an directory.
+ // * @param name the name. If <code>null</code> any file is accepted,
meaning
+ // * that this will return true if the directory contains any file
+ // * @return the first file matching the parsed prefix.
+ // */
+ // private File getFileByPrefix(File dir, String prefix){
+ // String[] files = dir.list(new PrefixFileFilter(prefix));
+ // return files.length>0?new File(dir,files[0]):null;
+ // }
+ /**
+ * Returns the first file that matches the parsed name (case sensitive)
+ *
+ * @param dir
+ * the Directory. This assumes that the parsed File is not
<code>null</code>, exists and is an
+ * directory.
+ * @param name
+ * the name. If <code>null</code> any file is accepted, meaning
that this will return true if
+ * the directory contains any file
+ * @return the first file matching the parsed name.
+ */
+ private File getFile(File dir, String name) {
+ String[] files = dir.list(new NameFileFilter(name));
+ return files.length > 0 ? new File(dir, files[0]) : null;
+ }
+}
Propchange:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/impl/EmbeddedSolrPorovider.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/ConfigUtils.java
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/ConfigUtils.java?rev=1144342&view=auto
==============================================================================
---
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/ConfigUtils.java
(added)
+++
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/ConfigUtils.java
Fri Jul 8 14:39:40 2011
@@ -0,0 +1,644 @@
+/*
+ * 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.stanbol.commons.solr.utils;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.net.URLDecoder;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.zip.GZIPInputStream;
+
+import org.apache.commons.compress.archivers.ArchiveEntry;
+import org.apache.commons.compress.archivers.ArchiveInputStream;
+import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
+import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
+import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
+import org.apache.commons.compress.archivers.zip.ZipFile;
+import
org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.FilenameUtils;
+import org.apache.commons.io.IOUtils;
+import org.apache.solr.client.solrj.embedded.EmbeddedSolrServer;
+import org.apache.stanbol.commons.solr.impl.EmbeddedSolrPorovider;
+import org.apache.stanbol.commons.solr.impl.install.IndexInstallerConstants;
+import org.osgi.framework.Bundle;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * This Utility provides Methods that copy a configuration from a {@link
Bundle} and copy it to a directory.
+ * <p>
+ * This is currently used by the {@link EmbeddedSolrPorovider} to initialise
the internally managed
+ * {@link EmbeddedSolrServer} and/or to add additional cores. There are always
two variants of the methods.
+ * The one taking a bundle as parameter is supposed to be used when running
within an OSGI environment. The
+ * variant taking a Class object works outside of an OSGI environment.
+ *
+ * @author Rupert Westenthaler
+ *
+ */
+public final class ConfigUtils {
+ private ConfigUtils() {}
+
+ /**
+ * Use <indexName>.solrindex[.<archiveType>] as file name
+ */
+ public static final String SOLR_INDEX_ARCHIVE_EXTENSION = "solrindex";
+
+ /**
+ * Supported archive types.
+ */
+ public static final Map<String,String> SUPPORTED_SOLR_ARCHIVE_FORMAT;
+ static {
+ Map<String,String> cfm = new HashMap<String,String>();
+ cfm.put(SOLR_INDEX_ARCHIVE_EXTENSION, "zip"); // the default if not
specified
+ cfm.put("gz", "gz");
+ cfm.put("bz2", "bz2");
+ cfm.put("zip", "zip");
+ cfm.put("jar", "zip");
+ cfm.put("ref", "properties"); // reference
+ cfm.put("properties", "properties"); // also accept properties as
references
+ SUPPORTED_SOLR_ARCHIVE_FORMAT = Collections.unmodifiableMap(cfm);
+ }
+ public static final String DEFAULT_ARCHIVE_FORMAT = "zip";
+ /**
+ * The default extension for Solr Index Archives. This is typically added
+ * to configuration names that are missing the extension.
+ */
+ public static final String DEFAULT_SOLR_INDEX_ARCHIVE_EXTENSION =
+ '.'+SOLR_INDEX_ARCHIVE_EXTENSION + '.' + DEFAULT_ARCHIVE_FORMAT;
+
+ public static boolean isValidSolrIndexFileName(String name){
+ return name.indexOf('.'+SOLR_INDEX_ARCHIVE_EXTENSION) >= 0 &&
+
SUPPORTED_SOLR_ARCHIVE_FORMAT.containsKey(FilenameUtils.getExtension(name));
+ }
+
+ public static String appandSolrIndexFileExtension(String name,String
format){
+ String extension;
+ if(SUPPORTED_SOLR_ARCHIVE_FORMAT.containsKey(format)){
+ extension = format;
+ } else {
+ extension = DEFAULT_ARCHIVE_FORMAT;
+ }
+ return name+'.'+SOLR_INDEX_ARCHIVE_EXTENSION+'.'+extension;
+ }
+
+ public static ArchiveInputStream getArchiveInputStream(String
solrArchiveName, InputStream is) throws IOException {
+ String archiveFormat;
+ String solrArchiveExtension =
FilenameUtils.getExtension(solrArchiveName);
+ if (solrArchiveExtension == null || solrArchiveExtension.isEmpty()) {
+ archiveFormat = solrArchiveName; // assume that the
archiveExtension was parsed
+ } else {
+ archiveFormat =
SUPPORTED_SOLR_ARCHIVE_FORMAT.get(solrArchiveExtension);
+ }
+ ArchiveInputStream ais;
+ if ("zip".equals(archiveFormat)) {
+ ais = new ZipArchiveInputStream(is);
+ } else {
+ if ("gz".equals(archiveFormat)) {
+ is = new GZIPInputStream(is);
+ } else if ("bz2".equals(archiveFormat)) {
+ is = new BZip2CompressorInputStream(is);
+ } else {
+ throw new IllegalStateException("Unsupported compression
format " + archiveFormat + " "
+ + "(implementation out of sync
with Constants defined in "
+ +
IndexInstallerConstants.class.getName() + "). "
+ + "Please report this to
stanbol-dev mailing list!");
+ }
+ ais = new TarArchiveInputStream(is);
+ }
+ return ais;
+ }
+
+ /**
+ * The logger
+ */
+ private static final Logger log =
LoggerFactory.getLogger(ConfigUtils.class);
+ /**
+ * The name of the directoy used in the bundle to search for the default
config
+ */
+ public static final String CONFIG_DIR = "solr/conf";
+ /**
+ * The name of the root directoy used within an bundle to search for all
cores that need to be added to an
+ * existing solr multi core configuration
+ */
+ public static final String CORE_CONFIG_DIR = "solr/core";
+
+ /**
+ * Initialises the default configuration for the SolrYard based on data in
the parsed bundle. The
+ * configuration will be copied to the parsed root directory.
+ *
+ * @param bundle
+ * the bundle used to load the defaultConfiguration from the
{@link #CONFIG_DIR} (value="
+ * {@value #CONFIG_DIR}") directory.
+ * @param rootDir
+ * the target directory for the configuration.
+ * @param override
+ * if true existing configurations are overridden.
+ * @return the root directory of the solr configuration (same as parsed as
rootDir)
+ * @throws IOException
+ * On any IO error while coping the configuration
+ * @throws IllegalStateException
+ * If the parsed bundle is in the {@link Bundle#UNINSTALLED}
state, the parsed rootDir does
+ * exist but is not a directory.
+ * @throws IllegalArgumentException
+ * If <code>null</code> is parsed as bundle or rootDir or if
the parsed bundle does not
+ * contain the required information to set up an configuration
+ */
+ @SuppressWarnings("unchecked")
+ // Enumeration<URL> required by OSGI specification
+ public static File copyDefaultConfig(Bundle bundle, File rootDir, boolean
override) throws IOException,
+
IllegalStateException,
+
IllegalArgumentException {
+ if (bundle == null) {
+ throw new IllegalArgumentException("The parsed Bundle MUST NOT be
NULL!");
+ }
+ if (rootDir == null) {
+ throw new IllegalArgumentException("The parsed root directory MUST
NOT be NULL!");
+ }
+ if (rootDir.exists() && !rootDir.isDirectory()) {
+ throw new IllegalStateException("The parsed root directory " +
rootDir.getAbsolutePath()
+ + " extists but is not a
directory!");
+ }
+ log.info(String.format("Copy Default Config from Bundle %s to %s
(override=%s)",
+ bundle.getSymbolicName(), rootDir.getAbsolutePath(), override));
+ Enumeration<URL> resources = (Enumeration<URL>)
bundle.findEntries(CONFIG_DIR, "*.*", true);
+ // TODO: check validity of config and thorw IllegalArgumentException
if not valid
+ while (resources.hasMoreElements()) {
+ URL resource = resources.nextElement();
+ copyResource(rootDir, resource, CONFIG_DIR, override);
+ }
+ log.debug(" ... default Configuration copied to " +
rootDir.getAbsolutePath());
+ return rootDir;
+ }
+
+ /**
+ * Initialises the default configuration for the SolrYard based on data in
the parsed bundle. The
+ * configuration will be copied to the parsed root directory.
+ *
+ * @param clazzInArchive
+ * This class is used to identify the archive containing the
default configuration. Parsing
+ * <code>null</code> causes this class to be used and therefore
initialises the default
+ * configuration contained by the SolrYard bundle.
+ * @param rootDir
+ * the target directory for the configuration.
+ * @param override
+ * if true existing configurations are overridden.
+ * @return the root directory of the solr configuration (same as parsed as
rootDir)
+ * @throws IOException
+ * On any IO error while coping the configuration
+ * @throws IllegalStateException
+ * If the parsed rootDir does exist but is not a directory.
+ * @throws IllegalArgumentException
+ * iIf <code>null</code> is parsed as rootDir or if the parsed
bundle does not contain the
+ * required information to set up an configuration
+ */
+ public static File copyDefaultConfig(Class<?> clazzInArchive, File
rootDir, boolean override) throws IOException,
+
IllegalStateException,
+
IllegalArgumentException {
+ if (rootDir == null) {
+ throw new IllegalArgumentException("The parsed root directory MUST
NOT be NULL!");
+ }
+ if (rootDir.exists() && !rootDir.isDirectory()) {
+ throw new IllegalStateException("The parsed root directory " +
rootDir.getAbsolutePath()
+ + " extists but is not a
directory!");
+ }
+ File sourceRoot = getSource(clazzInArchive != null ? clazzInArchive :
ConfigUtils.class);
+ log.info("Init Solr Managed Directory form {} to {} (override={})",
+ new Object[]{sourceRoot,rootDir,override});
+ if (sourceRoot.isFile()) {
+ ZipFile archive = new ZipFile(sourceRoot);
+ log.info(" - read from jar-file");
+ try {
+ for (@SuppressWarnings("unchecked")
+ Enumeration<ZipArchiveEntry> entries =
(Enumeration<ZipArchiveEntry>) archive.getEntries(); entries
+ .hasMoreElements();) {
+ ZipArchiveEntry entry = entries.nextElement();
+ if (!entry.isDirectory() &&
entry.getName().startsWith(CONFIG_DIR)) {
+ copyResource(rootDir, archive, entry, CONFIG_DIR,
override);
+ }
+ }
+ } finally {
+ // regardless what happens we need to close the archive!
+ ZipFile.closeQuietly(archive);
+ }
+ } else { // load from file
+ log.info(" - read from directory");
+ File source = new File(sourceRoot, CONFIG_DIR);
+ if (source.exists() && source.isDirectory()) {
+ FileUtils.copyDirectory(source, rootDir);
+ } else {
+ throw new FileNotFoundException("The SolrIndex default config
was not found in directory "
+ + source.getAbsolutePath());
+ }
+ }
+ return rootDir;
+ }
+
+ /**
+ * Uses the {@link ClassLoader} of the parsed {@link Class} instance to
locate the jar file the class was
+ * loaded from.
+ *
+ * @param clazz
+ * the class used as context to find the jar file
+ * @return the archive the parsed class was loaded from
+ * @throws IOException
+ * In case the jar file can not be accessed.
+ */
+ private static File getSource(Class<?> clazz) throws IOException {
+ String classFileName = clazz.getName().replace('.', '/') + ".class";
+ URL classLocation = clazz.getClassLoader().getResource(classFileName);
+ String classPath;
+ try {
+ classPath = new File(classLocation.toURI()).getAbsolutePath();
+ } catch (Exception e) {
+ // if we can not convert it to an URI, try directly with the URL
+ // URLs with jar:file:/{jarPath}!{classPath} can cause problems
+ // so try to parse manually by using the substring from the first
+ // '/' to (including '!')
+ String urlString = URLDecoder.decode(classLocation.toString(),
"UTF-8");
+ int slashIndex = urlString.indexOf('/');
+ int exclamationIndex = urlString.indexOf('!');
+ if (slashIndex >= 0 && exclamationIndex > 0) {
+ classPath = urlString.substring(slashIndex, exclamationIndex +
1);
+ log.info("manually parsed plassPath: {} from {}", classPath,
classLocation);
+ } else {
+ // looks like there is an other reason than an URL as
described above
+ // so better to throw an exception than to guess ...
+ throw new IOException("Unable to Access Source at location " +
classLocation, e);
+ }
+ }
+ if (classPath.indexOf('!') > 0) {
+ return new File(classPath.substring(0, classPath.indexOf('!')));
+ } else {
+ return new File(classPath.substring(0, classPath.length() -
classFileName.length()));
+ }
+ }
+
+ /**
+ * Copies a resource (URL of an resource within a Bundle) to a file
+ *
+ * @param rootDir
+ * the directory used as target
+ * @param resource
+ * the resource URL
+ * @param context
+ * the context used to search for the relative path within the
URL
+ * @param override
+ * if resources in the target should be overridden if they
already exist
+ * @throws IOException
+ * on any IO error
+ */
+ private static void copyResource(File rootDir, URL resource, String
context, boolean override) throws IOException {
+ String resourcePath = resource.toString();
+ File file = prepairCopy(resourcePath, rootDir, context);
+ if (file != null) {
+ boolean overrideState = false;
+ if (file.exists() && override) {
+ FileUtils.deleteQuietly(file);
+ overrideState = true;
+ }
+ if (!file.exists()) {
+ FileUtils.copyURLToFile(resource, file);
+ log.debug(String.format(" > %s %s", overrideState ? "override"
: "copy", file));
+ }
+ } // else can not cppy logging already provided
+ }
+
+ /**
+ * Variant of the copyResource method that used an entry of an archive as
source.
+ *
+ * @param rootDir
+ * the directory used as target
+ * @param archive
+ * the archive containing the parsed entry
+ * @param entry
+ * the entry to copy to the target directory
+ * @param context
+ * the context used to calculate the relative path of the
resource within the target directory
+ * @param override
+ * if an existing resource within the target directory should
be deleted
+ * @throws IOException
+ * in case of an error while reading or writing the resource
+ */
+ private static void copyResource(File rootDir,
+ ZipFile archive,
+ ZipArchiveEntry entry,
+ String context,
+ boolean override) throws IOException {
+ File file = prepairCopy(entry.getName(), rootDir, context);
+ if (file != null) {
+ boolean overrideState = false;
+ if (file.exists() && override) {
+ FileUtils.deleteQuietly(file);
+ overrideState = true;
+ }
+ if (!file.exists()) {
+ OutputStream os = null;
+ InputStream is = null;
+ try {
+ os = FileUtils.openOutputStream(file);
+ is = archive.getInputStream(entry);
+ IOUtils.copy(is, os);
+ log.debug(String.format(" > %s %s", overrideState ?
"override" : "copy", file));
+ } finally {
+ IOUtils.closeQuietly(is);
+ IOUtils.closeQuietly(os);
+ }
+ }
+ } // else can not cppy logging already provided
+
+ }
+
+ /**
+ * Prepares the copying of a resource. The context is used to determine
the relative path of the resource.
+ * Than missing sub-directories are created in the target directory.
Finally the file instance
+ * representing this resource within the target directory is returned.
+ *
+ * @param resource
+ * The path to the resource. This need not be the full path. It
must only be ensured that the
+ * parsed context is contained. e.g. the relative path of a
resource within an archive provides
+ * enough context for this method to work
+ * @param targetDir
+ * the target directory
+ * @param context
+ * the context to determine the relative path of the resource
within the target directory. The
+ * context MUST be part of the parsed resource name. Otherwise
this method will return
+ * <code>null</code>
+ * @return the file representing the resource within the target directory.
In cases the context can not be
+ * found in the parsed resource this method returns
<code>null</code>
+ */
+ private static File prepairCopy(String resource, File targetDir, String
context) {
+ if (!(context.charAt(context.length() - 1) == '/')) {
+ context = context + '/';
+ }
+ int contextPos = resource.lastIndexOf(context);
+ if (contextPos >= 0) {
+ contextPos = contextPos + context.length();
+ } else {
+ log.warn(String.format("Context %s not found in resource %s ->
ignored!", context, resource));
+ return null;
+ }
+ String relativePath = resource.substring(contextPos);
+ String[] relativePathElements = relativePath.split("/");
+ File parentElement = targetDir;
+ for (int i = 0; i < relativePathElements.length - 1; i++) {
+ File pathElement = new File(parentElement,
relativePathElements[i]);
+ if (!pathElement.exists()) {
+ pathElement.mkdir();
+ }
+ parentElement = pathElement;
+ }
+ File file = new File(parentElement,
relativePathElements[relativePathElements.length - 1]);
+ return file;
+ }
+
+ /**
+ * Copy the configuration of an core.
+ *
+ * @param bundle
+ * The bundle used to load the core
+ * @param coreDir
+ * the target directory for the core
+ * @param coreName
+ * the core name or <code>null</code> to directly load the
configuration as present under
+ * {@value #CONFIG_DIR} in the bundle. This property can be
used if a bundle needs to provide
+ * multiple core configurations
+ * @param override
+ * if files in the target directory should be overridden
+ * @throws IOException
+ * On any IO error while coping the configuration
+ * @throws IllegalStateException
+ * If the parsed bundle is in the {@link Bundle#UNINSTALLED}
state, the parsed coreDir does
+ * exist but is not a directory.
+ * @throws IllegalArgumentException
+ * if <code>null</code> is parsed as bundle or coreDir or if
the parsed bundle does not
+ * contain the required information to set up an configuration
or the parsed coreName is
+ * empty.
+ */
+ @SuppressWarnings("unchecked")
+ // Enumeration<URL> required by OSGI specification
+ public static void copyCore(Bundle bundle, File coreDir, String coreName,
boolean override) throws IOException,
+
IllegalStateException,
+
IllegalArgumentException {
+ if (bundle == null) {
+ throw new IllegalArgumentException("The parsed Bundle MUST NOT be
NULL!");
+ }
+ if (coreDir == null) {
+ throw new IllegalArgumentException("The parsed core directory MUST
NOT be NULL!");
+ }
+ if (coreDir.exists() && !coreDir.isDirectory()) {
+ throw new IllegalStateException("The parsed core directory " +
coreDir.getAbsolutePath()
+ + " extists but is not a
directory!");
+ }
+ if (coreName != null && coreName.isEmpty()) {
+ throw new IllegalArgumentException(
+ "The parsed core name MUST NOT be empty (However NULL is
supported)!");
+ }
+ String context = CORE_CONFIG_DIR + (coreName != null ? '/' + coreName
: "");
+ Enumeration<URL> resources = (Enumeration<URL>)
bundle.findEntries(context, "*.*", true);
+ while (resources.hasMoreElements()) {
+ URL resource = resources.nextElement();
+ copyResource(coreDir, resource, context, override);
+ }
+ }
+
+ /**
+ * Copies a core from the parsed archive input stream to the target
location
+ *
+ * @param ais
+ * The input stream of the archive (not closed by this method)
+ * @param coreDir
+ * the directory for the core
+ * @param coreName
+ * the name of the core (used as context when reading relative
paths from the archive
+ * @param override
+ * if existing files should be overridden
+ * @throws IOException
+ * On any error while accessing the data of the archive
+ * @throws IllegalArgumentException
+ * if any of the parameter is <code>null</code> or if the
coreDir exists but is not an
+ * directory or if the core name is empty
+ */
+ public static void copyCore(ArchiveInputStream ais, File coreDir, String
coreName, boolean override) throws IOException {
+ if (ais == null) {
+ throw new IllegalArgumentException("The parsed ArchiveInputStream
MUST NOT be NULL!");
+ }
+ if (coreDir == null) {
+ throw new IllegalArgumentException("The parsed core directory MUST
NOT be NULL!");
+ }
+ if (coreDir.exists() && !coreDir.isDirectory()) {
+ throw new IllegalStateException("The parsed core directory " +
coreDir.getAbsolutePath()
+ + " extists but is not a
directory!");
+ }
+ if (coreName == null || coreName.isEmpty()) {
+ throw new IllegalArgumentException("The parsed core name MUST NOT
be NULL or empty!");
+ }
+ ArchiveEntry entry;
+ while ((entry = ais.getNextEntry()) != null) {
+ if (!entry.isDirectory()) {
+ copyArchiveEntry(ais, entry, coreDir, coreName, override);
+ /*
+ * NOTE: Here we use the coreName as context (last argument to
prepairCopy(..)). This ensures
+ * that it matter if the archive contains the data directly in
the root or within an folder
+ * with the name of the core.
+ */
+ } // else - directories are created automatically and empty
directories are not needed
+ }
+ }
+
+ /**
+ * Copy an Entry of an Archive to the target (File) within the Core
Directory
+ *
+ * @param ais
+ * the ArchiveInputStream
+ * @param entry
+ * The Entry to copy
+ * @param coreDir
+ * the root directory
+ * @param context
+ * the context used to calculate the relative path of the
resource within the target directory
+ * @param override
+ * if an existing resource within the target directory should
be deleted
+ * @throws IOException
+ * in case of an error while reading or writing the resource
+ */
+ private static void copyArchiveEntry(ArchiveInputStream ais,
+ ArchiveEntry entry,
+ File coreDir,
+ String context,
+ boolean override) throws IOException {
+ File file = prepairCopy(entry.getName(), coreDir, context);
+ if (file != null) {
+ boolean overrideState = false;
+ if (file.exists() && override) {
+ FileUtils.deleteQuietly(file);
+ overrideState = true;
+ }
+ if (!file.exists()) {
+ OutputStream os = null;
+ try {
+ os = FileUtils.openOutputStream(file);
+ IOUtils.copy(ais, os);
+ log.debug(String.format(" > %s %s", overrideState ?
"override" : "copy", file));
+ } finally {
+ IOUtils.closeQuietly(os);
+ }
+ }
+ } // else can not cppy logging already provided
+ }
+
+ /**
+ * Copy the configuration of an core.
+ *
+ * @param clazzInArchive
+ * This class is used to identify the archive containing the
default configuration. Parsing
+ * <code>null</code> causes this class to be used and therefore
initialises the default core
+ * configuration contained by the SolrYard bundle.
+ * @param coreDir
+ * the target directory for the core
+ * @param coreName
+ * the core name or <code>null</code> to directly load the
configuration as present under
+ * {@value #CONFIG_DIR} in the bundle. This property can be
used if a bundle needs to provide
+ * multiple core configurations
+ * @param override
+ * if files in the target directory should be overridden
+ * @throws IOException
+ * On any IO error while coping the configuration
+ * @throws IllegalStateException
+ * If the parsed coreDir does exist but is not a directory.
+ * @throws IllegalArgumentException
+ * if <code>null</code> is parsed as coreDir or if the parsed
bundle does not contain the
+ * required information to set up an configuration or the
parsed coreName is empty.
+ */
+ public static void copyCore(Class<?> clazzInArchive, File coreDir, String
coreName, boolean override) throws IOException,
+
IllegalArgumentException,
+
IllegalStateException {
+ if (coreDir == null) {
+ throw new IllegalArgumentException("The parsed core directory MUST
NOT be NULL!");
+ }
+ if (coreDir.exists() && !coreDir.isDirectory()) {
+ throw new IllegalStateException("The parsed core directory " +
coreDir.getAbsolutePath()
+ + " extists but is not a
directory!");
+ }
+ if (coreName != null && coreName.isEmpty()) {
+ throw new IllegalArgumentException(
+ "The parsed core name MUST NOT be empty (However NULL is
supported)!");
+ }
+ String context = CORE_CONFIG_DIR + (coreName != null ? '/' + coreName
: "");
+ File sourceRoot = getSource(clazzInArchive != null ? clazzInArchive :
ConfigUtils.class);
+ if (sourceRoot.isFile()) {
+ ZipFile archive = new ZipFile(sourceRoot);
+ log.info(String.format("Copy core %s config from jar-file %s to %s
(override=%s)",
+ (coreName == null ? "" : coreName), sourceRoot.getName(),
coreDir.getAbsolutePath(), override));
+ try {
+ for (@SuppressWarnings("unchecked")
+ Enumeration<ZipArchiveEntry> entries =
(Enumeration<ZipArchiveEntry>) archive.getEntries(); entries
+ .hasMoreElements();) {
+ ZipArchiveEntry entry = entries.nextElement();
+ if (entry.getName().startsWith(context)) {
+ copyResource(coreDir, archive, entry, context,
override);
+ }
+ }
+ } finally {
+ // regardless what happens we need to close the archive!
+ ZipFile.closeQuietly(archive);
+ }
+ } else { // load from file
+ File source = new File(sourceRoot, context);
+ if (source.exists() && source.isDirectory()) {
+ FileUtils.copyDirectory(source, coreDir);
+ } else {
+ throw new FileNotFoundException("The SolrIndex default config
was not found in directory "
+ + source.getAbsolutePath());
+ }
+ }
+ }
+
+ /**
+ * Converts a parsed String to a File instance. The parsed string can be
formatted as file URL or as path
+ *
+ * @param uriOrPath
+ * the file location as URL or path
+ * @return the File
+ */
+ public static File toFile(String uriOrPath) {
+ File file = null;
+ try {
+ URI fileUri = new URI(uriOrPath);
+ file = new File(fileUri);
+ } catch (URISyntaxException e) {
+ // not an URI -> ignore
+ } catch (IllegalArgumentException e) {
+ // this happens if it is a URI but can not be converted to a file
+ // still we should try to work with the parsed file ...
+ }
+ if (file == null) {
+ file = new File(uriOrPath);
+ }
+ return file;
+ }
+
+}
Propchange:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/ConfigUtils.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/SolrUtil.java
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/SolrUtil.java?rev=1144342&view=auto
==============================================================================
---
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/SolrUtil.java
(added)
+++
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/SolrUtil.java
Fri Jul 8 14:39:40 2011
@@ -0,0 +1,38 @@
+/*
+ * 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.stanbol.commons.solr.utils;
+
+import java.util.regex.Pattern;
+
+public final class SolrUtil {
+ private SolrUtil() {}
+
+ private static final String LUCENE_ESCAPE_CHARS =
"[\\\\+\\-\\!\\(\\)\\:\\^\\[\\]\\{\\}\\~\\*\\?]";
+ private static final Pattern LUCENE_PATTERN =
Pattern.compile(LUCENE_ESCAPE_CHARS);
+ private static final String REPLACEMENT_STRING = "\\\\$0";
+
+ /**
+ * Escapes all special chars in an string (field name or constraint) to be
used in an SolrQuery.
+ *
+ * @param string
+ * the string to be escaped
+ * @return the escaped string
+ */
+ public static String escapeSolrSpecialChars(String string) {
+ return string != null ?
LUCENE_PATTERN.matcher(string).replaceAll(REPLACEMENT_STRING) : null;
+ }
+}
Propchange:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/SolrUtil.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/StreamQueryRequest.java
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/StreamQueryRequest.java?rev=1144342&view=auto
==============================================================================
---
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/StreamQueryRequest.java
(added)
+++
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/StreamQueryRequest.java
Fri Jul 8 14:39:40 2011
@@ -0,0 +1,39 @@
+package org.apache.stanbol.commons.solr.utils;
+
+import java.util.Arrays;
+import java.util.Collection;
+
+import org.apache.commons.lang.StringUtils;
+import org.apache.solr.client.solrj.SolrQuery;
+import org.apache.solr.client.solrj.request.QueryRequest;
+import org.apache.solr.common.params.CommonParams;
+import org.apache.solr.common.util.ContentStream;
+import org.apache.solr.common.util.ContentStreamBase.StringStream;
+
+/**
+ * Extend the default Solr QueryRequest to make it possible to pass
MoreLikeThis the payload as a content
+ * stream.
+ *
+ * This is temporary solution waiting for a proper support of
MoreLikeThisHandler in SolrJ.
+ * https://issues.apache.org/jira/browse/SOLR-1085
+ */
+public class StreamQueryRequest extends QueryRequest {
+
+ private static final long serialVersionUID = 1L;
+
+ protected ContentStream contentStream;
+
+ public StreamQueryRequest(SolrQuery q) {
+ super(q, METHOD.POST);
+ String[] bodies = q.remove(CommonParams.STREAM_BODY);
+ if (bodies!= null && bodies.length > 0) {
+ String body = StringUtils.join(bodies, " ");
+ this.contentStream = new StringStream(body);
+ }
+ }
+
+ @Override
+ public Collection<ContentStream> getContentStreams() {
+ return Arrays.asList(contentStream);
+ }
+}
Propchange:
incubator/stanbol/trunk/commons/solr/src/main/java/org/apache/stanbol/commons/solr/utils/StreamQueryRequest.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrDirectoryManager
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrDirectoryManager?rev=1144342&view=auto
==============================================================================
---
incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrDirectoryManager
(added)
+++
incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrDirectoryManager
Fri Jul 8 14:39:40 2011
@@ -0,0 +1 @@
+org.apache.stanbol.commons.solr.impl.DefaultSolrDirectoryManager
\ No newline at end of file
Added:
incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrServerProvider
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrServerProvider?rev=1144342&view=auto
==============================================================================
---
incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrServerProvider
(added)
+++
incubator/stanbol/trunk/commons/solr/src/main/resources/META-INF/services/org.apache.stanbol.commons.solr.SolrServerProvider
Fri Jul 8 14:39:40 2011
@@ -0,0 +1,2 @@
+org.apache.stanbol.commons.solr.impl.DefaultSolrServerProvider
+org.apache.stanbol.commons.solr.impl.EmbeddedSolrPorovider
\ No newline at end of file
Added: incubator/stanbol/trunk/commons/solr/src/main/resources/README.txt
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/resources/README.txt?rev=1144342&view=auto
==============================================================================
--- incubator/stanbol/trunk/commons/solr/src/main/resources/README.txt (added)
+++ incubator/stanbol/trunk/commons/solr/src/main/resources/README.txt Fri Jul
8 14:39:40 2011
@@ -0,0 +1,41 @@
+The "solr" directory includes the default configuration of an Solr Server used
+with the SolrYard configuration.
+
+To use this configuration override the default configuration that comes with
+the solr server by this one.
+
+This default configuration uses a multi-core configuration with three
predefined
+cores. Note however that the SolrYard does not require a multi core
+configuration.
+
+For some notes about the predefined cores see the notes within the solr.xml
+
+To add additional Cores one need to add a core within the solr.xml and create
+the directory with the configuration.
+
+Precomputed Indices (e.g. for dbpedia) will be distributed in archive
containing
+the configuration and the data of the Solr Index. This can be used as
+configuration for a Solr Server or can be configured as an additional core for
+an existing Solr Server using a multi-core configuration.
+
+Even when using an EmbeddedSolrServer the file structure need to be the same.
+
+
+Configuration of the Solr index (or a Core)
+
+For detailed information please see the Solr documentation.
+For the customisation of the Solr Server (Core) configuration the schema.xml
+and the solrconf.xml are central.
+
+Solr Schema (schema.xml)
+
+see comments within the shema.xml for more information on how to
+change/optimize the Solr schema used by the SolrYard.
+
+
+SolrServer (core) configuration (solrconf.xml)
+
+The solrconfig.xml provided with this default configuration is the same
+as used by the default installation of the SolrServer.
+See the documentation of Solr for possibility to improve search performance.
+See http://wiki.apache.org/solr/SolrConfigXml for more infos
Propchange: incubator/stanbol/trunk/commons/solr/src/main/resources/README.txt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
incubator/stanbol/trunk/commons/solr/src/main/resources/solr/conf/solr.xml
URL:
http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/solr/src/main/resources/solr/conf/solr.xml?rev=1144342&view=auto
==============================================================================
--- incubator/stanbol/trunk/commons/solr/src/main/resources/solr/conf/solr.xml
(added)
+++ incubator/stanbol/trunk/commons/solr/src/main/resources/solr/conf/solr.xml
Fri Jul 8 14:39:40 2011
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ 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.
+-->
+
+<!--
+ SolrYard Configuration for the internally managed Embedded SolrServer:
+
+ By default no cores are defined by this configuration because they are added
+ at runtime via the Java API
+-->
+<solr persistent="true">
+ <cores adminPath="/admin/cores">
+ <!-- Cores are added dynamically at runtime -->
+ </cores>
+</solr>
Propchange:
incubator/stanbol/trunk/commons/solr/src/main/resources/solr/conf/solr.xml
------------------------------------------------------------------------------
svn:mime-type = text/plain
