com.atlassian.httpclient.apache.httpcomponents

Class DefaultRequest

java.lang.Object

com.atlassian.httpclient.apache.httpcomponents.DefaultRequest

All Implemented Interfaces:

Message, Request

public class DefaultRequest
extends Object
implements Request

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultRequest.DefaultRequestBuilder

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

Request.Builder, Request.Method

Method Summary

Modifier and Type	Method and Description
static DefaultRequest.DefaultRequestBuilder	builder(HttpClient httpClient)
String	getAccept() Returns this request's Accept header, if set.
String	getAttribute(String name) Gets an attribute from the request.
Map<String,String>	getAttributes() Gets all attributes for this request.
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.
Request.Method	getMethod()
URI	getUri() Returns this request's URI, if set.
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	isCacheDisabled()
Request	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

Method Detail

builder

public static DefaultRequest.DefaultRequestBuilder builder(HttpClient httpClient)

getMethod

public Request.Method getMethod()

Specified by:

getMethod in interface Request

getUri

public URI getUri()

Description copied from interface: Request

Returns this request's URI, if set.

Specified by:

getUri in interface Request

Returns:

The URI or null if not yet set

getAccept

public String getAccept()

Description copied from interface: Request

Returns this request's Accept header, if set.

Specified by:

getAccept in interface Request

Returns:

The accept header value

getAttribute

public String getAttribute(String name)

Description copied from interface: Request

Gets an attribute from the request. Attributes are request metadata that are forwarded to the analytics plugin when enabled.

Specified by:

getAttribute in interface Request

Parameters:

name - The attribute name

Returns:

The attribute value, or null if not set

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: Request

Gets all attributes for this request. Attributes are request metadata that are forwarded to the analytics plugin when enabled.

Specified by:

getAttributes in interface Request

Returns:

All attributes

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.

isCacheDisabled

public boolean isCacheDisabled()

Specified by:

isCacheDisabled in interface Request

validate

public Request validate()

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

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