org.archive.wayback.replay

Class SelectorReplayDispatcher

java.lang.Object

org.archive.wayback.replay.SelectorReplayDispatcher

All Implemented Interfaces:

ReplayDispatcher

public class SelectorReplayDispatcher
extends Object
implements ReplayDispatcher

ReplayDispatcher instance which uses a configurable ClosestResultSelector to find the best result to show from a given set, and a list of ReplayRendererSelector to determine how best to replay that result to a user.

Optionally it can be configured with MimeTypeDetectors used for overriding unknown ("unk") or often-misused ("text/html") value of CaptureSearchResult.getMimeType().

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MISSING_MIMETYPE
static String[]	DEFAULT_UNTRUSTFUL_MIMETYPES default value for untrustfulMimeTypes

Constructor Summary

Constructors

Constructor and Description
SelectorReplayDispatcher()

Method Summary

Methods

Modifier and Type	Method and Description
CaptureSearchResult	getClosest(WaybackRequest wbRequest, CaptureSearchResults results)
ClosestResultSelector	getClosestSelector()
List<MimeTypeDetector>	getMimeTypeDetectors()
String	getMissingMimeType()
ReplayRenderer	getRenderer(WaybackRequest wbRequest, CaptureSearchResult result, Resource resource) Return a ReplayRenderer appropriate for the Resource.
ReplayRenderer	getRenderer(WaybackRequest wbRequest, CaptureSearchResult result, Resource httpHeadersResource, Resource payloadResource) Return a ReplayRenderer appropriate for the replaying the http headers from httpHeadersResource and the payload from payloadResource.
List<ReplayRendererSelector>	getSelectors()
void	setClosestSelector(ClosestResultSelector closestSelector)
void	setMimeTypeDetectors(List<MimeTypeDetector> sniffers)
void	setMissingMimeType(String missingMimeType) Value of mimetype field indicating Content-Type is unavailable in the response.
void	setSelectors(List<ReplayRendererSelector> selectors)
void	setUntrustfulMimeTypes(List<String> untrustfulMimeTypes) A list of mimetype values that cannot be fully trusted.
protected boolean	shouldDetectMimeType(String mimeType) check if mime-type detection is suggested for mimeType.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MISSING_MIMETYPE

public static final String DEFAULT_MISSING_MIMETYPE

See Also:

Constant Field Values

DEFAULT_UNTRUSTFUL_MIMETYPES

public static final String[] DEFAULT_UNTRUSTFUL_MIMETYPES

default value for untrustfulMimeTypes

Constructor Detail

SelectorReplayDispatcher

public SelectorReplayDispatcher()

Method Detail

setUntrustfulMimeTypes

public void setUntrustfulMimeTypes(List<String> untrustfulMimeTypes)

A list of mimetype values that cannot be fully trusted. For captures whose mimetype prefix-matches any of these, SelectorReplayDispatcher will attempt to detect actual mime-type with mimeTypeDetector (if configured).

Value set to missingMimeType is always considered untrustful. You don't need to include it in this list.

If passed null, default DEFAULT_UNTRUSTFUL_MIMETYPES will be used. If set to an empty array, detection is applied only to captures without Content-Type header.

Parameters:

untrustfulMimeTypes - list of mime-type prefixes

setMissingMimeType

public void setMissingMimeType(String missingMimeType)

Value of mimetype field indicating Content-Type is unavailable in the response. Default is unk (compatible with CDX-Writer). IndexWorker puts application/http, apparently.

Parameters:

missingMimeType -

getMissingMimeType

public String getMissingMimeType()

shouldDetectMimeType

protected boolean shouldDetectMimeType(String mimeType)

check if mime-type detection is suggested for mimeType.

Parameters:

mimeType - mime-type to test (must not be null/empty/"unk")

Returns:

true if mime-type should be determined by looking into Resource.

getRenderer

public ReplayRenderer getRenderer(WaybackRequest wbRequest,
                         CaptureSearchResult result,
                         Resource resource)

Description copied from interface: ReplayDispatcher

Return a ReplayRenderer appropriate for the Resource.

Specified by:

getRenderer in interface ReplayDispatcher

Parameters:

wbRequest - WaybackRequest being handled.

result - CapturSearchResult from the ResourceIndex which is being returned.

resource - Resource as returned by ResourceStore which should be returned to the user.

Returns:

an appropriate ReplayRenderer for the Resource, given the request context

getRenderer

public ReplayRenderer getRenderer(WaybackRequest wbRequest,
                         CaptureSearchResult result,
                         Resource httpHeadersResource,
                         Resource payloadResource)

Description copied from interface: ReplayDispatcher

Return a ReplayRenderer appropriate for the replaying the http headers from httpHeadersResource and the payload from payloadResource.

Specified by:

getRenderer in interface ReplayDispatcher

Parameters:

wbRequest - WaybackRequest being handled.

result - CapturSearchResult from the ResourceIndex which is being returned.

Returns:

an appropriate ReplayRenderer, given the request context

getClosest

public CaptureSearchResult getClosest(WaybackRequest wbRequest,
                             CaptureSearchResults results)

Specified by:

getClosest in interface ReplayDispatcher

Parameters:

wbRequest - the Request being handled

results - the CaptureSearchResults from the ResourceIndex

Returns:

the CaptureSearchResult to be rendered (best for the wbRequest)

getSelectors

public List<ReplayRendererSelector> getSelectors()

Returns:

the List of ReplayRendererSelector objects configured

setSelectors

public void setSelectors(List<ReplayRendererSelector> selectors)

Parameters:

selectors - the List of ReplayRendererSelector to use

getMimeTypeDetectors

public List<MimeTypeDetector> getMimeTypeDetectors()

setMimeTypeDetectors

public void setMimeTypeDetectors(List<MimeTypeDetector> sniffers)

setClosestSelector

public void setClosestSelector(ClosestResultSelector closestSelector)

Parameters:

closestSelector - the closestSelector to set

getClosestSelector

public ClosestResultSelector getClosestSelector()

Returns:

the closestSelector