CheckpointService (Heritrix 3 3.2.0 API)

java.lang.Object
- org.archive.crawler.framework.CheckpointService

All Implemented Interfaces:

HasValidator, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
```
public class CheckpointService
extends Object
implements org.springframework.context.Lifecycle, org.springframework.context.ApplicationContextAware, HasValidator
```
Executes checkpoints, and offers convenience methods for enumerating available Checkpoints and injecting a recovery-Checkpoint after build and before launch (setRecoveryCheckpointByName). Offers optional automatic checkpointing at a configurable interval in minutes.

Contributor:

stack, gojomo, pjack

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.springframework.context.support.AbstractApplicationContext`	`appCtx`
`protected Checkpoint`	`checkpointInProgress`
`protected long`	`checkpointIntervalMinutes`
`protected ConfigPath`	`checkpointsDir`
`protected TimerTask`	`checkpointTask`
`protected CrawlController`	`controller`
`protected boolean`	`forgetAllButLatest`
`protected boolean`	`isRunning`
`protected Checkpoint`	`lastCheckpoint`
`protected CrawlStatSnapshot`	`lastCheckpointSnapshot`
`protected int`	`nextCheckpointNumber` Next overall series checkpoint number
`protected Checkpoint`	`recoveryCheckpoint`
`protected Timer`	`timer` service for auto-checkpoint tasks at an interval
`protected static org.springframework.validation.Validator`	`VALIDATOR`

Constructor Summary

Constructors
Constructor and Description

CheckpointService()
Create a new Checkpointer

Constructors
Constructor and Description
`CheckpointService()` Create a new Checkpointer

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkpointFailed(Exception e)` Note that a checkpoint failed
`protected void`	`checkpointFailed(String message)`
`List<File>`	`findAvailableCheckpointDirectories()` Returns a list of available, valid (contains 'valid' file) checkpoint directories, as File instances, with the more recently-written appearing first.
`long`	`getCheckpointIntervalMinutes()`
`ConfigPath`	`getCheckpointsDir()`
`CrawlController`	`getCrawlController()`
`boolean`	`getForgetAllButLatest()`
`int`	`getNextCheckpointNumber()`
`Checkpoint`	`getRecoveryCheckpoint()`
`org.springframework.validation.Validator`	`getValidator()`
`boolean`	`hasAvailableCheckpoints()`
`boolean`	`isCheckpointing()`
`boolean`	`isRunning()`
`String`	`requestCrawlCheckpoint()` Run a checkpoint of the crawler
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`setCheckpointIntervalMinutes(long interval)` Period at which to create automatic checkpoints; -1 means no auto checkpointing.
`void`	`setCheckpointsDir(ConfigPath checkpointsDir)` Checkpoints directory
`void`	`setCrawlController(CrawlController controller)`
`void`	`setForgetAllButLatest(boolean forgetAllButLatest)` True to save only the latest checkpoint, false to save all of them.
`void`	`setRecoveryCheckpoint(Checkpoint checkpoint)`
`void`	`setRecoveryCheckpointByName(String selectedCheckpoint)` Given the name of a valid checkpoint subdirectory in the checkpoints directory, create a Checkpoint instance, and insert it into all Checkpointable beans.
`protected void`	`setupCheckpointTask()` Setup checkpointTask according to current interval.
`void`	`start()`
`void`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - nextCheckpointNumber
```
protected int nextCheckpointNumber
```
    Next overall series checkpoint number
  - checkpointInProgress
```
protected Checkpoint checkpointInProgress
```
  - lastCheckpoint
```
protected Checkpoint lastCheckpoint
```
  - lastCheckpointSnapshot
```
protected CrawlStatSnapshot lastCheckpointSnapshot
```
  - timer
```
protected Timer timer
```
    service for auto-checkpoint tasks at an interval
  - checkpointTask
```
protected TimerTask checkpointTask
```
  - checkpointsDir
```
protected ConfigPath checkpointsDir
```
  - checkpointIntervalMinutes
```
protected long checkpointIntervalMinutes
```
  - forgetAllButLatest
```
protected boolean forgetAllButLatest
```
  - recoveryCheckpoint
```
protected Checkpoint recoveryCheckpoint
```
  - controller
```
protected CrawlController controller
```
  - appCtx
```
protected org.springframework.context.support.AbstractApplicationContext appCtx
```
  - isRunning
```
protected boolean isRunning
```
  - VALIDATOR
```
protected static org.springframework.validation.Validator VALIDATOR
```
- Constructor Detail
  - CheckpointService
```
public CheckpointService()
```
    Create a new Checkpointer
- Method Detail
  - getCheckpointsDir
```
public ConfigPath getCheckpointsDir()
```
  - setCheckpointsDir
```
public void setCheckpointsDir(ConfigPath checkpointsDir)
```
    Checkpoints directory
  - getCheckpointIntervalMinutes
```
public long getCheckpointIntervalMinutes()
```
  - setCheckpointIntervalMinutes
```
public void setCheckpointIntervalMinutes(long interval)
```
    Period at which to create automatic checkpoints; -1 means no auto checkpointing.
  - getForgetAllButLatest
```
public boolean getForgetAllButLatest()
```
  - setForgetAllButLatest
```
public void setForgetAllButLatest(boolean forgetAllButLatest)
```
    True to save only the latest checkpoint, false to save all of them. Default is false.
  - setRecoveryCheckpoint
```
public void setRecoveryCheckpoint(Checkpoint checkpoint)
```
  - getRecoveryCheckpoint
```
public Checkpoint getRecoveryCheckpoint()
```
  - getCrawlController
```
public CrawlController getCrawlController()
```
  - setCrawlController
```
public void setCrawlController(CrawlController controller)
```
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.springframework.context.Lifecycle
  - setupCheckpointTask
```
protected void setupCheckpointTask()
```
    Setup checkpointTask according to current interval. (An already-scheduled task, if any, is canceled.)
  - 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
  - getNextCheckpointNumber
```
public int getNextCheckpointNumber()
```
    Returns:
    Returns the nextCheckpoint index.
  - requestCrawlCheckpoint
```
public String requestCrawlCheckpoint()
                              throws IllegalStateException
```
    Run a checkpoint of the crawler
    
    Throws:
    
    IllegalStateException
  - isCheckpointing
```
public boolean isCheckpointing()
```
    Returns:
    True if a checkpoint is in progress.
  - checkpointFailed
```
protected void checkpointFailed(Exception e)
```
    Note that a checkpoint failed
    
    Parameters:
    e - Exception checkpoint failed on.
  - checkpointFailed
```
protected void checkpointFailed(String message)
```
  - hasAvailableCheckpoints
```
public boolean hasAvailableCheckpoints()
```
  - findAvailableCheckpointDirectories
```
public List<File> findAvailableCheckpointDirectories()
```
    Returns a list of available, valid (contains 'valid' file) checkpoint directories, as File instances, with the more recently-written appearing first.
    
    Returns:
    List of valid checkpoint directory File instances
  - setRecoveryCheckpointByName
```
public void setRecoveryCheckpointByName(String selectedCheckpoint)
```
    Given the name of a valid checkpoint subdirectory in the checkpoints directory, create a Checkpoint instance, and insert it into all Checkpointable beans.
    
    Parameters:
    selectedCheckpoint -
  - getValidator
```
public org.springframework.validation.Validator getValidator()
```
    Specified by:
    
    getValidator in interface HasValidator

Class CheckpointService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nextCheckpointNumber

checkpointInProgress

lastCheckpoint

lastCheckpointSnapshot

timer

checkpointTask

checkpointsDir

checkpointIntervalMinutes

forgetAllButLatest

recoveryCheckpoint

controller

appCtx

isRunning

VALIDATOR

Constructor Detail

CheckpointService

Method Detail

getCheckpointsDir

setCheckpointsDir

getCheckpointIntervalMinutes

setCheckpointIntervalMinutes

getForgetAllButLatest

setForgetAllButLatest

setRecoveryCheckpoint

getRecoveryCheckpoint

getCrawlController

setCrawlController

setApplicationContext

start

setupCheckpointTask

isRunning

stop

getNextCheckpointNumber

requestCrawlCheckpoint

isCheckpointing

checkpointFailed

checkpointFailed

hasAvailableCheckpoints

findAvailableCheckpointDirectories

setRecoveryCheckpointByName

getValidator