java.lang.Object
- org.apache.solr.client.solrj.SolrRequest<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AliasesApi.DeleteAlias, AliasesApi.GetAliasByName, AliasesApi.GetAliases, AliasPropertiesApi.CreateOrUpdateAliasProperty, AliasPropertiesApi.DeleteAliasProperty, AliasPropertiesApi.GetAliasProperty, AliasPropertiesApi.GetAllAliasProperties, AliasPropertiesApi.UpdateAliasProperties, ClusterApi.BalanceReplicas, ClusterApi.MigrateReplicas, CollectionAdminRequest, CollectionBackupsApi.CreateCollectionBackup, CollectionBackupsApi.DeleteMultipleBackupsByRecency, CollectionBackupsApi.DeleteSingleBackupById, CollectionBackupsApi.GarbageCollectUnusedBackupFiles, CollectionBackupsApi.ListBackupsAtLocation, CollectionPropertiesApi.CreateOrUpdateCollectionProperty, CollectionPropertiesApi.DeleteCollectionProperty, CollectionRequiringSolrRequest, CollectionsApi.BalanceShardUnique, CollectionsApi.CreateCollection, CollectionsApi.DeleteCollection, CollectionsApi.ListCollections, CollectionsApi.ReloadCollection, CollectionsApi.RenameCollection, CollectionSnapshotsApi.CreateCollectionSnapshot, CollectionSnapshotsApi.DeleteCollectionSnapshot, ConfigSetAdminRequest, ConfigsetsApi.ListConfigSet, CoreAdminRequest, CoreBackupsApi.CreateBackup, CoresApi.InstallCoreData, CoresApi.MergeIndexes, CoresApi.ReloadCore, CoresApi.RenameCore, CoresApi.RestoreCore, CoresApi.SwapCores, CoresApi.UnloadCore, CoreSnapshotsApi.CreateSnapshot, CoreSnapshotsApi.DeleteSnapshot, CoreSnapshotsApi.ListSnapshots, DelegationTokenRequest, GenericSolrRequest, HealthCheckRequest, NodeApi.DeleteNode, NodeApi.GetCommandStatus, NodeApi.GetPublicKey, NodeApi.ReplaceNode, QueryingApi.JsonQuery, QueryingApi.Query, ReplicaPropertiesApi.AddReplicaProperty, ReplicaPropertiesApi.DeleteReplicaProperty, ReplicasApi.CreateReplica, ReplicasApi.DeleteReplicaByName, ReplicasApi.DeleteReplicasByCount, ReplicasApi.DeleteReplicasByCountAllShards, SchemaApi.GetSchemaInfo, SchemaApi.GetSchemaName, SchemaApi.GetSchemaSimilarity, SchemaApi.GetSchemaUniqueKey, SchemaApi.GetSchemaVersion, SchemaApi.GetSchemaZkVersion, ShardsApi.CreateShard, ShardsApi.DeleteShard, ShardsApi.ForceShardLeader, ShardsApi.InstallShardData, ShardsApi.SyncShard, V2Request
```
public abstract class SolrRequest<T extends SolrResponse>
extends Object
implements Serializable
```
Since:

solr 1.3

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SolrRequest.METHOD

static class SolrRequest.SolrClientContext

static class SolrRequest.SolrRequestType

Field Summary

Fields
Modifier and Type Field Description

static Set<String> SUPPORTED_METHODS

protected boolean useBinaryV2

protected boolean usev2

Constructor Summary

Constructors
Constructor Description

SolrRequest(SolrRequest.METHOD m, String path)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addHeader(String key, String value)`
`void`	`addHeaders(Map<String,String> headers)`
`protected abstract T`	`createResponse(SolrClient client)`	Create a new SolrResponse to hold the response from the server
`String`	`getBasePath()`
`String`	`getBasicAuthPassword()`
`String`	`getBasicAuthUser()`
`String`	`getCollection()`
`Collection<ContentStream>`	`getContentStreams()`	Deprecated. Please use `getContentWriter(String)` instead.
`RequestWriter.ContentWriter`	`getContentWriter(String expectedType)`	If a request object wants to do a push write, implement this method.
`Map<String,String>`	`getHeaders()`
`SolrRequest.METHOD`	`getMethod()`
`abstract SolrParams`	`getParams()`
`String`	`getPath()`
`List<String>`	`getPreferredNodes()`
`Set<String>`	`getQueryParams()`	Parameter keys that are sent via the query string
`abstract String`	`getRequestType()`	This method defines the type of this Solr request.
`ResponseParser`	`getResponseParser()`
`StreamingResponseCallback`	`getStreamingResponseCallback()`
`Principal`	`getUserPrincipal()`
`T`	`process(SolrClient client)`	Send this request to a `SolrClient` and return the response
`T`	`process(SolrClient client, String collection)`	Send this request to a `SolrClient` and return the response
`boolean`	`requiresCollection()`	Determines whether this request should use or ignore any specified collections (esp.
`void`	`setBasePath(String path)`
`SolrRequest<T>`	`setBasicAuthCredentials(String user, String password)`
`void`	`setMethod(SolrRequest.METHOD method)`
`void`	`setPath(String path)`
`SolrRequest<T>`	`setPreferredNodes(List<String> nodes)`
`void`	`setQueryParams(Set<String> queryParams)`
`void`	`setResponseParser(ResponseParser responseParser)`	Optionally specify how the Response should be parsed.
`void`	`setStreamingResponseCallback(StreamingResponseCallback callback)`
`SolrRequest<T>`	`setUseBinaryV2(boolean flag)`	Deprecated. use v2-native `SolrRequest` implementations directly instead
`void`	`setUserPrincipal(Principal userPrincipal)`
`SolrRequest<T>`	`setUseV2(boolean flag)`	Deprecated. use v2-native `SolrRequest` implementations directly instead

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUPPORTED_METHODS

public static final Set<String> SUPPORTED_METHODS

usev2
```
protected boolean usev2
```

useBinaryV2
```
protected boolean useBinaryV2
```

Constructor Detail

SolrRequest

public SolrRequest(SolrRequest.METHOD m,
                   String path)

Method Detail
- setUserPrincipal
```
public void setUserPrincipal(Principal userPrincipal)
```
- getUserPrincipal
```
public Principal getUserPrincipal()
```
- setUseV2
```
@Deprecated
public SolrRequest<T> setUseV2(boolean flag)
```
  Deprecated.
  use v2-native SolrRequest implementations directly instead
  
  If set to true, every request that implements V2RequestSupport will be converted to a V2 API call
- setUseBinaryV2
```
@Deprecated
public SolrRequest<T> setUseBinaryV2(boolean flag)
```
  Deprecated.
  use v2-native SolrRequest implementations directly instead
  
  If set to true use javabin instead of json (default)
- setPreferredNodes
```
public SolrRequest<T> setPreferredNodes(List<String> nodes)
```
- getPreferredNodes
```
public List<String> getPreferredNodes()
```
- setBasicAuthCredentials
```
public SolrRequest<T> setBasicAuthCredentials(String user,
                                              String password)
```
- getBasicAuthUser
```
public String getBasicAuthUser()
```
- getBasicAuthPassword
```
public String getBasicAuthPassword()
```
- getMethod
```
public SolrRequest.METHOD getMethod()
```
- setMethod
```
public void setMethod(SolrRequest.METHOD method)
```
- getPath
```
public String getPath()
```
- setPath
```
public void setPath(String path)
```
- getResponseParser
```
public ResponseParser getResponseParser()
```
  Returns:
  
  The ResponseParser
- setResponseParser
```
public void setResponseParser(ResponseParser responseParser)
```
  Optionally specify how the Response should be parsed. Not all server implementations require a ResponseParser to be specified.
  
  Parameters:
  
  responseParser - The ResponseParser
- getStreamingResponseCallback
```
public StreamingResponseCallback getStreamingResponseCallback()
```
- setStreamingResponseCallback
```
public void setStreamingResponseCallback(StreamingResponseCallback callback)
```
- getQueryParams
```
public Set<String> getQueryParams()
```
  Parameter keys that are sent via the query string
- setQueryParams
```
public void setQueryParams(Set<String> queryParams)
```
- getRequestType
```
public abstract String getRequestType()
```
  This method defines the type of this Solr request.
- getParams
```
public abstract SolrParams getParams()
```
- requiresCollection
```
public boolean requiresCollection()
```
  Determines whether this request should use or ignore any specified collections (esp. SolrClient.defaultCollection)
  Many Solr requests target a particular core or collection. But not all of them - many Solr APIs (e.g. security or other admin APIs) are agnostic of collections entirely. This method gives these requests a way to opt out of using SolrClient.defaultCollection or other specified collections.
- getContentStreams
```
@Deprecated
public Collection<ContentStream> getContentStreams()
                                            throws IOException
```
  Deprecated.
  Please use getContentWriter(String) instead.
  
  Throws:
  
  IOException
- getContentWriter
```
public RequestWriter.ContentWriter getContentWriter(String expectedType)
```
  If a request object wants to do a push write, implement this method.
  
  Parameters:
  
  expectedType - This is the type that the RequestWriter would like to get. But, it is OK to send any format
- createResponse
```
protected abstract T createResponse(SolrClient client)
```
  Create a new SolrResponse to hold the response from the server
  
  Parameters:
  
  client - the SolrClient the request will be sent to
- process
```
public final T process(SolrClient client,
                       String collection)
                throws SolrServerException,
                       IOException
```
  Send this request to a SolrClient and return the response
  
  Parameters:
  
  client - the SolrClient to communicate with
  
  collection - the collection to execute the request against
  
  Returns:
  
  the response
  
  Throws:
  
  SolrServerException - if there is an error on the Solr server
  
  IOException - if there is a communication error
- process
```
public final T process(SolrClient client)
                throws SolrServerException,
                       IOException
```
  Send this request to a SolrClient and return the response
  
  Parameters:
  
  client - the SolrClient to communicate with
  
  Returns:
  
  the response
  
  Throws:
  
  SolrServerException - if there is an error on the Solr server
  
  IOException - if there is a communication error
- getCollection
```
public String getCollection()
```
- setBasePath
```
public void setBasePath(String path)
```
- getBasePath
```
public String getBasePath()
```
- addHeader
```
public void addHeader(String key,
                      String value)
```
- addHeaders
```
public void addHeaders(Map<String,String> headers)
```
- getHeaders
```
public Map<String,String> getHeaders()
```

Modifier and Type	Class	Description
`static class`	`SolrRequest.METHOD`
`static class`	`SolrRequest.SolrClientContext`
`static class`	`SolrRequest.SolrRequestType`

Modifier and Type	Field	Description
`static Set<String>`	`SUPPORTED_METHODS`
`protected boolean`	`useBinaryV2`
`protected boolean`	`usev2`

Class SolrRequest<T extends SolrResponse>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SUPPORTED_METHODS

usev2

useBinaryV2

Constructor Detail

SolrRequest

Method Detail

setUserPrincipal

getUserPrincipal

setUseV2

setUseBinaryV2

setPreferredNodes

getPreferredNodes

setBasicAuthCredentials

getBasicAuthUser

getBasicAuthPassword

getMethod

setMethod

getPath

setPath

getResponseParser

setResponseParser

getStreamingResponseCallback

setStreamingResponseCallback

getQueryParams

setQueryParams

getRequestType

getParams

requiresCollection

getContentStreams

getContentWriter

createResponse

process

process

getCollection

setBasePath

getBasePath

addHeader

addHeaders

getHeaders