Package org.apache.solr.cloud.autoscaling

Class TriggerActionBase

java.lang.Object

org.apache.solr.cloud.autoscaling.TriggerActionBase

All Implemented Interfaces:

Closeable, AutoCloseable, TriggerAction

Direct Known Subclasses:

ComputePlanAction, ExecutePlanAction, InactiveMarkersPlanAction, InactiveShardPlanAction

public abstract class TriggerActionBase
extends Object
implements TriggerAction

Base class for TriggerAction implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected SolrCloudManager	cloudManager
protected SolrResourceLoader	loader
protected Map<String,Object>	properties
protected Set<String>	requiredProperties	Set of required property names.
protected Set<String>	validProperties	Set of valid property names.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TriggerActionBase()

Method Summary

Modifier and Type	Method	Description
void	close()
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.cloud.autoscaling.TriggerAction

process

Field Detail

properties

protected Map<String,Object> properties

loader

protected SolrResourceLoader loader

cloudManager

protected SolrCloudManager cloudManager

validProperties

protected final Set<String> validProperties

Set of valid property names. Subclasses may add to this set using TriggerUtils.validProperties(Set, String...)

requiredProperties

protected final Set<String> requiredProperties

Set of required property names. Subclasses may add to this set using TriggerUtils.requiredProperties(Set, Set, String...) (required properties are also valid properties).

Constructor Detail

TriggerActionBase

protected TriggerActionBase()

Method Detail

getName

public String getName()

Specified by:

getName in interface TriggerAction

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

configure

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

Description copied from interface: TriggerAction

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.

Specified by:

configure in interface TriggerAction

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

public void init()
          throws Exception

Description copied from interface: TriggerAction

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

Specified by:

init in interface TriggerAction

Throws:

Exception