Package org.apache.solr.request

Interface SolrQueryRequest

    • Method Detail

      • getParams

        org.apache.solr.common.params.SolrParams getParams()
        returns the current request parameters

      • setParams

        void setParams​(org.apache.solr.common.params.SolrParams params)
        Change the parameters for this request. This does not affect the original parameters returned by getOriginalParams()

      • getContentStreams

        Iterable<org.apache.solr.common.util.ContentStream> getContentStreams()
        A Collection of ContentStreams passed to the request

      • getOriginalParams

        org.apache.solr.common.params.SolrParams getOriginalParams()
        Returns the original request parameters. As this does not normally include configured defaults it's more suitable for logging.

      • getContext

        Map<Object,​Object> getContext()
        Generic information associated with this request that may be both read and updated.

      • close

        void close()
        This method should be called when all uses of this request are finished, so that resources can be freed.
        Specified by:
        close in interface AutoCloseable

      • getStartTime

        long getStartTime()
        The 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.

      • getRequestTimer

        RTimerTree getRequestTimer()
        The timer for this request, created when the request started being processed

      • getSearcher

        SolrIndexSearcher getSearcher()
        The index searcher associated with this request

      • getCore

        SolrCore getCore()
        The solr core (coordinator, etc) associated with this request

      • getSchema

        IndexSchema getSchema()
        The schema snapshot from core.getLatestSchema() at request creation.

      • updateSchemaToLatest

        void updateSchemaToLatest()
        Replaces the current schema snapshot with the latest from the core.

      • getParamString

        String getParamString()
        Returns a string representing all the important parameters. Suitable for logging.

      • getJSON

        Map<String,​Object> getJSON()
        Returns 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

      • getUserPrincipal

        Principal getUserPrincipal()

      • getPath

        default String getPath()

      • getPathTemplateValues

        default Map<String,​String> getPathTemplateValues()
        Only 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}

      • getCommands

        default 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 objects
        Parameters:
        validateInput - , If true it is validated against the json schema spec

      • getHttpMethod

        default String getHttpMethod()

      • getTracer

        default io.opentracing.Tracer getTracer()
        Distributed tracing Tracer. Never null but might implement NoopTracer.

      • getSpan

        default io.opentracing.Span getSpan()
        The distributed tracing Span for the request itself; never null. This is useful for adding tags or updating the operation name of the request span. If you need the current span, which might not necessarily be the request span, do this instead: tracer.activeSpan().