com.alipay.sofa.jraft.storage.snapshot.local

Class LocalSnapshotReader

java.lang.Object

com.alipay.sofa.jraft.Status

com.alipay.sofa.jraft.storage.snapshot.Snapshot

com.alipay.sofa.jraft.storage.snapshot.SnapshotReader

com.alipay.sofa.jraft.storage.snapshot.local.LocalSnapshotReader

All Implemented Interfaces:

Lifecycle<Void>, Copiable<Status>, Closeable, AutoCloseable

public class LocalSnapshotReader
extends SnapshotReader

Snapshot reader on local file system.

Author:

boyan (boyan@alibaba-inc.com) 2018-Apr-08 11:10:34 AM

Field Summary

Fields inherited from class com.alipay.sofa.jraft.storage.snapshot.Snapshot

JRAFT_SNAPSHOT_META_FILE, JRAFT_SNAPSHOT_PREFIX, REMOTE_SNAPSHOT_URI_SCHEME

Constructor Summary

Constructors

Constructor and Description
LocalSnapshotReader(LocalSnapshotStorage snapshotStorage, SnapshotThrottle snapshotThrottle, Endpoint addr, RaftOptions raftOptions, String path)

Method Summary

Modifier and Type	Method and Description
void	close()
String	generateURIForCopy() Generate uri for other peers to copy this snapshot.
com.google.protobuf.Message	getFileMeta(String fileName) Get file meta by fileName.
String	getPath() Get the path of the Snapshot
boolean	init(Void v) Initialize the service.
Set<String>	listFiles() List all the existing files in the Snapshot currently
RaftOutter.SnapshotMeta	load() Load the snapshot metadata.
void	shutdown() Dispose the resources for service.

Methods inherited from class com.alipay.sofa.jraft.Status

copy, equals, getCode, getErrorMsg, getRaftError, hashCode, isOk, OK, reset, setCode, setError, setError, setErrorMsg, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalSnapshotReader

public LocalSnapshotReader(LocalSnapshotStorage snapshotStorage,
                           SnapshotThrottle snapshotThrottle,
                           Endpoint addr,
                           RaftOptions raftOptions,
                           String path)

Method Detail

close

public void close()
           throws IOException

Throws:

IOException

init

public boolean init(Void v)

Description copied from interface: Lifecycle

Initialize the service.

Returns:

true when successes.

shutdown

public void shutdown()

Description copied from interface: Lifecycle

Dispose the resources for service.

load

public RaftOutter.SnapshotMeta load()

Description copied from class: SnapshotReader

Load the snapshot metadata.

Specified by:

load in class SnapshotReader

generateURIForCopy

public String generateURIForCopy()

Description copied from class: SnapshotReader

Generate uri for other peers to copy this snapshot. Return an empty string if some error has occur.

Specified by:

generateURIForCopy in class SnapshotReader

getPath

public String getPath()

Description copied from class: Snapshot

Get the path of the Snapshot

Specified by:

getPath in class Snapshot

listFiles

public Set<String> listFiles()

Description copied from class: Snapshot

List all the existing files in the Snapshot currently

Specified by:

listFiles in class Snapshot

getFileMeta

public com.google.protobuf.Message getFileMeta(String fileName)

Description copied from class: Snapshot

Get file meta by fileName.

Specified by:

getFileMeta in class Snapshot