net.sf.mmm.util.http

Class HttpResponse

java.lang.Object

net.sf.mmm.util.http.HttpMessage

net.sf.mmm.util.http.HttpResponse

public class HttpResponse
extends HttpMessage

This class represents an HTTP response message.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	reasonPhrase
static int	STATUS_CODE_ACCEPTED The status-code for Accepted.
static int	STATUS_CODE_BAD_GATEWAY The status-code for Bad Gateway.
static int	STATUS_CODE_BAD_REQUEST The status-code for Bad Request.
static int	STATUS_CODE_CONFLICT The status-code for Conflict.
static int	STATUS_CODE_CONTINUE The status-code for Continue.
static int	STATUS_CODE_CREATED The status-code for Created.
static int	STATUS_CODE_EXPECTATION_FAILED The status-code for Expectation Failed.
static int	STATUS_CODE_FORBIDDEN The status-code for Forbidden.
static int	STATUS_CODE_GATEWAY_TIMEOUT The status-code for Gateway Timeout.
static int	STATUS_CODE_GONE The status-code for Gone.
static int	STATUS_CODE_HTTP_VERSION_NOT_SUPPORTED The status-code for HTTP Version Not Supported.
static int	STATUS_CODE_INTERNAL_SERVER_ERROR The status-code for Internal Server Error.
static int	STATUS_CODE_LENGTH_REQUIRED The status-code for Length Required.
static int	STATUS_CODE_METHOD_NOT_ALLOWED The status-code for Not Allowed.
static int	STATUS_CODE_MOVED_PERMANENTLY The status-code for Moved Permanently.
static int	STATUS_CODE_MOVED_TEMPORARILY The status-code for Moved Temporary.
static int	STATUS_CODE_MULTIPLE_CHOICES The status-code for Multiple Choices.
static int	STATUS_CODE_NO_CONTENT The status-code for No Content.
static int	STATUS_CODE_NONAUTHORITATIVE_INFORMATION The status-code for Non-Authoritative Information.
static int	STATUS_CODE_NOT_ACCEPTABLE The status-code for Not Acceptable.
static int	STATUS_CODE_NOT_FOUND The status-code for Not Found.
static int	STATUS_CODE_NOT_IMPLEMENTED The status-code for Not Implemented.
static int	STATUS_CODE_NOT_MODIFIED The status-code for Not Modified.
static int	STATUS_CODE_OK The status-code for OK.
static int	STATUS_CODE_PARTIAL_CONTENT The status-code for Partial Content.
static int	STATUS_CODE_PAYMENT_REQUIRED The status-code for Payment Required.
static int	STATUS_CODE_PRECONDITION_FAILED The status-code for Precondition Failed.
static int	STATUS_CODE_PROXY_AUTHENTICATION_REQUIRED The status-code for Proxy Authentication Required.
static int	STATUS_CODE_REQUEST_ENTITY_TOO_LARGE The status-code for Request Entity Too Large.
static int	STATUS_CODE_REQUEST_RANGE_NOT_SATISFIABLE The status-code for Request Range Not Satisfiable.
static int	STATUS_CODE_REQUEST_TIMEOUT The status-code for Request Timeout.
static int	STATUS_CODE_REQUEST_URI_TOO_LONG The status-code for Request URI Too Long.
static int	STATUS_CODE_RESET_CONTENT The status-code for Reset Content.
static int	STATUS_CODE_SEE_OTHER The status-code for See other.
static int	STATUS_CODE_SERVICE_UNAVAILABLE The status-code for Service Unavailable.
static int	STATUS_CODE_SWITCHING_PROTOCOLS The status-code for Switching Protocols.
static int	STATUS_CODE_TEMPORARY_REDIRECT The status-code for Temporary Redirect.
static int	STATUS_CODE_UNAUTHORIZED The status-code for Unauthorized.
static int	STATUS_CODE_UNSUPPORTED_MEDIA_TYPE The status-code for Unsupported Media Type.
static int	STATUS_CODE_USE_PROXY The status-code for Use Proxy.
private int	statusCode

Fields inherited from class net.sf.mmm.util.http.HttpMessage

CHAR_FILTER_BLACKLIST_COMMA_OR_SEMICOLON, CHAR_FILTER_WHITELIST_COMMA_OR_SEMICOLON, CRLF, HEADER_ATTRIBUTE_MAX_AGE, HEADER_PROPERTY_CACHE_CONTROL, HEADER_PROPERTY_CONTENT_ENCODING, HEADER_PROPERTY_CONTENT_LENGTH, HEADER_PROPERTY_CONTENT_TYPE, HEADER_PROPERTY_DATE, HEADER_PROPERTY_EXPIRES, HEADER_PROPERTY_FROM, HEADER_PROPERTY_HOST, HEADER_PROPERTY_IF_MODIFIED_SINCE, HEADER_PROPERTY_LAST_MODIFIED, HEADER_PROPERTY_LOCATION, HEADER_PROPERTY_PRAGMA, HEADER_PROPERTY_REFERER, HEADER_PROPERTY_SERVER, HEADER_PROPERTY_USER_AGENT, HEADER_PROPERTY_WWW_AUTHENTICATE, VERSION_0_9, VERSION_1_0, VERSION_1_1, VERSION_PREFIX

Constructor Summary

Constructors

Constructor and Description
HttpResponse() The constructor.

Method Summary

Modifier and Type	Method and Description
String	getReasonPhrase() This method gets the reason-phrase explaining the status-code.
int	getStatusCode() This method gets the HTTP status code.
void	setReasonPhrase(String reason) This method sets the reason-phrase.
void	setStatusCode(int httpStatusCode) This method sets the HTTP status code.
protected void	writeFirstLine(StringBuffer buffer) This method writes the first line (request-line or status-line) of the HTTP message.

Methods inherited from class net.sf.mmm.util.http.HttpMessage

appendHeaderProperty, appendHeaderProperty, createHeaderNameHash, getCacheControlMaxAge, getContentEncoding, getContentLength, getContentType, getDate, getHeaderProperty, getHeaderPropertyAttribute, getVersion, serialize, setCacheControlMaxAge, setContentEncoding, setContentLength, setContentType, setDate, setHeaderProperty, setHeaderPropertyAttribute, setVersion, toString

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_CODE_CONTINUE

public static final int STATUS_CODE_CONTINUE

The status-code for Continue.

See Also:

Constant Field Values

STATUS_CODE_SWITCHING_PROTOCOLS

public static final int STATUS_CODE_SWITCHING_PROTOCOLS

The status-code for Switching Protocols.

See Also:

Constant Field Values

STATUS_CODE_OK

public static final int STATUS_CODE_OK

The status-code for OK.

See Also:

Constant Field Values

STATUS_CODE_CREATED

public static final int STATUS_CODE_CREATED

The status-code for Created.

See Also:

Constant Field Values

STATUS_CODE_ACCEPTED

public static final int STATUS_CODE_ACCEPTED

The status-code for Accepted.

See Also:

Constant Field Values

STATUS_CODE_NONAUTHORITATIVE_INFORMATION

public static final int STATUS_CODE_NONAUTHORITATIVE_INFORMATION

The status-code for Non-Authoritative Information.

See Also:

Constant Field Values

STATUS_CODE_NO_CONTENT

public static final int STATUS_CODE_NO_CONTENT

The status-code for No Content.

See Also:

Constant Field Values

STATUS_CODE_RESET_CONTENT

public static final int STATUS_CODE_RESET_CONTENT

The status-code for Reset Content.

See Also:

Constant Field Values

STATUS_CODE_PARTIAL_CONTENT

public static final int STATUS_CODE_PARTIAL_CONTENT

The status-code for Partial Content.

See Also:

Constant Field Values

STATUS_CODE_MULTIPLE_CHOICES

public static final int STATUS_CODE_MULTIPLE_CHOICES

The status-code for Multiple Choices.

See Also:

Constant Field Values

STATUS_CODE_MOVED_PERMANENTLY

public static final int STATUS_CODE_MOVED_PERMANENTLY

The status-code for Moved Permanently.

See Also:

Constant Field Values

STATUS_CODE_MOVED_TEMPORARILY

public static final int STATUS_CODE_MOVED_TEMPORARILY

The status-code for Moved Temporary.

See Also:

Constant Field Values

STATUS_CODE_SEE_OTHER

public static final int STATUS_CODE_SEE_OTHER

The status-code for See other.

See Also:

Constant Field Values

STATUS_CODE_NOT_MODIFIED

public static final int STATUS_CODE_NOT_MODIFIED

The status-code for Not Modified.

See Also:

Constant Field Values

STATUS_CODE_USE_PROXY

public static final int STATUS_CODE_USE_PROXY

The status-code for Use Proxy.

See Also:

Constant Field Values

STATUS_CODE_TEMPORARY_REDIRECT

public static final int STATUS_CODE_TEMPORARY_REDIRECT

The status-code for Temporary Redirect.

See Also:

Constant Field Values

STATUS_CODE_BAD_REQUEST

public static final int STATUS_CODE_BAD_REQUEST

The status-code for Bad Request.

See Also:

Constant Field Values

STATUS_CODE_UNAUTHORIZED

public static final int STATUS_CODE_UNAUTHORIZED

The status-code for Unauthorized.

See Also:

Constant Field Values

STATUS_CODE_PAYMENT_REQUIRED

public static final int STATUS_CODE_PAYMENT_REQUIRED

The status-code for Payment Required.

See Also:

Constant Field Values

STATUS_CODE_FORBIDDEN

public static final int STATUS_CODE_FORBIDDEN

The status-code for Forbidden.

See Also:

Constant Field Values

STATUS_CODE_NOT_FOUND

public static final int STATUS_CODE_NOT_FOUND

The status-code for Not Found.

See Also:

Constant Field Values

STATUS_CODE_METHOD_NOT_ALLOWED

public static final int STATUS_CODE_METHOD_NOT_ALLOWED

The status-code for Not Allowed.

See Also:

Constant Field Values

STATUS_CODE_NOT_ACCEPTABLE

public static final int STATUS_CODE_NOT_ACCEPTABLE

The status-code for Not Acceptable.

See Also:

Constant Field Values

STATUS_CODE_PROXY_AUTHENTICATION_REQUIRED

public static final int STATUS_CODE_PROXY_AUTHENTICATION_REQUIRED

The status-code for Proxy Authentication Required.

See Also:

Constant Field Values

STATUS_CODE_REQUEST_TIMEOUT

public static final int STATUS_CODE_REQUEST_TIMEOUT

The status-code for Request Timeout.

See Also:

Constant Field Values

STATUS_CODE_CONFLICT

public static final int STATUS_CODE_CONFLICT

The status-code for Conflict.

See Also:

Constant Field Values

STATUS_CODE_GONE

public static final int STATUS_CODE_GONE

The status-code for Gone.

See Also:

Constant Field Values

STATUS_CODE_LENGTH_REQUIRED

public static final int STATUS_CODE_LENGTH_REQUIRED

The status-code for Length Required.

See Also:

Constant Field Values

STATUS_CODE_PRECONDITION_FAILED

public static final int STATUS_CODE_PRECONDITION_FAILED

The status-code for Precondition Failed.

See Also:

Constant Field Values

STATUS_CODE_REQUEST_ENTITY_TOO_LARGE

public static final int STATUS_CODE_REQUEST_ENTITY_TOO_LARGE

The status-code for Request Entity Too Large.

See Also:

Constant Field Values

STATUS_CODE_REQUEST_URI_TOO_LONG

public static final int STATUS_CODE_REQUEST_URI_TOO_LONG

The status-code for Request URI Too Long.

See Also:

Constant Field Values

STATUS_CODE_UNSUPPORTED_MEDIA_TYPE

public static final int STATUS_CODE_UNSUPPORTED_MEDIA_TYPE

The status-code for Unsupported Media Type.

See Also:

Constant Field Values

STATUS_CODE_REQUEST_RANGE_NOT_SATISFIABLE

public static final int STATUS_CODE_REQUEST_RANGE_NOT_SATISFIABLE

The status-code for Request Range Not Satisfiable.

See Also:

Constant Field Values

STATUS_CODE_EXPECTATION_FAILED

public static final int STATUS_CODE_EXPECTATION_FAILED

The status-code for Expectation Failed.

See Also:

Constant Field Values

STATUS_CODE_INTERNAL_SERVER_ERROR

public static final int STATUS_CODE_INTERNAL_SERVER_ERROR

The status-code for Internal Server Error.

See Also:

Constant Field Values

STATUS_CODE_NOT_IMPLEMENTED

public static final int STATUS_CODE_NOT_IMPLEMENTED

The status-code for Not Implemented.

See Also:

Constant Field Values

STATUS_CODE_BAD_GATEWAY

public static final int STATUS_CODE_BAD_GATEWAY

The status-code for Bad Gateway.

See Also:

Constant Field Values

STATUS_CODE_SERVICE_UNAVAILABLE

public static final int STATUS_CODE_SERVICE_UNAVAILABLE

The status-code for Service Unavailable.

See Also:

Constant Field Values

STATUS_CODE_GATEWAY_TIMEOUT

public static final int STATUS_CODE_GATEWAY_TIMEOUT

The status-code for Gateway Timeout.

See Also:

Constant Field Values

STATUS_CODE_HTTP_VERSION_NOT_SUPPORTED

public static final int STATUS_CODE_HTTP_VERSION_NOT_SUPPORTED

The status-code for HTTP Version Not Supported.

See Also:

Constant Field Values

statusCode

private int statusCode

reasonPhrase

private String reasonPhrase

Constructor Detail

HttpResponse

public HttpResponse()

The constructor.

Method Detail

getStatusCode

public int getStatusCode()

This method gets the HTTP status code.

Returns:

the HTTP statusCode.

setStatusCode

public void setStatusCode(int httpStatusCode)

This method sets the HTTP status code.

Parameters:

httpStatusCode - the HTTP statusCode to set.

See Also:

getStatusCode()

getReasonPhrase

public String getReasonPhrase()

This method gets the reason-phrase explaining the status-code.

Returns:

the reason-phrase.

setReasonPhrase

public void setReasonPhrase(String reason)

This method sets the reason-phrase.

Parameters:

reason - the reason-phrase to set.

See Also:

getReasonPhrase()

writeFirstLine

protected void writeFirstLine(StringBuffer buffer)

Description copied from class: HttpMessage

This method writes the first line (request-line or status-line) of the HTTP message.

Specified by:

writeFirstLine in class HttpMessage

Parameters:

buffer - is the string-buffer where to append the first line.