org.elasticsearch.env

Class ShardLock

java.lang.Object

org.elasticsearch.env.ShardLock

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class ShardLock
extends Object
implements Closeable

A shard lock guarantees exclusive access to a shards data directory. Internal processes should acquire a lock on a shard before executing any write operations on the shards data directory.

See Also:

NodeEnvironment

Constructor Summary

Constructors

Constructor and Description
ShardLock(ShardId id)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected abstract void	closeInternal()
ShardId	getShardId() Returns the locks shards Id.
boolean	isOpen() Returns true if this lock is still open ie.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardLock

public ShardLock(ShardId id)

Method Detail

getShardId

public final ShardId getShardId()

Returns the locks shards Id.

close

public final void close()
                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

closeInternal

protected abstract void closeInternal()

isOpen

public final boolean isOpen()

Returns true if this lock is still open ie. has not been closed yet.

toString

public String toString()

Overrides:

toString in class Object