Package org.apache.solr.request
Class DelegatingSolrQueryRequest
java.lang.Object
org.apache.solr.request.DelegatingSolrQueryRequest
- All Implemented Interfaces:
AutoCloseable,SolrQueryRequest
A
SolrQueryRequest implementation that defers to a delegate in all cases.
Used primarily in cases where developers want to customize one or more SolrQueryRequest methods while deferring the remainder to an existing instances.
-
Field Summary
Fields inherited from interface org.apache.solr.request.SolrQueryRequest
ALLOW_PARTIAL_RESULTS_DEFAULT, SOLR_ALLOW_PARTIAL_RESULTS_DEFAULT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()This method should be called when all uses of this request are finished, so that resources can be freed.List<org.apache.solr.common.util.CommandOperation> getCommands(boolean validateInput) Only for v2 API if the request contains a command payload, it's parsed and returned as a list of CommandOperation objectsIterable<org.apache.solr.common.util.ContentStream> A Collection of ContentStreams passed to the requestGeneric information associated with this request that may be both read and updated.getCore()The solr core (coordinator, etc) associated with this requestgetJSON()Returns any associated JSON (or null if none) in deserialized generic form.org.apache.solr.common.params.SolrParamsThe original request parameters; never null.org.apache.solr.common.params.SolrParamsThe parameters for this request; never null.Returns a string representing all the important parameters.getPath()Only for V2 API.The timer for this request, created when the request started being processedThe schema snapshot from core.getLatestSchema() at request creation.The index searcher associated with this requestio.opentelemetry.api.trace.SpangetSpan()The distributed tracing Span for the request itself; never null.longThe start time of this request in milliseconds.voidvoidsetParams(org.apache.solr.common.params.SolrParams params) Change the parameters for this request.voidReplaces the current schema snapshot with the latest from the core.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.solr.request.SolrQueryRequest
getResponseWriter, subRequest
-
Constructor Details
-
DelegatingSolrQueryRequest
-
-
Method Details
-
getParams
public org.apache.solr.common.params.SolrParams getParams()Description copied from interface:SolrQueryRequestThe parameters for this request; never null. UseSolrQueryRequest.setParams(SolrParams)to change.- Specified by:
getParamsin interfaceSolrQueryRequest
-
setParams
public void setParams(org.apache.solr.common.params.SolrParams params) Description copied from interface:SolrQueryRequestChange the parameters for this request. This does not affect the original parameters returned by getOriginalParams()- Specified by:
setParamsin interfaceSolrQueryRequest
-
getContentStreams
Description copied from interface:SolrQueryRequestA Collection of ContentStreams passed to the request- Specified by:
getContentStreamsin interfaceSolrQueryRequest
-
getOriginalParams
public org.apache.solr.common.params.SolrParams getOriginalParams()Description copied from interface:SolrQueryRequestThe original request parameters; never null. As this does not normally include configured defaults, it's more suitable for logging.- Specified by:
getOriginalParamsin interfaceSolrQueryRequest
-
getContext
Description copied from interface:SolrQueryRequestGeneric information associated with this request that may be both read and updated.- Specified by:
getContextin interfaceSolrQueryRequest
-
close
public void close()Description copied from interface:SolrQueryRequestThis method should be called when all uses of this request are finished, so that resources can be freed.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceSolrQueryRequest
-
getStartTime
public long getStartTime()Description copied from interface:SolrQueryRequestThe start time of this request in milliseconds. Use this only if you need the absolute system time at the start of the request, getRequestTimer() provides a more accurate mechanism for timing purposes.- Specified by:
getStartTimein interfaceSolrQueryRequest
-
getRequestTimer
Description copied from interface:SolrQueryRequestThe timer for this request, created when the request started being processed- Specified by:
getRequestTimerin interfaceSolrQueryRequest
-
getSearcher
Description copied from interface:SolrQueryRequestThe index searcher associated with this request- Specified by:
getSearcherin interfaceSolrQueryRequest
-
getCore
Description copied from interface:SolrQueryRequestThe solr core (coordinator, etc) associated with this request- Specified by:
getCorein interfaceSolrQueryRequest
-
getSchema
Description copied from interface:SolrQueryRequestThe schema snapshot from core.getLatestSchema() at request creation.- Specified by:
getSchemain interfaceSolrQueryRequest
-
updateSchemaToLatest
public void updateSchemaToLatest()Description copied from interface:SolrQueryRequestReplaces the current schema snapshot with the latest from the core.- Specified by:
updateSchemaToLatestin interfaceSolrQueryRequest
-
getParamString
Description copied from interface:SolrQueryRequestReturns a string representing all the important parameters. Suitable for logging.- Specified by:
getParamStringin interfaceSolrQueryRequest
-
getJSON
Description copied from interface:SolrQueryRequestReturns any associated JSON (or null if none) in deserialized generic form. Java classes used to represent the JSON are as follows: Map, List, String, Long, Double, Boolean- Specified by:
getJSONin interfaceSolrQueryRequest
-
setJSON
- Specified by:
setJSONin interfaceSolrQueryRequest
-
getUserPrincipal
- Specified by:
getUserPrincipalin interfaceSolrQueryRequest
-
getPath
- Specified by:
getPathin interfaceSolrQueryRequest
-
getPathTemplateValues
Description copied from interface:SolrQueryRequestOnly for V2 API. Returns a map of path segments and their values. For example, if the path is configured as /path/{segment1}/{segment2} and a reguest is made as /path/x/y the returned map would contain {segment1:x ,segment2:y}- Specified by:
getPathTemplateValuesin interfaceSolrQueryRequest
-
getCommands
Description copied from interface:SolrQueryRequestOnly for v2 API if the request contains a command payload, it's parsed and returned as a list of CommandOperation objects- Specified by:
getCommandsin interfaceSolrQueryRequest- Parameters:
validateInput- , If true it is validated against the json schema spec
-
getHttpMethod
- Specified by:
getHttpMethodin interfaceSolrQueryRequest
-
getHttpSolrCall
- Specified by:
getHttpSolrCallin interfaceSolrQueryRequest
-
getSpan
public io.opentelemetry.api.trace.Span getSpan()Description copied from interface:SolrQueryRequestThe distributed tracing Span for the request itself; never null. This is useful for adding tags or updating the operation name of the request span. Not null.- Specified by:
getSpanin interfaceSolrQueryRequest
-
getCoreContainer
- Specified by:
getCoreContainerin interfaceSolrQueryRequest
-
getCloudDescriptor
- Specified by:
getCloudDescriptorin interfaceSolrQueryRequest
-