Package org.apache.solr.core

Class FileSystemConfigSetService

java.lang.Object

org.apache.solr.core.ConfigSetService

org.apache.solr.core.FileSystemConfigSetService

public class FileSystemConfigSetService
extends ConfigSetService

FileSystem ConfigSetService impl.

Loads a ConfigSet defined by the core's configSet property, looking for a directory named for the configSet property value underneath a base directory. If no configSet property is set, loads the ConfigSet instead from the core's instance directory.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.core.ConfigSetService

ConfigSetService.ConfigResource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_FILE	.metadata.json hidden file where metadata is stored

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

parentLoader, UPLOAD_FILENAME_EXCLUDE_PATTERN, UPLOAD_FILENAME_EXCLUDE_REGEX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileSystemConfigSetService(Path configSetBase)	Testing purpose
	FileSystemConfigSetService(CoreContainer cc)

Method Summary

Modifier and Type	Method	Description
boolean	checkConfigExists(String configName)	Check whether a config exists
String	configSetName(CoreDescriptor cd)	Return a name for the ConfigSet for a core to be used for printing/diagnostic purposes.
void	copyConfig(String fromConfig, String toConfig)	Copy a config
SolrResourceLoader	createCoreResourceLoader(CoreDescriptor cd)	Create a SolrResourceLoader for a core
void	deleteConfig(String configName)	Delete a config (recursively deletes its files if not empty)
void	deleteFilesFromConfig(String configName, List<String> filesToDelete)	Delete files in config
void	downloadConfig(String configName, Path dest)	Download all files from this config to the filesystem at dir
byte[]	downloadFileFromConfig(String configName, String fileName)	Download a file from config If the file does not exist, it returns null
List<String>	getAllConfigFiles(String configName)	Get the names of the files in config including dirs (mutable, non-null) sorted lexicographically e.g.
protected Path	getConfigDir(String configName)
Map<String,Object>	getConfigMetadata(String configName)	Get the config metadata (mutable, non-null)
Long	getCurrentSchemaModificationVersion(String configSet, SolrConfig solrConfig, String schemaFileName)	Returns a modification version for the schema file.
List<String>	listConfigs()	List the names of configs (non-null)
protected Path	locateInstanceDir(CoreDescriptor cd)
void	setConfigMetadata(String configName, Map<String,Object> data)	Set the config metadata If config does not exist, it will be created and set metadata on it Else metadata will be replaced with the provided metadata
void	uploadConfig(String configName, Path source)	Upload files from a given path to config
void	uploadFileToConfig(String configName, String fileName, byte[] data, boolean overwriteOnExists)	Upload a file to config If file does not exist, it will be uploaded If overwriteOnExists is set to true then file will be overwritten

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

createConfigSetService, createIndexSchema, createSolrConfig, getConfigsetPath, getDefaultConfigDirPath, loadConfigSet, loadConfigSetFlags, loadConfigSetProperties

Methods inherited from class java.lang.Object

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

Field Details

METADATA_FILE

public static final String METADATA_FILE

.metadata.json hidden file where metadata is stored

See Also:

• Constant Field Values

Constructor Details

FileSystemConfigSetService

public FileSystemConfigSetService(CoreContainer cc)

FileSystemConfigSetService

protected FileSystemConfigSetService(Path configSetBase)

Testing purpose

Method Details

createCoreResourceLoader

public SolrResourceLoader createCoreResourceLoader(CoreDescriptor cd)

Description copied from class: ConfigSetService

Create a SolrResourceLoader for a core

Specified by:

createCoreResourceLoader in class ConfigSetService

Parameters:

cd - the core's CoreDescriptor

Returns:

a SolrResourceLoader

configSetName

public String configSetName(CoreDescriptor cd)

Description copied from class: ConfigSetService

Return a name for the ConfigSet for a core to be used for printing/diagnostic purposes.

Specified by:

configSetName in class ConfigSetService

Parameters:

cd - the core's CoreDescriptor

Returns:

a name for the core's ConfigSet

checkConfigExists

public boolean checkConfigExists(String configName)
                          throws IOException

Description copied from class: ConfigSetService

Check whether a config exists

Specified by:

checkConfigExists in class ConfigSetService

Parameters:

configName - the config to check if it exists

Returns:

whether the config exists or not

Throws:

IOException

deleteConfig

public void deleteConfig(String configName)
                  throws IOException

Description copied from class: ConfigSetService

Delete a config (recursively deletes its files if not empty)

Specified by:

deleteConfig in class ConfigSetService

Parameters:

configName - the config to delete

Throws:

IOException

deleteFilesFromConfig

public void deleteFilesFromConfig(String configName,
 List<String> filesToDelete)
                           throws IOException

Description copied from class: ConfigSetService

Delete files in config

Specified by:

deleteFilesFromConfig in class ConfigSetService

Parameters:

configName - the name of the config

filesToDelete - a list of file paths to delete using '/' as file path separator

Throws:

IOException

copyConfig

public void copyConfig(String fromConfig,
 String toConfig)
                throws IOException

Description copied from class: ConfigSetService

Copy a config

Specified by:

copyConfig in class ConfigSetService

Parameters:

fromConfig - the config to copy from

toConfig - the config to copy to

Throws:

IOException

uploadConfig

public void uploadConfig(String configName,
 Path source)
                  throws IOException

Description copied from class: ConfigSetService

Upload files from a given path to config

Specified by:

uploadConfig in class ConfigSetService

Parameters:

configName - the config name

source - Path to the files

Throws:

IOException - if an I/O error occurs or the path does not exist

uploadFileToConfig

public void uploadFileToConfig(String configName,
 String fileName,
 byte[] data,
 boolean overwriteOnExists)
                        throws IOException

Description copied from class: ConfigSetService

Upload a file to config If file does not exist, it will be uploaded If overwriteOnExists is set to true then file will be overwritten

Specified by:

uploadFileToConfig in class ConfigSetService

Parameters:

configName - the name to give the config

fileName - the name of the file with '/' used as the file path separator

data - the content of the file

overwriteOnExists - if true then file will be overwritten

Throws:

IOException

setConfigMetadata

public void setConfigMetadata(String configName,
 Map<String,Object> data)
                       throws IOException

Description copied from class: ConfigSetService

Set the config metadata If config does not exist, it will be created and set metadata on it Else metadata will be replaced with the provided metadata

Specified by:

setConfigMetadata in class ConfigSetService

Parameters:

configName - the config name

data - the metadata to be set on config

Throws:

IOException

getConfigMetadata

public Map<String,Object> getConfigMetadata(String configName)
                                     throws IOException

Description copied from class: ConfigSetService

Get the config metadata (mutable, non-null)

Specified by:

getConfigMetadata in class ConfigSetService

Parameters:

configName - the config name

Returns:

the config metadata

Throws:

IOException

downloadConfig

public void downloadConfig(String configName,
 Path dest)
                    throws IOException

Description copied from class: ConfigSetService

Download all files from this config to the filesystem at dir

Specified by:

downloadConfig in class ConfigSetService

Parameters:

configName - the config to download

dest - the Path to write files under

Throws:

IOException

listConfigs

public List<String> listConfigs()
                         throws IOException

Description copied from class: ConfigSetService

List the names of configs (non-null)

Specified by:

listConfigs in class ConfigSetService

Returns:

list of config names

Throws:

IOException

downloadFileFromConfig

public byte[] downloadFileFromConfig(String configName,
 String fileName)
                              throws IOException

Description copied from class: ConfigSetService

Download a file from config If the file does not exist, it returns null

Specified by:

downloadFileFromConfig in class ConfigSetService

Parameters:

configName - the name of the config

fileName - the file to download with '/' as the separator

Returns:

the content of the file

Throws:

IOException

getAllConfigFiles

public List<String> getAllConfigFiles(String configName)
                               throws IOException

Description copied from class: ConfigSetService

Get the names of the files in config including dirs (mutable, non-null) sorted lexicographically e.g. solrconfig.xml, lang/, lang/stopwords_en.txt

Specified by:

getAllConfigFiles in class ConfigSetService

Parameters:

configName - the config name

Returns:

list of file name paths in the config with '/' uses as file path separators

Throws:

IOException

locateInstanceDir

protected Path locateInstanceDir(CoreDescriptor cd)

getCurrentSchemaModificationVersion

public Long getCurrentSchemaModificationVersion(String configSet,
 SolrConfig solrConfig,
 String schemaFileName)

Description copied from class: ConfigSetService

Returns a modification version for the schema file. Null may be returned if not known, and if so it defeats schema caching.

Specified by:

getCurrentSchemaModificationVersion in class ConfigSetService

getConfigDir

protected Path getConfigDir(String configName)
                     throws IOException

Throws:

IOException