com.screenscraper.http

Class ApacheScrapingHttpClient

java.lang.Object

com.screenscraper.http.AbstractScrapingHttpClient

com.screenscraper.http.ApacheScrapingHttpClient

All Implemented Interfaces:

ScrapingHttpClient, java.io.Closeable, java.lang.AutoCloseable

public class ApacheScrapingHttpClient
extends AbstractScrapingHttpClient

Scraping client that uses the Apache HTTP Client

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Fields inherited from class com.screenscraper.http.AbstractScrapingHttpClient

GLOBAL_REQUESTS_THREAD_LOCK, session

Fields inherited from interface com.screenscraper.http.ScrapingHttpClient

REDIRECT_WITH_POST_ENTITY_STATUS_CODE

Constructor Summary

Constructors

Constructor and Description
ApacheScrapingHttpClient(ScrapingSession session) Creates the client
ApacheScrapingHttpClient(ScrapingSession session, boolean followRedirects) Creates the client

Method Summary

Modifier and Type	Method and Description
void	clearCookies() Clears all cookies from this client
void	close()
java.util.List<ScrapingCookie>	getCookies() Returns a list of all the cookies for the current client, for any domain
protected ScrapingResponse	issueRequestInternal(ScrapingRequest request) Issues the given request
void	setCookie(ScrapingCookie cookie) Sets the cookie
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.

Methods inherited from class com.screenscraper.http.AbstractScrapingHttpClient

convertScrapeableFileToRequest, getProxy, isRedirectStatusCode, issueRequest, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarn, logWarn, scrapeFile, setProxyServer

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

ApacheScrapingHttpClient

public ApacheScrapingHttpClient(@Nullable
                                ScrapingSession session)
                         throws java.lang.Exception

Creates the client

Parameters:

session - The session, used for logging and various settings

Throws:

java.lang.Exception - On error creating the client

ApacheScrapingHttpClient

public ApacheScrapingHttpClient(@Nullable
                                ScrapingSession session,
                                boolean followRedirects)
                         throws java.lang.Exception

Creates the client

Parameters:

session - The session, used for logging and various settings

followRedirects - Whether redirects should be followed or not

Throws:

java.lang.Exception - On error creating the client

Method Detail

updateSessionClientInfo

public void updateSessionClientInfo()

Description copied from interface: ScrapingHttpClient

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

setCookie

public void setCookie(@NotNull
                      ScrapingCookie cookie)

Sets the cookie

Parameters:

cookie - The cookie to set

issueRequestInternal

@NotNull
protected ScrapingResponse issueRequestInternal(@NotNull
                                                          ScrapingRequest request)

Issues the given request

Specified by:

issueRequestInternal in class AbstractScrapingHttpClient

Parameters:

request - The request to be issued

Returns:

The response received

usesHint

public 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

getCookies

@NotNull
public 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

clearCookies

public void clearCookies()

Clears all cookies from this client

close

public void close()