Package org.apache.solr.servlet

Class SolrDispatchFilter

java.lang.Object

jakarta.servlet.GenericFilter

jakarta.servlet.http.HttpFilter

org.apache.solr.servlet.SolrDispatchFilter

All Implemented Interfaces:

jakarta.servlet.Filter, jakarta.servlet.FilterConfig, Serializable, PathExcluder

public class SolrDispatchFilter
extends jakarta.servlet.http.HttpFilter
implements PathExcluder

This filter looks at the incoming URL maps them to handlers defined in solrconfig.xml

Since:

solr 1.2

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SolrDispatchFilter.Action	Enum to define action that needs to be processed.
static interface	SolrDispatchFilter.HttpSolrCallFactory	internal API

Field Summary

Fields

Modifier and Type	Field	Description
protected String	abortErrorMessage
protected final CountDownLatch	init
final boolean	isV2Enabled
static final String	PROPERTIES_ATTRIBUTE
static final String	SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE
static final String	SOLR_INSTALL_DIR_ATTRIBUTE
static final String	SOLR_LOG_LEVEL
static final String	SOLR_LOG_MUTECONSOLE
static final String	SOLRHOME_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
SolrDispatchFilter()

Method Summary

Modifier and Type	Method	Description
void	doFilter(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
protected void	doFilterRetry(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain, boolean retry)
CoreContainer	getCores()	The CoreContainer.
protected HttpSolrCall	getHttpSolrCall(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean retry)	Allow a subclass to modify the HttpSolrCall.
void	init(jakarta.servlet.FilterConfig config)
void	setExcludePatterns(List<Pattern> excludePatterns)

Methods inherited from class jakarta.servlet.http.HttpFilter

doFilter

Methods inherited from class jakarta.servlet.GenericFilter

getFilterConfig, getFilterName, getInitParameter, getInitParameterNames, getServletContext, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.Filter

destroy

Field Details

init

protected final CountDownLatch init

abortErrorMessage

protected String abortErrorMessage

isV2Enabled

public final boolean isV2Enabled

PROPERTIES_ATTRIBUTE

public static final String PROPERTIES_ATTRIBUTE

See Also:

• Constant Field Values

SOLRHOME_ATTRIBUTE

public static final String SOLRHOME_ATTRIBUTE

See Also:

• Constant Field Values

SOLR_INSTALL_DIR_ATTRIBUTE

public static final String SOLR_INSTALL_DIR_ATTRIBUTE

See Also:

• Constant Field Values

SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE

public static final String SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE

See Also:

• Constant Field Values

SOLR_LOG_MUTECONSOLE

public static final String SOLR_LOG_MUTECONSOLE

See Also:

• Constant Field Values

SOLR_LOG_LEVEL

public static final String SOLR_LOG_LEVEL

See Also:

• Constant Field Values

Constructor Details

SolrDispatchFilter

public SolrDispatchFilter()

Method Details

setExcludePatterns

public void setExcludePatterns(List<Pattern> excludePatterns)

Specified by:

setExcludePatterns in interface PathExcluder

init

public void init(jakarta.servlet.FilterConfig config)
          throws jakarta.servlet.ServletException

Specified by:

init in interface jakarta.servlet.Filter

Overrides:

init in class jakarta.servlet.GenericFilter

Throws:

jakarta.servlet.ServletException

getCores

public CoreContainer getCores()
                       throws jakarta.servlet.UnavailableException

The CoreContainer. It's ready for use, albeit could shut down whenever. Never null.

Throws:

jakarta.servlet.UnavailableException

doFilter

public void doFilter(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)
              throws IOException,
jakarta.servlet.ServletException

Overrides:

doFilter in class jakarta.servlet.http.HttpFilter

Throws:

IOException

jakarta.servlet.ServletException

doFilterRetry

protected void doFilterRetry(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain,
 boolean retry)
                      throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

getHttpSolrCall

protected HttpSolrCall getHttpSolrCall(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 boolean retry)

Allow a subclass to modify the HttpSolrCall. In particular, subclasses may want to add attributes to the request and send errors differently