org.apache.solr.servlet

Class SolrDispatchFilter

java.lang.Object

org.apache.solr.servlet.SolrDispatchFilter

All Implemented Interfaces:

javax.servlet.Filter

public class SolrDispatchFilter
extends Object

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

Since:

solr 1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrDispatchFilter.ClosedServletInputStream
static class	SolrDispatchFilter.ClosedServletOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected String	abortErrorMessage
protected CoreContainer	cores
protected org.apache.http.client.HttpClient	httpClient
protected String	pathPrefix

Constructor Summary

Constructors

Constructor and Description
SolrDispatchFilter()

Method Summary

Methods

Modifier and Type	Method and Description
static javax.servlet.http.HttpServletRequest	closeShield(javax.servlet.http.HttpServletRequest request, boolean retry) Wrap the request's input stream with a close shield.
static javax.servlet.http.HttpServletResponse	closeShield(javax.servlet.http.HttpServletResponse response, boolean retry) Wrap the response's output stream with a close shield.
protected CoreContainer	createCoreContainer() Override this to change CoreContainer initialization
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain, boolean retry)
protected void	execute(javax.servlet.http.HttpServletRequest req, SolrRequestHandler handler, SolrQueryRequest sreq, SolrQueryResponse rsp)
CoreContainer	getCores()
String	getPathPrefix()
void	httpSolrCall(javax.servlet.ServletRequest _request, javax.servlet.ServletResponse _response, javax.servlet.FilterChain chain, boolean retry)
void	init(javax.servlet.FilterConfig config)
static ConfigSolr	loadConfigSolr(SolrResourceLoader loader)
void	sendError(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, int errorCode, String message)
protected void	sendError(SolrCore core, SolrQueryRequest req, javax.servlet.ServletRequest request, javax.servlet.http.HttpServletResponse response, Throwable ex)
void	setPathPrefix(String pathPrefix) Set the prefix for all paths.

Methods inherited from class java.lang.Object

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

Field Detail

cores

protected volatile CoreContainer cores

pathPrefix

protected String pathPrefix

abortErrorMessage

protected String abortErrorMessage

httpClient

protected org.apache.http.client.HttpClient httpClient

Constructor Detail

SolrDispatchFilter

public SolrDispatchFilter()

Method Detail

init

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

Throws:

javax.servlet.ServletException

loadConfigSolr

public static ConfigSolr loadConfigSolr(SolrResourceLoader loader)

createCoreContainer

protected CoreContainer createCoreContainer()

Override this to change CoreContainer initialization

Returns:

a CoreContainer to hold this server's cores

getCores

public CoreContainer getCores()

destroy

public void destroy()

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain chain,
            boolean retry)
              throws IOException,
                     javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

httpSolrCall

public void httpSolrCall(javax.servlet.ServletRequest _request,
                javax.servlet.ServletResponse _response,
                javax.servlet.FilterChain chain,
                boolean retry)
                  throws IOException,
                         javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

sendError

public void sendError(javax.servlet.ServletRequest request,
             javax.servlet.ServletResponse response,
             int errorCode,
             String message)
               throws IOException

Throws:

IOException

execute

protected void execute(javax.servlet.http.HttpServletRequest req,
           SolrRequestHandler handler,
           SolrQueryRequest sreq,
           SolrQueryResponse rsp)

sendError

protected void sendError(SolrCore core,
             SolrQueryRequest req,
             javax.servlet.ServletRequest request,
             javax.servlet.http.HttpServletResponse response,
             Throwable ex)
                  throws IOException

Throws:

IOException

closeShield

public static javax.servlet.http.HttpServletRequest closeShield(javax.servlet.http.HttpServletRequest request,
                                                boolean retry)

Wrap the request's input stream with a close shield. If this is a retry, we will assume that the stream has already been wrapped and do nothing.

Parameters:

request - The request to wrap.

retry - If this is an original request or a retry.

Returns:

A request object with an InputStream that will ignore calls to close.

closeShield

public static javax.servlet.http.HttpServletResponse closeShield(javax.servlet.http.HttpServletResponse response,
                                                 boolean retry)

Wrap the response's output stream with a close shield. If this is a retry, we will assume that the stream has already been wrapped and do nothing.

Parameters:

response - The response to wrap.

retry - If this response corresponds to an original request or a retry.

Returns:

A response object with an OutputStream that will ignore calls to close.

setPathPrefix

public void setPathPrefix(String pathPrefix)

Set the prefix for all paths. This is useful if you want to apply the filter to something other then /*, perhaps because you are merging this filter into a larger web application. For example, if web.xml specifies:

 <filter-mapping>
  <filter-name>SolrRequestFilter</filter-name>
  <url-pattern>/xxx/*</url-pattern>
 </filter-mapping>
 

Make sure to set the PathPrefix to "/xxx" either with this function or in web.xml.

 <init-param>
  <param-name>path-prefix</param-name>
  <param-value>/xxx</param-value>
 </init-param>
 

getPathPrefix

public String getPathPrefix()