org.simpleframework.http.message
Interface Message

All Known Implementing Classes:

MessageHeader

public interface Message

The Message object is used to store an retrieve the headers for both a request and response. Headers are stored and retrieved in a case insensitive manner according to RFC 2616. The message also allows multiple header values to be added to a single header name, headers such as Cookie and Set-Cookie can be added multiple times with different values.

Author:

Niall Gallagher

Method Summary

void	addDate(String name, long date) This is used as a convenience method for adding a header that needs to be parsed into a HTTPdate string.
void	addInteger(String name, int value) This can be used to add a HTTP message header to this object.
void	addValue(String name, String value) This can be used to add a HTTP message header to this object.
List<String>	getAll(String name) This is used to acquire all the individual header values from the message.
Cookie	getCookie(String name) This returns the Cookie object stored under the specified name.
List<Cookie>	getCookies() This returns all Cookie objects stored under the specified name.
long	getDate(String name) This can be used to get the value of the first message header that has the specified name.
int	getInteger(String name) This can be used to get the value of the first message header that has the specified name.
List<String>	getNames() This is used to acquire the names of the of the headers that have been set in the response.
String	getValue(String name) This can be used to get the value of the first message header that has the specified name.
String	getValue(String name, int index) This can be used to get the value of the first message header that has the specified name.
List<String>	getValues(List<String> list) This can be used to get the values of HTTP message headers that have the specified name.
List<String>	getValues(String name) This can be used to get the values of HTTP message headers that have the specified name.
Cookie	setCookie(Cookie cookie) The setCookie method is used to set a cookie value with the cookie name.
Cookie	setCookie(String name, String value) The setCookie method is used to set a cookie value with the cookie name.
void	setDate(String name, long date) This is used as a convenience method for adding a header that needs to be parsed into a HTTP date string.
void	setInteger(String name, int value) This can be used to set a HTTP message header to this object.
void	setValue(String name, String value) This can be used to set a HTTP message header to this object.

Method Detail

getNames

List<String> getNames()

This is used to acquire the names of the of the headers that have been set in the response. This can be used to acquire all header values by name that have been set within the response. If no headers have been set this will return an empty list.

Returns:

a list of strings representing the set header names

setValue

void setValue(String name,
              String value)

This can be used to set a HTTP message header to this object. The name and value of the HTTP message header will be used to create a HTTP message header object which can be retrieved using the getValue in combination with the get methods. This will perform a remove using the issued header name before the header value is set.

Parameters:

name - the name of the HTTP message header to be added

value - the value the HTTP message header will have

setInteger

void setInteger(String name,
                int value)

This can be used to set a HTTP message header to this object. The name and value of the HTTP message header will be used to create a HTTP message header object which can be retrieved using the getValue in combination with the get methods. This will perform a remove using the issued header name before the header value is set.

Parameters:

name - the name of the HTTP message header to be added

value - the value the HTTP message header will have

setDate

void setDate(String name,
             long date)

This is used as a convenience method for adding a header that needs to be parsed into a HTTP date string. This will convert the date given into a date string defined in RFC 2616 sec 3.3.1. This will perform a remove using the issued header name before the header value is set.

Parameters:

name - the name of the HTTP message header to be added

date - the value constructed as an RFC 1123 date string

addValue

void addValue(String name,
              String value)

This can be used to add a HTTP message header to this object. The name and value of the HTTP message header will be used to create a HTTP message header object which can be retrieved using the getValue in combination with the get methods.

Parameters:

name - the name of the HTTP message header to be added

value - the value the HTTP message header will have

addInteger

void addInteger(String name,
                int value)

This can be used to add a HTTP message header to this object. The name and value of the HTTP message header will be used to create a HTTP message header object which can be retrieved using the getInteger in combination with the get methods.

Parameters:

name - the name of the HTTP message header to be added

value - the value the HTTP message header will have

addDate

void addDate(String name,
             long date)

This is used as a convenience method for adding a header that needs to be parsed into a HTTPdate string. This will convert the date given into a date string defined in RFC 2616 sec 3.3.1.

Parameters:

name - the name of the HTTP message header to be added

date - the value constructed as an RFC 1123 date string

getValue

String getValue(String name)

This can be used to get the value of the first message header that has the specified name. This will return the full string representing the named header value. If the named header does not exist then this will return a null value.

Parameters:

name - the HTTP message header to get the value from

Returns:

this returns the value that the HTTP message header

getValue

String getValue(String name,
                int index)

This can be used to get the value of the first message header that has the specified name. This will return the full string representing the named header value. If the named header does not exist then this will return a null value.

Parameters:

name - the HTTP message header to get the value from

index - gets the value at the index if there are multiple

Returns:

this returns the value that the HTTP message header

getInteger

int getInteger(String name)

This can be used to get the value of the first message header that has the specified name. This will return the integer representing the named header value. If the named header does not exist then this will return a value of minus one, -1.

Parameters:

name - the HTTP message header to get the value from

Returns:

this returns the value that the HTTP message header

getDate

long getDate(String name)

This can be used to get the value of the first message header that has the specified name. This will return the long value representing the named header value. If the named header does not exist then this will return a value of minus one, -1.

Parameters:

name - the HTTP message header to get the value from

Returns:

this returns the value that the HTTP message header

getCookie

Cookie getCookie(String name)

This returns the Cookie object stored under the specified name. This is used to retrieve cookies that have been set with the setCookie methods. If the cookie does not exist under the specified name this will return null.

Parameters:

name - this is the name of the cookie to be retrieved

Returns:

returns the Cookie by the given name

getCookies

List<Cookie> getCookies()

This returns all Cookie objects stored under the specified name. This is used to retrieve cookies that have been set with the setCookie methods. If there are no cookies then this will return an empty list.

Returns:

returns all the Cookie in the response

setCookie

Cookie setCookie(String name,
                 String value)

The setCookie method is used to set a cookie value with the cookie name. This will add a cookie to the response stored under the name of the cookie, when this is committed it will be added as a Set-Cookie header to the resulting response. This is a convenience method that avoids cookie creation.

Parameters:

name - this is the cookie to be added to the response

value - this is the cookie value that is to be used

Returns:

returns the cookie that has been set in the response

setCookie

Cookie setCookie(Cookie cookie)

The setCookie method is used to set a cookie value with the cookie name. This will add a cookie to the response stored under the name of the cookie, when this is committed it will be added as a Set-Cookie header to the resulting response.

Parameters:

cookie - this is the cookie to be added to the response

Returns:

returns the cookie that has been set in the response

getValues

List<String> getValues(String name)

This can be used to get the values of HTTP message headers that have the specified name. This is a convenience method that will present that values as tokens extracted from the header. This has obvious performance benefits as it avoids having to deal with substring and trim calls.

The tokens returned by this method are ordered according to there HTTP quality values, or "q" values, see RFC 2616 section 3.9. This also strips out the quality parameter from tokens returned. So "image/html; q=0.9" results in "image/html". If there are no "q" values present then order is by appearance.

The result from this is either the trimmed header value, that is, the header value with no leading or trailing whitespace or an array of trimmed tokens ordered with the most preferred in the lower indexes, so index 0 is has highest preference.

Parameters:

name - the name of the headers that are to be retrieved

Returns:

ordered list of tokens extracted from the header(s)

getValues

List<String> getValues(List<String> list)

This can be used to get the values of HTTP message headers that have the specified name. This is a convenience method that will present that values as tokens extracted from the header. This has obvious performance benefits as it avoids having to deal with substring and trim calls.

The tokens returned by this method are ordered according to there HTTP quality values, or "q" values, see RFC 2616 section 3.9. This also strips out the quality parameter from tokens returned. So "image/html; q=0.9" results in "image/html". If there are no "q" values present then order is by appearance.

The result from this is either the trimmed header value, that is, the header value with no leading or trailing whitespace or an array of trimmed tokens ordered with the most preferred in the lower indexes, so index 0 is has highest preference.

Parameters:

list - this is the list of individual header values

Returns:

ordered list of tokens extracted from the header(s)

getAll

List<String> getAll(String name)

This is used to acquire all the individual header values from the message. The header values provided by this are unparsed and represent the actual string values that have been added to the message keyed by a given header name.

Parameters:

name - the name of the header to get the values for

Returns:

this returns a list of the values for the header name