org.archive.wayback.replay

Class DefaultReplayCaptureSelector

java.lang.Object

org.archive.wayback.replay.DefaultReplayCaptureSelector

All Implemented Interfaces:

ReplayCaptureSelector

public class DefaultReplayCaptureSelector
extends Object
implements ReplayCaptureSelector

Default implementation of ReplayCaptureSelector.

This is what used to be embedded in AccessPoint hadleReplay method. It compares previous and next capture of the current one, picks closer capture time-wise. Captures are removed as it traverses the captures list, so that the same capture will not be returned twice.

It also favors successful (200) captures over closer redirects and errors for embeds and bestLatestReplayRequest (see DatelessReplayRequestParser).

New feature 2014-00-18: It also skips captures with any of ROBOT_FLAGS_SKIPPED in robotflags field. This is for new soft-blocked captures feature.

For backward compatibility, this implementation delegates closest-selection (i.e. selecting the first capture to return) to ReplayDispatcher passed to its constructor. ReplayCaptureSelector is not ready for factory-based customization because of this. When ReplayCaptureSelector takes over closest-selection functionality from ReplayDispatcher, dependency on replayDispatcher will be removed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROBOT_FLAGS_SKIPPED captures with these flags in robotflags field are skipped.

Constructor Summary

Constructors

Constructor and Description
DefaultReplayCaptureSelector(ReplayDispatcher replayDispatcher) Initialize object with ReplayDispatcher, to which closest-selection is delegated.

Method Summary

Methods

Modifier and Type	Method and Description
protected CaptureSearchResult	findNextClosest()
protected static boolean	hasAnyRobotFlags(CaptureSearchResult capture, String flags)
CaptureSearchResult	next() return next best capture.
void	setCaptures(CaptureSearchResults captures) set a list of captures to select replay candidate from.
void	setReplayDispatcher(ReplayDispatcher replayDispatcher) set ReplayDispatcher for selecting the best capture.
void	setRequest(WaybackRequest wbRequest) set request information.

Methods inherited from class java.lang.Object

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

Field Detail

ROBOT_FLAGS_SKIPPED

public static final String ROBOT_FLAGS_SKIPPED

captures with these flags in robotflags field are skipped. (TODO: make this customizable?)

See Also:

Constant Field Values

Constructor Detail

DefaultReplayCaptureSelector

public DefaultReplayCaptureSelector(ReplayDispatcher replayDispatcher)

Initialize object with ReplayDispatcher, to which closest-selection is delegated.

Parameters:

replayDispatcher - ReplayDispatcher, cannot be null.

Method Detail

setRequest

public void setRequest(WaybackRequest wbRequest)

Description copied from interface: ReplayCaptureSelector

set request information.

AccessPoint calls this method just once on each instance.

Specified by:

setRequest in interface ReplayCaptureSelector

Parameters:

wbRequest - WaybackRequest for the replay request

setCaptures

public void setCaptures(CaptureSearchResults captures)

Description copied from interface: ReplayCaptureSelector

set a list of captures to select replay candidate from.

AccessPoint may call this method more than once with different instance of CaptureSearchResults within a request. When this method is called, next next() call shall return the best capture in new CaptureSearchResults.

Implementation can make changes to CaptureSearchResults for bookkeeping purposes etc.

Specified by:

setCaptures in interface ReplayCaptureSelector

Parameters:

captures - CaptureSearchResults, non-null

setReplayDispatcher

public void setReplayDispatcher(ReplayDispatcher replayDispatcher)

set ReplayDispatcher for selecting the best capture.

Parameters:

replayDispatcher -

hasAnyRobotFlags

protected static boolean hasAnyRobotFlags(CaptureSearchResult capture,
                       String flags)

next

public CaptureSearchResult next()

Description copied from interface: ReplayCaptureSelector

return next best capture.

Specified by:

next in interface ReplayCaptureSelector

Returns:

CaptureSearchResult, or null if there's no more captures suitable for the request.

findNextClosest

protected CaptureSearchResult findNextClosest()