org.apache.solr.request

Class SolrRequestInfo

java.lang.Object

org.apache.solr.request.SolrRequestInfo

public class SolrRequestInfo
extends Object

Information about the Solr request/response held in a ThreadLocal.

Field Summary

Fields

Modifier and Type	Field and Description
protected SolrDispatchFilter.Action	action
protected List<Closeable>	closeHooks
protected javax.servlet.http.HttpServletRequest	httpRequest
protected static int	MAX_STACK_SIZE
protected Date	now
protected ResponseBuilder	rb
protected SolrQueryRequest	req
protected SolrQueryResponse	rsp
protected static ThreadLocal<Deque<SolrRequestInfo>>	threadLocal
protected TimeZone	tz
protected boolean	useServerToken

Constructor Summary

Constructors

Constructor and Description
SolrRequestInfo(javax.servlet.http.HttpServletRequest httpReq, SolrQueryResponse rsp)
SolrRequestInfo(javax.servlet.http.HttpServletRequest httpReq, SolrQueryResponse rsp, SolrDispatchFilter.Action action)
SolrRequestInfo(SolrQueryRequest req, SolrQueryResponse rsp)
SolrRequestInfo(SolrQueryRequest req, SolrQueryResponse rsp, SolrDispatchFilter.Action action)

Method Summary

Modifier and Type	Method and Description
void	addCloseHook(Closeable hook)
static void	clearRequestInfo() Removes the most recent SolrRequestInfo from the stack
SolrDispatchFilter.Action	getAction()
TimeZone	getClientTimeZone() The TimeZone specified by the request, or UTC if none was specified.
static ExecutorUtil.InheritableThreadLocalProvider	getInheritableThreadLocalProvider()
Date	getNOW()
SolrQueryRequest	getReq()
static SolrRequestInfo	getRequestInfo()
ResponseBuilder	getResponseBuilder() May return null if the request handler is not based on SearchHandler
SolrQueryResponse	getRsp()
Principal	getUserPrincipal()
static void	reset() This reset method is more of a protection mechanism as we expect it to be empty by now because all "set" calls need to be balanced with a "clear".
void	setAction(SolrDispatchFilter.Action action)
static void	setRequestInfo(SolrRequestInfo info) Adds the SolrRequestInfo onto a stack held in a ThreadLocal.
void	setResponseBuilder(ResponseBuilder rb)
void	setUseServerToken(boolean use)
boolean	useServerToken() Used when making remote requests to other Solr nodes from the thread associated with this request, true means the server token header should be used instead of the Principal associated with the request.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_STACK_SIZE

protected static final int MAX_STACK_SIZE

See Also:

Constant Field Values

threadLocal

protected static final ThreadLocal<Deque<SolrRequestInfo>> threadLocal

req

protected SolrQueryRequest req

rsp

protected SolrQueryResponse rsp

now

protected Date now

httpRequest

protected javax.servlet.http.HttpServletRequest httpRequest

tz

protected TimeZone tz

rb

protected ResponseBuilder rb

closeHooks

protected List<Closeable> closeHooks

action

protected SolrDispatchFilter.Action action

useServerToken

protected boolean useServerToken

Constructor Detail

SolrRequestInfo

public SolrRequestInfo(SolrQueryRequest req,
                       SolrQueryResponse rsp)

SolrRequestInfo

public SolrRequestInfo(SolrQueryRequest req,
                       SolrQueryResponse rsp,
                       SolrDispatchFilter.Action action)

SolrRequestInfo

public SolrRequestInfo(javax.servlet.http.HttpServletRequest httpReq,
                       SolrQueryResponse rsp)

SolrRequestInfo

public SolrRequestInfo(javax.servlet.http.HttpServletRequest httpReq,
                       SolrQueryResponse rsp,
                       SolrDispatchFilter.Action action)

Method Detail

getRequestInfo

public static SolrRequestInfo getRequestInfo()

setRequestInfo

public static void setRequestInfo(SolrRequestInfo info)

Adds the SolrRequestInfo onto a stack held in a ThreadLocal. Remember to call clearRequestInfo()!

clearRequestInfo

public static void clearRequestInfo()

Removes the most recent SolrRequestInfo from the stack

reset

public static void reset()

This reset method is more of a protection mechanism as we expect it to be empty by now because all "set" calls need to be balanced with a "clear".

getUserPrincipal

public Principal getUserPrincipal()

getNOW

public Date getNOW()

getClientTimeZone

public TimeZone getClientTimeZone()

The TimeZone specified by the request, or UTC if none was specified.

getReq

public SolrQueryRequest getReq()

getRsp

public SolrQueryResponse getRsp()

getResponseBuilder

public ResponseBuilder getResponseBuilder()

May return null if the request handler is not based on SearchHandler

setResponseBuilder

public void setResponseBuilder(ResponseBuilder rb)

addCloseHook

public void addCloseHook(Closeable hook)

getAction

public SolrDispatchFilter.Action getAction()

setAction

public void setAction(SolrDispatchFilter.Action action)

useServerToken

public boolean useServerToken()

Used when making remote requests to other Solr nodes from the thread associated with this request, true means the server token header should be used instead of the Principal associated with the request.

setUseServerToken

public void setUseServerToken(boolean use)

getInheritableThreadLocalProvider

public static ExecutorUtil.InheritableThreadLocalProvider getInheritableThreadLocalProvider()