org.archive.wayback.memento

Class TimeMapRequestParser

java.lang.Object

org.archive.wayback.requestparser.BaseRequestParser

org.archive.wayback.requestparser.WrappedRequestParser

org.archive.wayback.memento.TimeMapRequestParser

All Implemented Interfaces:

MementoConstants, RequestParser

public class TimeMapRequestParser
extends WrappedRequestParser
implements MementoConstants

Class which parses TimeMap requests (/timemap/FORMAT/URL)

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	WB_REQUEST_REGEX

Fields inherited from class org.archive.wayback.requestparser.BaseRequestParser

DEFAULT_MAX_RECORDS, QUERY_BASE, REPLAY_BASE, XQUERY_BASE

Fields inherited from interface org.archive.wayback.memento.MementoConstants

ACCEPT_DATETIME, AGGREGATION_PREFIX_CONFIG, APPLICATION_LINK_FORMAT, APPLICATION_RDF_XML_FORMAT, DATE_FORMAT_14, DATETIME, FIRST, FIRST_LAST_MEMENTO, FIRST_MEMENTO, FORMAT_LINK, FORMAT_RDF, FROM, GMT_TIMEZONE_STRING, GMT_TZ, HTTP_LINK_DATE_FORMAT, LAST, LAST_MEMENTO, LINK, LINK_PATH, MEMENTO, MEMENTO_DATETIME, NEGOTIATE_DATETIME, NEXT, NEXT_LAST_MEMENTO, NEXT_MEMENTO, ORIGINAL, PAGE_MAXRECORDS_CONFIG, PAGE_STARTS, PREV, PREV_FIRST_MEMENTO, PREV_MEMENTO, RDF_XML_SERIALIZER, REL, TIMEBUNDLE, TIMEBUNDLE_RESPONSE_CODE, TIMEGATE, TIMEGATE_JSP_HANDLER, TIMEGATE_PREFIX_CONFIG, TIMEMAP, UNTIL, VARY, WBR_FORMAT_KEY, WBR_TIMEGATE_KEY, WBR_TIMEGATE_VALUE

Constructor Summary

Constructors

Constructor and Description
TimeMapRequestParser(BaseRequestParser wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
WaybackRequest	parse(javax.servlet.http.HttpServletRequest httpRequest, AccessPoint accessPoint) attempt to transform an incoming HttpServletRequest into a WaybackRequest object. returns null if there is missing information.

Methods inherited from class org.archive.wayback.requestparser.WrappedRequestParser

getEarliestTimestamp, getLatestTimestamp, getMaxRecords

Methods inherited from class org.archive.wayback.requestparser.BaseRequestParser

setEarliestTimestamp, setLatestTimestamp, setMaxRecords

Methods inherited from class java.lang.Object

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

Field Detail

WB_REQUEST_REGEX

public static final Pattern WB_REQUEST_REGEX

Constructor Detail

TimeMapRequestParser

public TimeMapRequestParser(BaseRequestParser wrapped)

Parameters:

wrapped - BaseRequestParser holding config

Method Detail

parse

public WaybackRequest parse(javax.servlet.http.HttpServletRequest httpRequest,
                   AccessPoint accessPoint)
                     throws BadQueryException,
                            BetterRequestException

Description copied from interface: RequestParser

attempt to transform an incoming HttpServletRequest into a WaybackRequest object. returns null if there is missing information.

Specified by:

parse in interface RequestParser

Specified by:

parse in class BaseRequestParser

Parameters:

httpRequest - ServletHttpRequest being handled

accessPoint - AccessPoint which is attempting to parse the request

Returns:

populated WaybackRequest object if successful, null otherwise.

Throws:

BadQueryException - if the request could match this AccessPoint, but is malformed: invalid datespec, URL, or flags

BetterRequestException - if the request should be redirected to provide better user feedback (corrected URL/date in address bar)