org.apache.solr.core

Class SolrConfig

java.lang.Object

org.apache.solr.core.Config

org.apache.solr.core.SolrConfig

public class SolrConfig
extends Config

Provides a static reference to a Config object modeling the main configuration data for a a Solr instance -- typically found in "solrconfig.xml".

Version:

$Id: SolrConfig.java 1305693 2012-03-27 00:43:47Z janhoy $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrConfig.HttpCachingConfig
static class	SolrConfig.JmxConfiguration
static class	SolrConfig.UpdateHandlerInfo

Field Summary

Fields

Modifier and Type	Field and Description
int	booleanQueryMaxClauseCount
static SolrConfig	config Deprecated. Use SolrCore.getSolrConfig() instead.
protected java.lang.String	dataDir
static java.lang.String	DEFAULT_CONF_FILE
SolrIndexConfig	defaultIndexConfig Deprecated.
CacheConfig	documentCacheConfig
boolean	enableLazyFieldLoading
CacheConfig	fieldValueCacheConfig
CacheConfig	filterCacheConfig
int	hashDocSetMaxSize
float	hashSetInverseLoadFactor
private SolrConfig.HttpCachingConfig	httpCachingConfig
SolrIndexConfig	indexConfig
SolrConfig.JmxConfiguration	jmxConfig
static org.slf4j.Logger	log
org.apache.lucene.util.Version	luceneMatchVersion
SolrIndexConfig	mainIndexConfig Deprecated.
int	maxWarmingSearchers
private NamedList	pingQueryParams Deprecated. Use PingRequestHandler instead.
private java.util.Map<java.lang.String,java.util.List<PluginInfo>>	pluginStore
CacheConfig	queryResultCacheConfig
int	queryResultMaxDocsCached
int	queryResultWindowSize
boolean	reopenReaders
static java.util.Collection<java.lang.Throwable>	severeErrors Deprecated. should simply be removed from code, this funcitonality is handled now by logging from the top-most leve.
boolean	unlockOnStartup
protected SolrConfig.UpdateHandlerInfo	updateHandlerInfo
boolean	useColdSearcher
boolean	useFilterForSortedQuery
CacheConfig[]	userCacheConfigs

Fields inherited from class org.apache.solr.core.Config

xpathFactory

Constructor Summary

Constructors

Constructor and Description
SolrConfig() Creates a default instance from the solrconfig.xml.
SolrConfig(SolrResourceLoader loader, java.lang.String name, org.xml.sax.InputSource is) Creates a configuration instance from a resource loader, a configuration name and a stream.
SolrConfig(java.lang.String name) Creates a configuration instance from a configuration name.
SolrConfig(java.lang.String name, org.xml.sax.InputSource is) Creates a configuration instance from a configuration name and stream.
SolrConfig(java.lang.String instanceDir, java.lang.String name, org.xml.sax.InputSource is) Creates a configuration instance from an instance directory, configuration name and stream.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDataDir()
SolrConfig.HttpCachingConfig	getHttpCachingConfig()
SolrQueryRequest	getPingQueryRequest(SolrCore core) Deprecated. use PingRequestHandler instead
PluginInfo	getPluginInfo(java.lang.String type)
java.util.List<PluginInfo>	getPluginInfos(java.lang.String type) SolrConfig keeps a repository of plugins by the type.
SolrConfig.UpdateHandlerInfo	getUpdateHandlerInfo()
private void	initLibs()
private void	loadPluginInfo(java.lang.Class clazz, java.lang.String tag, boolean requireName, boolean requireClass)
protected SolrConfig.UpdateHandlerInfo	loadUpdatehandlerInfo()
private static NamedList	readPingQueryParams(SolrConfig config)
java.util.List<PluginInfo>	readPluginInfos(java.lang.String tag, boolean requireName, boolean requireClass)

Methods inherited from class org.apache.solr.core.Config

evaluate, findClass, get, get, getBool, getBool, getConfigDir, getDocument, getDouble, getDouble, getFloat, getFloat, getInstanceDir, getInt, getInt, getLines, getLuceneVersion, getLuceneVersion, getName, getNode, getResourceLoader, getResourceName, getVal, getXPath, newInstance, openResource, parseLuceneVersionString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final org.slf4j.Logger log

DEFAULT_CONF_FILE

public static final java.lang.String DEFAULT_CONF_FILE

See Also:

Constant Field Values

config

@Deprecated
public static SolrConfig config

Deprecated. Use SolrCore.getSolrConfig() instead.

Compatibility feature for single-core (pre-solr{215,350} patch); should go away at solr-2.0

severeErrors

@Deprecated
public static final java.util.Collection<java.lang.Throwable> severeErrors

Deprecated. should simply be removed from code, this funcitonality is handled now by logging from the top-most leve.

Singleton keeping track of configuration errors Simply going away in 4.x

booleanQueryMaxClauseCount

public final int booleanQueryMaxClauseCount

filterCacheConfig

public final CacheConfig filterCacheConfig

queryResultCacheConfig

public final CacheConfig queryResultCacheConfig

documentCacheConfig

public final CacheConfig documentCacheConfig

fieldValueCacheConfig

public final CacheConfig fieldValueCacheConfig

userCacheConfigs

public final CacheConfig[] userCacheConfigs

useFilterForSortedQuery

public final boolean useFilterForSortedQuery

queryResultWindowSize

public final int queryResultWindowSize

queryResultMaxDocsCached

public final int queryResultMaxDocsCached

enableLazyFieldLoading

public final boolean enableLazyFieldLoading

reopenReaders

public final boolean reopenReaders

hashSetInverseLoadFactor

public final float hashSetInverseLoadFactor

hashDocSetMaxSize

public final int hashDocSetMaxSize

defaultIndexConfig

@Deprecated
public final SolrIndexConfig defaultIndexConfig

Deprecated.

mainIndexConfig

@Deprecated
public final SolrIndexConfig mainIndexConfig

Deprecated.

indexConfig

public final SolrIndexConfig indexConfig

updateHandlerInfo

protected SolrConfig.UpdateHandlerInfo updateHandlerInfo

pluginStore

private java.util.Map<java.lang.String,java.util.List<PluginInfo>> pluginStore

maxWarmingSearchers

public final int maxWarmingSearchers

unlockOnStartup

public final boolean unlockOnStartup

useColdSearcher

public final boolean useColdSearcher

luceneMatchVersion

public final org.apache.lucene.util.Version luceneMatchVersion

dataDir

protected java.lang.String dataDir

jmxConfig

public final SolrConfig.JmxConfiguration jmxConfig

httpCachingConfig

private final SolrConfig.HttpCachingConfig httpCachingConfig

pingQueryParams

@Deprecated
private final NamedList pingQueryParams

Deprecated. Use PingRequestHandler instead.

ping query request parameters

Constructor Detail

SolrConfig

public SolrConfig()
           throws javax.xml.parsers.ParserConfigurationException,
                  java.io.IOException,
                  org.xml.sax.SAXException

Creates a default instance from the solrconfig.xml.

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

SolrConfig

public SolrConfig(java.lang.String name)
           throws javax.xml.parsers.ParserConfigurationException,
                  java.io.IOException,
                  org.xml.sax.SAXException

Creates a configuration instance from a configuration name. A default resource loader will be created (@see SolrResourceLoader)

Parameters:

name - the configuration name used by the loader

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

SolrConfig

public SolrConfig(java.lang.String name,
                  org.xml.sax.InputSource is)
           throws javax.xml.parsers.ParserConfigurationException,
                  java.io.IOException,
                  org.xml.sax.SAXException

Creates a configuration instance from a configuration name and stream. A default resource loader will be created (@see SolrResourceLoader). If the stream is null, the resource loader will open the configuration stream. If the stream is not null, no attempt to load the resource will occur (the name is not used).

Parameters:

name - the configuration name

is - the configuration stream

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

SolrConfig

public SolrConfig(java.lang.String instanceDir,
                  java.lang.String name,
                  org.xml.sax.InputSource is)
           throws javax.xml.parsers.ParserConfigurationException,
                  java.io.IOException,
                  org.xml.sax.SAXException

Creates a configuration instance from an instance directory, configuration name and stream.

Parameters:

instanceDir - the directory used to create the resource loader

name - the configuration name used by the loader if the stream is null

is - the configuration stream

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

SolrConfig

SolrConfig(SolrResourceLoader loader,
           java.lang.String name,
           org.xml.sax.InputSource is)
    throws javax.xml.parsers.ParserConfigurationException,
           java.io.IOException,
           org.xml.sax.SAXException

Creates a configuration instance from a resource loader, a configuration name and a stream. If the stream is null, the resource loader will open the configuration stream. If the stream is not null, no attempt to load the resource will occur (the name is not used).

Parameters:

loader - the resource loader

name - the configuration name

is - the configuration stream

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

Method Detail

loadUpdatehandlerInfo

protected SolrConfig.UpdateHandlerInfo loadUpdatehandlerInfo()

loadPluginInfo

private void loadPluginInfo(java.lang.Class clazz,
                            java.lang.String tag,
                            boolean requireName,
                            boolean requireClass)

readPluginInfos

public java.util.List<PluginInfo> readPluginInfos(java.lang.String tag,
                                                  boolean requireName,
                                                  boolean requireClass)

getHttpCachingConfig

public SolrConfig.HttpCachingConfig getHttpCachingConfig()

readPingQueryParams

private static NamedList readPingQueryParams(SolrConfig config)

getPingQueryRequest

@Deprecated
public SolrQueryRequest getPingQueryRequest(SolrCore core)

Deprecated. use PingRequestHandler instead

Returns a Request object based on the admin/pingQuery section of the Solr config file.

getUpdateHandlerInfo

public SolrConfig.UpdateHandlerInfo getUpdateHandlerInfo()

getDataDir

public java.lang.String getDataDir()

getPluginInfos

public java.util.List<PluginInfo> getPluginInfos(java.lang.String type)

SolrConfig keeps a repository of plugins by the type. The known interfaces are the types.

Parameters:

type - The key is FQN of the plugin class there are a few known types : SolrFormatter, SolrFragmenter SolrRequestHandler,QParserPlugin, QueryResponseWriter,ValueSourceParser, SearchComponent, QueryConverter, SolrEventListener, DirectoryFactory, IndexDeletionPolicy, IndexReaderFactory

getPluginInfo

public PluginInfo getPluginInfo(java.lang.String type)

initLibs

private void initLibs()