Package org.apache.solr.cloud.api.collections

Class DistributedCollectionConfigSetCommandRunner

java.lang.Object

org.apache.solr.cloud.api.collections.DistributedCollectionConfigSetCommandRunner

public class DistributedCollectionConfigSetCommandRunner
extends Object

Class for execution Collection API and Config Set API commands in a distributed way, without going through Overseer and OverseerCollectionMessageHandler or OverseerConfigSetMessageHandler.

This class is only called when Collection and Config Set API calls are configured to be distributed, which implies cluster state updates are distributed as well.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ZK_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
DistributedCollectionConfigSetCommandRunner(CoreContainer coreContainer)

Method Summary

Modifier and Type	Method	Description
void	deleteAllAsyncIds()	See DistributedApiAsyncTracker.deleteAllAsyncIds()
boolean	deleteSingleAsyncId(String asyncId)	See DistributedApiAsyncTracker.deleteSingleAsyncId(String)
Pair<RequestStatusState,OverseerSolrResponse>	getAsyncTaskRequestStatus(String asyncId)	See DistributedApiAsyncTracker.getAsyncTaskRequestStatus(String)
static String	getCollectionName(ZkNodeProps message)	Collection name can be found in either of two message parameters (why??).
OverseerSolrResponse	runCollectionCommand(ZkNodeProps message, CollectionParams.CollectionAction action, long timeoutMs)	When CollectionsHandler.invokeAction(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse, org.apache.solr.core.CoreContainer, org.apache.solr.common.params.CollectionParams.CollectionAction, org.apache.solr.handler.admin.CollectionsHandler.CollectionOperation) does not enqueue to overseer queue and instead calls this method, this method is expected to do the equivalent of what Overseer does in OverseerCollectionMessageHandler.processMessage(org.apache.solr.common.cloud.ZkNodeProps, java.lang.String).
void	runConfigSetCommand(SolrQueryResponse rsp, ConfigSetsHandler.ConfigSetOperation operation, Map<String,Object> result, long timeoutMs)	When CollectionsHandler.invokeAction(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse, org.apache.solr.core.CoreContainer, org.apache.solr.common.params.CollectionParams.CollectionAction, org.apache.solr.handler.admin.CollectionsHandler.CollectionOperation) does not enqueue to overseer queue and instead calls this method, this method is expected to do the equivalent of what Overseer does in OverseerConfigSetMessageHandler.processMessage(org.apache.solr.common.cloud.ZkNodeProps, java.lang.String).
void	stopAndWaitForPendingTasksToComplete()	Best effort wait for termination of all tasks for a (short) while, then return.

Methods inherited from class java.lang.Object

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

Field Detail

ZK_PATH_SEPARATOR

public static final String ZK_PATH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

DistributedCollectionConfigSetCommandRunner

public DistributedCollectionConfigSetCommandRunner(CoreContainer coreContainer)

Method Detail

getAsyncTaskRequestStatus

public Pair<RequestStatusState,OverseerSolrResponse> getAsyncTaskRequestStatus(String asyncId)
                                                                              throws Exception

See DistributedApiAsyncTracker.getAsyncTaskRequestStatus(String)

Throws:

Exception

deleteSingleAsyncId

public boolean deleteSingleAsyncId(String asyncId)
                            throws Exception

See DistributedApiAsyncTracker.deleteSingleAsyncId(String)

Throws:

Exception

deleteAllAsyncIds

public void deleteAllAsyncIds()
                       throws Exception

See DistributedApiAsyncTracker.deleteAllAsyncIds()

Throws:

Exception

runConfigSetCommand

public void runConfigSetCommand(SolrQueryResponse rsp,
                                ConfigSetsHandler.ConfigSetOperation operation,
                                Map<String,Object> result,
                                long timeoutMs)
                         throws Exception

When CollectionsHandler.invokeAction(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse, org.apache.solr.core.CoreContainer, org.apache.solr.common.params.CollectionParams.CollectionAction, org.apache.solr.handler.admin.CollectionsHandler.CollectionOperation) does not enqueue to overseer queue and instead calls this method, this method is expected to do the equivalent of what Overseer does in OverseerConfigSetMessageHandler.processMessage(org.apache.solr.common.cloud.ZkNodeProps, java.lang.String).

The steps leading to that call in the Overseer execution path are (and the equivalent is done here):

• OverseerTaskProcessor.run() gets the message from the ZK queue, grabs the corresponding locks (write lock on the config set target of the API command and a read lock on the base config set if any - the case for config set creation) then executes the command using an executor service (it also checks the asyncId if any is specified but async calls are not supported for Config Set API calls).
• In OverseerTaskProcessor.Runner.run() (run on an executor thread) a call is made to OverseerConfigSetMessageHandler.processMessage(org.apache.solr.common.cloud.ZkNodeProps, java.lang.String) which does a few checks and calls the appropriate Config Set method.

Throws:

Exception

runCollectionCommand

public OverseerSolrResponse runCollectionCommand(ZkNodeProps message,
                                                 CollectionParams.CollectionAction action,
                                                 long timeoutMs)

When CollectionsHandler.invokeAction(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse, org.apache.solr.core.CoreContainer, org.apache.solr.common.params.CollectionParams.CollectionAction, org.apache.solr.handler.admin.CollectionsHandler.CollectionOperation) does not enqueue to overseer queue and instead calls this method, this method is expected to do the equivalent of what Overseer does in OverseerCollectionMessageHandler.processMessage(org.apache.solr.common.cloud.ZkNodeProps, java.lang.String).

The steps leading to that call in the Overseer execution path are (and the equivalent is done here):

• OverseerTaskProcessor.run() gets the message from the ZK queue, grabs the corresponding lock (Collection API calls do locking to prevent non compatible concurrent modifications of a collection), marks the async id of the task as running then executes the command using an executor service
• In OverseerTaskProcessor.Runner.run() (run on an executor thread) a call is made to OverseerCollectionMessageHandler.processMessage(org.apache.solr.common.cloud.ZkNodeProps, java.lang.String) which sets the logging context, calls CollApiCmds.CollectionApiCommand.call(org.apache.solr.common.cloud.ClusterState, org.apache.solr.common.cloud.ZkNodeProps, org.apache.solr.common.util.NamedList<java.lang.Object>)

stopAndWaitForPendingTasksToComplete

public void stopAndWaitForPendingTasksToComplete()

Best effort wait for termination of all tasks for a (short) while, then return. This method is called when the JVM shuts down so tasks that did not complete are expected to be stopped mid processing.

getCollectionName

public static String getCollectionName(ZkNodeProps message)

Collection name can be found in either of two message parameters (why??). Return it from where it's defined. (see also parameter collectionNameParamName of MutatingCommand(CollectionParams.CollectionAction, String))