org.apache.solr.cloud.autoscaling

Interface TriggerAction

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AutoAddReplicasPlanAction, ComputePlanAction, ExecutePlanAction, InactiveMarkersPlanAction, InactiveShardPlanAction, TriggerActionBase

public interface TriggerAction
extends Closeable

Interface for actions performed in response to a trigger being activated

Method Summary

Modifier and Type	Method and Description
void	configure(SolrResourceLoader loader, SolrCloudManager cloudManager, Map<String,Object> properties) Called when action is created but before it's initialized and used.
String	getName()
void	init() Called before an action is first used.
void	process(TriggerEvent event, ActionContext context)

Methods inherited from interface java.io.Closeable

close

Method Detail

configure

void configure(SolrResourceLoader loader,
               SolrCloudManager cloudManager,
               Map<String,Object> properties)
        throws TriggerValidationException

Called when action is created but before it's initialized and used. This method should also verify that the configuration parameters are correct. It may be called multiple times.

Parameters:

loader - loader to use for instantiating sub-components

cloudManager - current instance of SolrCloudManager

properties - configuration properties

Throws:

TriggerValidationException - contains details of invalid configuration parameters.

init

void init()
   throws Exception

Called before an action is first used. Any heavy object creation or initialization should be done in this method instead of the constructor or configure(SolrResourceLoader, SolrCloudManager, Map) method.

Throws:

Exception

getName

String getName()

process

void process(TriggerEvent event,
             ActionContext context)
      throws Exception

Throws:

Exception