Package org.apache.solr.schema

Class ManagedIndexSchemaFactory

java.lang.Object

org.apache.solr.schema.IndexSchemaFactory

org.apache.solr.schema.ManagedIndexSchemaFactory

All Implemented Interfaces:

NamedListInitializedPlugin, SolrCoreAware

@NotThreadSafe
public class ManagedIndexSchemaFactory
extends IndexSchemaFactory
implements SolrCoreAware

Factory for ManagedIndexSchema

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.schema.IndexSchemaFactory

IndexSchemaFactory.VersionedConfig

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_MANAGED_SCHEMA_RESOURCE_NAME
static String	LEGACY_MANAGED_SCHEMA_RESOURCE_NAME
static String	MANAGED_SCHEMA_RESOURCE_NAME
static String	UPGRADED_SCHEMA_EXTENSION

Fields inherited from class org.apache.solr.schema.IndexSchemaFactory

CACHE_MISS_LISTENER

Constructor Summary

Constructors

Constructor	Description
ManagedIndexSchemaFactory()

Method Summary

Modifier and Type	Method	Description
ManagedIndexSchema	create(String resourceName, SolrConfig config, ConfigSetService configSetService)	First, try to locate the managed schema file named in the managedSchemaResourceName param.
SolrConfig	getConfig()
String	getManagedSchemaResourceName()
SolrResourceLoader	getResourceLoader()
ManagedIndexSchema	getSchema()
String	getSchemaResourceName(String cdResourceName)	Returns the resource (file) name that will be used for the schema itself.
Object	getSchemaUpdateLock()
void	inform(SolrCore core)
void	init(org.apache.solr.common.util.NamedList<?> args)	init will be called just once, immediately after creation.
boolean	isMutable()
Path	lookupLocalManagedSchemaPath()	Lookup the path to the managed schema, dealing with falling back to the legacy managed-schema file, instead of the expected managed-schema.xml file if the legacy file exists.
String	lookupZKManagedSchemaPath()	Lookup the path to the managed schema, dealing with falling back to the legacy managed-schema file, instead of the expected managed-schema.xml file if the legacy file exists.
void	setSchema(ManagedIndexSchema schema)

Methods inherited from class org.apache.solr.schema.IndexSchemaFactory

buildIndexSchema, buildIndexSchema, getConfigResource, getFromCache, getParsedSchema, newIndexSchemaFactory

Methods inherited from class java.lang.Object

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

Field Detail

UPGRADED_SCHEMA_EXTENSION

public static final String UPGRADED_SCHEMA_EXTENSION

See Also:

Constant Field Values

DEFAULT_MANAGED_SCHEMA_RESOURCE_NAME

public static final String DEFAULT_MANAGED_SCHEMA_RESOURCE_NAME

See Also:

Constant Field Values

LEGACY_MANAGED_SCHEMA_RESOURCE_NAME

public static final String LEGACY_MANAGED_SCHEMA_RESOURCE_NAME

See Also:

Constant Field Values

MANAGED_SCHEMA_RESOURCE_NAME

public static final String MANAGED_SCHEMA_RESOURCE_NAME

See Also:

Constant Field Values

Constructor Detail

ManagedIndexSchemaFactory

public ManagedIndexSchemaFactory()

Method Detail

getManagedSchemaResourceName

public String getManagedSchemaResourceName()

getResourceLoader

public SolrResourceLoader getResourceLoader()

init

public void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from interface: NamedListInitializedPlugin

init will be called just once, immediately after creation.

Source of the initialization arguments will typically be solrconfig.xml, but will ultimately depends on the plugin itself

Specified by:

init in interface NamedListInitializedPlugin

Parameters:

args - non-null list of initialization parameters (may be empty)

getSchemaResourceName

public String getSchemaResourceName(String cdResourceName)

Description copied from class: IndexSchemaFactory

Returns the resource (file) name that will be used for the schema itself. The answer may be a guess. Do not pass the result of this to IndexSchemaFactory.create(String, SolrConfig, ConfigSetService). The input is the name coming from the CoreDescriptor which acts as a default or asked-for name.

Overrides:

getSchemaResourceName in class IndexSchemaFactory

lookupZKManagedSchemaPath

public String lookupZKManagedSchemaPath()

Lookup the path to the managed schema, dealing with falling back to the legacy managed-schema file, instead of the expected managed-schema.xml file if the legacy file exists.

This method is duplicated in ManagedIndexSchema.

lookupLocalManagedSchemaPath

public Path lookupLocalManagedSchemaPath()

Lookup the path to the managed schema, dealing with falling back to the legacy managed-schema file, instead of the expected managed-schema.xml file if the legacy file exists.

create

public ManagedIndexSchema create(String resourceName,
                                 SolrConfig config,
                                 ConfigSetService configSetService)

First, try to locate the managed schema file named in the managedSchemaResourceName param. If the managed schema file exists and is accessible, it is used to instantiate an IndexSchema.

If the managed schema file can't be found, the resource named by the resourceName parameter is used to instantiate an IndexSchema.

Once the IndexSchema is instantiated, if the managed schema file does not exist, the instantiated IndexSchema is persisted to the managed schema file named in the managedSchemaResourceName param, in the directory given by SolrResourceLoader.getConfigPath(), or if configs are in ZooKeeper, under ZkSolrResourceLoader.getConfigSetZkPath().

After the managed schema file is persisted, the original schema file is renamed by appending the extension named in UPGRADED_SCHEMA_EXTENSION.

Overrides:

create in class IndexSchemaFactory

getSchemaUpdateLock

public Object getSchemaUpdateLock()

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

getSchema

public ManagedIndexSchema getSchema()

setSchema

public void setSchema(ManagedIndexSchema schema)

isMutable

public boolean isMutable()

getConfig

public SolrConfig getConfig()