org.opencms.search.solr
Class CmsSolrConfiguration

java.lang.Object
  org.opencms.search.solr.CmsSolrConfiguration

public class CmsSolrConfiguration
extends java.lang.Object

The Solr configuration class.

Since:

8.5.0

Field Summary

static java.lang.String	CONF_FOLDER The 'conf' folder inside the Solr home directory.
static java.lang.String	SOLR_CONFIG_FILE The Solr configuration file name.
static long	SOLR_DEFAULT_COMMIT_MS The default max time in ms before a commit will happen (10 seconds by default).
static java.lang.String	SOLR_HOME_DEFAULT The default name of the Solr home directory.
static java.lang.String	SOLR_HOME_PROPERTY The system property name for the Solr home directory.

Constructor Summary

CmsSolrConfiguration()
Default constructor.

Method Summary

java.lang.String	getHome() Returns the home directory of Solr as String.
java.lang.String	getHomeFolderPath() Returns the configured Solr home.
java.lang.String	getServerUrl() Returns the servers URL if embedded is set to false.
long	getSolrCommitMs() Returns the max time (in ms) before a commit will happen.
org.apache.solr.core.SolrConfig	getSolrConfig() Returns the Solr configuration (object representation of 'solrconfig.xml').
java.io.File	getSolrConfigFile() Returns the solr configuration file, default: 'conf/solrconfig.xml'.
java.io.File	getSolrFile() Returns the Solr xml file, default: 'solr.xml'.
java.lang.String	getSolrFileName() Returns the Solr xml file name, default: 'solr.xml'.
org.apache.solr.schema.IndexSchema	getSolrSchema() Returns the Solr index schema.
java.io.File	getSolrSchemaFile() Returns the Solr index schema file.
boolean	isEnabled() Returns true if the Solr server is embedded, false otherwise.
void	setEnabled(java.lang.String isEnabled) Sets the enabled flag.
void	setHomeFolderPath(java.lang.String homeFolderPath) Sets the home folder for Solr.
void	setServerUrl(java.lang.String url) Sets the external servers URL, should be not null if the embedded falg is false.
void	setSolrCommitMs(java.lang.String time) Sets the max time (in ms) before a commit will happen.
void	setSolrFileName(java.lang.String name) Sets the Solr file name.

Methods inherited from class java.lang.Object

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

Field Detail

CONF_FOLDER

public static final java.lang.String CONF_FOLDER

The 'conf' folder inside the Solr home directory.

SOLR_CONFIG_FILE

public static final java.lang.String SOLR_CONFIG_FILE

The Solr configuration file name.

See Also:

Constant Field Values

SOLR_DEFAULT_COMMIT_MS

public static final long SOLR_DEFAULT_COMMIT_MS

The default max time in ms before a commit will happen (10 seconds by default).

Can be configured in 'opencms-search.xml'.

See Also:

Constant Field Values

SOLR_HOME_DEFAULT

public static final java.lang.String SOLR_HOME_DEFAULT

The default name of the Solr home directory.

SOLR_HOME_PROPERTY

public static final java.lang.String SOLR_HOME_PROPERTY

The system property name for the Solr home directory.

See Also:

Constant Field Values

Constructor Detail

CmsSolrConfiguration

public CmsSolrConfiguration()

Default constructor.

Method Detail

getHome

public java.lang.String getHome()

Returns the home directory of Solr as String.

Returns:

the home directory of Solr as String

getHomeFolderPath

public java.lang.String getHomeFolderPath()

Returns the configured Solr home.

Returns:

the configured Solr home

getServerUrl

public java.lang.String getServerUrl()

Returns the servers URL if embedded is set to false.

Returns:

the external servers URL

getSolrCommitMs

public long getSolrCommitMs()

Returns the max time (in ms) before a commit will happen.

Returns:

the max time (in ms) before a commit will happen

getSolrConfig

public org.apache.solr.core.SolrConfig getSolrConfig()

Returns the Solr configuration (object representation of 'solrconfig.xml').

Returns:

the Solr configuration

getSolrConfigFile

public java.io.File getSolrConfigFile()

Returns the solr configuration file, default: 'conf/solrconfig.xml'.

Returns:

the solr configuration file

getSolrFile

public java.io.File getSolrFile()

Returns the Solr xml file, default: 'solr.xml'.

Returns:

the Solr xml file

getSolrFileName

public java.lang.String getSolrFileName()

Returns the Solr xml file name, default: 'solr.xml'.

Returns:

the Solr xml file name

getSolrSchema

public org.apache.solr.schema.IndexSchema getSolrSchema()

Returns the Solr index schema.

Returns:

the Solr index schema

getSolrSchemaFile

public java.io.File getSolrSchemaFile()

Returns the Solr index schema file.

Returns:

the Solr index schema file

isEnabled

public boolean isEnabled()

Returns true if the Solr server is embedded, false otherwise.

Returns:

true if the Solr server is embedded, false otherwise

setEnabled

public void setEnabled(java.lang.String isEnabled)

Sets the enabled flag.

Parameters:

isEnabled - true, if the Solr server should be used, false otherwise

setHomeFolderPath

public void setHomeFolderPath(java.lang.String homeFolderPath)

Sets the home folder for Solr.

Parameters:

homeFolderPath - the Solr home folder to set

setServerUrl

public void setServerUrl(java.lang.String url)

Sets the external servers URL, should be not null if the embedded falg is false.

Parameters:

url - the URL

setSolrCommitMs

public void setSolrCommitMs(java.lang.String time)

Sets the max time (in ms) before a commit will happen.

Parameters:

time - the time as long value

setSolrFileName

public void setSolrFileName(java.lang.String name)

Sets the Solr file name.

Parameters:

name - the file name to set