jodd.http

Class HttpBase<T>

java.lang.Object

jodd.http.HttpBase<T>

Direct Known Subclasses:

HttpRequest, HttpResponse

public abstract class HttpBase<T>
extends java.lang.Object

Base class for HttpRequest and HttpResponse.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	body
protected java.lang.String	charset
protected HttpValuesMap	form
protected java.lang.String	formEncoding
static java.lang.String	HEADER_ACCEPT_ENCODING
static java.lang.String	HEADER_CLOSE
static java.lang.String	HEADER_CONNECTION
static java.lang.String	HEADER_CONTENT_ENCODING
static java.lang.String	HEADER_CONTENT_LENGTH
static java.lang.String	HEADER_CONTENT_TYPE
static java.lang.String	HEADER_ETAG
static java.lang.String	HEADER_HOST
static java.lang.String	HEADER_KEEP_ALIVE
protected HttpValuesMap	headers
static java.lang.String	HTTP_1_0
static java.lang.String	HTTP_1_1
protected java.lang.String	httpVersion
protected java.lang.String	mediaType

Constructor Summary

Constructors

Constructor and Description
HttpBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_header(java.lang.String name, java.lang.String value, boolean overwrite) Internal direct header setting.
java.lang.String	acceptEncoding() Returns "Accept-Encoding" header.
T	acceptEncoding(java.lang.String encodings) Sets "Accept-Encoding" header.
java.lang.String	body() Returns raw body as received or set (always in ISO-8859-1 encoding).
T	body(byte[] content, java.lang.String contentType) Sets raw body content and discards form parameters.
T	body(java.lang.String body) Sets raw body content and discards all form parameters.
byte[]	bodyBytes() Returns raw body bytes.
java.lang.String	bodyText() Returns body content as text.
T	bodyText(java.lang.String body) Defines body text content that will be encoded as default body media type in default body encoding.
T	bodyText(java.lang.String body, java.lang.String mediaType) Defines body text content that will be encoded in default body encoding.
T	bodyText(java.lang.String body, java.lang.String mediaType, java.lang.String charset) Defines body text and content type (as media type and charset).
java.lang.String	charset() Returns charset, as defined by 'Content-Type' header.
T	charset(java.lang.String charset) Defines just content type charset.
T	connectionKeepAlive(boolean keepAlive) Defines "Connection" header as "Keep-Alive" or "Close".
java.lang.String	contentEncoding() Returns "Content-Encoding" header.
java.lang.String	contentLength() Returns full "Content-Length" header or null if not set.
T	contentLength(int value) Sets the full "Content-Length" header.
java.lang.String	contentType() Returns full "Content-Type" header.
T	contentType(java.lang.String contentType) Sets full "Content-Type" header.
T	contentType(java.lang.String mediaType, java.lang.String charset) Sets "Content-Type" header by defining media-type and/or charset parameter.
java.util.Map<java.lang.String,java.lang.Object[]>	form() Return map of form parameters.
T	form(java.util.Map<java.lang.String,java.lang.Object> formMap) Sets many form parameters at once.
T	form(java.lang.String name, java.lang.Object value) Adds the form parameter.
T	form(java.lang.String name, java.lang.Object value, boolean overwrite) Sets form parameter.
T	form(java.lang.String name, java.lang.Object value, java.lang.Object... parameters) Sets many form parameters at once.
T	formEncoding(java.lang.String encoding) Defines encoding for forms parameters.
protected java.lang.String	formString() Creates form string and sets few headers.
java.lang.String	header(java.lang.String name) Returns value of header parameter.
T	header(java.lang.String name, int value) Adds int value as header parameter,
T	header(java.lang.String name, long millis) Adds date value as header parameter.
T	header(java.lang.String name, java.lang.String value) Adds header parameter.
T	header(java.lang.String name, java.lang.String value, boolean overwrite) Adds or sets header parameter.
java.lang.String[]	headers(java.lang.String name) Returns all values for given header name.
java.lang.String	httpVersion() Returns HTTP version string.
T	httpVersion(java.lang.String httpVersion) Sets the HTTP version string.
protected void	initForm()
boolean	isConnectionPersistent() Returns true if connection is persistent.
protected boolean	isFormMultipart() Returns true if form contains Uploadable.
java.lang.String	mediaType() Returns media type, as defined by 'Content-Type' header.
T	mediaType(java.lang.String mediaType) Defines just content media type.
protected void	readBody(java.io.BufferedReader reader) Parses body.
protected void	readHeaders(java.io.BufferedReader reader) Parses headers.
void	removeHeader(java.lang.String name) Removes all header parameters for given name.
void	sendTo(java.io.OutputStream out) Sends request or response to output stream.
byte[]	toByteArray() Returns byte array of request or response.
protected java.lang.Object	wrapFormValue(java.lang.Object value) Wraps non-Strings form values with uploadable content.

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_ACCEPT_ENCODING

public static final java.lang.String HEADER_ACCEPT_ENCODING

See Also:

Constant Field Values

HEADER_CONTENT_TYPE

public static final java.lang.String HEADER_CONTENT_TYPE

See Also:

Constant Field Values

HEADER_CONTENT_LENGTH

public static final java.lang.String HEADER_CONTENT_LENGTH

See Also:

Constant Field Values

HEADER_CONTENT_ENCODING

public static final java.lang.String HEADER_CONTENT_ENCODING

See Also:

Constant Field Values

HEADER_HOST

public static final java.lang.String HEADER_HOST

See Also:

Constant Field Values

HEADER_ETAG

public static final java.lang.String HEADER_ETAG

See Also:

Constant Field Values

HEADER_CONNECTION

public static final java.lang.String HEADER_CONNECTION

See Also:

Constant Field Values

HEADER_KEEP_ALIVE

public static final java.lang.String HEADER_KEEP_ALIVE

See Also:

Constant Field Values

HEADER_CLOSE

public static final java.lang.String HEADER_CLOSE

See Also:

Constant Field Values

HTTP_1_0

public static final java.lang.String HTTP_1_0

See Also:

Constant Field Values

HTTP_1_1

public static final java.lang.String HTTP_1_1

See Also:

Constant Field Values

httpVersion

protected java.lang.String httpVersion

headers

protected HttpValuesMap headers

form

protected HttpValuesMap form

body

protected java.lang.String body

charset

protected java.lang.String charset

mediaType

protected java.lang.String mediaType

formEncoding

protected java.lang.String formEncoding

Constructor Detail

HttpBase

public HttpBase()

Method Detail

httpVersion

public java.lang.String httpVersion()

Returns HTTP version string. By default it's "HTTP/1.1".

httpVersion

public T httpVersion(java.lang.String httpVersion)

Sets the HTTP version string. Must be formed like "HTTP/1.1".

header

public java.lang.String header(java.lang.String name)

Returns value of header parameter. If multiple headers with the same names exist, the first value will be returned. Returns null if header doesn't exist.

headers

public java.lang.String[] headers(java.lang.String name)

Returns all values for given header name.

removeHeader

public void removeHeader(java.lang.String name)

Removes all header parameters for given name.

header

public T header(java.lang.String name,
       java.lang.String value)

Adds header parameter. If a header with the same name exist, it will not be overwritten, but the new header with the same name is going to be added. The order of header parameters is preserved. Also detects 'Content-Type' header and extracts media type and charset values.

header

public T header(java.lang.String name,
       java.lang.String value,
       boolean overwrite)

Adds or sets header parameter.

See Also:

header(String, String)

_header

protected void _header(java.lang.String name,
           java.lang.String value,
           boolean overwrite)

Internal direct header setting.

header

public T header(java.lang.String name,
       int value)

Adds int value as header parameter,

See Also:

header(String, String)

header

public T header(java.lang.String name,
       long millis)

Adds date value as header parameter.

See Also:

header(String, String)

charset

public java.lang.String charset()

Returns charset, as defined by 'Content-Type' header. If not set, returns null - indicating the default charset (ISO-8859-1).

charset

public T charset(java.lang.String charset)

Defines just content type charset. Setting this value to null will remove the charset information from the header.

mediaType

public java.lang.String mediaType()

Returns media type, as defined by 'Content-Type' header. If not set, returns null - indicating the default media type, depending on request/response.

mediaType

public T mediaType(java.lang.String mediaType)

Defines just content media type. Setting this value to null will not have any effects.

contentType

public java.lang.String contentType()

Returns full "Content-Type" header. It consists of media type and charset.

contentType

public T contentType(java.lang.String contentType)

Sets full "Content-Type" header. Both media type and charset are overridden.

contentType

public T contentType(java.lang.String mediaType,
            java.lang.String charset)

Sets "Content-Type" header by defining media-type and/or charset parameter. This method may be used to update media-type and/or charset by passing non-null value for changes.

Important: if Content-Type header has some other parameters, they will be removed!

connectionKeepAlive

public T connectionKeepAlive(boolean keepAlive)

Defines "Connection" header as "Keep-Alive" or "Close". Existing value is overwritten.

isConnectionPersistent

public boolean isConnectionPersistent()

Returns true if connection is persistent. If "Connection" header does not exist, returns true for HTTP 1.1 and false for HTTP 1.0. If "Connection" header exist, checks if it is equal to "Close".

In HTTP 1.1, all connections are considered persistent unless declared otherwise. Under HTTP 1.0, there is no official specification for how keepalive operates.

contentLength

public java.lang.String contentLength()

Returns full "Content-Length" header or null if not set.

contentLength

public T contentLength(int value)

Sets the full "Content-Length" header.

contentEncoding

public java.lang.String contentEncoding()

Returns "Content-Encoding" header.

acceptEncoding

public java.lang.String acceptEncoding()

Returns "Accept-Encoding" header.

acceptEncoding

public T acceptEncoding(java.lang.String encodings)

Sets "Accept-Encoding" header.

initForm

protected void initForm()

wrapFormValue

protected java.lang.Object wrapFormValue(java.lang.Object value)

Wraps non-Strings form values with uploadable content. Detects invalid types and throws an exception. So all uploadable values are of the same type.

form

public T form(java.lang.String name,
     java.lang.Object value)

Adds the form parameter. Existing parameter will not be overwritten.

form

public T form(java.lang.String name,
     java.lang.Object value,
     boolean overwrite)

Sets form parameter. Optionally overwrite existing one.

form

public T form(java.lang.String name,
     java.lang.Object value,
     java.lang.Object... parameters)

Sets many form parameters at once.

form

public T form(java.util.Map<java.lang.String,java.lang.Object> formMap)

Sets many form parameters at once.

form

public java.util.Map<java.lang.String,java.lang.Object[]> form()

Return map of form parameters. Note that all uploadable values are wrapped with Uploadable.

formEncoding

public T formEncoding(java.lang.String encoding)

Defines encoding for forms parameters. Default value is copied from JoddHttp.defaultFormEncoding. It is overridden by charset value.

body

public java.lang.String body()

Returns raw body as received or set (always in ISO-8859-1 encoding). If body content is a text, use bodyText() to get it converted. Returns null if body is not specified!

bodyBytes

public byte[] bodyBytes()

Returns raw body bytes. Returns null if body is not specified.

bodyText

public java.lang.String bodyText()

Returns body content as text. If charset parameter of "Content-Type" header is defined, body string charset is converted, otherwise the same raw body content is returned. Never returns null.

body

public T body(java.lang.String body)

Sets raw body content and discards all form parameters. Important: body string is in RAW format, meaning, ISO-8859-1 encoding. Also sets "Content-Length" parameter. However, "Content-Type" is not set and it is expected from user to set this one.

bodyText

public T bodyText(java.lang.String body,
         java.lang.String mediaType,
         java.lang.String charset)

Defines body text and content type (as media type and charset). Body string will be converted to raw body string and "Content-Type" header will be set.

bodyText

public T bodyText(java.lang.String body,
         java.lang.String mediaType)

Defines body text content that will be encoded in default body encoding.

bodyText

public T bodyText(java.lang.String body)

Defines body text content that will be encoded as default body media type in default body encoding.

body

public T body(byte[] content,
     java.lang.String contentType)

Sets raw body content and discards form parameters. Also sets "Content-Length" and "Content-Type" parameter.

See Also:

body(String)

isFormMultipart

protected boolean isFormMultipart()

Returns true if form contains Uploadable.

formString

protected java.lang.String formString()

Creates form string and sets few headers.

toByteArray

public byte[] toByteArray()

Returns byte array of request or response.

sendTo

public void sendTo(java.io.OutputStream out)
            throws java.io.IOException

Sends request or response to output stream.

Throws:

java.io.IOException

readHeaders

protected void readHeaders(java.io.BufferedReader reader)

Parses headers.

readBody

protected void readBody(java.io.BufferedReader reader)

Parses body.