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

Class LocalSnapshotStorage

java.lang.Object

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

All Implemented Interfaces:

Lifecycle<Void>, SnapshotStorage, Storage

public class LocalSnapshotStorage
extends Object
implements SnapshotStorage

Snapshot storage based on local file storage.

Author:

boyan (boyan@alibaba-inc.com)

2018-Mar-13 2:11:30 PM

Constructor Summary

Constructors

Constructor and Description
LocalSnapshotStorage(String path, String tempPath, RaftOptions raftOptions)

Method Summary

Modifier and Type	Method and Description
SnapshotReader	copyFrom(String uri, SnapshotCopierOptions opts) Copy data from remote uri.
SnapshotWriter	create() Create a snapshot writer.
SnapshotWriter	create(boolean fromEmpty)
long	getLastSnapshotIndex()
boolean	hasServerAddr()
boolean	init(Void v) Initialize the service.
SnapshotReader	open() Open a snapshot reader.
boolean	setFilterBeforeCopyRemote() Set filterBeforeCopyRemote to be true.When true, it will filter the data before copy to remote.
void	setServerAddr(Endpoint addr)
void	setSnapshotThrottle(SnapshotThrottle snapshotThrottle) Configure a SnapshotThrottle.
void	shutdown() Dispose the resources for service.
SnapshotCopier	startToCopyFrom(String uri, SnapshotCopierOptions opts) Starts a copy job to copy data from remote uri.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalSnapshotStorage

public LocalSnapshotStorage(String path,
                            String tempPath,
                            RaftOptions raftOptions)

Method Detail

setSnapshotThrottle

public void setSnapshotThrottle(SnapshotThrottle snapshotThrottle)

Description copied from interface: SnapshotStorage

Configure a SnapshotThrottle.

Specified by:

setSnapshotThrottle in interface SnapshotStorage

Parameters:

snapshotThrottle - throttle of snapshot

hasServerAddr

public boolean hasServerAddr()

setServerAddr

public void setServerAddr(Endpoint addr)

getLastSnapshotIndex

public long getLastSnapshotIndex()

init

public boolean init(Void v)

Description copied from interface: Lifecycle

Initialize the service.

Specified by:

init in interface Lifecycle<Void>

Returns:

true when successes.

shutdown

public void shutdown()

Description copied from interface: Lifecycle

Dispose the resources for service.

Specified by:

shutdown in interface Lifecycle<Void>

setFilterBeforeCopyRemote

public boolean setFilterBeforeCopyRemote()

Description copied from interface: SnapshotStorage

Set filterBeforeCopyRemote to be true.When true, it will filter the data before copy to remote.

Specified by:

setFilterBeforeCopyRemote in interface SnapshotStorage

create

public SnapshotWriter create()

Description copied from interface: SnapshotStorage

Create a snapshot writer.

Specified by:

create in interface SnapshotStorage

create

public SnapshotWriter create(boolean fromEmpty)

open

public SnapshotReader open()

Description copied from interface: SnapshotStorage

Open a snapshot reader.

Specified by:

open in interface SnapshotStorage

copyFrom

public SnapshotReader copyFrom(String uri,
                               SnapshotCopierOptions opts)

Description copied from interface: SnapshotStorage

Copy data from remote uri.

Specified by:

copyFrom in interface SnapshotStorage

Parameters:

uri - remote uri

opts - copy options

Returns:

a SnapshotReader instance

startToCopyFrom

public SnapshotCopier startToCopyFrom(String uri,
                                      SnapshotCopierOptions opts)

Description copied from interface: SnapshotStorage

Starts a copy job to copy data from remote uri.

Specified by:

startToCopyFrom in interface SnapshotStorage

Parameters:

uri - remote uri

opts - copy options

Returns:

a SnapshotCopier instance