OverseerMessageHandler (Solr 9.7.0 core API)

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 Description

static interface OverseerMessageHandler.Lock

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getName()`
`String`	`getTaskKey(org.apache.solr.common.cloud.ZkNodeProps message)`
`String`	`getTimerName(String operation)`
`OverseerMessageHandler.Lock`	`lockTask(org.apache.solr.common.cloud.ZkNodeProps message, long batchSessionId)`	Grabs an exclusive lock for this particular task.
`OverseerSolrResponse`	`processMessage(org.apache.solr.common.cloud.ZkNodeProps message, String operation)`

- Method Detail
  - processMessage
```
OverseerSolrResponse processMessage(org.apache.solr.common.cloud.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
  - lockTask
```
OverseerMessageHandler.Lock lockTask(org.apache.solr.common.cloud.ZkNodeProps message,
                                     long batchSessionId)
```
    Grabs an exclusive lock for this particular task.
    
    Returns:
    
    null if locking is not possible.
  - getTaskKey
```
String getTaskKey(org.apache.solr.common.cloud.ZkNodeProps message)
```
    Parameters:
    
    message - the message being processed
    
    Returns:
    
    the taskKey for the message for handling task exclusivity