com.endeca.itl.web.auth

Interface Authenticator

All Superinterfaces:

Configurable, Pluggable

public interface Authenticator
extends Pluggable, Configurable

Field Summary

Fields

Modifier and Type	Field and Description
static String	X_POINT_ID

Method Summary

Modifier and Type	Method and Description
URI	authenticate(List<URI> redirectUrls, FetcherOutput fetcherOutput, Protocol protocol) Authenticates the crawler for a particular site during the crawl, if necessary.
AuthenticatorConfiguration	getAuthConf()
void	preCrawlAuthenticate(Protocol protocol) Authenticates the crawler for a particular site before the crawl starts.
void	setAuthConf(AuthenticatorConfiguration conf) Initializes the Authenticator with the given configuration.

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Field Detail

X_POINT_ID

static final String X_POINT_ID

Method Detail

setAuthConf

void setAuthConf(AuthenticatorConfiguration conf)

Initializes the Authenticator with the given configuration.

Parameters:

conf -

getAuthConf

AuthenticatorConfiguration getAuthConf()

preCrawlAuthenticate

void preCrawlAuthenticate(Protocol protocol)
                   throws AuthenticationFailedException,
                          RequestFailedException

Authenticates the crawler for a particular site before the crawl starts.

Parameters:

protocol -

Throws:

AuthenticationFailedException

RequestFailedException

authenticate

URI authenticate(List<URI> redirectUrls,
                 FetcherOutput fetcherOutput,
                 Protocol protocol)
          throws AuthenticationFailedException,
                 RequestFailedException

Authenticates the crawler for a particular site during the crawl, if necessary. Usually this involves checking the content of the page to see if it requires login, then using the HttpClient to make additional login requests as necessary. The URL passed back will be refetched; typically this is the original URL that was going to be fetched.

Parameters:

redirectUrls - list of the URLs that have been followed during redirect

fetcherOutput - fetcherOutput object, includes Content object and Parse object

protocol - protocol that was used to fetch the page

Returns:

URL to refetch. if null, no URL is fetched

Throws:

AuthenticationFailedException - the authentication failed. UrlProcessor will log this but not try to refetch the page.

RequestFailedException - the login request was unsuccessful. UrlProcessor will queue up the original URL for a retry.