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".

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
protected String	dataDir
static String	DEFAULT_CONF_FILE
SolrIndexConfig	defaultIndexConfig Deprecated.
CacheConfig	documentCacheConfig
boolean	enableLazyFieldLoading
CacheConfig	fieldValueCacheConfig
CacheConfig	filterCacheConfig
int	hashDocSetMaxSize
float	hashSetInverseLoadFactor
SolrIndexConfig	indexConfig
SolrConfig.JmxConfiguration	jmxConfig
static org.slf4j.Logger	log
Version	luceneMatchVersion
SolrIndexConfig	mainIndexConfig Deprecated.
int	maxWarmingSearchers
boolean	nrtMode
CacheConfig	queryResultCacheConfig
int	queryResultMaxDocsCached
int	queryResultWindowSize
boolean	unlockOnStartup
protected SolrConfig.UpdateHandlerInfo	updateHandlerInfo
boolean	useColdSearcher
boolean	useFilterForSortedQuery
CacheConfig[]	userCacheConfigs

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getDataDir()
int	getFormUploadLimitKB()
SolrConfig.HttpCachingConfig	getHttpCachingConfig()
int	getMultipartUploadLimitKB()
PluginInfo	getPluginInfo(String type)
List<PluginInfo>	getPluginInfos(String type) SolrConfig keeps a repository of plugins by the type.
SolrRequestParsers	getRequestParsers()
SolrConfig.UpdateHandlerInfo	getUpdateHandlerInfo()
boolean	isAddHttpRequestToContext()
boolean	isEnableRemoteStreams()
boolean	isHandleSelect()
protected SolrConfig.UpdateHandlerInfo	loadUpdatehandlerInfo()
static SolrConfig	readFromResourceLoader(SolrResourceLoader loader, String name)
List<PluginInfo>	readPluginInfos(String tag, boolean requireName, boolean requireClass)

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

complainAboutUnknownAttributes, evaluate, get, get, getBool, getBool, getDocument, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLuceneVersion, getLuceneVersion, getName, getNode, getNode, getNodeList, getOriginalConfig, getResourceLoader, getResourceName, getUnknownAttributes, getUnsubstitutedNode, getVal, getXPath, parseLuceneVersionString, substituteProperties

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 String DEFAULT_CONF_FILE

See Also:

Constant Field Values

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

nrtMode

public final boolean nrtMode

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

maxWarmingSearchers

public final int maxWarmingSearchers

unlockOnStartup

public final boolean unlockOnStartup

useColdSearcher

public final boolean useColdSearcher

luceneMatchVersion

public final Version luceneMatchVersion

dataDir

protected String dataDir

jmxConfig

public final SolrConfig.JmxConfiguration jmxConfig

Constructor Detail

SolrConfig

public SolrConfig()
           throws ParserConfigurationException,
                  IOException,
                  SAXException

Creates a default instance from the solrconfig.xml.

Throws:

ParserConfigurationException

IOException

SAXException

SolrConfig

public SolrConfig(String name)
           throws ParserConfigurationException,
                  IOException,
                  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:

ParserConfigurationException

IOException

SAXException

SolrConfig

public SolrConfig(String name,
          InputSource is)
           throws ParserConfigurationException,
                  IOException,
                  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:

ParserConfigurationException

IOException

SAXException

SolrConfig

public SolrConfig(String instanceDir,
          String name,
          InputSource is)
           throws ParserConfigurationException,
                  IOException,
                  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:

ParserConfigurationException

IOException

SAXException

SolrConfig

public SolrConfig(SolrResourceLoader loader,
          String name,
          InputSource is)
           throws ParserConfigurationException,
                  IOException,
                  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:

ParserConfigurationException

IOException

SAXException

Method Detail

readFromResourceLoader

public static SolrConfig readFromResourceLoader(SolrResourceLoader loader,
                                String name)

loadUpdatehandlerInfo

protected SolrConfig.UpdateHandlerInfo loadUpdatehandlerInfo()

readPluginInfos

public List<PluginInfo> readPluginInfos(String tag,
                               boolean requireName,
                               boolean requireClass)

getRequestParsers

public SolrRequestParsers getRequestParsers()

getHttpCachingConfig

public SolrConfig.HttpCachingConfig getHttpCachingConfig()

getUpdateHandlerInfo

public SolrConfig.UpdateHandlerInfo getUpdateHandlerInfo()

getDataDir

public String getDataDir()

getPluginInfos

public List<PluginInfo> getPluginInfos(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, TransformerFactory

getPluginInfo

public PluginInfo getPluginInfo(String type)

getMultipartUploadLimitKB

public int getMultipartUploadLimitKB()

getFormUploadLimitKB

public int getFormUploadLimitKB()

isHandleSelect

public boolean isHandleSelect()

isAddHttpRequestToContext

public boolean isAddHttpRequestToContext()

isEnableRemoteStreams

public boolean isEnableRemoteStreams()