org.archive.wayback.accesspoint

Class AccessPointAdapter

java.lang.Object

org.archive.wayback.util.webapp.AbstractRequestHandler

org.archive.wayback.webapp.AccessPoint

org.archive.wayback.accesspoint.AccessPointAdapter

All Implemented Interfaces:

CollectionContext, RequestHandler, ShutdownListener, org.springframework.beans.factory.BeanNameAware

public class AccessPointAdapter
extends AccessPoint

Sub-AccessPoint managed by CompositeAccessPoint. TODO: Strictly speaking this is not an Adapter. It is an AccessPoint extended with a capability to inherit/override parent's configuration.

Nested Class Summary

Nested classes/interfaces inherited from class org.archive.wayback.webapp.AccessPoint

AccessPoint.PerfStat, AccessPoint.SingleLoadResourceStore

Field Summary

Fields inherited from class org.archive.wayback.webapp.AccessPoint

EMPTY_VALUE, INTERSTITIAL_DATE, INTERSTITIAL_JSP, INTERSTITIAL_SECONDS, INTERSTITIAL_TARGET, INTERSTITIAL_URL, REVISIT_STR, RUNTIME_ERROR_HEADER

Constructor Summary

Constructors

Constructor and Description
AccessPointAdapter(CompositeAccessPoint baseAccessPoint, AccessPointConfig config)
AccessPointAdapter(String accessPointName, CompositeAccessPoint baseAccessPoint)

Method Summary

Methods

Modifier and Type	Method and Description
AccessPointConfig	getAccessPointConfig()
String	getAccessPointPath()
BooleanOperator<WaybackRequest>	getAuthentication()
CompositeAccessPoint	getBaseAccessPoint()
WaybackCollection	getCollection()
String	getCollectionContextName() Default implementation returns null.
Properties	getConfigs()
long	getEmbargoMS()
ExceptionRenderer	getException()
ExclusionFilterFactory	getExclusionFactory()
List<String>	getFileExcludePrefixes()
List<String>	getFileIncludePrefixes()
List<String>	getFilePatterns()
CustomResultFilterFactory	getFilterFactory()
String	getInterstitialJsp()
String	getLiveWebPrefix()
LiveWebRedirector	getLiveWebRedirector()
Locale	getLocale()
int	getMaxRedirectAttempts()
RequestParser	getParser()
String	getPerfStatsHeader()
protected String	getPrefix(String basePrefix)
QueryRenderer	getQuery()
int	getQueryCollapseTime()
String	getQueryPrefix()
String	getRefererAuth()
ReplayDispatcher	getReplay()
String	getReplayPrefix()
RewriteDirector	getRewriteDirector()
UrlCanonicalizer	getSelfRedirectCanonicalizer() URL canonicalizer for testing self-redirect.
javax.servlet.ServletContext	getServletContext()
String	getStaticPrefix()
String	getSwitchCollPath()
ResultURIConverter	getUriConverter()
String	getWarcFileHeader()
boolean	hasExclusions() Deprecated.
protected void	initMergedProps()
boolean	isBounceToQueryPrefix()
boolean	isBounceToReplayPrefix()
boolean	isExactHostMatch()
boolean	isExactSchemeMatch()
boolean	isForceCleanQueries()
boolean	isProxyMode()
boolean	isProxySwitchable()
boolean	isRequestAuth()
boolean	isServeStatic()
boolean	isTimestampSearch()
boolean	isUseAnchorWindow()

Methods inherited from class org.archive.wayback.webapp.AccessPoint

checkAccessPointAware, closeResources, createExclusionFilter, dispatchLocal, getErrorMsgHeader, getMementoHandler, getRewriteDirective, getUrlRoot, handleQuery, handleReplay, handleReplayRedirect, handleRequest, init, isEnableErrorMsgHeader, isEnableMemento, isEnablePerfStatsHeader, isEnableWarcFileHeader, isFixedEmbeds, isSelfRedirect, isUseServerName, isWaybackReferer, isWaybackReferer, logError, makeCaptureQueryUrl, queryIndex, retrievePayloadForIdenticalContentRevisit, searchCaptures, setAuthentication, setBounceToQueryPrefix, setBounceToReplayPrefix, setCollection, setConfigs, setEmbargoMS, setEnableErrorMsgHeader, setEnableMemento, setEnablePerfStatsHeader, setEnableWarcFileHeader, setErrorMsgHeader, setExactHostMatch, setExactSchemeMatch, setException, setExclusionFactory, setFileExcludePrefixes, setFileIncludePrefixes, setFilePatterns, setFilterFactory, setFixedEmbeds, setForceCleanQueries, setInterstitialJsp, setLiveWebPrefix, setLiveWebRedirector, setLocale, setMaxRedirectAttempts, setMementoHandler, setParser, setPerfStatsHeader, setPerfStatsHeaderFormat, setQuery, setQueryCollapseTime, setQueryPrefix, setRefererAuth, setReplay, setReplayPrefix, setRequestAuth, setRewriteDirector, setSelfRedirectCanonicalizer, setServeStatic, setStaticPrefix, setTimestampSearch, setUriConverter, setUrlRoot, setUseAnchorWindow, setUseServerName, setWarcFileHeader, shutdown

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

getBeanName, getInternalPort, getMapParam, getMapParamOrEmpty, getRequiredMapParam, 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

AccessPointAdapter

public AccessPointAdapter(CompositeAccessPoint baseAccessPoint,
                  AccessPointConfig config)

AccessPointAdapter

public AccessPointAdapter(String accessPointName,
                  CompositeAccessPoint baseAccessPoint)

Method Detail

initMergedProps

protected void initMergedProps()

getBaseAccessPoint

public CompositeAccessPoint getBaseAccessPoint()

isProxyMode

public boolean isProxyMode()

isProxySwitchable

public boolean isProxySwitchable()

getSwitchCollPath

public String getSwitchCollPath()

getAccessPointConfig

public AccessPointConfig getAccessPointConfig()

getFileIncludePrefixes

public List<String> getFileIncludePrefixes()

Overrides:

getFileIncludePrefixes in class AccessPoint

Returns:

List of file String prefixes that will be matched when querying the ResourceIndex

getFileExcludePrefixes

public List<String> getFileExcludePrefixes()

Overrides:

getFileExcludePrefixes in class AccessPoint

Returns:

List of file String prefixes that will be matched when querying the ResourceIndex

getConfigs

public Properties getConfigs()

Overrides:

getConfigs in class AccessPoint

Returns:

the generic customization Properties used with this AccessPoint, generally to tune the UI

getAccessPointPath

public String getAccessPointPath()

Overrides:

getAccessPointPath in class AbstractRequestHandler

getCollectionContextName

public String getCollectionContextName()

Description copied from class: AccessPoint

Default implementation returns null.

Specified by:

getCollectionContextName in interface CollectionContext

Overrides:

getCollectionContextName in class AccessPoint

Returns:

getPrefix

protected String getPrefix(String basePrefix)

getStaticPrefix

public String getStaticPrefix()

Overrides:

getStaticPrefix in class AccessPoint

Returns:

the String url prefix to use when generating self referencing static URLs

getReplayPrefix

public String getReplayPrefix()

Overrides:

getReplayPrefix in class AccessPoint

Returns:

the String url prefix to use when generating self referencing replay URLs

getQueryPrefix

public String getQueryPrefix()

Overrides:

getQueryPrefix in class AccessPoint

Returns:

the String url prefix to use when generating self referencing replay URLs

isExactHostMatch

public boolean isExactHostMatch()

Overrides:

isExactHostMatch in class AccessPoint

Returns:

the exactHostMatch

isExactSchemeMatch

public boolean isExactSchemeMatch()

Overrides:

isExactSchemeMatch in class AccessPoint

Returns:

the exactSchemeMatch

isUseAnchorWindow

public boolean isUseAnchorWindow()

Overrides:

isUseAnchorWindow in class AccessPoint

Returns:

true if this AccessPoint is configured to useAnchorWindow, that is, to replay documents only if they are within a certain proximity to the users requested AnchorDate

isServeStatic

public boolean isServeStatic()

Overrides:

isServeStatic in class AccessPoint

Returns:

true if this AccessPoint serves static content

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface RequestHandler

Overrides:

getServletContext in class AbstractRequestHandler

Returns:

the ServletContext where the RequestHandler is registered.

getLiveWebRedirector

public LiveWebRedirector getLiveWebRedirector()

Overrides:

getLiveWebRedirector in class AccessPoint

Returns:

the livewebRedirector which determines if custom loading or handling is done for resources that are not successfully loaded,

getLiveWebPrefix

public String getLiveWebPrefix()

Overrides:

getLiveWebPrefix in class AccessPoint

getInterstitialJsp

public String getInterstitialJsp()

Overrides:

getInterstitialJsp in class AccessPoint

Returns:

the interstitialJsp

getLocale

public Locale getLocale()

Overrides:

getLocale in class AccessPoint

Returns:

explicit Locale to use within this AccessPoint.

getFilePatterns

public List<String> getFilePatterns()

Overrides:

getFilePatterns in class AccessPoint

Returns:

List of file patterns that will be matched when querying the ResourceIndex

getCollection

public WaybackCollection getCollection()

Overrides:

getCollection in class AccessPoint

Returns:

the WaybackCollection used by this AccessPoint

getException

public ExceptionRenderer getException()

Overrides:

getException in class AccessPoint

Returns:

the ExceptionRenderer in use with this AccessPoint

getQuery

public QueryRenderer getQuery()

Overrides:

getQuery in class AccessPoint

Returns:

the QueryRenderer to use with this AccessPoint

getParser

public RequestParser getParser()

Overrides:

getParser in class AccessPoint

Returns:

the RequestParser used by this AccessPoint to attempt to translate incoming HttpServletRequest objects into WaybackRequest objects

getReplay

public ReplayDispatcher getReplay()

Overrides:

getReplay in class AccessPoint

Returns:

the ReplayDispatcher to use with this AccessPoint, responsible for returning an appropriate ReplayRenderer given the user request and the returned document type.

getUriConverter

public ResultURIConverter getUriConverter()

Overrides:

getUriConverter in class AccessPoint

Returns:

the ResultURIConverter used to construct Replay URLs within this AccessPoint

getAuthentication

public BooleanOperator<WaybackRequest> getAuthentication()

Overrides:

getAuthentication in class AccessPoint

Returns:

the configured AuthenticationControl BooleanOperator in use with this AccessPoint.

getRefererAuth

public String getRefererAuth()

Overrides:

getRefererAuth in class AccessPoint

Returns:

the refererAuth

isBounceToReplayPrefix

public boolean isBounceToReplayPrefix()

Overrides:

isBounceToReplayPrefix in class AccessPoint

Returns:

the bounceToReplayPrefix

isBounceToQueryPrefix

public boolean isBounceToQueryPrefix()

Overrides:

isBounceToQueryPrefix in class AccessPoint

Returns:

the bounceToQueryPrefix

getEmbargoMS

public long getEmbargoMS()

Overrides:

getEmbargoMS in class AccessPoint

Returns:

the configured number of MS for min age to return from the index

isForceCleanQueries

public boolean isForceCleanQueries()

Overrides:

isForceCleanQueries in class AccessPoint

Returns:

the forceCleanQueries

getFilterFactory

public CustomResultFilterFactory getFilterFactory()

Overrides:

getFilterFactory in class AccessPoint

Returns:

the filterFactory

getSelfRedirectCanonicalizer

public UrlCanonicalizer getSelfRedirectCanonicalizer()

Description copied from class: AccessPoint

URL canonicalizer for testing self-redirect.

Overrides:

getSelfRedirectCanonicalizer in class AccessPoint

Returns:

The UrlCanonicalizer

isRequestAuth

public boolean isRequestAuth()

Overrides:

isRequestAuth in class AccessPoint

getMaxRedirectAttempts

public int getMaxRedirectAttempts()

Overrides:

getMaxRedirectAttempts in class AccessPoint

isTimestampSearch

public boolean isTimestampSearch()

Overrides:

isTimestampSearch in class AccessPoint

getPerfStatsHeader

public String getPerfStatsHeader()

Overrides:

getPerfStatsHeader in class AccessPoint

getWarcFileHeader

public String getWarcFileHeader()

Overrides:

getWarcFileHeader in class AccessPoint

getQueryCollapseTime

public int getQueryCollapseTime()

Overrides:

getQueryCollapseTime in class AccessPoint

hasExclusions

@Deprecated
public boolean hasExclusions()

Deprecated.

getExclusionFactory

public ExclusionFilterFactory getExclusionFactory()

Overrides:

getExclusionFactory in class AccessPoint

Returns:

the ExclusionFilterFactory in use with this AccessPoint

getRewriteDirector

public RewriteDirector getRewriteDirector()

Overrides:

getRewriteDirector in class AccessPoint