com.endeca.itl.web.auth
Interface Authenticator
- All Superinterfaces:
- Configurable, Pluggable
public interface Authenticator
- extends Pluggable, Configurable
X_POINT_ID
static final String X_POINT_ID
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 redirectfetcherOutput
- fetcherOutput object, includes Content object and Parse objectprotocol
- 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.
Copyright © 2007, 2012, Oracle and/or its affiliates. All rights reserved.