Package org.apache.solr.handler.admin.api

Class AdminAPIBase

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.AdminAPIBase

Direct Known Subclasses:

AddReplicaProperty, AliasProperty, BackupAPIBase, BalanceReplicas, BalanceShardUnique, ClusterProperty, CollectionProperty, CreateAlias, CreateCollection, CreateCollectionSnapshot, CreateReplica, CreateShard, DeleteAlias, DeleteCollection, DeleteCollectionSnapshot, DeleteNode, DeleteReplica, DeleteReplicaProperty, DeleteShard, ForceLeader, InstallShardData, ListAliases, ListCollections, ListCollectionSnapshots, MigrateReplicas, ReloadCollectionAPI, RenameCollection, ReplaceNode, SyncShard, ZookeeperRead

public abstract class AdminAPIBase
extends JerseyResource

A common parent for "admin" (i.e. container-level) APIs.

Field Summary

Fields

Modifier and Type	Field	Description
protected CoreContainer	coreContainer
protected SolrQueryRequest	solrQueryRequest
protected SolrQueryResponse	solrQueryResponse

Fields inherited from class org.apache.solr.api.JerseyResource

containerRequestContext

Constructor Summary

Constructors

Constructor	Description
AdminAPIBase(CoreContainer coreContainer, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse)

Method Summary

Modifier and Type	Method	Description
void	disableResponseCaching()
protected CoreContainer	fetchAndValidateZooKeeperAwareCoreContainer()
protected static void	insertIfNotNull(Map<String,Object> destination, String key, Object value)
static void	recordCollectionForLogAndTracing(String collection, SolrQueryRequest solrQueryRequest)	TODO Taken from CollectionsHandler.handleRequestBody, but its unclear where (if ever) this gets cleared.
protected String	resolveAndValidateAliasIfEnabled(String unresolvedCollectionName, boolean aliasResolutionEnabled)
protected String	resolveCollectionName(String collName, boolean followAliases)
protected org.apache.solr.client.solrj.SolrResponse	submitRemoteMessageAndHandleResponse(SubResponseAccumulatingJerseyResponse response, org.apache.solr.common.params.CollectionParams.CollectionAction action, org.apache.solr.common.cloud.ZkNodeProps remoteMessage, String asyncId)
static void	validateZooKeeperAwareCoreContainer(CoreContainer coreContainer)

Methods inherited from class org.apache.solr.api.JerseyResource

ensureRequiredParameterProvided, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Field Detail

coreContainer

protected final CoreContainer coreContainer

solrQueryRequest

protected final SolrQueryRequest solrQueryRequest

solrQueryResponse

protected final SolrQueryResponse solrQueryResponse

Constructor Detail

AdminAPIBase

public AdminAPIBase(CoreContainer coreContainer,
                    SolrQueryRequest solrQueryRequest,
                    SolrQueryResponse solrQueryResponse)

Method Detail

fetchAndValidateZooKeeperAwareCoreContainer

protected CoreContainer fetchAndValidateZooKeeperAwareCoreContainer()

resolveAndValidateAliasIfEnabled

protected String resolveAndValidateAliasIfEnabled(String unresolvedCollectionName,
                                                  boolean aliasResolutionEnabled)

validateZooKeeperAwareCoreContainer

public static void validateZooKeeperAwareCoreContainer(CoreContainer coreContainer)

resolveCollectionName

protected String resolveCollectionName(String collName,
                                       boolean followAliases)

recordCollectionForLogAndTracing

public static void recordCollectionForLogAndTracing(String collection,
                                                    SolrQueryRequest solrQueryRequest)

TODO Taken from CollectionsHandler.handleRequestBody, but its unclear where (if ever) this gets cleared.

disableResponseCaching

public void disableResponseCaching()

submitRemoteMessageAndHandleResponse

protected org.apache.solr.client.solrj.SolrResponse submitRemoteMessageAndHandleResponse(SubResponseAccumulatingJerseyResponse response,
                                                                                         org.apache.solr.common.params.CollectionParams.CollectionAction action,
                                                                                         org.apache.solr.common.cloud.ZkNodeProps remoteMessage,
                                                                                         String asyncId)
                                                                                  throws Exception

Throws:

Exception

insertIfNotNull

protected static void insertIfNotNull(Map<String,Object> destination,
                                      String key,
                                      Object value)