AccessPoint (OpenWayback 2.3.0 API)

java.lang.Object
- org.archive.wayback.util.webapp.AbstractRequestHandler
- - org.archive.wayback.webapp.AccessPoint

All Implemented Interfaces:

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

Direct Known Subclasses:

AccessPointAdapter, CompositeAccessPoint
```
public class AccessPoint
extends AbstractRequestHandler
implements ShutdownListener, CollectionContext
```
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

Author:

brad

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AccessPoint.PerfStat`
`protected static class`	`AccessPoint.SingleLoadResourceStore` Per-request, decorating ResourceStore that throws `ResourceNotAvailableException` if retrieval of the archive has failed previously within the session.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY_VALUE`
`static String`	`INTERSTITIAL_DATE` argument for Interstitial.jsp msse for replay date
`static String`	`INTERSTITIAL_JSP` webapp relative location of Interstitial.jsp
`static String`	`INTERSTITIAL_SECONDS` argument for Interstitial.jsp seconds to delay
`static String`	`INTERSTITIAL_TARGET` argument for Interstitial.jsp target URL
`static String`	`INTERSTITIAL_URL` argument for Interstitial.jsp URL being loaded
`static String`	`REVISIT_STR`
`static String`	`RUNTIME_ERROR_HEADER`

Constructor Summary

Constructors
Constructor and Description

AccessPoint()

Constructors
Constructor and Description
`AccessPoint()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkAccessPointAware(Object... os)`
`protected void`	`closeResources(Resource payloadResource, Resource httpHeadersResource)`
`ExclusionFilter`	`createExclusionFilter()` Return new instance of `ExclusionFilter` instance for this AccessPoint.
`protected boolean`	`dispatchLocal(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)`
`BooleanOperator<WaybackRequest>`	`getAuthentication()`
`WaybackCollection`	`getCollection()`
`String`	`getCollectionContextName()` Default implementation returns `null`.
`Properties`	`getConfigs()`
`long`	`getEmbargoMS()`
`String`	`getErrorMsgHeader()`
`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()`
`MementoHandler`	`getMementoHandler()`
`RequestParser`	`getParser()`
`String`	`getPerfStatsHeader()`
`QueryRenderer`	`getQuery()`
`int`	`getQueryCollapseTime()`
`String`	`getQueryPrefix()`
`String`	`getRefererAuth()`
`ReplayDispatcher`	`getReplay()`
`String`	`getReplayPrefix()`
`String`	`getRewriteDirective(CaptureSearchResult capture)` Return rewrite directive for `capture`.
`RewriteDirector`	`getRewriteDirector()`
`UrlCanonicalizer`	`getSelfRedirectCanonicalizer()` URL canonicalizer for testing self-redirect.
`String`	`getStaticPrefix()`
`ResultURIConverter`	`getUriConverter()`
`String`	`getUrlRoot()` Deprecated. use getQueryPrefix, getReplayPrefix, getStaticPrefix
`String`	`getWarcFileHeader()`
`protected void`	`handleQuery(WaybackRequest wbRequest, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)`
`protected void`	`handleReplay(WaybackRequest wbRequest, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)`
`protected void`	`handleReplayRedirect(WaybackRequest wbRequest, javax.servlet.http.HttpServletResponse httpResponse, CaptureSearchResults captureResults, CaptureSearchResult closest)` if capture `closest` is of timestamp different from the one requested, redirect to exact Archival-URL for `closest`.
`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.
`void`	`init()`
`boolean`	`isBounceToQueryPrefix()`
`boolean`	`isBounceToReplayPrefix()`
`boolean`	`isEnableErrorMsgHeader()`
`boolean`	`isEnableMemento()`
`boolean`	`isEnablePerfStatsHeader()`
`boolean`	`isEnableWarcFileHeader()`
`boolean`	`isExactHostMatch()`
`boolean`	`isExactSchemeMatch()`
`boolean`	`isFixedEmbeds()`
`boolean`	`isForceCleanQueries()`
`boolean`	`isRequestAuth()`
`protected boolean`	`isSelfRedirect(Resource resource, CaptureSearchResult closest, WaybackRequest wbRequest, String canonRequestURL)`
`boolean`	`isServeStatic()`
`boolean`	`isTimestampSearch()`
`boolean`	`isUseAnchorWindow()`
`boolean`	`isUseServerName()` Deprecated. no longer used, use {replay,query,static}Prefix
`boolean`	`isWaybackReferer(String referer, String path)`
`boolean`	`isWaybackReferer(WaybackRequest wbRequest, String path)`
`void`	`logError(javax.servlet.http.HttpServletResponse httpResponse, String header, Exception e, WaybackRequest request)`
`String`	`makeCaptureQueryUrl(String url, String startdate, String enddate)` Build a self-referencing URL that will perform a query for all copies of URL `url`.
`SearchResults`	`queryIndex(WaybackRequest wbRequest)`
`protected CaptureSearchResult`	`retrievePayloadForIdenticalContentRevisit(WaybackRequest currRequest, Resource revisitRecord, CaptureSearchResult closest)` If closest
`protected CaptureSearchResults`	`searchCaptures(WaybackRequest wbr)`
`void`	`setAuthentication(BooleanOperator<WaybackRequest> auth)`
`void`	`setBounceToQueryPrefix(boolean bounceToQueryPrefix)`
`void`	`setBounceToReplayPrefix(boolean bounceToReplayPrefix)`
`void`	`setCollection(WaybackCollection collection)`
`void`	`setConfigs(Properties configs)`
`void`	`setEmbargoMS(long ms)`
`void`	`setEnableErrorMsgHeader(boolean enableErrorMsgHeader)`
`void`	`setEnableMemento(boolean enableMemento)`
`void`	`setEnablePerfStatsHeader(boolean enablePerfStatsHeader)`
`void`	`setEnableWarcFileHeader(boolean enableWarcFileHeader)`
`void`	`setErrorMsgHeader(String errorMsgHeader)`
`void`	`setExactHostMatch(boolean exactHostMatch)`
`void`	`setExactSchemeMatch(boolean exactSchemeMatch)`
`void`	`setException(ExceptionRenderer exception)`
`void`	`setExclusionFactory(ExclusionFilterFactory exclusionFactory)`
`void`	`setFileExcludePrefixes(List<String> fileExcludePrefixes)`
`void`	`setFileIncludePrefixes(List<String> fileIncludePrefixes)`
`void`	`setFilePatterns(List<String> filePatterns)`
`void`	`setFilterFactory(CustomResultFilterFactory filterFactory)` `CustomResultFilterFactory` to be applied on CDX query result.
`void`	`setFixedEmbeds(boolean fixedEmbeds)`
`void`	`setForceCleanQueries(boolean forceCleanQueries)`
`void`	`setInterstitialJsp(String interstitialJsp)`
`void`	`setLiveWebPrefix(String liveWebPrefix)`
`void`	`setLiveWebRedirector(LiveWebRedirector liveWebRedirector)`
`void`	`setLocale(Locale locale)`
`void`	`setMaxRedirectAttempts(int maxRedirectAttempts)`
`void`	`setMementoHandler(MementoHandler mementoHandler)`
`void`	`setParser(RequestParser parser)`
`void`	`setPerfStatsHeader(String perfStatsHeader)`
`void`	`setPerfStatsHeaderFormat(PerfStats.OutputFormat perfStatsHeaderFormat)` Format of profiling header field.
`void`	`setQuery(QueryRenderer query)`
`void`	`setQueryCollapseTime(int queryCollapseTime)` CDXServer `collapseTime` parameter for capture query.
`void`	`setQueryPrefix(String queryPrefix)`
`void`	`setRefererAuth(String refererAuth)`
`void`	`setReplay(ReplayDispatcher replay)`
`void`	`setReplayPrefix(String replayPrefix)`
`void`	`setRequestAuth(boolean requestAuth)`
`void`	`setRewriteDirector(RewriteDirector rewriteDirector)`
`void`	`setSelfRedirectCanonicalizer(UrlCanonicalizer selfRedirectCanonicalizer)` Optional
`void`	`setServeStatic(boolean serveStatic)`
`void`	`setStaticPrefix(String staticPrefix)`
`void`	`setTimestampSearch(boolean timestampSearch)`
`void`	`setUriConverter(ResultURIConverter uriConverter)` Refactoring: remove this method. let `getUriConverter()` create ResultURIConverter with factory (like AccessPointAdapter does).
`void`	`setUrlRoot(String urlRoot)` Deprecated. use setQueryPrefix, setReplayPrefix, setStaticPrefix
`void`	`setUseAnchorWindow(boolean useAnchorWindow)`
`void`	`setUseServerName(boolean useServerName)` Deprecated. no longer used, use {replay,query,static}Prefix
`void`	`setWarcFileHeader(String warcFileHeader)`
`void`	`shutdown()` Release any resources associated with this AccessPoint, including stopping any background processing threads

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

- Field Detail
  - INTERSTITIAL_JSP
```
public static final String INTERSTITIAL_JSP
```
    webapp relative location of Interstitial.jsp
    
    See Also:
    Constant Field Values
  - INTERSTITIAL_TARGET
```
public static final String INTERSTITIAL_TARGET
```
    argument for Interstitial.jsp target URL
    
    See Also:
    Constant Field Values
  - INTERSTITIAL_SECONDS
```
public static final String INTERSTITIAL_SECONDS
```
    argument for Interstitial.jsp seconds to delay
    
    See Also:
    Constant Field Values
  - INTERSTITIAL_DATE
```
public static final String INTERSTITIAL_DATE
```
    argument for Interstitial.jsp msse for replay date
    
    See Also:
    Constant Field Values
  - INTERSTITIAL_URL
```
public static final String INTERSTITIAL_URL
```
    argument for Interstitial.jsp URL being loaded
    
    See Also:
    Constant Field Values
  - REVISIT_STR
```
public static final String REVISIT_STR
```
    See Also:
    Constant Field Values
  - EMPTY_VALUE
```
public static final String EMPTY_VALUE
```
    See Also:
    Constant Field Values
  - RUNTIME_ERROR_HEADER
```
public static final String RUNTIME_ERROR_HEADER
```
    See Also:
    Constant Field Values
- Constructor Detail
  - AccessPoint
```
public AccessPoint()
```
- Method Detail
  - init
```
public void init()
```
  - dispatchLocal
```
protected boolean dispatchLocal(javax.servlet.http.HttpServletRequest httpRequest,
                    javax.servlet.http.HttpServletResponse httpResponse)
                         throws javax.servlet.ServletException,
                                IOException
```
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - 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.
    
    Specified by:
    
    handleRequest in interface RequestHandler
    
    Parameters:
    httpRequest - HttpServletRequest which is being handled
    httpResponse - HttpServletResponse which is being handled
    
    Returns:
    true if the request was actually handled
    
    Throws:
    
    javax.servlet.ServletException - per usual
    
    IOException - per usual
  - createExclusionFilter
```
public ExclusionFilter createExclusionFilter()
                                      throws AccessControlException
```
    Return new instance of ExclusionFilter instance for this AccessPoint.
    
    Throws:
    
    AccessControlException - If it cannot instantiate ExclusionFilter when it's supposed to (i.e. configured but failed to complete because of network error etc.)
  - getRewriteDirector
```
public RewriteDirector getRewriteDirector()
```
  - setRewriteDirector
```
public void setRewriteDirector(RewriteDirector rewriteDirector)
```
  - getRewriteDirective
```
public String getRewriteDirective(CaptureSearchResult capture)
```
    Return rewrite directive for capture.
    
    Parameters:
    capture -
    
    Returns:
    string representing rewrite rules
  - getCollectionContextName
```
public String getCollectionContextName()
```
    Default implementation returns null.
    
    Specified by:
    
    getCollectionContextName in interface CollectionContext
    
    Returns:
  - logError
```
public void logError(javax.servlet.http.HttpServletResponse httpResponse,
            String header,
            Exception e,
            WaybackRequest request)
```
  - checkAccessPointAware
```
protected void checkAccessPointAware(Object... os)
```
  - isSelfRedirect
```
protected boolean isSelfRedirect(Resource resource,
                     CaptureSearchResult closest,
                     WaybackRequest wbRequest,
                     String canonRequestURL)
```
  - queryIndex
```
public SearchResults queryIndex(WaybackRequest wbRequest)
                         throws ResourceIndexNotAvailableException,
                                ResourceNotInArchiveException,
                                BadQueryException,
                                AccessControlException,
                                ConfigurationException
```
    Throws:
    
    ResourceIndexNotAvailableException
    
    ResourceNotInArchiveException
    
    BadQueryException
    
    AccessControlException
    
    ConfigurationException
  - isWaybackReferer
```
public boolean isWaybackReferer(WaybackRequest wbRequest,
                       String path)
```
  - isWaybackReferer
```
public boolean isWaybackReferer(String referer,
                       String path)
```
  - handleReplayRedirect
```
protected void handleReplayRedirect(WaybackRequest wbRequest,
                        javax.servlet.http.HttpServletResponse httpResponse,
                        CaptureSearchResults captureResults,
                        CaptureSearchResult closest)
                             throws BetterRequestException
```
    if capture closest is of timestamp different from the one requested, redirect to exact Archival-URL for closest. Memento Timegate request is always redirected regardless of timestamp. Needs better method name.
    
    Parameters:
    wbRequest -
    httpResponse -
    captureResults -
    closest -
    
    Throws:
    
    BetterRequestException
  - handleReplay
```
protected void handleReplay(WaybackRequest wbRequest,
                javax.servlet.http.HttpServletRequest httpRequest,
                javax.servlet.http.HttpServletResponse httpResponse)
                     throws IOException,
                            javax.servlet.ServletException,
                            WaybackException
```
    Throws:
    
    IOException
    
    javax.servlet.ServletException
    
    WaybackException
  - searchCaptures
```
protected CaptureSearchResults searchCaptures(WaybackRequest wbr)
                                       throws ResourceIndexNotAvailableException,
                                              ResourceNotInArchiveException,
                                              BadQueryException,
                                              AccessControlException,
                                              ConfigurationException,
                                              ResourceNotAvailableException
```
    Throws:
    
    ResourceIndexNotAvailableException
    
    ResourceNotInArchiveException
    
    BadQueryException
    
    AccessControlException
    
    ConfigurationException
    
    ResourceNotAvailableException
  - retrievePayloadForIdenticalContentRevisit
```
protected CaptureSearchResult retrievePayloadForIdenticalContentRevisit(WaybackRequest currRequest,
                                                            Resource revisitRecord,
                                                            CaptureSearchResult closest)
                                                                 throws ResourceIndexNotAvailableException,
                                                                        ResourceNotInArchiveException,
                                                                        BadQueryException,
                                                                        AccessControlException,
                                                                        ConfigurationException,
                                                                        ResourceNotAvailableException
```
    If closest
    
    Parameters:
    currRequest -
    revisitRecord -
    closest -
    
    Returns:
    the payload resource
    
    Throws:
    
    ResourceNotAvailableException
    
    ConfigurationException
    
    AccessControlException
    
    BadQueryException
    
    ResourceNotInArchiveException
    
    ResourceIndexNotAvailableException
    See Also:
    WARCRevisitAnnotationFilter
  - setQueryCollapseTime
```
public void setQueryCollapseTime(int queryCollapseTime)
```
    CDXServer collapseTime parameter for capture query.
    
    Parameters:
    queryCollapseTime - integer, negative value instructs CDXServer to use the default value.
  - getQueryCollapseTime
```
public int getQueryCollapseTime()
```
  - handleQuery
```
protected void handleQuery(WaybackRequest wbRequest,
               javax.servlet.http.HttpServletRequest httpRequest,
               javax.servlet.http.HttpServletResponse httpResponse)
                    throws javax.servlet.ServletException,
                           IOException,
                           WaybackException
```
    Throws:
    
    javax.servlet.ServletException
    
    IOException
    
    WaybackException
  - shutdown
```
public void shutdown()
```
    Release any resources associated with this AccessPoint, including stopping any background processing threads
    
    Specified by:
    
    shutdown in interface ShutdownListener
  - closeResources
```
protected void closeResources(Resource payloadResource,
                  Resource httpHeadersResource)
```
  - isExactHostMatch
```
public boolean isExactHostMatch()
```
    Returns:
    the exactHostMatch
  - setExactHostMatch
```
public void setExactHostMatch(boolean exactHostMatch)
```
    Parameters:
    exactHostMatch - if true, then only SearchResults exactly matching the requested hostname will be returned from this AccessPoint. If false, then hosts which canonicalize to the same host as requested hostname will be returned (www.)
  - isExactSchemeMatch
```
public boolean isExactSchemeMatch()
```
    Returns:
    the exactSchemeMatch
  - setExactSchemeMatch
```
public void setExactSchemeMatch(boolean exactSchemeMatch)
```
    Parameters:
    exactSchemeMatch - the exactSchemeMatch to set
  - isUseAnchorWindow
```
public boolean isUseAnchorWindow()
```
    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
  - setUseAnchorWindow
```
public void setUseAnchorWindow(boolean useAnchorWindow)
```
    Parameters:
    useAnchorWindow - , when set to true, causes this AccessPoint to only replay documents if they are within a certain proximity to the users requested AnchorDate
  - isUseServerName
```
public boolean isUseServerName()
```
    Deprecated. no longer used, use {replay,query,static}Prefix
    
    Returns:
    the useServerName
  - setUseServerName
```
public void setUseServerName(boolean useServerName)
```
    Deprecated. no longer used, use {replay,query,static}Prefix
    
    Parameters:
    useServerName - the useServerName to set
  - isServeStatic
```
public boolean isServeStatic()
```
    Returns:
    true if this AccessPoint serves static content
  - setServeStatic
```
public void setServeStatic(boolean serveStatic)
```
    Parameters:
    serveStatic - if set to true, this AccessPoint will serve static content, and .jsp files
  - getLiveWebRedirector
```
public LiveWebRedirector getLiveWebRedirector()
```
    Returns:
    the livewebRedirector which determines if custom loading or handling is done for resources that are not successfully loaded,
  - setLiveWebRedirector
```
public void setLiveWebRedirector(LiveWebRedirector liveWebRedirector)
```
    Parameters:
    liveWebRedirector - Set the LiveWebRedirector to use to try and retrieve documents from the live web on demand when missing from the collection.
  - setLiveWebPrefix
```
public void setLiveWebPrefix(String liveWebPrefix)
```
  - getLiveWebPrefix
```
public String getLiveWebPrefix()
```
  - getStaticPrefix
```
public String getStaticPrefix()
```
    Returns:
    the String url prefix to use when generating self referencing static URLs
  - setStaticPrefix
```
public void setStaticPrefix(String staticPrefix)
```
    Parameters:
    staticPrefix - explicit URL prefix to use when creating self referencing static URLs
  - getReplayPrefix
```
public String getReplayPrefix()
```
    Returns:
    the String url prefix to use when generating self referencing replay URLs
  - setReplayPrefix
```
public void setReplayPrefix(String replayPrefix)
```
    Parameters:
    replayPrefix - explicit URL prefix to use when creating self referencing replay URLs
  - setQueryPrefix
```
public void setQueryPrefix(String queryPrefix)
```
    Parameters:
    queryPrefix - explicit URL prefix to use when creating self referencing query URLs
  - getQueryPrefix
```
public String getQueryPrefix()
```
    Returns:
    the String url prefix to use when generating self referencing replay URLs
  - makeCaptureQueryUrl
```
public String makeCaptureQueryUrl(String url,
                         String startdate,
                         String enddate)
```
    Build a self-referencing URL that will perform a query for all copies of URL url.
    
    Parameters:
    url - URL to search for copies of
    startdate - start of date range in DT14 format (may be null for no date range.
    enddate - end of date range in DT14 format (may be null, ignored if startdate is null)
    
    Returns:
    String URL that will make a query for all captures of url.
  - setInterstitialJsp
```
public void setInterstitialJsp(String interstitialJsp)
```
    Parameters:
    interstitialJsp - the interstitialJsp to set
  - getInterstitialJsp
```
public String getInterstitialJsp()
```
    Returns:
    the interstitialJsp
  - setUrlRoot
```
public void setUrlRoot(String urlRoot)
```
    Deprecated. use setQueryPrefix, setReplayPrefix, setStaticPrefix
    
    Parameters:
    urlRoot - explicit URL prefix to use when creating ANY self referencing URLs
  - getUrlRoot
```
public String getUrlRoot()
```
    Deprecated. use getQueryPrefix, getReplayPrefix, getStaticPrefix
    
    Returns:
    the String url prefix used when generating self referencing URLs
  - getLocale
```
public Locale getLocale()
```
    Returns:
    explicit Locale to use within this AccessPoint.
  - setLocale
```
public void setLocale(Locale locale)
```
    Parameters:
    locale - explicit Locale to use for requests within this AccessPoint. If not set, will attempt to use the one specified by each requests User Agent via HTTP headers
  - getConfigs
```
public Properties getConfigs()
```
    Returns:
    the generic customization Properties used with this AccessPoint, generally to tune the UI
  - setConfigs
```
public void setConfigs(Properties configs)
```
    Parameters:
    configs - the generic customization Properties to use with this AccessPoint, generally used to tune the UI
  - getFilePatterns
```
public List<String> getFilePatterns()
```
    Returns:
    List of file patterns that will be matched when querying the ResourceIndex
  - setFilePatterns
```
public void setFilePatterns(List<String> filePatterns)
```
    Parameters:
    filePatterns - List of file Patterns (regular expressions) that will be matched when querying the ResourceIndex - only SearchResults matching one of these patterns will be returned.
  - getFileIncludePrefixes
```
public List<String> getFileIncludePrefixes()
```
    Returns:
    List of file String prefixes that will be matched when querying the ResourceIndex
  - setFileIncludePrefixes
```
public void setFileIncludePrefixes(List<String> fileIncludePrefixes)
```
    Parameters:
    fileIncludePrefixes - List of String file prefixes that will be matched when querying the ResourceIndex - only SearchResults from files with a prefix matching one of those in this List will be returned.
  - getFileExcludePrefixes
```
public List<String> getFileExcludePrefixes()
```
    Returns:
    List of file String prefixes that will be matched when querying the ResourceIndex
  - setFileExcludePrefixes
```
public void setFileExcludePrefixes(List<String> fileExcludePrefixes)
```
    Parameters:
    fileExcludePrefixes - List of String file prefixes that will be matched when querying the ResourceIndex - only SearchResults from files with a prefix matching one of those in this List will be returned.
  - getCollection
```
public WaybackCollection getCollection()
```
    Returns:
    the WaybackCollection used by this AccessPoint
  - setCollection
```
public void setCollection(WaybackCollection collection)
```
    Parameters:
    collection - the WaybackCollection to use with this AccessPoint
  - getException
```
public ExceptionRenderer getException()
```
    Returns:
    the ExceptionRenderer in use with this AccessPoint
  - setException
```
public void setException(ExceptionRenderer exception)
```
    Parameters:
    exception - the ExceptionRender to use with this AccessPoint
  - getQuery
```
public QueryRenderer getQuery()
```
    Returns:
    the QueryRenderer to use with this AccessPoint
  - setQuery
```
public void setQuery(QueryRenderer query)
```
    Parameters:
    query - the QueryRenderer responsible for returning query data to clients.
  - getParser
```
public RequestParser getParser()
```
    Returns:
    the RequestParser used by this AccessPoint to attempt to translate incoming HttpServletRequest objects into WaybackRequest objects
  - setParser
```
public void setParser(RequestParser parser)
```
    Parameters:
    parser - the RequestParser to use with this AccessPoint
  - getReplay
```
public ReplayDispatcher getReplay()
```
    Returns:
    the ReplayDispatcher to use with this AccessPoint, responsible for returning an appropriate ReplayRenderer given the user request and the returned document type.
  - setReplay
```
public void setReplay(ReplayDispatcher replay)
```
    Parameters:
    replay - the ReplayDispatcher to use with this AccessPoint.
  - getUriConverter
```
public ResultURIConverter getUriConverter()
```
    Returns:
    the ResultURIConverter used to construct Replay URLs within this AccessPoint
  - setUriConverter
```
public void setUriConverter(ResultURIConverter uriConverter)
```
    Refactoring: remove this method. let getUriConverter() create ResultURIConverter with factory (like AccessPointAdapter does).
    
    Parameters:
    uriConverter - the ResultURIConverter to use with this AccessPoint to construct Replay URLs
  - getExclusionFactory
```
public ExclusionFilterFactory getExclusionFactory()
```
    Returns:
    the ExclusionFilterFactory in use with this AccessPoint
  - setExclusionFactory
```
public void setExclusionFactory(ExclusionFilterFactory exclusionFactory)
```
    Parameters:
    exclusionFactory - all requests to this AccessPoint will create an exclusionFilter from this factory when handling requests
  - getAuthentication
```
public BooleanOperator<WaybackRequest> getAuthentication()
```
    Returns:
    the configured AuthenticationControl BooleanOperator in use with this AccessPoint.
  - setAuthentication
```
public void setAuthentication(BooleanOperator<WaybackRequest> auth)
```
    Parameters:
    auth - the BooleanOperator which determines if incoming requests are allowed to connect to this AccessPoint.
  - isRequestAuth
```
public boolean isRequestAuth()
```
  - setRequestAuth
```
public void setRequestAuth(boolean requestAuth)
```
  - getRefererAuth
```
public String getRefererAuth()
```
    Returns:
    the refererAuth
  - setRefererAuth
```
public void setRefererAuth(String refererAuth)
```
    Parameters:
    refererAuth - the refererAuth to set
  - isBounceToReplayPrefix
```
public boolean isBounceToReplayPrefix()
```
    Returns:
    the bounceToReplayPrefix
  - setBounceToReplayPrefix
```
public void setBounceToReplayPrefix(boolean bounceToReplayPrefix)
```
    Parameters:
    bounceToReplayPrefix - the bounceToReplayPrefix to set
  - isBounceToQueryPrefix
```
public boolean isBounceToQueryPrefix()
```
    Returns:
    the bounceToQueryPrefix
  - setBounceToQueryPrefix
```
public void setBounceToQueryPrefix(boolean bounceToQueryPrefix)
```
    Parameters:
    bounceToQueryPrefix - the bounceToQueryPrefix to set
  - getEmbargoMS
```
public long getEmbargoMS()
```
    Returns:
    the configured number of MS for min age to return from the index
  - setEmbargoMS
```
public void setEmbargoMS(long ms)
```
    Parameters:
    ms - minimum number of MS age for content to be served from the index
  - isForceCleanQueries
```
public boolean isForceCleanQueries()
```
    Returns:
    the forceCleanQueries
  - setForceCleanQueries
```
public void setForceCleanQueries(boolean forceCleanQueries)
```
    Parameters:
    forceCleanQueries - the forceCleanQueries to set
  - setFilterFactory
```
public void setFilterFactory(CustomResultFilterFactory filterFactory)
```
    CustomResultFilterFactory to be applied on CDX query result.
    AccessPoint itself does not use this object. ResourceIndex implementation needs to implement filtering using this property. ClusterResourceIndex is the only implementation known at this moment.
    
    Note: this property will likely be removed in the future.
    
    Parameters:
    filterFactory - the filterFactory to set
  - getFilterFactory
```
public CustomResultFilterFactory getFilterFactory()
```
    Returns:
    the filterFactory
  - setSelfRedirectCanonicalizer
```
public void setSelfRedirectCanonicalizer(UrlCanonicalizer selfRedirectCanonicalizer)
```
    Optional
    
    Parameters:
    selfRedirectCanonicalizer -
  - getSelfRedirectCanonicalizer
```
public UrlCanonicalizer getSelfRedirectCanonicalizer()
```
    URL canonicalizer for testing self-redirect.
    
    Returns:
    The UrlCanonicalizer
  - getMaxRedirectAttempts
```
public int getMaxRedirectAttempts()
```
  - setMaxRedirectAttempts
```
public void setMaxRedirectAttempts(int maxRedirectAttempts)
```
  - isFixedEmbeds
```
public boolean isFixedEmbeds()
```
  - setFixedEmbeds
```
public void setFixedEmbeds(boolean fixedEmbeds)
```
  - isTimestampSearch
```
public boolean isTimestampSearch()
```
  - setTimestampSearch
```
public void setTimestampSearch(boolean timestampSearch)
```
  - getPerfStatsHeader
```
public String getPerfStatsHeader()
```
  - setPerfStatsHeader
```
public void setPerfStatsHeader(String perfStatsHeader)
```
  - getWarcFileHeader
```
public String getWarcFileHeader()
```
  - setWarcFileHeader
```
public void setWarcFileHeader(String warcFileHeader)
```
  - getErrorMsgHeader
```
public String getErrorMsgHeader()
```
  - setErrorMsgHeader
```
public void setErrorMsgHeader(String errorMsgHeader)
```
  - isEnableErrorMsgHeader
```
public boolean isEnableErrorMsgHeader()
```
  - setEnableErrorMsgHeader
```
public void setEnableErrorMsgHeader(boolean enableErrorMsgHeader)
```
  - isEnablePerfStatsHeader
```
public boolean isEnablePerfStatsHeader()
```
  - setEnablePerfStatsHeader
```
public void setEnablePerfStatsHeader(boolean enablePerfStatsHeader)
```
  - isEnableWarcFileHeader
```
public boolean isEnableWarcFileHeader()
```
  - setEnableWarcFileHeader
```
public void setEnableWarcFileHeader(boolean enableWarcFileHeader)
```
  - isEnableMemento
```
public boolean isEnableMemento()
```
  - setEnableMemento
```
public void setEnableMemento(boolean enableMemento)
```
  - getMementoHandler
```
public MementoHandler getMementoHandler()
```
  - setMementoHandler
```
public void setMementoHandler(MementoHandler mementoHandler)
```
  - setPerfStatsHeaderFormat
```
public void setPerfStatsHeaderFormat(PerfStats.OutputFormat perfStatsHeaderFormat)
```
    Format of profiling header field.
    
    Parameters:
    perfStatsHeaderFormat -
    See Also:
    PerfStats.OutputFormat

Class AccessPoint

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

INTERSTITIAL_JSP

INTERSTITIAL_TARGET

INTERSTITIAL_SECONDS

INTERSTITIAL_DATE

INTERSTITIAL_URL

REVISIT_STR

EMPTY_VALUE

RUNTIME_ERROR_HEADER

Constructor Detail

AccessPoint

Method Detail

init

dispatchLocal

handleRequest

createExclusionFilter

getRewriteDirector

setRewriteDirector

getRewriteDirective

getCollectionContextName

logError

checkAccessPointAware

isSelfRedirect

queryIndex

isWaybackReferer

isWaybackReferer

handleReplayRedirect

handleReplay

searchCaptures

retrievePayloadForIdenticalContentRevisit

setQueryCollapseTime

getQueryCollapseTime

handleQuery

shutdown

closeResources

isExactHostMatch

setExactHostMatch

isExactSchemeMatch

setExactSchemeMatch

isUseAnchorWindow

setUseAnchorWindow

isUseServerName

setUseServerName

isServeStatic

setServeStatic

getLiveWebRedirector

setLiveWebRedirector

setLiveWebPrefix

getLiveWebPrefix

getStaticPrefix

setStaticPrefix

getReplayPrefix

setReplayPrefix

setQueryPrefix

getQueryPrefix

makeCaptureQueryUrl

setInterstitialJsp

getInterstitialJsp

setUrlRoot

getUrlRoot

getLocale

setLocale

getConfigs

setConfigs

getFilePatterns

setFilePatterns

getFileIncludePrefixes

setFileIncludePrefixes

getFileExcludePrefixes

setFileExcludePrefixes

getCollection

setCollection

getException