com.atlassian.httpclient.api

Interface Common<B extends Common<B>>

All Known Subinterfaces:

Request.Builder, Response.Builder

All Known Implementing Classes:

CommonBuilder, DefaultRequest.DefaultRequestBuilder, DefaultResponse.DefaultResponseBuilder

public interface Common<B extends Common<B>>

Method Summary

Modifier and Type	Method and Description
B	setContentCharset(String contentCharset) Sets the charset for this object's entity, if any.
B	setContentType(String contentType) Sets the IANA media type, for the current entity, if any.
B	setEntity(String entity) Sets this object's entity stream from a string.
B	setEntityStream(InputStream entityStream) Sets this object's entity as an input stream.
B	setEntityStream(InputStream entityStream, String charset) Sets this object's entity as an input stream, encoded with the specified charset.
B	setHeader(String name, String value) Sets an HTTP header on this object.
B	setHeaders(Map<String,String> headers) Copies the specified map of HTTP headers into this object.

Method Detail

setHeader

B setHeader(String name,
            String value)

Sets an HTTP header on this object. If the header's name is "Content-Type", the value will be parsed into this object's content type and content charset properties, as appropriate.

Parameters:

name - The name of the header to be set

value - The value of the header to be set

Returns:

This object, for builder-style chaining

setHeaders

B setHeaders(Map<String,String> headers)

Copies the specified map of HTTP headers into this object. It will also parse any included Content-Type header into its constituent parts of IANA media type and content charset, updating those properties as appropriate.

Parameters:

headers - A map of HTTP headers

Returns:

This object, for builder-style chaining

setEntity

B setEntity(String entity)

Sets this object's entity stream from a string. Using this method of setting the entity automatically sets this object's content charset property to "UTF-8" if the entity is not null.

Parameters:

entity - An entity string

Returns:

This object, for builder-style chaining

setEntityStream

B setEntityStream(InputStream entityStream)

Sets this object's entity as an input stream. Invocations of this method reset this object's hasReadEntity() state to false. It is recommended to also set this object's content charset property when setting an entity stream for a textual media type (or using the overloaded form that takes both the entity stream and charset in the same call). Clients of this object should assume the HTTP standard of ISO-8859-1 (latin-1) for the content charset property if a textual media type is set but no explcit charset was provided for this message. A charset should NOT be provided for entity streams targetting binary media types.

Parameters:

entityStream - An entity input stream ready to be read

Returns:

This object, for builder-style chaining

setContentCharset

B setContentCharset(String contentCharset)

Sets the charset for this object's entity, if any. This value is ignored during headeer access if no entity is present or if the content type property is not set.

Parameters:

contentCharset - The entity's charset value, or null

Returns:

This object, for builder-style chaining

setContentType

B setContentType(String contentType)

Sets the IANA media type, for the current entity, if any. If the contentType argument also contains charset information, this method will have the side effect of parsing the charset out and storing the component parts independently. The method getContentCharset() can be used to retrieve extracted content charset, if present, and getHeader("Content-Type") can be used to retrieve the entire Content-Type header, complete with charset information, if set. The content type property is required when an entity is present.

Parameters:

contentType - An IANA media type with optional charset information

Returns:

This object, for builder-style chaining

setEntityStream

B setEntityStream(InputStream entityStream,
                  String charset)

Sets this object's entity as an input stream, encoded with the specified charset. Invocations of this method reset this object's hasReadEntity() state to false. This method should only be called for entity streams targetting textual media types -- that is, it's nonsensical to set the charset of an entity stream for binary media types (e.g. image/*, etc).

Parameters:

entityStream - An entity input stream ready to be read

charset - The charset in which the entity stream is encoded

Returns:

This object, for builder-style chaining