org.opencms.search.solr.CmsSolrConfiguration Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* File : $Source$
* Date : $Date$
* Version: $Revision$
*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (C) 2002 - 2009 Alkacon Software (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.search.solr;
import org.opencms.configuration.CmsConfigurationException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.util.CmsStringUtil;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.nio.file.Paths;
import org.apache.commons.logging.Log;
import org.apache.solr.core.SolrConfig;
import org.apache.solr.schema.IndexSchema;
import org.xml.sax.InputSource;
/**
* The Solr configuration class.
*
* @since 8.5.0
*/
public class CmsSolrConfiguration {
/** The default config set path. */
public static final String DEFAULT_CONFIGSET_FOLDER = File.separatorChar
+ "configsets"
+ File.separatorChar
+ "default";
/** The 'conf' folder inside the Solr home directory. */
public static final String CONF_FOLDER = File.separatorChar + "conf" + File.separatorChar;
/** The Solr configuration file name. */
public static final String SOLR_CONFIG_FILE = "solr.xml";
/**
* The default max time in ms before a commit will happen (10 seconds by default).
*
* Can be configured in 'opencms-search.xml'.
*/
public static final long SOLR_DEFAULT_COMMIT_MS = 10000;
/** The default name of the Solr home directory. */
public static final String SOLR_HOME_DEFAULT = "solr" + File.separatorChar;
/** The system property name for the Solr home directory. */
public static final String SOLR_HOME_PROPERTY = "solr.solr.home";
/** The Solr schema name. */
public static final String SOLR_SCHEMA_NAME = "OpenCms SOLR schema";
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsSolrConfiguration.class);
/** Max time (in ms) before a commit will happen. */
private long m_commitMs = SOLR_DEFAULT_COMMIT_MS;
/** Signals whether the server is enabled or disabled. */
private boolean m_enabled;
/** The Solr home. */
private String m_home;
/** The configured path to the Solr home. */
private String m_homeFolderPath;
/** The schema file. */
private IndexSchema m_schema;
/** The servers URL, must be set if embedded is false. */
private String m_serverUrl;
/** The Solr configuration. */
private SolrConfig m_solrConfig;
/** The Solr configuration file "solr.xml". */
private File m_solrFile;
/** The file name of the Solr configuration. */
private String m_solrFileName;
/**
* Default constructor.
*/
public CmsSolrConfiguration() {
// needed for the digester
}
/**
* Returns the home directory of Solr as String.
*
* @return the home directory of Solr as String
*/
public String getHome() {
if (m_homeFolderPath == null) {
if (CmsStringUtil.isNotEmpty(System.getProperty(SOLR_HOME_PROPERTY))) {
m_home = System.getProperty(SOLR_HOME_PROPERTY);
} else {
m_home = OpenCms.getSystemInfo().getAbsoluteRfsPathRelativeToWebInf(SOLR_HOME_DEFAULT);
}
m_home = (m_home.endsWith(File.separator)
? m_home.substring(0, m_home.lastIndexOf(File.separator))
: m_home);
} else {
m_home = m_homeFolderPath;
}
return m_home;
}
/**
* Returns the configured Solr home.
*
* @return the configured Solr home
*/
public String getHomeFolderPath() {
return m_homeFolderPath;
}
/**
* Returns the servers URL if embedded is set to false.
*
* @return the external servers URL
*/
public String getServerUrl() {
return m_serverUrl;
}
/**
* Returns the max time (in ms) before a commit will happen.
*
* @return the max time (in ms) before a commit will happen
*/
public long getSolrCommitMs() {
return m_commitMs;
}
/**
* Returns the Solr configuration (object representation of 'solrconfig.xml').
*
* @return the Solr configuration
*
*/
public SolrConfig getSolrConfig() {
if (m_solrConfig == null) {
try {
InputSource solrConfig = new InputSource(new FileInputStream(getSolrConfigFile()));
m_solrConfig = new SolrConfig(Paths.get(getHome(), DEFAULT_CONFIGSET_FOLDER), null, solrConfig);
} catch (FileNotFoundException e) {
CmsConfigurationException ex = new CmsConfigurationException(
Messages.get().container(Messages.LOG_SOLR_ERR_CONFIG_XML_NOT_FOUND_1, getSolrConfigFile()),
e);
LOG.error(ex.getLocalizedMessage(), ex);
} catch (Exception e) {
CmsConfigurationException ex = new CmsConfigurationException(
Messages.get().container(Messages.LOG_SOLR_ERR_CONFIG_XML_NOT_READABLE_1, getSolrConfigFile()),
e);
LOG.error(ex.getLocalizedMessage(), ex);
}
}
return m_solrConfig;
}
/**
* Returns the solr configuration file, default: 'conf/solrconfig.xml'.
*
* @return the solr configuration file
*/
public File getSolrConfigFile() {
return new File(getHome() + DEFAULT_CONFIGSET_FOLDER + CONF_FOLDER + SolrConfig.DEFAULT_CONF_FILE);
}
/**
* Returns the Solr xml file, default: 'solr.xml'.
*
* @return the Solr xml file
*/
public File getSolrFile() {
if (m_solrFile == null) {
String solrFileName = m_solrFileName != null ? m_solrFileName : SOLR_CONFIG_FILE;
m_solrFile = new File(getHome() + File.separator + solrFileName);
}
return m_solrFile;
}
/**
* Returns the Solr xml file name, default: 'solr.xml'.
*
* @return the Solr xml file name
*/
public String getSolrFileName() {
return m_solrFileName;
}
/**
* Returns the Solr index schema.
*
* @return the Solr index schema
*/
public IndexSchema getSolrSchema() {
if (m_schema == null) {
try {
InputSource solrSchema = new InputSource(new FileInputStream(getSolrSchemaFile()));
m_schema = new IndexSchema(getSolrConfig(), SOLR_SCHEMA_NAME, solrSchema);
} catch (FileNotFoundException e) {
CmsConfigurationException ex = new CmsConfigurationException(
Messages.get().container(
Messages.LOG_SOLR_ERR_SCHEMA_XML_NOT_FOUND_1,
getSolrSchemaFile().getPath()),
e);
LOG.error(ex.getLocalizedMessage(), ex);
}
}
return m_schema;
}
/**
* Returns the Solr index schema file.
*
* @return the Solr index schema file
*/
public File getSolrSchemaFile() {
return new File(getHome() + DEFAULT_CONFIGSET_FOLDER + CONF_FOLDER + IndexSchema.DEFAULT_SCHEMA_FILE);
}
/**
* Returns true if the Solr server is embedded, false otherwise.
*
* @return true if the Solr server is embedded, false otherwise
*/
public boolean isEnabled() {
return m_enabled;
}
/**
* Sets the enabled flag.
*
* @param isEnabled true, if the Solr server should be used, false otherwise
*/
public void setEnabled(String isEnabled) {
m_enabled = Boolean.valueOf(isEnabled).booleanValue();
}
/**
* Sets the home folder for Solr.
*
* @param homeFolderPath the Solr home folder to set
*/
public void setHomeFolderPath(String homeFolderPath) {
m_homeFolderPath = homeFolderPath;
}
/**
* Sets the external servers URL, should be not null if the embedded falg is false.
*
* @param url the URL
*/
public void setServerUrl(String url) {
m_serverUrl = url;
}
/**
* Sets the max time (in ms) before a commit will happen.
*
* @param time the time as long value
*/
public void setSolrCommitMs(String time) {
m_commitMs = new Long(time).longValue();
}
/**
* Sets the Solr file name.
*
* @param name the file name to set
*/
public void setSolrFileName(String name) {
m_solrFileName = name;
}
}