org.archive.wayback.webapp
Class AccessPoint

java.lang.Object
  org.archive.wayback.webapp.AccessPoint

All Implemented Interfaces:

RequestContext, org.springframework.beans.factory.BeanNameAware

public class AccessPoint
extends java.lang.Object
implements RequestContext, org.springframework.beans.factory.BeanNameAware

Retains all information about a particular Wayback configuration within a ServletContext, including holding references to the implementation instances of the primary Wayback classes: RequestParser ResourceIndex(via WaybackCollection) ResourceStore(via WaybackCollection) QueryRenderer ReplayDispatcher ExceptionRenderer ResultURIConverter

Version:

$Date$, $Revision$

Author:

brad

Constructor Summary

AccessPoint()

Method Summary

java.lang.String	getAbsoluteLocalPrefix(javax.servlet.http.HttpServletRequest httpRequest)
java.lang.String	getAbsoluteServerPrefix(javax.servlet.http.HttpServletRequest httpRequest)
BooleanOperator<WaybackRequest>	getAuthentication()
java.lang.String	getBeanName()
WaybackCollection	getCollection()
java.util.Properties	getConfigs()
java.lang.String	getContextPath(javax.servlet.http.HttpServletRequest httpRequest)
int	getContextPort()
ExceptionRenderer	getException()
ExclusionFilterFactory	getExclusionFactory()
java.util.Locale	getLocale()
java.lang.String	getUrlRoot()
boolean	handleRequest(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
boolean	isExactSchemeMatch()
boolean	isUseAnchorWindow()
boolean	isUseServerName()
void	setAuthentication(BooleanOperator<WaybackRequest> authentication)
void	setBeanName(java.lang.String beanName)
void	setCollection(WaybackCollection collection)
void	setConfigs(java.util.Properties configs)
void	setContextName(java.lang.String contextName)
void	setContextPort(int contextPort)
void	setExactSchemeMatch(boolean exactSchemeMatch)
void	setException(ExceptionRenderer exception)
void	setExclusionFactory(ExclusionFilterFactory exclusionFactory)
void	setLocale(java.util.Locale locale)
void	setParser(RequestParser parser)
void	setQuery(QueryRenderer query)
void	setReplay(ReplayDispatcher replay)
void	setUriConverter(ResultURIConverter uriConverter)
void	setUrlRoot(java.lang.String urlRoot)
void	setUseAnchorWindow(boolean useAnchorWindow)
void	setUseServerName(boolean useServerName)
void	shutdown()
java.lang.String	translateRequestPath(javax.servlet.http.HttpServletRequest httpRequest)
java.lang.String	translateRequestPathQuery(javax.servlet.http.HttpServletRequest httpRequest)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessPoint

public AccessPoint()

Method Detail

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

setBeanName

public void setBeanName(java.lang.String beanName)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getBeanName

public java.lang.String getBeanName()

getContextPath

public java.lang.String getContextPath(javax.servlet.http.HttpServletRequest httpRequest)

Parameters:

httpRequest -

Returns:

the prefix of paths recieved by this server that are handled by this WaybackContext, including the trailing '/'

translateRequestPathQuery

public java.lang.String translateRequestPathQuery(javax.servlet.http.HttpServletRequest httpRequest)

Parameters:

httpRequest -

Returns:

the portion of the request following the path to this context, including any query information,without leading '/'

translateRequestPath

public java.lang.String translateRequestPath(javax.servlet.http.HttpServletRequest httpRequest)

Parameters:

httpRequest -

Returns:

the portion of the request following the path to this context, excluding any query information, without leading '/'

getAbsoluteServerPrefix

public java.lang.String getAbsoluteServerPrefix(javax.servlet.http.HttpServletRequest httpRequest)

Parameters:

httpRequest -

Returns:

absolute URL pointing to the base of this WaybackContext, using Server and port information from the HttpServletRequest argument.

getAbsoluteLocalPrefix

public java.lang.String getAbsoluteLocalPrefix(javax.servlet.http.HttpServletRequest httpRequest)

Parameters:

httpRequest -

Returns:

absolute URL pointing to the base of this WaybackContext, using Canonical server and port information.

handleRequest

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

Specified by:

handleRequest in interface RequestContext

Parameters:

httpRequest -

httpResponse -

Returns:

true if the request was actually handled

Throws:

javax.servlet.ServletException

java.io.IOException

shutdown

public void shutdown()
              throws java.io.IOException

Throws:

java.io.IOException

setContextPort

public void setContextPort(int contextPort)

Parameters:

contextPort - the contextPort to set

setContextName

public void setContextName(java.lang.String contextName)

Parameters:

contextName - the contextName to set

setReplay

public void setReplay(ReplayDispatcher replay)

Parameters:

replay - the replay to set

setQuery

public void setQuery(QueryRenderer query)

Parameters:

query - the query to set

setParser

public void setParser(RequestParser parser)

Parameters:

parser - the parser to set

setUriConverter

public void setUriConverter(ResultURIConverter uriConverter)

Parameters:

uriConverter - the uriConverter to set

getContextPort

public int getContextPort()

Returns:

the contextPort

getConfigs

public java.util.Properties getConfigs()

Returns:

the configs

setConfigs

public void setConfigs(java.util.Properties configs)

Parameters:

configs - the configs to set

isUseServerName

public boolean isUseServerName()

Returns:

the useServerName

setUseServerName

public void setUseServerName(boolean useServerName)

Parameters:

useServerName - the useServerName to set

isUseAnchorWindow

public boolean isUseAnchorWindow()

Returns:

the useAnchorWindow

setUseAnchorWindow

public void setUseAnchorWindow(boolean useAnchorWindow)

Parameters:

useAnchorWindow - the useAnchorWindow to set

isExactSchemeMatch

public boolean isExactSchemeMatch()

Returns:

the exactSchemeMatch

setExactSchemeMatch

public void setExactSchemeMatch(boolean exactSchemeMatch)

Parameters:

exactSchemeMatch - the exactSchemeMatch to set

getExclusionFactory

public ExclusionFilterFactory getExclusionFactory()

setExclusionFactory

public void setExclusionFactory(ExclusionFilterFactory exclusionFactory)

getAuthentication

public BooleanOperator<WaybackRequest> getAuthentication()

setAuthentication

public void setAuthentication(BooleanOperator<WaybackRequest> authentication)

getCollection

public WaybackCollection getCollection()

setCollection

public void setCollection(WaybackCollection collection)

getException

public ExceptionRenderer getException()

setException

public void setException(ExceptionRenderer exception)

getUrlRoot

public java.lang.String getUrlRoot()

setUrlRoot

public void setUrlRoot(java.lang.String urlRoot)