com.screenscraper.http

Class CurlHttpClient

java.lang.Object

com.screenscraper.http.AbstractScrapingHttpClient

com.screenscraper.http.CurlHttpClient

All Implemented Interfaces:

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

public class CurlHttpClient
extends AbstractScrapingHttpClient

Http Client that uses cURL. Note the value must be set in the properties file for the location of curl (otherwise it assumes it's available directly)

Version:

1.0

Field Summary

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
CurlHttpClient(ScrapingSession session)

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

Constructor Detail

CurlHttpClient

public CurlHttpClient(@Nullable
                      ScrapingSession session)

Method Detail

issueRequestInternal

@NotNull
protected ScrapingResponse issueRequestInternal(@NotNull
                                                          ScrapingRequest request)

Description copied from class: AbstractScrapingHttpClient

Issues the given request. This method should be overridden in subclasses to do the request.

Specified by:

issueRequestInternal in class AbstractScrapingHttpClient

Parameters:

request - The request to be issued

Returns:

The response received

setCookie

public void setCookie(@NotNull
                      ScrapingCookie cookie)

Description copied from interface: ScrapingHttpClient

Sets the cookie

Parameters:

cookie - The cookie to set

clearCookies

public void clearCookies()

Description copied from interface: ScrapingHttpClient

Clears all cookies from this client

usesHint

public boolean usesHint(@NotNull
                        ScrapingHint hint)

Description copied from interface: ScrapingHttpClient

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()

Description copied from interface: ScrapingHttpClient

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

Returns:

A list of all cookies in the current client

close

public void close()

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