org.archive.wayback.memento

Class MementoUtils

java.lang.Object

org.archive.wayback.memento.MementoUtils

All Implemented Interfaces:

MementoConstants

public class MementoUtils
extends Object
implements MementoConstants

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleDateFormat[]	ACCEPT_DATE_FORMATS

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
MementoUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDoNotNegotiateHeader(javax.servlet.http.HttpServletResponse response)
static void	addLinkHeader(javax.servlet.http.HttpServletResponse response, CaptureSearchResults results, WaybackRequest wbr, boolean includeTimegateLink, boolean includeOriginalLink) Add Link header.
static void	addMementoDatetimeHeader(javax.servlet.http.HttpServletResponse response, CaptureSearchResult result) Add Memento-Datetime header.
static void	addMementoHeaders(javax.servlet.http.HttpServletResponse response, CaptureSearchResults results, CaptureSearchResult result, WaybackRequest wbr) Deprecated. 1.8.1 2014-09-12 use addMementoDatetimeHeader(HttpServletResponse, CaptureSearchResult) and addLinkHeader(HttpServletResponse, CaptureSearchResults, WaybackRequest, boolean, boolean)
static void	addOrigHeader(javax.servlet.http.HttpServletResponse response, String url) Add Link header with just original relation link url.
static void	addOrigHeader(javax.servlet.http.HttpServletResponse response, WaybackRequest wbr)
static void	addTimegateHeaders(javax.servlet.http.HttpServletResponse response, CaptureSearchResults results, WaybackRequest wbr, boolean includeOriginal) Add Vary: accept-datetime header and Link header for timegate response.
static void	addVaryHeader(javax.servlet.http.HttpServletResponse response)
protected static String	captureDate(String label, Date date) format label="date in HTTP date format".
protected static String	formatLinkDate(Date date)
static String	generateMementoLinkHeaders(CaptureSearchResults results, WaybackRequest wbr, boolean includeTimegateLink, boolean includeOriginalLink) Add Link header value.
static String	getMementoPrefix(AccessPoint ap)
static int	getPageMaxRecord(AccessPoint ap)
static String	getTimeGatePrefix(AccessPoint ap)
static String	getTimegateUrl(AccessPoint ap, String url)
static String	getTimemapDateUrl(AccessPoint ap, String format, String pagestr, String url)
static String	getTimeMapPrefix(AccessPoint ap)
static String	getTimemapUrl(AccessPoint ap, String format, String url)
static boolean	hasLinkHeader(javax.servlet.http.HttpServletResponse response)
static String	makeOrigHeader(String url)
static Date	parseAcceptDateTimeHeader(String datespec)
static void	printLinkTimemap(CaptureSearchResults results, WaybackRequest wbr, PrintWriter pw)
static void	printTimemapResponse(CaptureSearchResults results, WaybackRequest wbRequest, javax.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

ACCEPT_DATE_FORMATS

public static final SimpleDateFormat[] ACCEPT_DATE_FORMATS

Constructor Detail

MementoUtils

public MementoUtils()

Method Detail

formatLinkDate

protected static String formatLinkDate(Date date)

captureDate

protected static String captureDate(String label,
                 Date date)

format label="date in HTTP date format".

Parameters:

label - text representing type of date, ex: "from".

date - date

printTimemapResponse

public static void printTimemapResponse(CaptureSearchResults results,
                        WaybackRequest wbRequest,
                        javax.servlet.http.HttpServletResponse response)
                                 throws IOException

Throws:

IOException

printLinkTimemap

public static void printLinkTimemap(CaptureSearchResults results,
                    WaybackRequest wbr,
                    PrintWriter pw)

generateMementoLinkHeaders

public static String generateMementoLinkHeaders(CaptureSearchResults results,
                                WaybackRequest wbr,
                                boolean includeTimegateLink,
                                boolean includeOriginalLink)

Add Link header value. Includes: first, prev, next, last, original (if includeOriginal is true), and timegate (if includeTimegateLink is true).

addVaryHeader

public static void addVaryHeader(javax.servlet.http.HttpServletResponse response)

hasLinkHeader

public static boolean hasLinkHeader(javax.servlet.http.HttpServletResponse response)

addOrigHeader

public static void addOrigHeader(javax.servlet.http.HttpServletResponse response,
                 String url)

Add Link header with just original relation link url.

Parameters:

response -

url -

addDoNotNegotiateHeader

public static void addDoNotNegotiateHeader(javax.servlet.http.HttpServletResponse response)

addOrigHeader

public static void addOrigHeader(javax.servlet.http.HttpServletResponse response,
                 WaybackRequest wbr)

makeOrigHeader

public static String makeOrigHeader(String url)

addMementoHeaders

public static void addMementoHeaders(javax.servlet.http.HttpServletResponse response,
                     CaptureSearchResults results,
                     CaptureSearchResult result,
                     WaybackRequest wbr)

Deprecated. 1.8.1 2014-09-12 use addMementoDatetimeHeader(HttpServletResponse, CaptureSearchResult) and addLinkHeader(HttpServletResponse, CaptureSearchResults, WaybackRequest, boolean, boolean)

Add Memento-Datetime header, and full Link header if wbr is not a Memento Timegate request.

Parameters:

response -

results -

result -

wbr -

addMementoDatetimeHeader

public static void addMementoDatetimeHeader(javax.servlet.http.HttpServletResponse response,
                            CaptureSearchResult result)

Add Memento-Datetime header.

Parameters:

response - HttpServletResponse

result - Capture whose timestamp is used

addLinkHeader

public static void addLinkHeader(javax.servlet.http.HttpServletResponse response,
                 CaptureSearchResults results,
                 WaybackRequest wbr,
                 boolean includeTimegateLink,
                 boolean includeOriginalLink)

Add Link header.

Parameters:

response - HttpServletResponse

results - CaptureSearchResults for generating first/last and prev/next relation links

wbr - WaybackRequest for accessing AccessPoint

includeTimegateLink - whether timegate relation link is included (false for Timegate response, true for Memento response)

includeOriginalLink - whether original relation link is included (usually true)

addTimegateHeaders

public static void addTimegateHeaders(javax.servlet.http.HttpServletResponse response,
                      CaptureSearchResults results,
                      WaybackRequest wbr,
                      boolean includeOriginal)

Add Vary: accept-datetime header and Link header for timegate response. See generateMementoLinkHeaders(CaptureSearchResults, WaybackRequest, boolean, boolean) for details of Link header.

Parameters:

response -

results -

wbr -

includeOriginal -

parseAcceptDateTimeHeader

public static Date parseAcceptDateTimeHeader(String datespec)

getTimegateUrl

public static String getTimegateUrl(AccessPoint ap,
                    String url)

getTimemapUrl

public static String getTimemapUrl(AccessPoint ap,
                   String format,
                   String url)

getTimemapDateUrl

public static String getTimemapDateUrl(AccessPoint ap,
                       String format,
                       String pagestr,
                       String url)

getTimeMapPrefix

public static String getTimeMapPrefix(AccessPoint ap)

getTimeGatePrefix

public static String getTimeGatePrefix(AccessPoint ap)

getMementoPrefix

public static String getMementoPrefix(AccessPoint ap)

getPageMaxRecord

public static int getPageMaxRecord(AccessPoint ap)