org.elasticsearch.indices.breaker

Class CircuitBreakerService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<CircuitBreakerService>

org.elasticsearch.indices.breaker.CircuitBreakerService

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<CircuitBreakerService>, Releasable

Direct Known Subclasses:

HierarchyCircuitBreakerService, NoneCircuitBreakerService

public abstract class CircuitBreakerService
extends AbstractLifecycleComponent<CircuitBreakerService>

Interface for Circuit Breaker services, which provide breakers to classes that load field data.

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

componentSettings, logger, settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CircuitBreakerService(Settings settings)

Method Summary

Modifier and Type	Method and Description
protected void	doClose()
protected void	doStart()
protected void	doStop()
abstract CircuitBreaker	getBreaker(CircuitBreaker.Name type)
abstract AllCircuitBreakerStats	stats()
abstract CircuitBreakerStats	stats(CircuitBreaker.Name name)

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

CircuitBreakerService

protected CircuitBreakerService(Settings settings)

Method Detail

getBreaker

public abstract CircuitBreaker getBreaker(CircuitBreaker.Name type)

Returns:

the breaker that can be used to register estimates against

stats

public abstract AllCircuitBreakerStats stats()

Returns:

stats about all breakers

stats

public abstract CircuitBreakerStats stats(CircuitBreaker.Name name)

Returns:

stats about a specific breaker

doStart

protected void doStart()
                throws ElasticsearchException

Specified by:

doStart in class AbstractLifecycleComponent<CircuitBreakerService>

Throws:

ElasticsearchException

doStop

protected void doStop()
               throws ElasticsearchException

Specified by:

doStop in class AbstractLifecycleComponent<CircuitBreakerService>

Throws:

ElasticsearchException

doClose

protected void doClose()
                throws ElasticsearchException

Specified by:

doClose in class AbstractLifecycleComponent<CircuitBreakerService>

Throws:

ElasticsearchException