Package org.apache.solr.handler

Class ReplicationHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.ReplicationHandler

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, APIConfigProvider<ReplicationHandler.ReplicationHandlerConfig>, SolrMetricProducer, SolrRequestHandler, PermissionNameProvider, SolrCoreAware

public class ReplicationHandler
extends RequestHandlerBase
implements SolrCoreAware, APIConfigProvider<ReplicationHandler.ReplicationHandlerConfig>

A Handler which provides a REST API for replication and serves replication requests from Followers.

When running on the leader, it provides the following commands

1. Get the current replicable index version (command=indexversion)
2. Get the list of files for a given index version (command=filelist&indexversion=<VERSION>)
3. Get full or a part (chunk) of a given index or a config file (command=filecontent&file=<FILE_NAME>) You can optionally specify an offset and length to get that chunk of the file. You can request a configuration file by using "cf" parameter instead of the "file" parameter.
4. Get status/statistics (command=details)

When running on the follower, it provides the following commands

1. Perform an index fetch now (command=snappull)
2. Get status/statistics (command=details)
3. Abort an index fetch (command=abort)
4. Enable/Disable polling the leader for new versions (command=enablepoll or command=disablepoll)

Since:

solr 1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReplicationHandler.PollListener
static class	ReplicationHandler.ReplicationHandlerConfig

Nested classes/interfaces inherited from class org.apache.solr.handler.RequestHandlerBase

RequestHandlerBase.HandlerMetrics

Nested classes/interfaces inherited from interface org.apache.solr.jersey.APIConfigProvider

APIConfigProvider.APIConfig

Nested classes/interfaces inherited from interface org.apache.solr.security.PermissionNameProvider

PermissionNameProvider.Name

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIAS
static final String	CMD_ABORT_FETCH
static final String	CMD_BACKUP
static final String	CMD_DELETE_BACKUP
static final String	CMD_DETAILS
static final String	CMD_DISABLE_POLL
static final String	CMD_DISABLE_REPL
static final String	CMD_ENABLE_POLL
static final String	CMD_ENABLE_REPL
static final String	CMD_FETCH_INDEX
static final String	CMD_GET_FILE
static final String	CMD_GET_FILE_LIST
static final String	CMD_INDEX_VERSION
static final String	CMD_RESTORE
static final String	CMD_RESTORE_STATUS
static final String	CMD_SHOW_COMMITS
static final String	COMMAND
static final String	CONF_FILES
static final String	ERR_STATUS
static final String	EXCEPTION
static final String	EXTERNAL
static final String	FETCH_FROM_LEADER
static final String	INTERNAL
static final String	LEADER_URL
static final String	MESSAGE
static final String	NEXT_EXECUTION_AT
static final String	NUMBER_BACKUPS_TO_KEEP_INIT_PARAM
static final String	NUMBER_BACKUPS_TO_KEEP_REQUEST_PARAM
static final String	OK_STATUS
static final String	PATH
static final String	REPLICATE_AFTER
static final String	RESERVE
static final String	SIZE
static final String	SKIP_COMMIT_ON_LEADER_VERSION_ZERO
static final String	WAIT	Boolean param for tests that can be specified when using CMD_FETCH_INDEX to force the current request to block until the fetch is complete.

Fields inherited from class org.apache.solr.handler.RequestHandlerBase

aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, publishCpuTime, REQUEST_CPU_TIMER_CONTEXT, solrMetricsContext, SOURCE_ATTR

Fields inherited from interface org.apache.solr.security.PermissionNameProvider

ANY, NULL, values

Fields inherited from interface org.apache.solr.metrics.SolrMetricProducer

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

Fields inherited from interface org.apache.solr.request.SolrRequestHandler

TYPE

Constructor Summary

Constructors

Constructor	Description
ReplicationHandler()

Method Summary

Modifier and Type	Method	Description
boolean	abortFetch()
void	close()	Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered.
IndexFetcher.IndexFetchResult	doFetch(org.apache.solr.common.params.SolrParams solrParams, boolean forceReplication)
static void	doSnapShoot(int numberToKeep, int numberBackupsToKeep, String location, String repoName, String commitName, String name, SolrCore core, Consumer<org.apache.solr.common.util.NamedList<?>> result)
SolrInfoBean.Category	getCategory()	Category of this component
Map<String,org.apache.solr.handler.ReplicationHandler.FileInfo>	getConfFileInfoCache()
List<FileMetaData>	getConfFileInfoFromCache(org.apache.solr.common.util.NamedList<String> nameAndAlias, Map<String,org.apache.solr.handler.ReplicationHandler.FileInfo> confFileInfoCache)	For configuration files, checksum of the file is included because, unlike index files, they may have same content but different timestamps.
org.apache.solr.common.util.NamedList<String>	getConfFileNameAlias()
Class<ReplicationHandler.ReplicationHandlerConfig>	getConfigClass()
String	getDescription()	Simple one or two line description
String	getIncludeConfFiles()
IndexVersionResponse	getIndexVersionResponse()
Collection<Class<? extends JerseyResource>>	getJerseyResources()	Returns any JAX-RS annotated v2 APIs associated with this request handler.
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
Long	getReserveCommitDuration()
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
void	inform(SolrCore core)
void	initializeMetrics(SolrMetricsContext parentContext, io.opentelemetry.api.common.Attributes attributes)	Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component
boolean	isFollower()
ReplicationHandler.ReplicationHandlerConfig	provide()
static Long	readIntervalNs(String interval)
Boolean	registerV2()	Whether this request handler must be made available at the /v2/ path
void	setPollListener(ReplicationHandler.PollListener pollListener)
void	shutdown()

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getApis, getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, init, isInternalShardRequest, processErrorMetricsOnException, processReceivedException, setPluginInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.api.ApiSupport

registerV1

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

EXCEPTION

public static final String EXCEPTION

See Also:

• Constant Field Values

LEADER_URL

public static final String LEADER_URL

See Also:

• Constant Field Values

FETCH_FROM_LEADER

public static final String FETCH_FROM_LEADER

See Also:

• Constant Field Values

SKIP_COMMIT_ON_LEADER_VERSION_ZERO

public static final String SKIP_COMMIT_ON_LEADER_VERSION_ZERO

See Also:

• Constant Field Values

MESSAGE

public static final String MESSAGE

See Also:

• Constant Field Values

COMMAND

public static final String COMMAND

See Also:

• Constant Field Values

CMD_DETAILS

public static final String CMD_DETAILS

See Also:

• Constant Field Values

CMD_BACKUP

public static final String CMD_BACKUP

See Also:

• Constant Field Values

CMD_RESTORE

public static final String CMD_RESTORE

See Also:

• Constant Field Values

CMD_RESTORE_STATUS

public static final String CMD_RESTORE_STATUS

See Also:

• Constant Field Values

CMD_FETCH_INDEX

public static final String CMD_FETCH_INDEX

See Also:

• Constant Field Values

CMD_ABORT_FETCH

public static final String CMD_ABORT_FETCH

See Also:

• Constant Field Values

CMD_GET_FILE_LIST

public static final String CMD_GET_FILE_LIST

See Also:

• Constant Field Values

CMD_GET_FILE

public static final String CMD_GET_FILE

See Also:

• Constant Field Values

CMD_DISABLE_POLL

public static final String CMD_DISABLE_POLL

See Also:

• Constant Field Values

CMD_DISABLE_REPL

public static final String CMD_DISABLE_REPL

See Also:

• Constant Field Values

CMD_ENABLE_REPL

public static final String CMD_ENABLE_REPL

See Also:

• Constant Field Values

CMD_ENABLE_POLL

public static final String CMD_ENABLE_POLL

See Also:

• Constant Field Values

CMD_INDEX_VERSION

public static final String CMD_INDEX_VERSION

See Also:

• Constant Field Values

CMD_SHOW_COMMITS

public static final String CMD_SHOW_COMMITS

See Also:

• Constant Field Values

CMD_DELETE_BACKUP

public static final String CMD_DELETE_BACKUP

See Also:

• Constant Field Values

SIZE

public static final String SIZE

See Also:

• Constant Field Values

ALIAS

public static final String ALIAS

See Also:

• Constant Field Values

CONF_FILES

public static final String CONF_FILES

See Also:

• Constant Field Values

REPLICATE_AFTER

public static final String REPLICATE_AFTER

See Also:

• Constant Field Values

RESERVE

public static final String RESERVE

See Also:

• Constant Field Values

EXTERNAL

public static final String EXTERNAL

See Also:

• Constant Field Values

INTERNAL

public static final String INTERNAL

See Also:

• Constant Field Values

ERR_STATUS

public static final String ERR_STATUS

See Also:

• Constant Field Values

OK_STATUS

public static final String OK_STATUS

See Also:

• Constant Field Values

NEXT_EXECUTION_AT

public static final String NEXT_EXECUTION_AT

See Also:

• Constant Field Values

NUMBER_BACKUPS_TO_KEEP_REQUEST_PARAM

public static final String NUMBER_BACKUPS_TO_KEEP_REQUEST_PARAM

See Also:

• Constant Field Values

NUMBER_BACKUPS_TO_KEEP_INIT_PARAM

public static final String NUMBER_BACKUPS_TO_KEEP_INIT_PARAM

See Also:

• Constant Field Values

WAIT

public static final String WAIT

Boolean param for tests that can be specified when using CMD_FETCH_INDEX to force the current request to block until the fetch is complete. NOTE: This param is not advised for non-test code, since the duration of the fetch for non-trivial indexes will likely cause the request to time out.

See Also:

• Constant Field Values

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Constructor Details

ReplicationHandler

public ReplicationHandler()

Method Details

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)

Specified by:

getPermissionName in interface PermissionNameProvider

setPollListener

public void setPollListener(ReplicationHandler.PollListener pollListener)

isFollower

public boolean isFollower()

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
 SolrQueryResponse rsp)
                       throws Exception

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

abortFetch

public boolean abortFetch()

doFetch

public IndexFetcher.IndexFetchResult doFetch(org.apache.solr.common.params.SolrParams solrParams,
 boolean forceReplication)

doSnapShoot

public static void doSnapShoot(int numberToKeep,
 int numberBackupsToKeep,
 String location,
 String repoName,
 String commitName,
 String name,
 SolrCore core,
 Consumer<org.apache.solr.common.util.NamedList<?>> result)
                        throws IOException

Throws:

IOException

getIndexVersionResponse

public IndexVersionResponse getIndexVersionResponse()
                                             throws IOException

Throws:

IOException

getConfFileInfoFromCache

public List<FileMetaData> getConfFileInfoFromCache(org.apache.solr.common.util.NamedList<String> nameAndAlias,
 Map<String,org.apache.solr.handler.ReplicationHandler.FileInfo> confFileInfoCache)

For configuration files, checksum of the file is included because, unlike index files, they may have same content but different timestamps.

The local conf files information is cached so that everytime it does not have to compute the checksum. The cache is refreshed only if the lastModified of the file changes

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class RequestHandlerBase

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class RequestHandlerBase

getConfFileNameAlias

public org.apache.solr.common.util.NamedList<String> getConfFileNameAlias()

getConfFileInfoCache

public Map<String,org.apache.solr.handler.ReplicationHandler.FileInfo> getConfFileInfoCache()

getIncludeConfFiles

public String getIncludeConfFiles()

getReserveCommitDuration

public Long getReserveCommitDuration()

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
 io.opentelemetry.api.common.Attributes attributes)

Description copied from interface: SolrMetricProducer

Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component

Specified by:

initializeMetrics in interface SolrMetricProducer

Overrides:

initializeMetrics in class RequestHandlerBase

Parameters:

parentContext - The registry that the component will initialize metrics to

attributes - Base set of attributes that will be bound to all metrics for that component

close

public void close()
           throws IOException

Description copied from interface: SolrMetricProducer

Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered. This prevents obscure memory leaks.

from: https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html While this interface method is declared to throw Exception, implementers are strongly encouraged to declare concrete implementations of the close method to throw more specific exceptions, or to throw no exception at all if the close operation cannot fail.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SolrMetricProducer

Throws:

IOException

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

getJerseyResources

public Collection<Class<? extends JerseyResource>> getJerseyResources()

Description copied from interface: ApiSupport

Returns any JAX-RS annotated v2 APIs associated with this request handler.

Specified by:

getJerseyResources in interface ApiSupport

See Also:

• ApiSupport.getApis()

registerV2

public Boolean registerV2()

Description copied from interface: ApiSupport

Whether this request handler must be made available at the /v2/ path

Specified by:

registerV2 in interface ApiSupport

shutdown

public void shutdown()

readIntervalNs

public static Long readIntervalNs(String interval)

provide

public ReplicationHandler.ReplicationHandlerConfig provide()

Specified by:

provide in interface APIConfigProvider<ReplicationHandler.ReplicationHandlerConfig>

getConfigClass

public Class<ReplicationHandler.ReplicationHandlerConfig> getConfigClass()

Specified by:

getConfigClass in interface APIConfigProvider<ReplicationHandler.ReplicationHandlerConfig>