org.archive.checkpointing

Class Checkpoint

java.lang.Object

org.archive.checkpointing.Checkpoint

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class Checkpoint
extends Object
implements org.springframework.beans.factory.InitializingBean

Represents a single checkpoint, by its name and main store directory.

Contributor:

gojomo

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigPath	checkpointDir Checkpoints directory; either an absolute path, or relative to the CheckpointService's checkpointsDirectory (which will be inserted as the COnfigPath base before the Checkpoint is consulted).
protected boolean	forgetAllButLatest
static DecimalFormat	INDEX_FORMAT format for serial numbers
protected String	name
protected String	shortName
protected boolean	success
static String	VALIDITY_STAMP_FILENAME Name of file written with timestamp into valid checkpoints

Constructor Summary

Constructors

Constructor and Description
Checkpoint()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	generateFrom(ConfigPath checkpointsDir, int nextCheckpointNumber) Use immediately after instantiation to fill-in a Checkpoint created outside Spring configuration.
ConfigPath	getCheckpointDir()
boolean	getForgetAllButLatest()
String	getName()
String	getShortName()
boolean	getSuccess()
static boolean	hasValidStamp(File checkpointDirectory)
org.json.JSONObject	loadJson(String beanName)
BufferedReader	loadReader(String beanName, String extraName)
void	saveJson(String beanName, org.json.JSONObject json)
BufferedWriter	saveWriter(String beanName, String extraName)
void	setCheckpointDir(ConfigPath checkpointsDir)
void	setForgetAllButLatest(boolean b)
void	setSuccess(boolean b)
void	writeValidity(String stamp)

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_FORMAT

public static final DecimalFormat INDEX_FORMAT

format for serial numbers

VALIDITY_STAMP_FILENAME

public static final String VALIDITY_STAMP_FILENAME

Name of file written with timestamp into valid checkpoints

See Also:

Constant Field Values

name

protected String name

shortName

protected String shortName

success

protected boolean success

checkpointDir

protected ConfigPath checkpointDir

Checkpoints directory; either an absolute path, or relative to the CheckpointService's checkpointsDirectory (which will be inserted as the COnfigPath base before the Checkpoint is consulted).

forgetAllButLatest

protected boolean forgetAllButLatest

Constructor Detail

Checkpoint

public Checkpoint()

Method Detail

getCheckpointDir

public ConfigPath getCheckpointDir()

setCheckpointDir

public void setCheckpointDir(ConfigPath checkpointsDir)

generateFrom

public void generateFrom(ConfigPath checkpointsDir,
                int nextCheckpointNumber)
                  throws IOException

Use immediately after instantiation to fill-in a Checkpoint created outside Spring configuration.

Parameters:

checkpointsDir -

nextCheckpointNumber -

Throws:

IOException

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

setSuccess

public void setSuccess(boolean b)

getSuccess

public boolean getSuccess()

getName

public String getName()

getShortName

public String getShortName()

writeValidity

public void writeValidity(String stamp)

saveJson

public void saveJson(String beanName,
            org.json.JSONObject json)

loadJson

public org.json.JSONObject loadJson(String beanName)

saveWriter

public BufferedWriter saveWriter(String beanName,
                        String extraName)
                          throws IOException

Throws:

IOException

loadReader

public BufferedReader loadReader(String beanName,
                        String extraName)
                          throws IOException

Throws:

IOException

hasValidStamp

public static boolean hasValidStamp(File checkpointDirectory)

setForgetAllButLatest

public void setForgetAllButLatest(boolean b)

getForgetAllButLatest

public boolean getForgetAllButLatest()