Package sonia.scm.net.ahc

Class AdvancedHttpResponse

java.lang.Object

sonia.scm.net.ahc.AdvancedHttpResponse

public abstract class AdvancedHttpResponse
extends Object

Http response. The response of a AdvancedHttpRequest or AdvancedHttpRequestWithBody.

Since:

1.46

Constructor Summary

Constructors

Constructor	Description
AdvancedHttpResponse()

Method Summary

Modifier and Type	Method	Description
byte[]	content()	Returns the content of the response as byte array.
abstract com.google.common.io.ByteSource	contentAsByteSource()	Returns the response content as byte source.
BufferedReader	contentAsReader()	Returns a reader for the content of the response.
InputStream	contentAsStream()	Returns response content as stream.
String	contentAsString()	Returns the response content as string.
<T> T	contentFromJson(Class<T> type)	Transforms the response content from json to the given type.
<T> T	contentFromXml(Class<T> type)	Transforms the response content from xml to the given type.
<T> T	contentTransformed(Class<T> type)	Transforms the response content to the given type.
<T> T	contentTransformed(Class<T> type, String contentType)	Transforms the response content to the given type.
protected abstract ContentTransformer	createTransformer(Class<?> type, String contentType)	Creates a ContentTransformer for the given Content-Type.
String	getFirstHeader(String name)	Returns the first header value for the given header name or null.
abstract com.google.common.collect.Multimap<String,String>	getHeaders()	Returns the response headers.
abstract int	getStatus()	Returns the status code of the response.
abstract String	getStatusText()	Returns the status text of the response.
boolean	isSuccessful()	Returns true if the response was successful.

Methods inherited from class java.lang.Object

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

Constructor Details

AdvancedHttpResponse

public AdvancedHttpResponse()

Method Details

contentAsByteSource

public abstract com.google.common.io.ByteSource contentAsByteSource()
                                                             throws IOException

Returns the response content as byte source.

Throws:

IOException

getHeaders

public abstract com.google.common.collect.Multimap<String,String> getHeaders()

Returns the response headers.

getStatus

public abstract int getStatus()

Returns the status code of the response.

getStatusText

public abstract String getStatusText()

Returns the status text of the response.

createTransformer

protected abstract ContentTransformer createTransformer(Class<?> type,
 String contentType)

Creates a ContentTransformer for the given Content-Type.

Parameters:

type - object type

contentType - content-type

Returns:

ContentTransformer

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the content-type

content

public byte[] content()
               throws IOException

Returns the content of the response as byte array.

Throws:

IOException

contentAsReader

public BufferedReader contentAsReader()
                               throws IOException

Returns a reader for the content of the response.

Throws:

IOException

contentAsStream

public InputStream contentAsStream()
                            throws IOException

Returns response content as stream.

Throws:

IOException

contentAsString

public String contentAsString()
                       throws IOException

Returns the response content as string.

Throws:

IOException

contentFromJson

public <T> T contentFromJson(Class<T> type)
                      throws IOException

Transforms the response content from json to the given type.

Type Parameters:

T - object type

Parameters:

type - object type

Returns:

transformed object

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the json content-type

IOException

contentFromXml

public <T> T contentFromXml(Class<T> type)
                     throws IOException

Transforms the response content from xml to the given type.

Type Parameters:

T - object type

Parameters:

type - object type

Returns:

transformed object

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the xml content-type

IOException

contentTransformed

public <T> T contentTransformed(Class<T> type)
                         throws IOException

Transforms the response content to the given type. The method uses the content-type header to pick the right ContentTransformer.

Type Parameters:

T - object type

Parameters:

type - object type

Returns:

transformed object

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the content-type

IOException

contentTransformed

public <T> T contentTransformed(Class<T> type,
 String contentType)
                         throws IOException

Transforms the response content to the given type. The method will use the ContentTransformer which is responsible for the given content type.

Type Parameters:

T - object type

Parameters:

type - object type

contentType - type to pick ContentTransformer

Returns:

transformed object

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the content-type

IOException

getFirstHeader

public String getFirstHeader(String name)

Returns the first header value for the given header name or null.

isSuccessful

public boolean isSuccessful()

Returns true if the response was successful. A response is successful, if the status code is greater than 199 and lower than 400.