org.archive.wayback.accesscontrol

Class ExternalExcluder

java.lang.Object

org.archive.wayback.accesscontrol.ExternalExcluder

public class ExternalExcluder
extends Object

Class which simplifies usage of wayback robots and static map exclusion policies and software in external applications. Uses Spring to construct an ExclusionFilterFactory which handles requests.

Version:

$Date$, $Revision$

Author:

brad

Constructor Summary

Constructors

Constructor and Description
ExternalExcluder(ObjectFilter<CaptureSearchResult> filter)

Method Summary

Methods

Modifier and Type	Method and Description
static ExternalExcluder	getExcluder(String configPath)
boolean	isExcluded(String urlString, String timestamp)
static void	shutdown() shutdown underlying resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalExcluder

public ExternalExcluder(ObjectFilter<CaptureSearchResult> filter)

Parameters:

filter - ObjectFilter responsible for excluding content

Method Detail

isExcluded

public boolean isExcluded(String urlString,
                 String timestamp)

Parameters:

urlString - String URL that should be checked for blocking.

timestamp - String 14-digit timestamp to check for blocking.

Returns:

true if the url-timestamp should not be shown to end users

getExcluder

public static ExternalExcluder getExcluder(String configPath)

Parameters:

configPath - String path to local Sprint XML configuration. This Spring config file must include a bean with id "excluder-factory" that implements org.archive.wayback.accesscontrol.ExclusionFilterFactory

Returns:

an excluder fully configured via the XML Spring configuration at configPath

shutdown

public static void shutdown()

shutdown underlying resources.