org.apache.solr.security

Class AuthenticationPlugin

java.lang.Object

org.apache.solr.security.AuthenticationPlugin

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

KerberosPlugin

public abstract class AuthenticationPlugin
extends Object
implements Closeable

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
AuthenticationPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	doAuthenticate(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain filterChain) This method must authenticate the request.
abstract HttpClientConfigurer	getDefaultConfigurer()
abstract void	init(Map<String,Object> pluginConfig) This is called upon loading up of a plugin, used for setting it up.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

AuthenticationPlugin

public AuthenticationPlugin()

Method Detail

init

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

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

Parameters:

pluginConfig - Config parameters, possibly from a ZK source

doAuthenticate

public abstract void doAuthenticate(javax.servlet.ServletRequest request,
                  javax.servlet.ServletResponse response,
                  javax.servlet.FilterChain filterChain)
                             throws Exception

This method must authenticate the request. Upon a successful authentication, this must call the next filter in the filter chain and set the user principal of the request, or else, upon an error or an authentication failure, throw an exception.

Parameters:

request - the http request

response - the http response

filterChain - the servlet filter chain

Throws:

Exception - any exception thrown during the authentication, e.g. PriviledgedAccessException

getDefaultConfigurer

public abstract HttpClientConfigurer getDefaultConfigurer()

Returns:

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

WARNING: This API is experimental and might change in incompatible ways in the next release.