Package org.elasticsearch.common.component

Class AbstractLifecycleComponent

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable

Direct Known Subclasses:

BlobStoreRepository, CircuitBreakerService, ClusterApplierService, ClusterService, DelayedAllocationService, GatewayService, IndicesClusterStateService, IndicesService, JvmGcMonitorService, MasterService, MonitorService, NodeConnectionsService, ResourceWatcherService, RoutingService, SearchService, SingleNodeDiscovery, SnapshotShardsService, SnapshotsService, TcpTransport, TransportService, ZenDiscovery

public abstract class AbstractLifecycleComponent
extends java.lang.Object
implements LifecycleComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected Lifecycle	lifecycle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLifecycleComponent()
protected	AbstractLifecycleComponent(Settings settings)	Deprecated. the settings parameters are not used, therefore the use of this constructor is deprecated.

Method Summary

Modifier and Type	Method	Description
void	addLifecycleListener(LifecycleListener listener)
void	close()
protected abstract void	doClose()
protected abstract void	doStart()
protected abstract void	doStop()
Lifecycle.State	lifecycleState()
void	removeLifecycleListener(LifecycleListener listener)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

lifecycle

protected final Lifecycle lifecycle

Constructor Detail

AbstractLifecycleComponent

protected AbstractLifecycleComponent()

AbstractLifecycleComponent

@Deprecated
protected AbstractLifecycleComponent(Settings settings)

Deprecated.

the settings parameters are not used, therefore the use of this constructor is deprecated. Going to be removed in subsequent versions. The parameterless constructor should be used instead.

Method Detail

lifecycleState

public Lifecycle.State lifecycleState()

Specified by:

lifecycleState in interface LifecycleComponent

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)

Specified by:

addLifecycleListener in interface LifecycleComponent

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)

Specified by:

removeLifecycleListener in interface LifecycleComponent

start

public void start()

Specified by:

start in interface LifecycleComponent

doStart

protected abstract void doStart()

stop

public void stop()

Specified by:

stop in interface LifecycleComponent

doStop

protected abstract void doStop()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface Releasable

doClose

protected abstract void doClose()
                         throws java.io.IOException

Throws:

java.io.IOException