Package org.apache.solr.pkg

Class PackageListeningClassLoader

java.lang.Object

org.apache.solr.pkg.PackageListeningClassLoader

All Implemented Interfaces:

SolrClassLoader, PackageListeners.Listener

public class PackageListeningClassLoader
extends Object
implements SolrClassLoader, PackageListeners.Listener

A SolrClassLoader that is designed to listen to a set of packages. This class registers a listener for each package that is loaded through this. If any of those packages are updated, the onReload runnable is run

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.pkg.PackageListeners.Listener

PackageListeners.Listener.Ctx

Constructor Summary

Constructors

Constructor	Description
PackageListeningClassLoader(CoreContainer coreContainer, SolrClassLoader fallbackClassLoader, Function<String,String> pkgVersionSupplier, Runnable onReload)

Method Summary

Modifier and Type	Method	Description
void	changed(PackageLoader.Package pkg, PackageListeners.Listener.Ctx ctx)	A callback when the package is updated
protected void	doReloadAction(PackageListeners.Listener.Ctx ctx)
<T> Class<? extends T>	findClass(String cname, Class<T> expectedType)
PackageLoader.Package.Version	findPackageVersion(PluginInfo.ClassName cName, boolean registerListener)	This looks up for package and also listens for that package if required
MapWriter	getPackageVersion(PluginInfo.ClassName cName)
<T> T	newInstance(String cname, Class<T> expectedType, String... subpackages)
<T> T	newInstance(String cname, Class<T> expectedType, String[] subPackages, Class<?>[] params, Object[] args)
Map<String,PackageAPI.PkgVersion>	packageDetails()	fetch the package versions of class names
String	packageName()	Name of the package or null to listen to all package changes

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageListeningClassLoader

public PackageListeningClassLoader(CoreContainer coreContainer,
                                   SolrClassLoader fallbackClassLoader,
                                   Function<String,String> pkgVersionSupplier,
                                   Runnable onReload)

Parameters:

fallbackClassLoader - The SolrClassLoader to use if no package is specified

pkgVersionSupplier - Get the version configured for a given package

onReload - The callback function that should be run if a package is updated

Method Detail

newInstance

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

Specified by:

newInstance in interface SolrClassLoader

findPackageVersion

public PackageLoader.Package.Version findPackageVersion(PluginInfo.ClassName cName,
                                                        boolean registerListener)

This looks up for package and also listens for that package if required

Parameters:

cName - The class name

getPackageVersion

public MapWriter getPackageVersion(PluginInfo.ClassName cName)

Specified by:

getPackageVersion in interface PackageListeners.Listener

newInstance

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

Specified by:

newInstance in interface SolrClassLoader

findClass

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

Specified by:

findClass in interface SolrClassLoader

packageName

public String packageName()

Description copied from interface: PackageListeners.Listener

Name of the package or null to listen to all package changes

Specified by:

packageName in interface PackageListeners.Listener

packageDetails

public Map<String,PackageAPI.PkgVersion> packageDetails()

Description copied from interface: PackageListeners.Listener

fetch the package versions of class names

Specified by:

packageDetails in interface PackageListeners.Listener

changed

public void changed(PackageLoader.Package pkg,
                    PackageListeners.Listener.Ctx ctx)

Description copied from interface: PackageListeners.Listener

A callback when the package is updated

Specified by:

changed in interface PackageListeners.Listener

doReloadAction

protected void doReloadAction(PackageListeners.Listener.Ctx ctx)