com.screenscraper.util.internal.services.util

Class SimpleHttpResponse

java.lang.Object

com.screenscraper.util.internal.services.util.SimpleHttpResponse

public class SimpleHttpResponse
extends java.lang.Object

Class Description

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleHttpResponse.SimpleHttpResponseBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleHttpResponse	EMPTY_RESPONSE

Method Summary

Modifier and Type	Method and Description
void	close()
byte[]	getBytes() Returns the body contents as a byte array
java.lang.String	getCharacterSet() Returns the character set of the response, if known, null otherwise
java.lang.String	getContentType() Returns the content type of the response, if known, null otherwise
java.io.InputStream	getInputStream() Returns the input stream that can be used to read the response content
int	getLength() Returns the length of the response, if known, or -1 if unknown.
java.lang.String	getResponseAsString() Returns the body contents as a String
int	getStatusCode() Returns the status code of the response
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_RESPONSE

@Nullable
public static final SimpleHttpResponse EMPTY_RESPONSE

Method Detail

getInputStream

public java.io.InputStream getInputStream()

Returns the input stream that can be used to read the response content

Returns:

The input stream to read response body

Throws:

java.lang.IllegalStateException - If a call to getBytes has already been issued on this response

getBytes

@NotNull
public byte[] getBytes()
                          throws java.io.IOException

Returns the body contents as a byte array

Returns:

The contents of the body, as bytes. This is a copy, so each call returns a unique array

Throws:

java.io.IOException - If there is an error reading the input stream

java.lang.IllegalStateException - If the input stream has already been retrieved (meaning we have no guarantee the bytes are complete)

getResponseAsString

@NotNull
public java.lang.String getResponseAsString()
                                               throws java.io.IOException

Returns the body contents as a String

Returns:

The contents of the body, as a String.

Throws:

java.io.IOException - If there is an error reading the input stream

java.lang.IllegalStateException - If the input stream has already been retrieved (meaning we have no guarantee the bytes are complete)

getLength

public int getLength()

Returns the length of the response, if known, or -1 if unknown. This could change if the bytes are read rather than reading a stream.

Returns:

The length of the response or -1 if it is unknown

getStatusCode

public int getStatusCode()

Returns the status code of the response

Returns:

The status code returned in the response

getCharacterSet

public java.lang.String getCharacterSet()

Returns the character set of the response, if known, null otherwise

Returns:

The character set of the response, if known, null otherwise

getContentType

public java.lang.String getContentType()

Returns the content type of the response, if known, null otherwise

Returns:

The content type of the response, if known, null otherwise

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object