org.apache.solr.cloud.autoscaling

Class TriggerListenerBase

java.lang.Object

org.apache.solr.cloud.autoscaling.TriggerListenerBase

All Implemented Interfaces:

Closeable, AutoCloseable, TriggerListener

Direct Known Subclasses:

HttpTriggerListener, LoggingListener, SystemLogListener

public abstract class TriggerListenerBase
extends Object
implements TriggerListener

Base class for implementations of TriggerListener.

Field Summary

Fields

Modifier and Type	Field and Description
protected SolrCloudManager	cloudManager
protected AutoScalingConfig.TriggerListenerConfig	config
protected boolean	enabled
protected SolrResourceLoader	loader
protected Set<String>	requiredProperties Set of required property names.
protected Set<String>	validProperties Set of valid property names.
protected Set<String>	validPropertyPrefixes Subclasses can add to this set if they want to allow arbitrary properties that start with one of valid prefixes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TriggerListenerBase()

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(SolrResourceLoader loader, SolrCloudManager cloudManager, AutoScalingConfig.TriggerListenerConfig config) Called when listener is created but before it's initialized and used.
AutoScalingConfig.TriggerListenerConfig	getConfig()
void	init()
boolean	isEnabled() If this method returns false then the listener's TriggerListener.onEvent(TriggerEvent, TriggerEventProcessorStage, String, ActionContext, Throwable, String) method should not be called.

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.TriggerListener

onEvent

Field Detail

config

protected AutoScalingConfig.TriggerListenerConfig config

cloudManager

protected SolrCloudManager cloudManager

loader

protected SolrResourceLoader loader

enabled

protected boolean enabled

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).

validPropertyPrefixes

protected final Set<String> validPropertyPrefixes

Subclasses can add to this set if they want to allow arbitrary properties that start with one of valid prefixes.

Constructor Detail

TriggerListenerBase

protected TriggerListenerBase()

Method Detail

configure

public void configure(SolrResourceLoader loader,
                      SolrCloudManager cloudManager,
                      AutoScalingConfig.TriggerListenerConfig config)
               throws TriggerValidationException

Description copied from interface: TriggerListener

Called when listener 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 TriggerListener

Parameters:

loader - loader to use for instantiating sub-components

cloudManager - current instance of SolrCloudManager

config - coniguration

Throws:

TriggerValidationException - contains details of invalid configuration parameters.

getConfig

public AutoScalingConfig.TriggerListenerConfig getConfig()

Specified by:

getConfig in interface TriggerListener

isEnabled

public boolean isEnabled()

Description copied from interface: TriggerListener

If this method returns false then the listener's TriggerListener.onEvent(TriggerEvent, TriggerEventProcessorStage, String, ActionContext, Throwable, String) method should not be called.

Specified by:

isEnabled in interface TriggerListener

init

public void init()
          throws Exception

Specified by:

init in interface TriggerListener

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException