com.norconex.collector.http.redirect

Interface IRedirectURLProvider

All Known Implementing Classes:

GenericRedirectURLProvider

public interface IRedirectURLProvider

Responsible for providing a target absolute URL each time an HTTP redirect is encountered when invoking a URL. Target URLs are treated as new URLs to process, while the original URL gets rejected. Sometimes redirect URLs returned with the HTTP headers are relatives, have bad encoding, etc. Implementors are free to handle/fix these conditions as they see fit.

Since:

2.4.0

Author:

Pascal Essiembre

Method Summary

Modifier and Type	Method and Description
String	provideRedirectURL(HttpRequest request, HttpResponse response, HttpContext context) Provides the redirect URL that the crawler must follow.

Method Detail

provideRedirectURL

String provideRedirectURL(HttpRequest request,
                          HttpResponse response,
                          HttpContext context)

Provides the redirect URL that the crawler must follow. This method is only invoked when a redirect has been detected. As such, it should rarely return null. Returning null effectively prevents a redirect from happening, but it is an efficient way to disable redirects. The recommended approach to disable redirects is to set zero on GenericHttpClientFactory.setMaxRedirects(int)

Parameters:

request - the HTTP request that led to the redirect

response - original URL HTTP response

context - execution state of an HTTP process

Returns:

redirect URL