Package org.apache.solr.core

Class TransientSolrCoreCacheDefault

java.lang.Object

org.apache.solr.core.TransientSolrCoreCache

org.apache.solr.core.TransientSolrCoreCacheDefault

public class TransientSolrCoreCacheDefault
extends TransientSolrCoreCache

Cache of the most frequently accessed transient cores. Keeps track of all the registered transient cores descriptors, including the cores in the cache as well as all the others.

Field Summary

Fields

Modifier and Type	Field	Description
protected CoreContainer	coreContainer
protected com.github.benmanes.caffeine.cache.Cache<String,SolrCore>	transientCores	"Lazily loaded" cores cache with limited size.
protected Map<String,CoreDescriptor>	transientDescriptors	Unlimited map of all the descriptors for all the registered transient cores, including the cores in the transientCores as well as all the others.

Constructor Summary

Constructors

Constructor	Description
TransientSolrCoreCacheDefault(CoreContainer coreContainer)

Method Summary

Modifier and Type	Method	Description
SolrCore	addCore(String name, SolrCore core)	Adds the newly-opened core to the list of open cores.
void	addTransientDescriptor(String rawName, CoreDescriptor cd)	Adds a new CoreDescriptor.
boolean	containsCore(String name)	Returns whether the cache contains the named core.
Set<String>	getAllCoreNames()	Returns the names of all possible cores, whether they are currently loaded or not.
CoreContainer	getContainer()	Gets the core container that encloses this cache.
SolrCore	getCore(String name)	Gets the core associated with the name.
Set<String>	getLoadedCoreNames()	Returns the names of all currently loaded cores.
int	getStatus(String coreName)	Gets a custom status for the given core name.
CoreDescriptor	getTransientDescriptor(String name)	Gets the CoreDescriptor for a transient core (loaded or unloaded).
Collection<CoreDescriptor>	getTransientDescriptors()	Gets the CoreDescriptor for all transient cores (loaded and unloaded).
Collection<SolrCore>	prepareForShutdown()	This method will be called when the container is to be shut down.
SolrCore	removeCore(String name)	Removes a core from the internal structures, presumably it being closed.
CoreDescriptor	removeTransientDescriptor(String name)	Removes a CoreDescriptor from the list of transient cores descriptors.
void	setStatus(String coreName, int status)	Sets a custom status for the given core name.

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

close

Methods inherited from class java.lang.Object

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

Field Detail

coreContainer

protected final CoreContainer coreContainer

transientCores

protected final com.github.benmanes.caffeine.cache.Cache<String,SolrCore> transientCores

"Lazily loaded" cores cache with limited size. When the max size is reached, the least accessed core is evicted to make room for a new core.

transientDescriptors

protected final Map<String,CoreDescriptor> transientDescriptors

Unlimited map of all the descriptors for all the registered transient cores, including the cores in the transientCores as well as all the others.

Constructor Detail

TransientSolrCoreCacheDefault

public TransientSolrCoreCacheDefault(CoreContainer coreContainer)

Parameters:

coreContainer - The enclosing CoreContainer.

Method Detail

prepareForShutdown

public Collection<SolrCore> prepareForShutdown()

Description copied from class: TransientSolrCoreCache

This method will be called when the container is to be shut down. It returns all transient solr cores and clear any internal structures that hold them.

Specified by:

prepareForShutdown in class TransientSolrCoreCache

getContainer

public CoreContainer getContainer()

Description copied from class: TransientSolrCoreCache

Gets the core container that encloses this cache.

Specified by:

getContainer in class TransientSolrCoreCache

addCore

public SolrCore addCore(String name,
                        SolrCore core)

Description copied from class: TransientSolrCoreCache

Adds the newly-opened core to the list of open cores.

Specified by:

addCore in class TransientSolrCoreCache

getAllCoreNames

public Set<String> getAllCoreNames()

Description copied from class: TransientSolrCoreCache

Returns the names of all possible cores, whether they are currently loaded or not.

Specified by:

getAllCoreNames in class TransientSolrCoreCache

getLoadedCoreNames

public Set<String> getLoadedCoreNames()

Description copied from class: TransientSolrCoreCache

Returns the names of all currently loaded cores.

Specified by:

getLoadedCoreNames in class TransientSolrCoreCache

removeCore

public SolrCore removeCore(String name)

Description copied from class: TransientSolrCoreCache

Removes a core from the internal structures, presumably it being closed. If the core is re-opened, it will be re-added by CoreContainer.

Specified by:

removeCore in class TransientSolrCoreCache

getCore

public SolrCore getCore(String name)

Description copied from class: TransientSolrCoreCache

Gets the core associated with the name. Returns null if there is none.

Specified by:

getCore in class TransientSolrCoreCache

containsCore

public boolean containsCore(String name)

Description copied from class: TransientSolrCoreCache

Returns whether the cache contains the named core.

Specified by:

containsCore in class TransientSolrCoreCache

addTransientDescriptor

public void addTransientDescriptor(String rawName,
                                   CoreDescriptor cd)

Description copied from class: TransientSolrCoreCache

Adds a new CoreDescriptor. This method will only be called during core discovery at startup.

Specified by:

addTransientDescriptor in class TransientSolrCoreCache

getTransientDescriptor

public CoreDescriptor getTransientDescriptor(String name)

Description copied from class: TransientSolrCoreCache

Gets the CoreDescriptor for a transient core (loaded or unloaded). This method is used when opening cores and the like. If you want to change a core's descriptor, override this method and return the current core descriptor.

Specified by:

getTransientDescriptor in class TransientSolrCoreCache

getTransientDescriptors

public Collection<CoreDescriptor> getTransientDescriptors()

Description copied from class: TransientSolrCoreCache

Gets the CoreDescriptor for all transient cores (loaded and unloaded).

Specified by:

getTransientDescriptors in class TransientSolrCoreCache

removeTransientDescriptor

public CoreDescriptor removeTransientDescriptor(String name)

Description copied from class: TransientSolrCoreCache

Removes a CoreDescriptor from the list of transient cores descriptors.

Specified by:

removeTransientDescriptor in class TransientSolrCoreCache

getStatus

public int getStatus(String coreName)

Description copied from class: TransientSolrCoreCache

Gets a custom status for the given core name. Allows custom implementations to communicate arbitrary information as necessary.

Specified by:

getStatus in class TransientSolrCoreCache

setStatus

public void setStatus(String coreName,
                      int status)

Description copied from class: TransientSolrCoreCache

Sets a custom status for the given core name. Allows custom implementations to communicate arbitrary information as necessary.

Specified by:

setStatus in class TransientSolrCoreCache