com.screenscraper.http.models

Class ScrapingResponse

java.lang.Object

com.screenscraper.http.models.ScrapingResponse

public class ScrapingResponse
extends java.lang.Object

Represents a response from the server

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScrapingResponse.Builder
static class	ScrapingResponse.SynchronizedBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBody() Returns the Body for the object, as it was received.
java.lang.String	getBodyWithBinaryCheck(boolean forceNonBinary) Returns the Body for the object, checking for binary types, and when found, returning a "binary data" string instead of garbage text
java.lang.String	getCharacterEncoding() Returns the CharacterEncoding for the object
RequestError	getError() Returns the Error for the object
java.lang.String	getFinalUrl() Returns the FinalUrl for the object
java.util.Set<ScrapingHttpHeader>	getHeaders() Returns the Headers for the object
java.lang.String	getHeaderSectionString()
byte[]	getRawResponse() Returns the RawResponse for the object
java.util.List<java.lang.String>	getRedirectUrls() Returns the RedirectUrls for the object
int	getStatusCode() Returns the StatusCode for the object
java.lang.String	getStatusLine() Returns the StatusLine for the object
java.lang.String	toFullResponseString() Returns the body string for display (includes the headers).
java.lang.String	toFullResponseString(boolean forceNonBinary) Returns the body string for display (includes the headers)
boolean	wasErrorOnRequest() Returns the ErrorOnRequest for the object

Methods inherited from class java.lang.Object

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

Method Detail

getError

@Nullable
public RequestError getError()

Returns the Error for the object

Returns:

The Error for the object

getCharacterEncoding

@NotNull
public java.lang.String getCharacterEncoding()

Returns the CharacterEncoding for the object

Returns:

The CharacterEncoding for the object

getRedirectUrls

@NotNull
public java.util.List<java.lang.String> getRedirectUrls()

Returns the RedirectUrls for the object

Returns:

The RedirectUrls for the object

getFinalUrl

@NotNull
public java.lang.String getFinalUrl()

Returns the FinalUrl for the object

Returns:

The FinalUrl for the object

getStatusCode

public int getStatusCode()

Returns the StatusCode for the object

Returns:

The StatusCode for the object

getStatusLine

@NotNull
public java.lang.String getStatusLine()

Returns the StatusLine for the object

Returns:

The StatusLine for the object

getHeaders

@NotNull
public java.util.Set<ScrapingHttpHeader> getHeaders()

Returns the Headers for the object

Returns:

The Headers for the object

getBody

@NotNull
public java.lang.String getBody()

Returns the Body for the object, as it was received. If this was a binary file, this could be garbage text

Returns:

The Body for the object, as it was received. If this was a binary file, this could be garbage text

getBodyWithBinaryCheck

@NotNull
public java.lang.String getBodyWithBinaryCheck(boolean forceNonBinary)

Returns the Body for the object, checking for binary types, and when found, returning a "binary data" string instead of garbage text

Parameters:

forceNonBinary - True to force this to be treated as non binary, false to let the code try to determine if it is binary or not

Returns:

The Body for the object, checking for binary types, and when found, returning a "binary data" string instead of garbage text

wasErrorOnRequest

public boolean wasErrorOnRequest()

Returns the ErrorOnRequest for the object

Returns:

The ErrorOnRequest for the object

getRawResponse

@NotNull
public byte[] getRawResponse()

Returns the RawResponse for the object

Returns:

The RawResponse for the object

getHeaderSectionString

@NotNull
public java.lang.String getHeaderSectionString()

toFullResponseString

@NotNull
public java.lang.String toFullResponseString()

Returns the body string for display (includes the headers). This doesn't force a non binary file

Returns:

The body and headers

toFullResponseString

@NotNull
public java.lang.String toFullResponseString(boolean forceNonBinary)

Returns the body string for display (includes the headers)

Parameters:

forceNonBinary - True if we should display the body as non binary regardless, false to try and hide binary data

Returns:

The body and headers