Package org.apache.solr.update

Class UpdateShardHandler

java.lang.Object

org.apache.solr.update.UpdateShardHandler

All Implemented Interfaces:

SolrInfoBean, SolrMetricProducer

public class UpdateShardHandler
extends Object
implements SolrMetricProducer, SolrInfoBean

Nested Class Summary

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

SolrInfoBean.Category, SolrInfoBean.Group

Constructor Summary

Constructors

Constructor	Description
UpdateShardHandler(UpdateShardHandlerConfig cfg)

Method Summary

Modifier and Type	Method	Description
void	close()
SolrInfoBean.Category	getCategory()	Category of this component
int	getConnectionTimeout()
org.apache.http.impl.conn.PoolingHttpClientConnectionManager	getDefaultConnectionManager()
org.apache.http.client.HttpClient	getDefaultHttpClient()
String	getDescription()	Simple one or two line description
Set<String>	getMetricNames()	Modifiable set of metric names that this component reports (default is null, which means none).
com.codahale.metrics.MetricRegistry	getMetricRegistry()	An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).
String	getName()	Simple common usage name, e.g.
ExecutorService	getRecoveryExecutor()
org.apache.http.impl.conn.PoolingHttpClientConnectionManager	getRecoveryOnlyConnectionManager()
org.apache.http.client.HttpClient	getRecoveryOnlyHttpClient()
int	getSocketTimeout()
ExecutorService	getUpdateExecutor()	This method returns an executor that is meant for non search related tasks.
org.apache.http.client.HttpClient	getUpdateOnlyHttpClient()
void	initializeMetrics(SolrMetricManager manager, String registryName, String tag, String scope)	Initializes metrics specific to this producer.

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.core.SolrInfoBean

getMetricsSnapshot, registerMetricName

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

initializeMetrics

Constructor Detail

UpdateShardHandler

public UpdateShardHandler(UpdateShardHandlerConfig cfg)

Method Detail

getName

public String getName()

Description copied from interface: SolrInfoBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified class name.

Specified by:

getName in interface SolrInfoBean

initializeMetrics

public void initializeMetrics(SolrMetricManager manager,
                              String registryName,
                              String tag,
                              String scope)

Description copied from interface: SolrMetricProducer

Initializes metrics specific to this producer.

Note: for back-compatibility this method by default calls SolrMetricProducer.initializeMetrics(SolrMetricManager, String, String).

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

manager - an instance of SolrMetricManager

registryName - registry name where metrics are registered

tag - symbolic tag that represents a group of related instances that have the same life-cycle. Parent component can use the tag when calling SolrMetricManager.unregisterGauges(String, String) to unregister metrics created by this instance of the producer.

scope - scope of the metrics (eg. handler name) to separate metrics of instances of the same component executing in different contexts

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

getMetricNames

public Set<String> getMetricNames()

Description copied from interface: SolrInfoBean

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by SolrInfoBean.registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

Specified by:

getMetricNames in interface SolrInfoBean

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

Description copied from interface: SolrInfoBean

An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).

Specified by:

getMetricRegistry in interface SolrInfoBean

getDefaultHttpClient

public org.apache.http.client.HttpClient getDefaultHttpClient()

getUpdateOnlyHttpClient

public org.apache.http.client.HttpClient getUpdateOnlyHttpClient()

getRecoveryOnlyHttpClient

public org.apache.http.client.HttpClient getRecoveryOnlyHttpClient()

getUpdateExecutor

public ExecutorService getUpdateExecutor()

This method returns an executor that is meant for non search related tasks.

Returns:

an executor for update side related activities.

getDefaultConnectionManager

public org.apache.http.impl.conn.PoolingHttpClientConnectionManager getDefaultConnectionManager()

getRecoveryOnlyConnectionManager

public org.apache.http.impl.conn.PoolingHttpClientConnectionManager getRecoveryOnlyConnectionManager()

getRecoveryExecutor

public ExecutorService getRecoveryExecutor()

Returns:

executor for recovery operations

close

public void close()

getSocketTimeout

public int getSocketTimeout()

getConnectionTimeout

public int getConnectionTimeout()