com.atlassian.httpclient.apache.httpcomponents

Class DefaultResponse

java.lang.Object

com.atlassian.httpclient.apache.httpcomponents.DefaultResponse

All Implemented Interfaces:

Message, Response

public final class DefaultResponse
extends Object
implements Response

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultResponse.DefaultResponseBuilder

Nested classes/interfaces inherited from interface com.atlassian.httpclient.api.Response

Response.Builder

Constructor Summary

Constructors

Constructor and Description
DefaultResponse(Headers headers, InputStream entityStream, com.atlassian.fugue.Option<Long> maxEntitySize, int statusCode, String statusText)

Method Summary

Modifier and Type	Method and Description
static DefaultResponse.DefaultResponseBuilder	builder()
String	getAccept()
String	getContentCharset() Returns the currently set content charset value, if any.
com.atlassian.fugue.Option<Long>	getContentLength() Returns the content length for the entity in the message.
String	getContentType() Returns the IANA media type, minus charset information, for the current entity, if any.
String	getEntity() Returns the current entity in String form, if available, converting the underlying entity stream to a string using the currently set content charset, or defaulting to the HTTP standard of "ISO-8859-1" if no content charset has been specified.
InputStream	getEntityStream() Returns the current entity as an input stream, or null if not set.
String	getHeader(String name) Returns the specified header by name.
Map<String,String>	getHeaders() Returns a map of all headers that have been set on this object.
int	getStatusCode() Gets the status code of the response.
String	getStatusText() Gets the status text of the response.
boolean	hasEntity() Returns whether or not an entity has been set on this object.
boolean	hasReadEntity() Returns whether or not the current entity property, if any, has been read from this object.
boolean	isBadRequest() Indicates whether or not this response's status code is "Bad Request".
boolean	isClientError() Indicates whether or not this response's status code is categorized as "Client Error" (4xx).
boolean	isConflict() Indicates whether or not this response's status code is "Conflict".
boolean	isCreated() Indicates whether or not this response's status code is "Created".
boolean	isError() Indicates whether or not this response's status code is categorized as either "Client Error" or "Server Error".
boolean	isForbidden() Indicates whether or not this response's status code is "Forbidden".
boolean	isInformational() Indicates whether or not this response's status code is categorized as "Informational" (1xx).
boolean	isInternalServerError() Indicates whether or not this response's status code is "Internal Server Error".
boolean	isNoContent() Indicates whether or not this response's status code is "No Content".
boolean	isNotFound() Indicates whether or not this response's status code is "Not Found".
boolean	isNotModified() Indicates whether or not this response's status code is "Not Modified".
boolean	isNotSuccessful() Indicates whether or not this response's status code is categorized as one of "Informational", "Redirection", "Client Error" or "Server Error".
boolean	isOk() Indicates whether or not this response's status code is "OK".
boolean	isRedirection() Indicates whether or not this response's status code is categorized as "Redirection" (3xx).
boolean	isSeeOther() Indicates whether or not this response's status code is "See Other".
boolean	isServerError() Indicates whether or not this response's status code is categorized as "Server Error" (5xx).
boolean	isServiceUnavailable() Indicates whether or not this response's status code is "Service Unavailable".
boolean	isSuccessful() Indicates whether or not this response's status code is categorized as "Successful" (2xx).
boolean	isUnauthorized() Indicates whether or not this response's status code is "Unauthorized".
Message	validate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.httpclient.api.Message

getContentCharset, getContentType, getEntity, getEntityStream, getHeader, getHeaders, hasEntity, hasReadEntity

Constructor Detail

DefaultResponse

public DefaultResponse(Headers headers,
                       InputStream entityStream,
                       com.atlassian.fugue.Option<Long> maxEntitySize,
                       int statusCode,
                       String statusText)

Method Detail

builder

public static DefaultResponse.DefaultResponseBuilder builder()

getStatusCode

public int getStatusCode()

Description copied from interface: Response

Gets the status code of the response.

Specified by:

getStatusCode in interface Response

Returns:

The status code

getStatusText

public String getStatusText()

Description copied from interface: Response

Gets the status text of the response.

Specified by:

getStatusText in interface Response

Returns:

The status text

isInformational

public boolean isInformational()

Description copied from interface: Response

Indicates whether or not this response's status code is categorized as "Informational" (1xx).

Specified by:

isInformational in interface Response

Returns:

True if status code gte 100 and lt 200

isSuccessful

public boolean isSuccessful()

Description copied from interface: Response

Indicates whether or not this response's status code is categorized as "Successful" (2xx).

Specified by:

isSuccessful in interface Response

Returns:

True if status code gte 200 and lt 300

isOk

public boolean isOk()

Description copied from interface: Response

Indicates whether or not this response's status code is "OK".

Specified by:

isOk in interface Response

Returns:

True if status code is 200

isCreated

public boolean isCreated()

Description copied from interface: Response

Indicates whether or not this response's status code is "Created".

Specified by:

isCreated in interface Response

Returns:

True if status code is 201

isNoContent

public boolean isNoContent()

Description copied from interface: Response

Indicates whether or not this response's status code is "No Content".

Specified by:

isNoContent in interface Response

Returns:

True if status code is 204

isRedirection

public boolean isRedirection()

Description copied from interface: Response

Indicates whether or not this response's status code is categorized as "Redirection" (3xx).

Specified by:

isRedirection in interface Response

Returns:

True if status code gte 300 and lt 400

isSeeOther

public boolean isSeeOther()

Description copied from interface: Response

Indicates whether or not this response's status code is "See Other".

Specified by:

isSeeOther in interface Response

Returns:

True if status code is 303

isNotModified

public boolean isNotModified()

Description copied from interface: Response

Indicates whether or not this response's status code is "Not Modified".

Specified by:

isNotModified in interface Response

Returns:

True if status code is 304

isClientError

public boolean isClientError()

Description copied from interface: Response

Indicates whether or not this response's status code is categorized as "Client Error" (4xx).

Specified by:

isClientError in interface Response

Returns:

True if status code gte 400 and lt 500

isBadRequest

public boolean isBadRequest()

Description copied from interface: Response

Indicates whether or not this response's status code is "Bad Request".

Specified by:

isBadRequest in interface Response

Returns:

True if status code is 400

isUnauthorized

public boolean isUnauthorized()

Description copied from interface: Response

Indicates whether or not this response's status code is "Unauthorized".

Specified by:

isUnauthorized in interface Response

Returns:

True if status code is 401

isForbidden

public boolean isForbidden()

Description copied from interface: Response

Indicates whether or not this response's status code is "Forbidden".

Specified by:

isForbidden in interface Response

Returns:

True if status code is 403

isNotFound

public boolean isNotFound()

Description copied from interface: Response

Indicates whether or not this response's status code is "Not Found".

Specified by:

isNotFound in interface Response

Returns:

True if status code is 404

isConflict

public boolean isConflict()

Description copied from interface: Response

Indicates whether or not this response's status code is "Conflict".

Specified by:

isConflict in interface Response

Returns:

True if status code is 409

isServerError

public boolean isServerError()

Description copied from interface: Response

Indicates whether or not this response's status code is categorized as "Server Error" (5xx).

Specified by:

isServerError in interface Response

Returns:

True if status code gte 500 and lt 600

isInternalServerError

public boolean isInternalServerError()

Description copied from interface: Response

Indicates whether or not this response's status code is "Internal Server Error".

Specified by:

isInternalServerError in interface Response

Returns:

True if status code is 500

isServiceUnavailable

public boolean isServiceUnavailable()

Description copied from interface: Response

Indicates whether or not this response's status code is "Service Unavailable".

Specified by:

isServiceUnavailable in interface Response

Returns:

True if status code is 503

isError

public boolean isError()

Description copied from interface: Response

Indicates whether or not this response's status code is categorized as either "Client Error" or "Server Error".

Specified by:

isError in interface Response

Returns:

True if either of isClientError() or isServerError() is true

isNotSuccessful

public boolean isNotSuccessful()

Description copied from interface: Response

Indicates whether or not this response's status code is categorized as one of "Informational", "Redirection", "Client Error" or "Server Error".

Specified by:

isNotSuccessful in interface Response

Returns:

True if one of isInformational(), isRedirection() or isError() is true

getContentLength

public com.atlassian.fugue.Option<Long> getContentLength()

Description copied from interface: Message

Returns the content length for the entity in the message. For requests, this would be the content length of the entity that you set, or the content length that you can set manually (e.g. for streamed entities). For responses, this would be the content length from the header.

Specified by:

getContentLength in interface Message

Returns:

The content length as an option. None is returned if no content length has been set or not present.

getContentType

public String getContentType()

Description copied from interface: Message

Returns the IANA media type, minus charset information, for the current entity, if any. To access charset information, use getContentCharset(). To get the full Content-Type header value including charset if specified, use getHeader("Content-Type").

Specified by:

getContentType in interface Message

Returns:

An IANA media type, or null

getContentCharset

public String getContentCharset()

Description copied from interface: Message

Returns the currently set content charset value, if any.

Specified by:

getContentCharset in interface Message

Returns:

The current content charset

getAccept

public String getAccept()

getEntityStream

public InputStream getEntityStream()
                            throws IllegalStateException

Description copied from interface: Message

Returns the current entity as an input stream, or null if not set. Use hasEntity() to check if this message has an entity value.

Specified by:

getEntityStream in interface Message

Returns:

An input stream for the current entity, or null if not set

Throws:

IllegalStateException - If the non-null entity has already been accessed once, through any accessor for this object

getEntity

public String getEntity()
                 throws IllegalStateException,
                        IllegalArgumentException

Description copied from interface: Message

Returns the current entity in String form, if available, converting the underlying entity stream to a string using the currently set content charset, or defaulting to the HTTP standard of "ISO-8859-1" if no content charset has been specified.

Specified by:

getEntity in interface Message

Returns:

The entity string, or null if no entity has been set

Throws:

IllegalStateException - If the non-null entity has already been accessed once, through any accessor for this object. Also thrown if underlying body cannot be converted into a String

IllegalArgumentException - If the entity exceeds the maximum size

hasEntity

public boolean hasEntity()

Description copied from interface: Message

Returns whether or not an entity has been set on this object. Use this instead of calling an entity getter to test for presence of an entity, as the getters will affect this object's hasReadEntity() state.

Specified by:

hasEntity in interface Message

Returns:

This object, for builder-style chaining

hasReadEntity

public boolean hasReadEntity()

Description copied from interface: Message

Returns whether or not the current entity property, if any, has been read from this object. If this method returns true, any further calls to entity property accessors on this object will result in an IllegalStateException being thrown.

Specified by:

hasReadEntity in interface Message

Returns:

True if the entity has already been read

getHeaders

public Map<String,String> getHeaders()

Description copied from interface: Message

Returns a map of all headers that have been set on this object. If the content type property has been set, a full "Content-Type" header including content charset, if set, is generated as part of this map.

Specified by:

getHeaders in interface Message

Returns:

The headers map

getHeader

public String getHeader(String name)

Description copied from interface: Message

Returns the specified header by name. If "Content-Type" is requested, the value will be constructed from this object's content type and content charset properties, if set and as appropriate.

Specified by:

getHeader in interface Message

Parameters:

name - The name of the header to fetch

Returns:

The value of the named header, or null if not set

validate

public Message validate()