org.archive.wayback.webapp

Class ServerRelativeArchivalRedirect

java.lang.Object

org.archive.wayback.util.webapp.AbstractRequestHandler

org.archive.wayback.webapp.ServerRelativeArchivalRedirect

All Implemented Interfaces:

RequestHandler, org.springframework.beans.factory.BeanNameAware

public class ServerRelativeArchivalRedirect
extends AbstractRequestHandler

ServerRelativeArchivalRedirect is a RequestHandler that redirects leaked server-relative URL back to replay request URL.

For example, assuming Referer is http://web.archive.org/web/20010203040506/http://example.com/index.html, it redirects request http://web.archive.org/js/foo.js to http://web.archive.org/web/20010203040506/http://example.com/js/foo.js.

It is typically set up as catch-all RequestHandler

Author:

brad

Constructor Summary

Constructors

Constructor and Description
ServerRelativeArchivalRedirect()

Method Summary

Methods

Modifier and Type	Method and Description
String	getMatchHost()
int	getMatchPort()
String	getReplayPrefix()
boolean	handleRequest(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Possibly handle an incoming HttpServletRequest, much like a normal HttpServlet, but includes a return value.
boolean	isUseCollection()
protected String	modifyCollection(String collection) modify collection if necessary.
void	setMatchHost(String matchHost) optional host name Referer URL should match.
void	setMatchPort(int matchPort) optional port number Referer URL should match.
void	setReplayPrefix(String replayPrefix) optional replay URL prefix used by fallback method.
void	setUseCollection(boolean useCollection) whether replay URL has collection part.

Methods inherited from class org.archive.wayback.util.webapp.AbstractRequestHandler

getAccessPointPath, getBeanName, getInternalPort, getMapParam, getMapParamOrEmpty, getRequiredMapParam, getServletContext, registerPortListener, setAccessPointPath, setBeanName, setInternalPort, setServletContext, translateRequestPath, translateRequestPathQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerRelativeArchivalRedirect

public ServerRelativeArchivalRedirect()

Method Detail

modifyCollection

protected String modifyCollection(String collection)

modify collection if necessary.

default implementation simply return collection.

Parameters:

collection - (the first path component of Referer URL.) note value has leading slash, which must be retained.

Returns:

possibly modified collection.

handleRequest

public boolean handleRequest(javax.servlet.http.HttpServletRequest httpRequest,
                    javax.servlet.http.HttpServletResponse httpResponse)
                      throws javax.servlet.ServletException,
                             IOException

Description copied from interface: RequestHandler

Possibly handle an incoming HttpServletRequest, much like a normal HttpServlet, but includes a return value.

Parameters:

httpRequest - the incoming HttpServletRequest

httpResponse - the HttpServletResponse to return data to the client.

Returns:

true if the RequestHandler returned a response to the client, false otherwise

Throws:

javax.servlet.ServletException - for usual reasons.

IOException - for usual reasons.

isUseCollection

public boolean isUseCollection()

Returns:

the useCollection

setUseCollection

public void setUseCollection(boolean useCollection)

whether replay URL has collection part.

set this to true if replay URL has collection part, path component between context path and timestamp (although it's called collection based on the common usage of this part, there's no need to have particular semantics.)

collection part will be passed to modifyCollection(String) before constructing final replay URL to redirect to.

Parameters:

useCollection - the useCollection to set

getMatchHost

public String getMatchHost()

Returns:

the matchHost

setMatchHost

public void setMatchHost(String matchHost)

optional host name Referer URL should match.

Parameters:

matchHost - the matchHost to set

getMatchPort

public int getMatchPort()

Returns:

the matchPort

setMatchPort

public void setMatchPort(int matchPort)

optional port number Referer URL should match.

Parameters:

matchPort - the matchPort to set

getReplayPrefix

public String getReplayPrefix()

Returns:

the replayPrefix

setReplayPrefix

public void setReplayPrefix(String replayPrefix)

optional replay URL prefix used by fallback method.

Parameters:

replayPrefix - the replayPrefix to set