org.archive.modules.net

Class BdbServerCache

java.lang.Object

org.archive.modules.net.ServerCache

org.archive.modules.fetcher.DefaultServerCache

org.archive.modules.net.BdbServerCache

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Checkpointable, org.springframework.context.Lifecycle

public class BdbServerCache
extends DefaultServerCache
implements org.springframework.context.Lifecycle, Checkpointable

ServerCache backed by BDB big maps; the usual choice for crawls.

See Also:

Serialized Form

Contributor:

pjack, gojomo

Field Summary

Fields

Modifier and Type	Field and Description
protected BdbModule	bdb
protected boolean	isCheckpointRecovery
protected boolean	isRunning

Fields inherited from class org.archive.modules.fetcher.DefaultServerCache

hosts, servers

Constructor Summary

Constructors

Constructor and Description
BdbServerCache()

Method Summary

Methods

Modifier and Type	Method and Description
void	doCheckpoint(Checkpoint checkpointInProgress) Do the actual checkpoint.
void	finishCheckpoint(Checkpoint checkpointInProgress) Cleanup/unlock; need not complete for a checkpoint to be valid.
boolean	isRunning()
void	setBdbModule(BdbModule bdb)
void	setRecoveryCheckpoint(Checkpoint recoveryCheckpoint) Used to inform a bean that it should restore its state from the given Checkpoint when launched (Lifecycle start()).
void	start()
void	startCheckpoint(Checkpoint checkpointInProgress) Note a checkpoint is about to begin.
void	stop()

Methods inherited from class org.archive.modules.fetcher.DefaultServerCache

close, containsHost, containsServer, forAllHostsDo, getHostFor, getServerFor, hostKeys

Methods inherited from class org.archive.modules.net.ServerCache

getHostFor, getServerFor

Methods inherited from class java.lang.Object

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

Field Detail

bdb

protected BdbModule bdb

isRunning

protected boolean isRunning

isCheckpointRecovery

protected boolean isCheckpointRecovery

Constructor Detail

BdbServerCache

public BdbServerCache()

Method Detail

setBdbModule

public void setBdbModule(BdbModule bdb)

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

startCheckpoint

public void startCheckpoint(Checkpoint checkpointInProgress)

Description copied from interface: Checkpointable

Note a checkpoint is about to begin. Most beans will ignore, but some can use this to wrap up tasks that shouldn't be half-done during a checkpoint (and hold a lock to prevent tasks from beginning during the checkpoint).

Specified by:

startCheckpoint in interface Checkpointable

Parameters:

checkpointInProgress - Checkpoint

doCheckpoint

public void doCheckpoint(Checkpoint checkpointInProgress)
                  throws IOException

Description copied from interface: Checkpointable

Do the actual checkpoint. Beans should ensure any state that they would need to recover gets saved in an appropriate place. A moderate amount of state may be saved as a JSONObject into the Checkpoint (which then keeps it in the checkpoint directory.) Larger amounts of state may be stored in a manner private to the bean, or via other collaborating beans (such as BdbModule) which checkpoint backgin database state.

Specified by:

doCheckpoint in interface Checkpointable

Parameters:

checkpointInProgress - Checkpoint

Throws:

IOException

finishCheckpoint

public void finishCheckpoint(Checkpoint checkpointInProgress)

Description copied from interface: Checkpointable

Cleanup/unlock; need not complete for a checkpoint to be valid.

Specified by:

finishCheckpoint in interface Checkpointable

Parameters:

checkpointInProgress - Checkpoint

setRecoveryCheckpoint

public void setRecoveryCheckpoint(Checkpoint recoveryCheckpoint)

Description copied from interface: Checkpointable

Used to inform a bean that it should restore its state from the given Checkpoint when launched (Lifecycle start()). May be autowired or configured after build, but before launch, for example via CheckpointService.setRecoveryCheckpointByName().

Specified by:

setRecoveryCheckpoint in interface Checkpointable

Parameters:

recoveryCheckpoint - Checkpoint