HttpMessage (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.http.HttpMessage

Direct Known Subclasses:

HttpRequest, HttpResponse
```
public abstract class HttpMessage
extends Object
```
This class represents an HTTP message.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`HttpMessage.HeaderPropertyKey` This inner class represents a string that can be used as hash key that behaves case in-sensitive.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static CharFilter`	`CHAR_FILTER_BLACKLIST_COMMA_OR_SEMICOLON` char-filter accepting everything except ',' and ';'
`protected static CharFilter`	`CHAR_FILTER_WHITELIST_COMMA_OR_SEMICOLON` char-filter accepting only ',' and ';'
`protected static String`	`CRLF` the line termination sequence used by HTTP
`private Map<Object,String>`	`header`
`static String`	`HEADER_ATTRIBUTE_MAX_AGE` The `header-property` `max-age`.
`static String`	`HEADER_PROPERTY_CACHE_CONTROL` The `header-property` `Cache-Control`.
`static String`	`HEADER_PROPERTY_CONTENT_ENCODING` The `header-property` `Content-Encoding`.
`static String`	`HEADER_PROPERTY_CONTENT_LENGTH` The `header-property` `Content-Length`.
`static String`	`HEADER_PROPERTY_CONTENT_TYPE` The `header-property` `Content-Type`.
`static String`	`HEADER_PROPERTY_DATE` The `header-property` `Date`.
`static String`	`HEADER_PROPERTY_EXPIRES` The `header-property` `Expires`.
`static String`	`HEADER_PROPERTY_FROM` The `header-property` `From`.
`static String`	`HEADER_PROPERTY_HOST` The `header-property` `Host`.
`static String`	`HEADER_PROPERTY_IF_MODIFIED_SINCE` The `header-property` `If-Modified-Since`.
`static String`	`HEADER_PROPERTY_LAST_MODIFIED` The `header-property` `Last-Modified`.
`static String`	`HEADER_PROPERTY_LOCATION` The `header-property` `Location`.
`static String`	`HEADER_PROPERTY_PRAGMA` The `header-property` `Pragma`.
`static String`	`HEADER_PROPERTY_REFERER` The `header-property` `Referer`.
`static String`	`HEADER_PROPERTY_SERVER` The `header-property` `Server`.
`static String`	`HEADER_PROPERTY_USER_AGENT` The `header-property` `User-Agent`.
`static String`	`HEADER_PROPERTY_WWW_AUTHENTICATE` The `header-property` `WWW-Authenticate`.
`private String`	`version`
`static String`	`VERSION_0_9` HTTP version 0.9 (should NOT be used anymore)
`static String`	`VERSION_1_0` HTTP version 1.0 (RFC 1945)
`static String`	`VERSION_1_1` HTTP version 1.1 (RFC 2616)
`static String`	`VERSION_PREFIX` HTTP version prefix

Constructor Summary

Constructors
Constructor and Description

HttpMessage()
The constructor.

Constructors
Constructor and Description
`HttpMessage()` The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendHeaderProperty(String name, String appendValue)` This method appends the given `value` to the HTTP header-property with the given `name`.
`void`	`appendHeaderProperty(String name, String appendValue, String separator)` This method appends the given `value` to the HTTP header-property with the given `name`.
`protected Object`	`createHeaderNameHash(String name)` This method converts the header property to an hash key.
`int`	`getCacheControlMaxAge()` This method gets the `maximum age` (lease time) in seconds.
`String`	`getContentEncoding()` This method gets the `content-encoding`.
`Long`	`getContentLength()` This method gets the `content-length`.
`String`	`getContentType()` This method gets the `content-type`.
`String`	`getDate()` This method gets the `date`.
`String`	`getHeaderProperty(String name)` This method gets the property with the given `name` from the header of this HTTP message.
`String`	`getHeaderPropertyAttribute(String name, String attributeName)` This method gets a single attribute of the property with the given `name` from the header of this HTTP message.
`String`	`getVersion()` This method gets the HTTP version to use.
`void`	`serialize(StringBuffer buffer)` This method serializes this HTTP-message to the given string buffer.
`void`	`setCacheControlMaxAge(int seconds)` This method sets the `maximum age` (lease time) in seconds.
`void`	`setContentEncoding(String encoding)` This method sets the `content-encoding`.
`void`	`setContentLength(long contentLength)` This method sets the `content-length`.
`void`	`setContentType(String contentType)` This method sets the `content-type`.
`void`	`setDate(String date)` This method sets the `date`.
`void`	`setHeaderProperty(String name, String value)` This method sets the HTTP header-property with the given `name` to the given `value`.
`void`	`setHeaderPropertyAttribute(String name, String attributeName, String attributeValue)` This method sets a single attribute of the property with the given `name` in the header of this HTTP message.
`void`	`setVersion(String httpVersion)` This method sets the HTTP version to use.
`String`	`toString()`
`protected abstract void`	`writeFirstLine(StringBuffer buffer)` This method writes the first line (request-line or status-line) of the HTTP message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - VERSION_PREFIX
```
public static final String VERSION_PREFIX
```
    HTTP version prefix
    
    See Also:
    
    Constant Field Values
  - VERSION_0_9
```
public static final String VERSION_0_9
```
    HTTP version 0.9 (should NOT be used anymore)
    
    See Also:
    
    Constant Field Values
  - VERSION_1_0
```
public static final String VERSION_1_0
```
    HTTP version 1.0 (RFC 1945)
    
    See Also:
    
    Constant Field Values
  - VERSION_1_1
```
public static final String VERSION_1_1
```
    HTTP version 1.1 (RFC 2616)
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_CONTENT_ENCODING
```
public static final String HEADER_PROPERTY_CONTENT_ENCODING
```
    The header-property Content-Encoding.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_CONTENT_LENGTH
```
public static final String HEADER_PROPERTY_CONTENT_LENGTH
```
    The header-property Content-Length.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_CONTENT_TYPE
```
public static final String HEADER_PROPERTY_CONTENT_TYPE
```
    The header-property Content-Type.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_CACHE_CONTROL
```
public static final String HEADER_PROPERTY_CACHE_CONTROL
```
    The header-property Cache-Control.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_DATE
```
public static final String HEADER_PROPERTY_DATE
```
    The header-property Date.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_EXPIRES
```
public static final String HEADER_PROPERTY_EXPIRES
```
    The header-property Expires.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_FROM
```
public static final String HEADER_PROPERTY_FROM
```
    The header-property From.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_IF_MODIFIED_SINCE
```
public static final String HEADER_PROPERTY_IF_MODIFIED_SINCE
```
    The header-property If-Modified-Since.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_LAST_MODIFIED
```
public static final String HEADER_PROPERTY_LAST_MODIFIED
```
    The header-property Last-Modified.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_LOCATION
```
public static final String HEADER_PROPERTY_LOCATION
```
    The header-property Location.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_PRAGMA
```
public static final String HEADER_PROPERTY_PRAGMA
```
    The header-property Pragma.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_REFERER
```
public static final String HEADER_PROPERTY_REFERER
```
    The header-property Referer.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_SERVER
```
public static final String HEADER_PROPERTY_SERVER
```
    The header-property Server.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_USER_AGENT
```
public static final String HEADER_PROPERTY_USER_AGENT
```
    The header-property User-Agent.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_WWW_AUTHENTICATE
```
public static final String HEADER_PROPERTY_WWW_AUTHENTICATE
```
    The header-property WWW-Authenticate.
    
    See Also:
    
    Constant Field Values
  - HEADER_PROPERTY_HOST
```
public static final String HEADER_PROPERTY_HOST
```
    The header-property Host.
    
    See Also:
    
    Constant Field Values
  - HEADER_ATTRIBUTE_MAX_AGE
```
public static final String HEADER_ATTRIBUTE_MAX_AGE
```
    The header-property max-age.
    
    See Also:
    
    HEADER_PROPERTY_CACHE_CONTROL, Constant Field Values
  - CRLF
```
protected static final String CRLF
```
    the line termination sequence used by HTTP
    
    See Also:
    
    Constant Field Values
  - CHAR_FILTER_WHITELIST_COMMA_OR_SEMICOLON
```
protected static final CharFilter CHAR_FILTER_WHITELIST_COMMA_OR_SEMICOLON
```
    char-filter accepting only ',' and ';'
  - CHAR_FILTER_BLACKLIST_COMMA_OR_SEMICOLON
```
protected static final CharFilter CHAR_FILTER_BLACKLIST_COMMA_OR_SEMICOLON
```
    char-filter accepting everything except ',' and ';'
  - header
```
private final Map<Object,String> header
```
  - version
```
private String version
```
- Constructor Detail
  - HttpMessage
```
public HttpMessage()
```
    The constructor.
- Method Detail
  - getVersion
```
public String getVersion()
```
    This method gets the HTTP version to use.
    
    Returns:
    
    the HTTP version.
    
    See Also:
    
    VERSION_1_0, VERSION_1_1
  - setVersion
```
public void setVersion(String httpVersion)
```
    This method sets the HTTP version to use.
    By default the version is VERSION_1_1.
    
    Parameters:
    
    httpVersion - the HTTP version to set.
  - createHeaderNameHash
```
protected Object createHeaderNameHash(String name)
```
    This method converts the header property to an hash key.
    The result must ensure that its string-representation is case in-sensitive equal to the given name. Additionally it needs to have compliant implementations for equals and hashCode.
    This implementations ensures that the original case of the header name is NOT modified while getHeaderProperty(String) acts case in-sensitive.
    
    Parameters:
    
    name - is the header-name to convert.
    
    Returns:
    
    an object that will be used as hash-key for the header with the given name.
  - getHeaderProperty
```
public String getHeaderProperty(String name)
```
    This method gets the property with the given name from the header of this HTTP message.
    
    Parameters:
    
    name - is the name of the requested property.
    
    Returns:
    
    the requested property or null if NOT set.
  - setHeaderPropertyAttribute
```
public void setHeaderPropertyAttribute(String name,
                                       String attributeName,
                                       String attributeValue)
```
    This method sets a single attribute of the property with the given name in the header of this HTTP message.
    
    Parameters:
    
    name - is the name of the property to manipulate.
    
    attributeName - is the name of the attribute to set.
    
    attributeValue - is the value of the attribute or the empty string ("") if the attribute is just a flag.
  - getHeaderPropertyAttribute
```
public String getHeaderPropertyAttribute(String name,
                                         String attributeName)
```
    This method gets a single attribute of the property with the given name from the header of this HTTP message.
    E.g. the property Cache-Control may have the value no-cache,no-store,max-age=0. Then the following code snipplet would return "0":
```
 getHeaderPropertyAttribute("Cache-Control", "max-age")
 
```
    Parameters:
    
    name - is the name of the requested property.
    
    attributeName - the name of the requested attribute.
    
    Returns:
    
    the value of the requested attribute or null if the property is NOT set or does NOT contain the attribute. If the property is set but has no value, the empty string ("") is returned.
  - setHeaderProperty
```
public void setHeaderProperty(String name,
                              String value)
```
    This method sets the HTTP header-property with the given name to the given value.
    
    Parameters:
    
    name - is the name of the property to set.
    
    value - is the value of the property to set.
    
    See Also:
    
    appendHeaderProperty(String, String)
  - appendHeaderProperty
```
public void appendHeaderProperty(String name,
                                 String appendValue)
```
    This method appends the given value to the HTTP header-property with the given name.
    
    Parameters:
    
    name - is the name of the property to append to.
    
    appendValue - is the value to append to the header-property.
    
    See Also:
    
    appendHeaderProperty(String, String, String)
  - appendHeaderProperty
```
public void appendHeaderProperty(String name,
                                 String appendValue,
                                 String separator)
```
    This method appends the given value to the HTTP header-property with the given name. If the header-property is NOT yet set, this method behaves like setHeaderProperty(name, appendValue).
    
    Parameters:
    
    name - is the name of the property to append to.
    
    appendValue - is the value to append to the header-property.
    
    separator - if NOT null and the header property is already set, this string will be appended after the current value and before the given appendValue.
  - getContentType
```
public String getContentType()
```
    This method gets the content-type.
    
    Returns:
    
    the content-type or null if NOT set.
  - setContentType
```
public void setContentType(String contentType)
```
    This method sets the content-type.
    
    Parameters:
    
    contentType - is the content-type to set.
  - getContentLength
```
public Long getContentLength()
```
    This method gets the content-length.
    
    Returns:
    
    the content-length or null if NOT set.
  - setContentLength
```
public void setContentLength(long contentLength)
```
    This method sets the content-length.
    
    Parameters:
    
    contentLength - is the content-length to set. It should be a non-negative value.
  - getContentEncoding
```
public String getContentEncoding()
```
    This method gets the content-encoding.
    
    Returns:
    
    the content-encoding or null if NOT set.
  - setContentEncoding
```
public void setContentEncoding(String encoding)
```
    This method sets the content-encoding.
    
    Parameters:
    
    encoding - is the content-encoding to set.
  - setCacheControlMaxAge
```
public void setCacheControlMaxAge(int seconds)
```
    This method sets the maximum age (lease time) in seconds.
    
    Parameters:
    
    seconds - is the max-age in seconds.
  - getCacheControlMaxAge
```
public int getCacheControlMaxAge()
```
    This method gets the maximum age (lease time) in seconds.
    
    Returns:
    
    the maximum age in seconds or -1 if the max-age is NOT set (properly).
  - getDate
```
public String getDate()
```
    This method gets the date. TODO: implement HTTP date parser
    
    Returns:
    
    the date or null if NOT set.
  - setDate
```
public void setDate(String date)
```
    This method sets the date. TODO: implement HTTP date formatter
    
    Parameters:
    
    date - is the date to set.
  - writeFirstLine
```
protected abstract void writeFirstLine(StringBuffer buffer)
```
    This method writes the first line (request-line or status-line) of the HTTP message.
    
    Parameters:
    
    buffer - is the string-buffer where to append the first line.
  - serialize
```
public void serialize(StringBuffer buffer)
```
    This method serializes this HTTP-message to the given string buffer.
    
    Parameters:
    
    buffer - is the string buffer where to append this HTTP-message to.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HttpMessage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION_PREFIX

VERSION_0_9

VERSION_1_0

VERSION_1_1

HEADER_PROPERTY_CONTENT_ENCODING

HEADER_PROPERTY_CONTENT_LENGTH

HEADER_PROPERTY_CONTENT_TYPE

HEADER_PROPERTY_CACHE_CONTROL

HEADER_PROPERTY_DATE

HEADER_PROPERTY_EXPIRES

HEADER_PROPERTY_FROM

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

HEADER_PROPERTY_HOST

HEADER_ATTRIBUTE_MAX_AGE

CRLF

CHAR_FILTER_WHITELIST_COMMA_OR_SEMICOLON

CHAR_FILTER_BLACKLIST_COMMA_OR_SEMICOLON

header

version

Constructor Detail

HttpMessage

Method Detail

getVersion

setVersion

createHeaderNameHash

getHeaderProperty

setHeaderPropertyAttribute

getHeaderPropertyAttribute

setHeaderProperty

appendHeaderProperty

appendHeaderProperty

getContentType

setContentType

getContentLength

setContentLength

getContentEncoding

setContentEncoding

setCacheControlMaxAge

getCacheControlMaxAge

getDate

setDate

writeFirstLine

serialize

toString