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

Class LocalSnapshotWriter

java.lang.Object

com.alipay.sofa.jraft.Status

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

com.alipay.sofa.jraft.storage.snapshot.SnapshotWriter

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

All Implemented Interfaces:

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

public class LocalSnapshotWriter
extends SnapshotWriter

Snapshot writer to write snapshot into local file system.

Author:

boyan (boyan@alibaba-inc.com) 2018-Apr-08 11:51:43 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
LocalSnapshotWriter(String path, LocalSnapshotStorage snapshotStorage, RaftOptions raftOptions)

Method Summary

Modifier and Type	Method and Description
boolean	addFile(String fileName, com.google.protobuf.Message fileMeta) Adds a snapshot file with metadata.
void	close()
void	close(boolean keepDataOnError) Close the writer.
com.google.protobuf.Message	getFileMeta(String fileName) Get file meta by fileName.
String	getPath() Get the path of the Snapshot
long	getSnapshotIndex()
boolean	init(Void v) Initialize the service.
Set<String>	listFiles() List all the existing files in the Snapshot currently
boolean	removeFile(String fileName) Remove a snapshot file.
boolean	saveMeta(RaftOutter.SnapshotMeta meta) Save a snapshot metadata.
void	shutdown() Dispose the resources for service.
boolean	sync()

Methods inherited from class com.alipay.sofa.jraft.storage.snapshot.SnapshotWriter

addFile, getCurrentMeta

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

LocalSnapshotWriter

public LocalSnapshotWriter(String path,
                           LocalSnapshotStorage snapshotStorage,
                           RaftOptions raftOptions)

Method Detail

init

public boolean init(Void v)

Description copied from interface: Lifecycle

Initialize the service.

Returns:

true when successes.

getSnapshotIndex

public long getSnapshotIndex()

shutdown

public void shutdown()

Description copied from interface: Lifecycle

Dispose the resources for service.

close

public void close()
           throws IOException

Throws:

IOException

close

public void close(boolean keepDataOnError)
           throws IOException

Description copied from class: SnapshotWriter

Close the writer.

Specified by:

close in class SnapshotWriter

Parameters:

keepDataOnError - whether to keep data when error happens.

Throws:

IOException - if occurred an IO error

saveMeta

public boolean saveMeta(RaftOutter.SnapshotMeta meta)

Description copied from class: SnapshotWriter

Save a snapshot metadata.

Specified by:

saveMeta in class SnapshotWriter

Parameters:

meta - snapshot metadata

Returns:

true on success

sync

public boolean sync()
             throws IOException

Throws:

IOException

addFile

public boolean addFile(String fileName,
                       com.google.protobuf.Message fileMeta)

Description copied from class: SnapshotWriter

Adds a snapshot file with metadata.

Specified by:

addFile in class SnapshotWriter

Parameters:

fileName - file name

fileMeta - file metadata

Returns:

true on success

removeFile

public boolean removeFile(String fileName)

Description copied from class: SnapshotWriter

Remove a snapshot file.

Specified by:

removeFile in class SnapshotWriter

Parameters:

fileName - file name

Returns:

true on success

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