ej.hoka.http

Class HTTPResponse

java.lang.Object

ej.hoka.http.HTTPResponse

public class HTTPResponse
extends java.lang.Object

Represents a HTTP Response.

Constructor Summary

Constructors

Constructor and Description
HTTPResponse() Creates an empty HTTPResponse.
HTTPResponse(byte[] data) Creates a new HTTPResponse using the given byte array as response data.
HTTPResponse(java.io.InputStream data) Creates a new HTTPResponse using the given InputStream as the response data.
HTTPResponse(java.io.InputStream data, int length) Creates a new HTTPResponse using the given InputStream as the response data.
HTTPResponse(java.lang.String data) Creates a new HTTPResponse using the given String as response data.
HTTPResponse(java.lang.String data, java.lang.String encoding) Creates a new HTTPResponse using the String data as response data and the encoding.
HTTPResponse(java.lang.String status, java.lang.String mimeType, java.io.InputStream body) Creates a new HTTPResponse using the InputStream body as response data.
HTTPResponse(java.lang.String status, java.lang.String mimeType, java.lang.String body) Creates a new HTTPResponse using the String body as response data.

Method Summary

Modifier and Type	Method and Description
void	addHeaderField(java.lang.String name, java.lang.String value) Adds a response header field.
static HTTPResponse	createError(java.lang.String status, java.lang.String msg) Create a HTTPResponse to write the msg for the given status.
static HTTPResponse	createResponseFromStatus(java.lang.String status) Creates a HTTPResponse with given status and empty body.
java.util.Map<java.lang.String,java.lang.String>	getHeader() Returns the response header.
java.lang.String	getHeaderField(java.lang.String key) Returns the header field value associated to the given header field key.
protected long	getLength() Returns the length (in bytes) of the response data or -1 if the length is unknown.
java.lang.String	getMimeType() Returns the MIME-TYPE of the response.
java.lang.String	getStatus() Returns the response status.
void	setMimeType(java.lang.String mimeType) Set the response MIME-TYPE.
void	setStatus(java.lang.String status) Set the response status.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPResponse

public HTTPResponse()

Creates an empty HTTPResponse.

HTTPResponse

public HTTPResponse(byte[] data)

Creates a new HTTPResponse using the given byte array as response data.

Parameters:

data - the data to send through response (as a raw byte array).

HTTPResponse

public HTTPResponse(java.io.InputStream data)

Creates a new HTTPResponse using the given InputStream as the response data.

Parameters:

data - the data to send through response (as a stream), the stream will be closed automatically when the response is sent.

HTTPResponse

public HTTPResponse(java.io.InputStream data,
                    int length)

Creates a new HTTPResponse using the given InputStream as the response data.

Parameters:

data - the data to send through response (as a stream), the stream will be closed automatically when the response is sent.

length - the length of the response.

HTTPResponse

public HTTPResponse(java.lang.String data)

Creates a new HTTPResponse using the given String as response data. The data is transformed into bytes using the ISO-8859-1 encoding.

Parameters:

data - the data to send through response (as a raw string)

HTTPResponse

public HTTPResponse(java.lang.String data,
                    java.lang.String encoding)
             throws java.io.UnsupportedEncodingException

Creates a new HTTPResponse using the String data as response data and the encoding.

Parameters:

data - the String to be used as response body.

encoding - the encoding used to transform the String data to bytes. The following encodings can be used:

• ISO-8859-1 ISO-8859-1 encoding, always supported by the platform
• UTF-8 UTF-8 encoding, only supported if the "Embed UTF-8 encoding" option is enabled in the Run Configurations. If this option is not set, an UnsupportedEncodingException is thrown.
• US-ASCII US-ASCII encoding

Throws:

java.io.UnsupportedEncodingException - when the specified encoding is not supported.

HTTPResponse

public HTTPResponse(java.lang.String status,
                    java.lang.String mimeType,
                    java.io.InputStream body)

Creates a new HTTPResponse using the InputStream body as response data.

Parameters:

status - the status of the response.

mimeType - the mime type of the response.

body - the InputStream to be used as response data, the stream will be closed automatically when the response is sent.

HTTPResponse

public HTTPResponse(java.lang.String status,
                    java.lang.String mimeType,
                    java.lang.String body)

Creates a new HTTPResponse using the String body as response data.

Parameters:

status - the status of the response.

mimeType - the mime type of the response.

body - the String to be used as response data.

Method Detail

createResponseFromStatus

public static HTTPResponse createResponseFromStatus(java.lang.String status)

Creates a HTTPResponse with given status and empty body.

Parameters:

status - the status of the response.

Returns:

the empty response with given status.

addHeaderField

public void addHeaderField(java.lang.String name,
                           java.lang.String value)

Adds a response header field.

Parameters:

name - name of the header field to set.

value - value of the header filed.

getHeader

public java.util.Map<java.lang.String,java.lang.String> getHeader()

Returns the response header.

Returns:

a Map of (String,String) representing the HTTP header fields (may be empty).

getHeaderField

public java.lang.String getHeaderField(java.lang.String key)

Returns the header field value associated to the given header field key.

Parameters:

key - a header field name (if null, null is returned).

Returns:

the replied header field value, null if the header field is not found.

getLength

protected long getLength()

Returns the length (in bytes) of the response data or -1 if the length is unknown.

Returns:

the length (in bytes) of the response data.

getMimeType

public java.lang.String getMimeType()

Returns the MIME-TYPE of the response.

Returns:

the response MIME-TYPE.

getStatus

public java.lang.String getStatus()

Returns the response status.

Returns:

the response status.

setMimeType

public final void setMimeType(java.lang.String mimeType)

Set the response MIME-TYPE.

Parameters:

mimeType - the response MIME-TYPE to set.

setStatus

public final void setStatus(java.lang.String status)

Set the response status.

Parameters:

status - the response status to set. Should be one of the HTTP_STATUS_* constants defined in HTTPConstants

createError

public static HTTPResponse createError(java.lang.String status,
                                       java.lang.String msg)

Create a HTTPResponse to write the msg for the given status.

Parameters:

status - the error status. One of HTTP_STATUS_* constant of the HTTPConstants interface.

msg - an optional error message to add in response.

Returns:

a HTTPResponse that represent the error.

See Also:

HTTPConstants.HTTP_STATUS_BADREQUEST, HTTPConstants.HTTP_STATUS_FORBIDDEN, HTTPConstants.HTTP_STATUS_INTERNALERROR, HTTPConstants.HTTP_STATUS_MEDIA_TYPE, HTTPConstants.HTTP_STATUS_METHOD, HTTPConstants.HTTP_STATUS_NOTACCEPTABLE, HTTPConstants.HTTP_STATUS_NOTFOUND, HTTPConstants.HTTP_STATUS_NOTIMPLEMENTED, HTTPConstants.HTTP_STATUS_NOTMODIFIED, HTTPConstants.HTTP_STATUS_OK, HTTPConstants.HTTP_STATUS_REDIRECT