com.screenscraper.http

Interface ScrapingHttpClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

AbstractScrapingHttpClient, ApacheScrapingHttpClient, AsyncNingScrapingHttpClient, AsyncScrapingHttpClient2, CurlHttpClient

public interface ScrapingHttpClient
extends java.io.Closeable

Interface for a scraping http client

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	REDIRECT_WITH_POST_ENTITY_STATUS_CODE

Method Summary

Modifier and Type	Method and Description
void	clearCookies() Clears all cookies from this client
void	close()
ScrapingRequest.Builder	convertScrapeableFileToRequest(ScrapeableFile scrapeableFile) Converts the scrapeable file to the request.
java.util.List<ScrapingCookie>	getCookies() Returns a list of all the cookies for the current client, for any domain
ScrapingResponse	issueRequest(ScrapingRequest request) Issues the given request
ScrapingData	scrapeFile(ScrapeableFile scrapeableFile) Requests data for a scrapeable file.
void	setCookie(ScrapingCookie cookie) Sets the cookie
void	setProxyServer(ScrapingProxy proxyServer) Sets a proxy server to use for future requests
void	updateSessionClientInfo() Tells the client the session http info value has changed.
boolean	usesHint(ScrapingHint hint) Returns whether or not this client implementation uses the given hint.

Field Detail

REDIRECT_WITH_POST_ENTITY_STATUS_CODE

static final int REDIRECT_WITH_POST_ENTITY_STATUS_CODE

See Also:

Constant Field Values

Method Detail

issueRequest

@NotNull
ScrapingResponse issueRequest(@NotNull
                                        ScrapingRequest request)

Issues the given request

Parameters:

request - The request to be issued

Returns:

The response received

setProxyServer

void setProxyServer(@Nullable
                    ScrapingProxy proxyServer)

Sets a proxy server to use for future requests

Parameters:

proxyServer - The proxy server to use for future requests

setCookie

void setCookie(@NotNull
               ScrapingCookie cookie)

Sets the cookie

Parameters:

cookie - The cookie to set

clearCookies

void clearCookies()

Clears all cookies from this client

usesHint

boolean usesHint(@NotNull
                 ScrapingHint hint)

Returns whether or not this client implementation uses the given hint. This method is for utility purposes, as hints may be ignored regardless of what this method returns. This is instead a clue about whether a given hint will be used. Developers may forget to return the correct value here and it won't cause any failures (just helps determine the client to use)

Parameters:

hint - The hint to test

Returns:

True if the client tries to use the given hint type, false if it doesn't. This is a clue, and is not guaranteed to always hold

scrapeFile

ScrapingData scrapeFile(@NotNull
                        ScrapeableFile scrapeableFile)

Requests data for a scrapeable file.

Parameters:

scrapeableFile - The scrapeable file to request

Returns:

The response from the server

getCookies

@NotNull
java.util.List<ScrapingCookie> getCookies()

Returns a list of all the cookies for the current client, for any domain

Returns:

A list of all cookies in the current client

convertScrapeableFileToRequest

ScrapingRequest.Builder convertScrapeableFileToRequest(@NotNull
                                                       ScrapeableFile scrapeableFile)

Converts the scrapeable file to the request. It returns the builder type so implementors can add their own stuff. For example:

return super.convertScrapeableFileToRequest(scrapeableFile).addHeader("Cookie: " + someCookie)

Parameters:

scrapeableFile - The scrapeable file to convert

Returns:

The builder prepared to create the request

Since:

7.0.2a

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

updateSessionClientInfo

void updateSessionClientInfo()

Tells the client the session http info value has changed. If the client is built from values at the start of the session rather than grabbing them per request, it may need to update something internally. This method should be called to indicate a change has occurred, and all the session.getXXX methods should return the updated values

Since:

7.0.6a