org.archive.wayback.requestparser
Class OpenSearchRequestParser

java.lang.Object
  org.archive.wayback.requestparser.BaseRequestParser
      org.archive.wayback.requestparser.OpenSearchRequestParser

All Implemented Interfaces:

RequestParser

public class OpenSearchRequestParser
extends BaseRequestParser

Version:

$Date$, $Revision$

Author:

brad

Field Summary

static java.lang.String	SEARCH_QUERY CGI argument name for query arguments
static java.lang.String	SEARCH_RESULTS CGI argument name for number of results per page, 1 based
static java.lang.String	START_PAGE CGI argument name for page number of results, 1 based

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

DEFAULT_MAX_RECORDS, earliestTimestamp, latestTimestamp, maxRecords, QUERY_BASE, REPLAY_BASE, XQUERY_BASE

Constructor Summary

OpenSearchRequestParser()

Method Summary

WaybackRequest

parse(javax.servlet.http.HttpServletRequest httpRequest, AccessPoint wbContext) attempt to transform an incoming HttpServletRequest into a WaybackRequest object.

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

getEarliestTimestamp, getLatestTimestamp, getMapParam, getMapParamOrEmpty, getMaxRecords, getRequiredMapParam, setEarliestTimestamp, setLatestTimestamp, setMaxRecords

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_QUERY

public static final java.lang.String SEARCH_QUERY

CGI argument name for query arguments

See Also:

Constant Field Values

SEARCH_RESULTS

public static final java.lang.String SEARCH_RESULTS

CGI argument name for number of results per page, 1 based

See Also:

Constant Field Values

START_PAGE

public static final java.lang.String START_PAGE

CGI argument name for page number of results, 1 based

See Also:

Constant Field Values

Constructor Detail

OpenSearchRequestParser

public OpenSearchRequestParser()

Method Detail

parse

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

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

Returns:

populated WaybackRequest object if successful, null otherwise.

Throws:

BadQueryException