Package org.apache.solr.security

Class ConfigurableInternodeAuthHadoopPlugin

java.lang.Object

org.apache.solr.security.AuthenticationPlugin

org.apache.solr.security.HadoopAuthPlugin

org.apache.solr.security.ConfigurableInternodeAuthHadoopPlugin

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, HttpClientBuilderPlugin

public class ConfigurableInternodeAuthHadoopPlugin
extends HadoopAuthPlugin
implements HttpClientBuilderPlugin

This class extends HadoopAuthPlugin by enabling configuration of authentication mechanism for Solr internal communication.

Nested Class Summary

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

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields inherited from class org.apache.solr.security.HadoopAuthPlugin

coreContainer, PROXY_USER_CONFIGS

Fields inherited from class org.apache.solr.security.AuthenticationPlugin

AUTHENTICATION_PLUGIN_PROP, HTTP_HEADER_X_SOLR_AUTHDATA, numAuthenticated, numErrors, numMissingCredentials, numPassThrough, numWrongCredentials, requests, requestTimes, solrMetricsContext, totalTime

Constructor Summary

Constructors

Constructor	Description
ConfigurableInternodeAuthHadoopPlugin(CoreContainer coreContainer)

Method Summary

Modifier and Type	Method	Description
void	close()	Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered.
SolrHttpClientBuilder	getHttpClientBuilder(SolrHttpClientBuilder builder)
void	init(Map<String,Object> pluginConfig)	This is called upon loading up of a plugin, used for setting it up.
void	setup(Http2SolrClient client)

Methods inherited from class org.apache.solr.security.HadoopAuthPlugin

doAuthenticate, getInitFilterConfig

Methods inherited from class org.apache.solr.security.AuthenticationPlugin

authenticate, closeRequest, getCategory, getDescription, getMetricNames, getName, getSolrMetricsContext, initializeMetrics, interceptInternodeRequest, interceptInternodeRequest

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

getMetricRegistry, getMetricsSnapshot, registerMetricName

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

initializeMetrics

Constructor Detail

ConfigurableInternodeAuthHadoopPlugin

public ConfigurableInternodeAuthHadoopPlugin(CoreContainer coreContainer)

Method Detail

init

public void init(Map<String,Object> pluginConfig)

Description copied from class: AuthenticationPlugin

This is called upon loading up of a plugin, used for setting it up.

Overrides:

init in class HadoopAuthPlugin

Parameters:

pluginConfig - Config parameters, possibly from a ZK source

setup

public void setup(Http2SolrClient client)

Specified by:

setup in interface HttpClientBuilderPlugin

getHttpClientBuilder

public SolrHttpClientBuilder getHttpClientBuilder(SolrHttpClientBuilder builder)

Specified by:

getHttpClientBuilder in interface HttpClientBuilderPlugin

Returns:

Returns an instance of a SolrHttpClientBuilder to be used for configuring the HttpClients for use with SolrJ clients.

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

Overrides:

close in class HadoopAuthPlugin

Throws:

IOException