org.apache.solr.core

Class SolrResourceLoader

java.lang.Object

org.apache.solr.core.SolrResourceLoader

All Implemented Interfaces:

Closeable, AutoCloseable, ResourceLoader, SolrClassLoader, SolrCoreAware

Direct Known Subclasses:

ZkSolrResourceLoader

public class SolrResourceLoader
extends Object
implements ResourceLoader, Closeable, SolrClassLoader, SolrCoreAware

Since:

solr 1.3

Field Summary

Fields

Modifier and Type	Field and Description
protected URLClassLoader	classLoader
static String	USER_FILES_DIRECTORY Deprecated.

Constructor Summary

Constructors

Constructor and Description
SolrResourceLoader() Deprecated. Use new SolrResourceLoader(Path)
SolrResourceLoader(Path instanceDir) Creates a loader.
SolrResourceLoader(Path instanceDir, ClassLoader parent)
SolrResourceLoader(Path instanceDir, ClassLoader parent, Properties properties) Deprecated.
SolrResourceLoader(String name, List<Path> classpath, Path instanceDir, ClassLoader parent) Creates a loader.

Method Summary

Modifier and Type	Method and Description
<T> boolean	addToCoreAware(T obj) the inform() callback should be invoked on the listener.
<T> void	addToInfoBeans(T obj)
<T> boolean	addToResourceLoaderAware(T obj)
static Class	assertAwareCompatibility(Class aware, Object obj) Utility function to throw an exception if the class is invalid
void	close()
<T> Class<? extends T>	findClass(PluginInfo info, Class<T> type, boolean registerCoreReloadListener) Load a class using an appropriate SolrResourceLoader depending of the package on that class
<T> Class<? extends T>	findClass(String cname, Class<T> expectedType)
<T> Class<? extends T>	findClass(String cname, Class<T> expectedType, String... subpackages) This method loads a class either with its FQN or a short-name (solr.class-simplename or class-simplename).
ClassLoader	getClassLoader() EXPERT
String	getConfigDir()
CoreContainer	getCoreContainer()
Properties	getCoreProperties() Deprecated.
String	getDataDir() Deprecated.
static List<URL>	getFilteredURLs(Path libDir, String regex) Utility method to get the URLs of all paths under a given directory that match a regex
List<SolrInfoBean>	getInfoMBeans()
Path	getInstancePath()
List<String>	getLines(String resource) Accesses a resource by name and returns the (non comment) lines containing data.
List<String>	getLines(String resource, Charset charset)
List<String>	getLines(String resource, String encoding) Accesses a resource by name and returns the (non comment) lines containing data using the given character encoding.
RestManager.Registry	getManagedResourceRegistry()
SolrClassLoader	getSchemaLoader()
SolrConfig	getSolrConfig()
static List<URL>	getURLs(Path libDir) Utility method to get the URLs of all paths under a given directory
static List<URL>	getURLs(Path libDir, DirectoryStream.Filter<Path> filter) Utility method to get the URLs of all paths under a given directory that match a filter
void	inform(Map<String,SolrInfoBean> infoRegistry) Register any SolrInfoBeans
void	inform(ResourceLoader loader) Tell all ResourceLoaderAware instances about the loader
void	inform(SolrCore core) Tell all SolrCoreAware instances about the SolrCore
static void	informAware(ResourceLoader loader, ResourceLoaderAware aware) Set the current ResourceLoaderAware object in thread local so that appropriate classloader can be used for package loaded classes
String[]	listConfigDir() Deprecated.
static Path	locateSolrHome() Deprecated.
<T> T	newInstance(PluginInfo info, Class<T> type, boolean registerCoreReloadListener) Create a n instance of a class using an appropriate SolrResourceLoader depending on the package of that class
<T> T	newInstance(String name, Class<T> expectedType)
<T> T	newInstance(String cname, Class<T> expectedType, String... subpackages)
<T> T	newInstance(String cName, Class<T> expectedType, String[] subPackages, Class[] params, Object[] args)
static String	normalizeDir(String path) Deprecated.
InputStream	openConfig(String name) Deprecated.
InputStream	openResource(String resource) Opens any resource by its name.
InputStream	openSchema(String name) Deprecated.
static void	persistConfLocally(SolrResourceLoader loader, String resourceName, byte[] content)
String	resourceLocation(String resource) Report the location of a resource found by the resource loader

Methods inherited from class java.lang.Object

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

Field Detail

classLoader

protected URLClassLoader classLoader

USER_FILES_DIRECTORY

@Deprecated
public static final String USER_FILES_DIRECTORY

Deprecated.

See Also:

Constant Field Values

Constructor Detail

SolrResourceLoader

@Deprecated
public SolrResourceLoader()

Deprecated. Use new SolrResourceLoader(Path)

See Also:

CoreContainer.getSolrHome()

SolrResourceLoader

public SolrResourceLoader(String name,
                          List<Path> classpath,
                          Path instanceDir,
                          ClassLoader parent)

Creates a loader. Note: we do NOT call reloadLuceneSPI(). (Behavior when instanceDir is null is un-specified, in future versions this will fail due to NPE)

SolrResourceLoader

public SolrResourceLoader(Path instanceDir)

Creates a loader. (Behavior when instanceDir is null is un-specified, in future versions this will fail due to NPE)

SolrResourceLoader

public SolrResourceLoader(Path instanceDir,
                          ClassLoader parent)

SolrResourceLoader

@Deprecated
public SolrResourceLoader(Path instanceDir,
                                      ClassLoader parent,
                                      Properties properties)

Deprecated.

Parameters:

instanceDir - - base directory for this resource loader, if null locateSolrHome() will be used. (in future versions this will fail due to NPE)

See Also:

SolrPaths.locateSolrHome()

Method Detail

getManagedResourceRegistry

public RestManager.Registry getManagedResourceRegistry()

getSchemaLoader

public SolrClassLoader getSchemaLoader()

getURLs

public static List<URL> getURLs(Path libDir,
                                DirectoryStream.Filter<Path> filter)
                         throws IOException

Utility method to get the URLs of all paths under a given directory that match a filter

Parameters:

libDir - the root directory

filter - the filter

Returns:

all matching URLs

Throws:

IOException - on error

getURLs

public static List<URL> getURLs(Path libDir)
                         throws IOException

Utility method to get the URLs of all paths under a given directory

Parameters:

libDir - the root directory

Returns:

all subdirectories as URLs

Throws:

IOException - on error

getFilteredURLs

public static List<URL> getFilteredURLs(Path libDir,
                                        String regex)
                                 throws IOException

Utility method to get the URLs of all paths under a given directory that match a regex

Parameters:

libDir - the root directory

regex - the regex as a String

Returns:

all matching URLs

Throws:

IOException - on error

normalizeDir

@Deprecated
public static String normalizeDir(String path)

Deprecated.

Ensures a directory name always ends with a '/'.

listConfigDir

@Deprecated
public String[] listConfigDir()

Deprecated.

getConfigDir

public String getConfigDir()

getDataDir

@Deprecated
public String getDataDir()

Deprecated.

getCoreProperties

@Deprecated
public Properties getCoreProperties()

Deprecated.

getClassLoader

public ClassLoader getClassLoader()

EXPERT

The underlying class loader. Most applications will not need to use this.

Returns:

The ClassLoader

openSchema

@Deprecated
public InputStream openSchema(String name)
                                   throws IOException

Deprecated.

Opens a schema resource by its name. Override this method to customize loading schema resources.

Returns:

the stream for the named schema

Throws:

IOException

openConfig

@Deprecated
public InputStream openConfig(String name)
                                   throws IOException

Deprecated.

Opens a config resource by its name. Override this method to customize loading config resources.

Returns:

the stream for the named configuration

Throws:

IOException

openResource

public InputStream openResource(String resource)
                         throws IOException

Opens any resource by its name. By default, this will look in multiple locations to load the resource: $configDir/$resource (if resource is not absolute) $CWD/$resource otherwise, it will look for it in any jar accessible through the class loader. Override this method to customize loading resources.

Specified by:

openResource in interface ResourceLoader

Returns:

the stream for the named resource

Throws:

IOException

resourceLocation

public String resourceLocation(String resource)

Report the location of a resource found by the resource loader

getLines

public List<String> getLines(String resource)
                      throws IOException

Accesses a resource by name and returns the (non comment) lines containing data.

A comment line is any line that starts with the character "#"

Returns:

a list of non-blank non-comment lines with whitespace trimmed from front and back.

Throws:

IOException - If there is a low-level I/O error.

getLines

public List<String> getLines(String resource,
                             String encoding)
                      throws IOException

Accesses a resource by name and returns the (non comment) lines containing data using the given character encoding.

A comment line is any line that starts with the character "#"

Parameters:

resource - the file to be read

Returns:

a list of non-blank non-comment lines with whitespace trimmed

Throws:

IOException - If there is a low-level I/O error.

getLines

public List<String> getLines(String resource,
                             Charset charset)
                      throws IOException

Throws:

IOException

findClass

public <T> Class<? extends T> findClass(String cname,
                                        Class<T> expectedType)

Specified by:

findClass in interface ResourceLoader

Specified by:

findClass in interface SolrClassLoader

findClass

public <T> Class<? extends T> findClass(String cname,
                                        Class<T> expectedType,
                                        String... subpackages)

This method loads a class either with its FQN or a short-name (solr.class-simplename or class-simplename). It tries to load the class with the name that is given first and if it fails, it tries all the known solr packages. This method caches the FQN of a short-name in a static map in-order to make subsequent lookups for the same class faster. The caching is done only if the class is loaded by the webapp classloader and it is loaded using a shortname.

Parameters:

cname - The name or the short name of the class.

subpackages - the packages to be tried if the cname starts with solr.

Returns:

the loaded class. An exception is thrown if it fails

newInstance

public <T> T newInstance(String name,
                         Class<T> expectedType)

Specified by:

newInstance in interface ResourceLoader

newInstance

public <T> T newInstance(String cname,
                         Class<T> expectedType,
                         String... subpackages)

Specified by:

newInstance in interface SolrClassLoader

newInstance

public <T> T newInstance(String cName,
                         Class<T> expectedType,
                         String[] subPackages,
                         Class[] params,
                         Object[] args)

Specified by:

newInstance in interface SolrClassLoader

addToInfoBeans

public <T> void addToInfoBeans(T obj)

addToResourceLoaderAware

public <T> boolean addToResourceLoaderAware(T obj)

addToCoreAware

public <T> boolean addToCoreAware(T obj)

the inform() callback should be invoked on the listener. If this is 'live', the callback is not called so currently this returns 'false'

inform

public void inform(SolrCore core)

Tell all SolrCoreAware instances about the SolrCore

Specified by:

inform in interface SolrCoreAware

inform

public void inform(ResourceLoader loader)
            throws IOException

Tell all ResourceLoaderAware instances about the loader

Throws:

IOException

informAware

public static void informAware(ResourceLoader loader,
                               ResourceLoaderAware aware)
                        throws IOException

Set the current ResourceLoaderAware object in thread local so that appropriate classloader can be used for package loaded classes

Throws:

IOException

inform

public void inform(Map<String,SolrInfoBean> infoRegistry)

Register any SolrInfoBeans

Parameters:

infoRegistry - The Info Registry

locateSolrHome

@Deprecated
public static Path locateSolrHome()

Deprecated.

See SolrPaths.locateSolrHome().

getInstancePath

public Path getInstancePath()

Returns:

the instance path for this resource loader

assertAwareCompatibility

public static Class assertAwareCompatibility(Class aware,
                                             Object obj)

Utility function to throw an exception if the class is invalid

getCoreContainer

public CoreContainer getCoreContainer()

getSolrConfig

public SolrConfig getSolrConfig()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getInfoMBeans

public List<SolrInfoBean> getInfoMBeans()

findClass

public <T> Class<? extends T> findClass(PluginInfo info,
                                        Class<T> type,
                                        boolean registerCoreReloadListener)

Load a class using an appropriate SolrResourceLoader depending of the package on that class

Parameters:

registerCoreReloadListener - register a listener for the package and reload the core if the package is changed. Use this sparingly. This will result in core reloads across all the cores in all collections using this configset

newInstance

public <T> T newInstance(PluginInfo info,
                         Class<T> type,
                         boolean registerCoreReloadListener)

Create a n instance of a class using an appropriate SolrResourceLoader depending on the package of that class

Parameters:

registerCoreReloadListener - register a listener for the package and reload the core if the package is changed. Use this sparingly. This will result in core reloads across all the cores in all collections using this configset

persistConfLocally

public static void persistConfLocally(SolrResourceLoader loader,
                                      String resourceName,
                                      byte[] content)