All Classes and Interfaces
Class
Description
Allows better caching by establishing deterministic evenly-distributed replica routing
preferences according to either explicitly configured hash routing parameter, or the hash of a
query parameter (configurable, usually related to the main query).
Factory for constructing an
AffinityReplicaListTransformer that reorders replica routing
preferences deterministically, based on request parameters.Holds collection aliases -- virtual collections that point to one or more other collections.
Experimental SolrRequest's and SolrResponse's for aliases, generated from an OAS.
Experimental SolrRequest's and SolrResponse's for aliasProperties, generated from an OAS.
Defines the request parameters used by all analysis request handlers.
A base class for all analysis responses.
A phase in the analysis process.
Holds all information of a token as part of an analysis phase.
Types and utilities used by many ApiMapping classes.
Deprecated.
SolrParams wrapper which acts similar to DefaultSolrParams except that it "appends" the values of
multi-value params from both sub instances, so that all the values are returned.
Deprecated.
Use the async variants that return CompletableFuture.
V2 API POJO for the /v2/collections 'backup-collection' command.
This should be thrown when a server has an error in executing the request, and it sends a
proper payload back to the client
Subclass of SolrException that allows us to capture an arbitrary HTTP status code that may have
been returned by the remote server or a proxy along the way.
A RequestWriter which writes requests in the javabin format
Represents the top-level response for a bucket-based JSON facet (i.e.
Represents an individual bucket result of a "term" or "range" facet.
A mutable byte[] backed Utf8CharSequence.
Deprecated.
Use the async variants that return CompletableFuture.
SolrJ client class to communicate with SolrCloud using Http2SolrClient.
Constructs
CloudHttp2SolrClient instances from provided configuration.Deprecated.
Please use
CloudSolrClientConstructs
CloudLegacySolrClient instances from provided configuration.Deprecated.
Please use
CloudHttp2SolrClient.BuilderThis class represents a cluster of Solr Docs .
Experimental SolrRequest's and SolrResponse's for cluster, generated from an OAS.
Encapsulates responses from ClusteringComponent
Experimental SolrRequest's and SolrResponse's for clusterProperties, generated from an OAS.
Immutable state of the cloud.
Provides cluster state from some source
This class is experimental and subject to change.
Base class for asynchronous collection admin requests
SolrRequest class for the "Backup Deletion" API.SolrRequest class for the "Backup List" API.A Modify Collection request
A response object for
CollectionAdminRequest.RequestApiDistributedProcessing requestsA response object for
CollectionAdminRequest.RequestStatus requestsExperimental SolrRequest's and SolrResponse's for collectionBackups, generated from an OAS.
Deprecated.
(Mostly) Collection API actions that can be sent by nodes to the Overseer over the
/overseer/collection-queue-work ZooKeeper queue.Experimental SolrRequest's and SolrResponse's for collectionProperties, generated from an OAS.
Parent
SolrRequest class that requires a target collection or core.Experimental SolrRequest's and SolrResponse's for collections, generated from an OAS.
This SolrClient delegates to a backing client with a specified collection.
Experimental SolrRequest's and SolrResponse's for collectionSnapshots, generated from an OAS.
Interface to determine if a set of liveNodes and a collection's state matches some expectations.
Methods for creating collections with exact sizes, and other convenience methods
This class provides constants for configuration parameters related to the combiner.
Parameters used across many handlers
valid values for:
echoParamsAllows random faults to be injected in running code during test runs across all solr packages.
Breakpoints should be set via this
CommonTestInjection.BreakpointSetter within the test case and close
should be invoked as cleanup.CompositeIdRouter partitions ids based on a
CompositeIdRouter.SEPARATOR, hashes each partition and merges
the hashes together to map the id to a slice.Helper class to calculate parts, masks etc.
A Solr client using
Http2SolrClient to send concurrent updates to Solr.Constructs
ConcurrentUpdateHttp2SolrClient instances from provided configuration.Deprecated.
Please use
ConcurrentUpdateHttp2SolrClientConstructs
ConcurrentUpdateSolrClient instances from provided configuration.A generic interface that represents a config file, mostly XML Please note that this is an
immutable, read-only object.
This class is experimental and subject to change.
Creates a new config set by cloning an existing "base" configset.
Uploads files to create a new configset, or modify an existing config set.
No special handling at this time.
ConfigSets API related parameters and actions.
Experimental SolrRequest's and SolrResponse's for configsets, generated from an OAS.
Deprecated.
Use
RequestWriter.ContentWriter instead.Three concrete implementations for ContentStream - one for File/URL/String
Construct a
ContentStream from a FileConstruct a
ContentStream from a FileConstruct a
ContentStream from a StringConstruct a
ContentStream from a URL This uses a URLConnection
to get the content streamBasic functionality to upload a File or
ContentStream to a
Solr Cell or some other handler that takes ContentStreams (CSV)This class is experimental and subject to change.
Experimental SolrRequest's and SolrResponse's for coreBackups, generated from an OAS.
Experimental SolrRequest's and SolrResponse's for cores, generated from an OAS.
Experimental SolrRequest's and SolrResponse's for coreSnapshots, generated from an OAS.
Parameters and constants used when dealing with cursor based requests across large sorted result
sets.
This represents a data entry in the payload/stream.
The types are a superset of json
An abstract DataInput that extends InputStream
Base class for overriding some behavior of
ClusterStateProviderClass for making Solr delegation token requests.
Delegation Token responses
Represents a query using the JSON Query
DSL
Deprecated.
Use
GenericSolrRequest.A collection of params used in DisMaxRequestHandler, both for Plugin initialization and for
Requests.
Models a Collection in zookeeper (but that Java name is obviously taken, hence "DocCollection")
JSON properties related to a collection's state.
Class to partition int range into n ranges.
A request for the org.apache.solr.handler.DocumentAnalysisRequestHandler.
A response that is returned by processing the
DocumentAnalysisRequest.An analysis process breakdown of a document.
An analysis process breakdown for a specific field.
A class to map objects to and from solr documents.
XML DOM utilities
This class provides several singletons of entity resolvers used by SAX and StAX in the Java API.
Represents an Enum field value, which includes integer value (indicating the sort order) and
string (displayed) value.
Provides convenient access to System Properties for Solr.
Any class which wants to carry forward the thread local values to the threads run by thread
pools must implement this interface and the implementation should be registered here
Expand parameters
A utility class to hold the facet response.
Facet parameters
An enumeration of the legal values for
lower = all gap based ranges include their lower bound upper = all gap based ranges include their upper bound edge = the first and last gap ranges include their edge bounds (ie: lower for the first one, upper for the last one) even if the corresponding upper/lower option is not specified outer = the BEFORE and AFTER ranges should be inclusive of their bounds, even if the first or last ranges already include those boundaries.
FacetParams.FACET_DATE_INCLUDE and FacetParams.FACET_RANGE_INCLUDE lower = all gap based ranges include their lower bound upper = all gap based ranges include their upper bound edge = the first and last gap ranges include their edge bounds (ie: lower for the first one, upper for the last one) even if the corresponding upper/lower option is not specified outer = the BEFORE and AFTER ranges should be inclusive of their bounds, even if the first or last ranges already include those boundaries.
An enumeration of the legal values for
FacetParams.FACET_RANGE_METHOD
filter =
dv =
An enumeration of the legal values for
FacetParams.FACET_RANGE_OTHER and FacetParams.FACET_DATE_OTHER
...Single threaded buffered InputStream Internal Solr use only, subject to change.
Single threaded buffered OutputStream Internal Solr use only, subject to change.
Single threaded BufferedWriter Internal Solr use only, subject to change.
This class can be used to annotate a field or a setter an any class and SolrJ would help you
convert to SolrInputDocument and from SolrDocument
A request for the org.apache.solr.handler.FieldAnalysisRequestHandler.
A response that is returned by processing the
FieldAnalysisRequest.The analysis of a field.
Holds stats info
Experimental SolrRequest's and SolrResponse's for fileStore, generated from an OAS.
A
GenericSolrRequest implementation intended for v2 APIsProvides methods for matching glob patterns against input strings.
Represents a group.
This class represents the result of a group command.
Group parameters
Overall grouping result.
Fast, well distributed, cross-platform hash functions.
128 bits of state
Deprecated.
Represents a "heatmap" facet in a JSON request query.
Represents the result of a "heatmap" JSON facet.
An HTTP
SolrClient using Jetty HttpClient.Factory interface for configuring SolrHttpClientBuilder.
Deprecated.
Used to configure the Apache HTTP client.
Deprecated.
Please use
Http2ClusterStateProviderA SolrClient implementation that communicates to a Solr server using the built-in Java 11+ Http
Client.
Deprecated.
Please use
Http2SolrClient or HttpJdkSolrClientDeprecated.
Please use
Http2SolrClientThis document router is for custom sharding
Represents the NamedList response format created by
InputStreamResponseParser.Simply puts the InputStream into an entry in a NamedList named "stream".
Objects of this class will contain the result of all the intervals defined for a specific field.
Holds counts for facet intervals defined in a field
Marker class so that we can determine which requests are updates.
Interface to help do push writing to an array
Defines a space-efficient serialization/deserialization format for transferring data.
Allows extension of
JavaBinCodec to support serialization of arbitrary data types.Provides methods for marshalling an UpdateRequest to a NamedList which can be serialized in the
javabin format and vice versa.
A common parent for a small set of classes that allow easier composition of JSON facet objects.
ResponseParser for JsonMaps.
Provides a 1:1 mapping from jackson's annotation.
Represents a query using the JSON Query
DSL
A Streaming parser for json to emit one record at a time.
Implement this interface to stream records as and when one is found.
Creates a json schema from an annotated Java Object.
A very basic and lightweight json schema parsing and data validation tool.
Kerberos-enabled SolrHttpClientBuilder
LBHttp2SolrClient or "LoadBalanced LBHttp2SolrClient" is a load balancing wrapper around
Http2SolrClient.Deprecated.
Please use
LBHttp2SolrClientConstructs
LBHttpSolrClient instances from provided configuration.A Solr endpoint for
LBSolrClient to include in its load-balancingExperimental SolrRequest's and SolrResponse's for logging, generated from an OAS.
This is an incomplete representation of the data returned from Luke
Deprecated.
Use
MapWriter insteadSolrParams implementation that can be built from and is backed by a Map.Use this class to push all entries of a Map into an output.
An interface to push one entry at a time to the output.
Deprecated.
This class is similar to
MultiMapSolrParams except you can edit the parameters after it
is initialized.Params for
MoreLikeThisHandler.This is a very fast, non-cryptographic hash suitable for general hash-based lookup.
A simple container class for modeling an ordered list of name/value pairs.
Deprecated.
This class contains helper methods for navigating deeply nested Objects.
Represents the response to a "query" JSON facet.
Experimental SolrRequest's and SolrResponse's for node, generated from an OAS.
This comparator makes sure that the given replicas are sorted according to the given list of
preferences.
Fetch a node's system properties.
Deprecated.
see
instead; more efficientSimple object cache with a type-safe accessor.
Just a container class for POJOs used in Package APIs
A utility class to efficiently parse/store/lookup hierarchical paths which are templatized like
/collections/{collection}/shards/{shard}/{replica}
This represents the individual replica states in a collection This is an immutable object.
The state of a replica as stored as a node under
/collections/collection-name/state.json/replica-state
POJO for a plugin metadata used in container plugins
Deprecated.
Please look into using Solr's new Http2 clients
HttpClientConfigurer implementation providing support for preemptive Http Basic authentication
scheme.
Breaking out some utility methods into a separate class as part of SOLR-4196.
This is an interface to stream data out using a push API
Parameters used with the QueryElevationComponent
Represents a "query" facet in a JSON query request.
Experimental SolrRequest's and SolrResponse's for querying, generated from an OAS.
Represents a range facet result
Represents a "range" facet in a JSON request query.
POJO for Rate Limiter Metadata Configuration
JSON properties related to a replica's state.
The replica's state.
Experimental SolrRequest's and SolrResponse's for replicaProperties, generated from an OAS.
Experimental SolrRequest's and SolrResponse's for replicas, generated from an OAS.
Experimental SolrRequest's and SolrResponse's for replication, generated from an OAS.
Experimental SolrRequest's and SolrResponse's for replicationBackups, generated from an OAS.
Represents the state of an asynchronous request.
A RequestWriter is used to write requests to Solr.
This is a simple wrapper to SolrParams that will throw a 400 exception if you ask for a parameter
that does not exist.
Deprecated.
An
InputStream that can be resumed when the connection that is driving the input is
interrupted.Types of Routed Alias supported.
Deprecated.
Used for routing docs with particular keys into another collection
Experimental SolrRequest's and SolrResponse's for schema, generated from an OAS.
This class offers access to the operations exposed by the Solr Schema API.
Adds a new copy field rule to the schema of the specified collection.
Adds a new dynamic field rule to the schema of the specified collection.
Adds a new field definition to the schema.
Update request used to add a new field type to the schema.
Schema API request that retrieves the source and destination of each copy field in the schema.
Deletes a copy field rule from the schema of the specified collection.
Deletes a dynamic field rule from your schema.
Removes a field definition from the schema.
Removes a field type from the schema of the specified collection.
Schema API request that lists the dynamic field definition for the specified field contained in
the schema.
Schema API request that lists the dynamic field definitions contained in the schema.
Schema API request that lists the field definition for the specified field contained in the
schema.
Schema API request class that lists the field definitions contained in the schema.
Schema API request that retrieves the type definitions for the specified field type contained
in the schema.
Schema API request that lists the types definitions contained in the schema.
Retrieves the class name of the global similarity defined (if any) in the schema.
The Schema API offers the possibility to perform one or more add requests in a single command.
Replaces a dynamic field rule in the schema of the specified collection.
Replaces a field's definition.
Replaces a field type in schema belonging to the schema of the specified collection.
Schema API request class that can be used to retrieve the name of the schema.
Schema API request that can be used to retrieve the version of the schema for the specified
collection.
Schema API request that retrieves the field name that is defined as the uniqueKey for the index
of the specified collection.
This class is used to wrap the response messages retrieved from Solr Schema API.
Experimental SolrRequest's and SolrResponse's for segments, generated from an OAS.
Deprecated.
Parameters used for distributed search.
Deprecated.
Experimental SolrRequest's and SolrResponse's for shards, generated from an OAS.
Hold values of terms, this class is immutable.
Deprecated.
SimpleOrderedMap is a NamedList where access by key is more important than
maintaining order when it comes to representing the held data in other forms, as ResponseWriters
normally do.Parameters used by the SimpleQParser.
A Slice contains immutable information about a logical shard (all replicas that share the same
shard id).
JSON properties related to a slice's state.
The slice's state.
Kindly borrowed the idea and base implementation from the ActiveMQ project; useful for blocking
traffic on a specified port.
BasicAuthentication that does not care about uri and realm
A generic interface to load plugin classes
Abstraction through which all communication with a Solr server may be routed
Deprecated.
Please look into using Solr's new Http2 clients
A lambda intended for invoking SolrClient operations
A
Closeable that also allows checking whether it's been closed.This class mimics the operation of
CountDownLatch, but it also
periodically checks the state of the provided SolrCloseable and terminates the wait if
it's closed by throwing an InterruptedException.Deprecated.
Deprecated.
A concrete representation of a document within a Solr index.
Represent a list of SolrDocuments returned from a search.
This list of valid HTTP Status error codes that Solr may return when there is a "Server Side"
error.
Deprecated.
Please look into using Solr's new Http2 clients
Deprecated.
Please look into using Solr's new Http2 clients
Constants for HTTP Solr interaction.
Deprecated.
Please look into using Solr's new Http2 clients
Ensures that provided identifiers align with Solr's recommendations/requirements for choosing
collection, core, etc.
Represent the field-value information needed to construct and index a Lucene Document.
Use this to serialize an object into Json.
A
ThreadFactory that names threads with the given prefix.Deprecated.
SolrParams is designed to hold parameters to Solr, often from the request coming into Solr.
Verify that there is a working Solr core at the URL of a
SolrClient.A domain handler to validate and match cookies based on the domain and origin.
This is an augmented SolrParams with get/set/add fields for common fields used in the Standard
and Dismax request handlers
A single sort clause, encapsulating what to sort and the sort order.
Exception to catch all types of communication / parsing issues associated with talking to SOLR
A generic interface for any class that is capable of providing its specification as a json schema
Encapsulates responses from SpellCheckComponent
Parameters used for spellchecking
Encapsulates settings related to SSL Configuration.
Stats Parameters
A BinaryResponseParser that sends callback events rather than build a large response
A callback interface for streaming response
A simple update request which streams content to the server
Streaming Expressions Parameters and Properties.
Encapsulates responses from the Suggester Component
This class models a Suggestion coming from Solr Suggest Component.
Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.
Represents a "terms" facet in a JSON query request.
Encapsulates responses from TermsComponent
Source of time.
Implementation that uses
System.currentTimeMillis().Implementation that uses
System.nanoTime().Implementation that uses
TimeSource.NANO_TIME accelerated by a double multiplier.Models the basic information related to a single "tolerated" error that occurred during updates.
Helper class for dealing with SolrException metadata (String) keys
A collection of standard params used by Update handlers
TODO -- mostly a stub until we have a defined output format
A byte[] backed String
Deprecated.
use v2-native
SolrRequest implementations directly insteadDeprecated.
ZkNodeProps contains generic immutable properties.
Experimental SolrRequest's and SolrResponse's for zookeeperRead, generated from an OAS.