org.apache.solr.cloud

Interface OverseerMessageHandler

All Known Implementing Classes:

OverseerCollectionMessageHandler, OverseerConfigSetMessageHandler

public interface OverseerMessageHandler

Interface for processing messages received by an OverseerTaskProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OverseerMessageHandler.ExclusiveMarking

Method Summary

Modifier and Type	Method and Description
OverseerMessageHandler.ExclusiveMarking	checkExclusiveMarking(String taskKey, ZkNodeProps message)
String	getName()
String	getTaskKey(ZkNodeProps message)
String	getTimerName(String operation)
void	markExclusiveTask(String taskKey, ZkNodeProps message)
SolrResponse	processMessage(ZkNodeProps message, String operation)
void	unmarkExclusiveTask(String taskKey, String operation, ZkNodeProps message)

Method Detail

processMessage

SolrResponse processMessage(ZkNodeProps message,
                            String operation)

Parameters:

message - the message to process

operation - the operation to process

Returns:

response

getName

String getName()

Returns:

the name of the OverseerMessageHandler

getTimerName

String getTimerName(String operation)

Parameters:

operation - the operation to be timed

Returns:

the name of the timer to use for the operation

getTaskKey

String getTaskKey(ZkNodeProps message)

Parameters:

message - the message being processed

Returns:

the taskKey for the message for handling task exclusivity

markExclusiveTask

void markExclusiveTask(String taskKey,
                       ZkNodeProps message)

Parameters:

taskKey - the key associated with the task, cached from getTaskKey

message - the message being processed

unmarkExclusiveTask

void unmarkExclusiveTask(String taskKey,
                         String operation,
                         ZkNodeProps message)

Parameters:

taskKey - the key associated with the task

operation - the operation being processed

message - the message being processed

checkExclusiveMarking

OverseerMessageHandler.ExclusiveMarking checkExclusiveMarking(String taskKey,
                                                              ZkNodeProps message)

Parameters:

taskKey - the key associated with the task

message - the message being processed

Returns:

the exclusive marking