org.xlightweb
Class HttpRequestHeader

java.lang.Object
  org.xlightweb.Header
      org.xlightweb.HttpRequestHeader

All Implemented Interfaces:

Cloneable, IHeader, IHttpMessageHeader, IHttpRequestHeader

public class HttpRequestHeader
extends Header
implements IHttpRequestHeader

http request header

Field Summary

Fields inherited from interface org.xlightweb.IHttpMessageHeader

DEFAULT_ENCODING

Constructor Summary

HttpRequestHeader(String method, String url)
constructor

HttpRequestHeader(String method, String url, String contentType)
constructor

Method Summary

void	addMatrixParameter(String parameterName, String parameterValue) adds a matrix parameter
void	addParameter(String parameterName, String parameterValue) adds a parameter
protected Object	clone()
boolean	containsHeader(String headername) Returns a boolean indicating whether the named header has already been set.
IHttpRequestHeader	copy() creates a copy of this header
void	copyHeaderFrom(IHttpMessageHeader otherHeader, String... upperExcludenames) copy the headers
Object	getAttribute(String name) Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
Enumeration	getAttributeNames() Returns an Enumeration containing the names of the attributes available to this message.
Set<String>	getAttributeNameSet() Returns an Set containing the names of the attributes available to this messaget.
Boolean	getBooleanParameter(String name) Get an Boolean parameter, or null if not present.
boolean	getBooleanParameter(String name, boolean defaultVal) Get an boolean parameter, with a fallback value.
int	getContentLength() Returns the length, in bytes, of the message body and made available by the input stream, or -1 if the length is not known.
Double	getDoubleParameter(String name) Get an Double parameter, or null if not present.
double	getDoubleParameter(String name, double defaultVal) Get an double parameter, with a fallback value.
Float	getFloatParameter(String name) Get an Float parameter, or null if not present.
float	getFloatParameter(String name, float defaultVal) Get an float parameter, with a fallback value.
String	getHeader(String headername) Returns the value of the specified header as a String.
List<String>	getHeaderList(String headername) Returns all the values of the specified header as an List of String objects.
Set<String>	getHeaderNameSet() Returns an set of all the header names.
String	getHost() returns the Host header parameter or null if the header is not set
Integer	getIntParameter(String name) Get an Integer parameter, or null if not present.
int	getIntParameter(String name, int defaultVal) Get an int parameter, with a fallback value.
Long	getLongParameter(String name) Get an Long parameter, or null if not present.
long	getLongParameter(String name, long defaultVal) Get an long parameter, with a fallback value.
String	getMatrixParameter(String name) Returns the value of a request matrix parameter as a String, or null if the parameter does not exist.
Set<String>	getMatrixParameterNameSet() returns the matrix parameter name set
String[]	getMatrixParameterValues(String name) Returns an array of String objects containing all of the values the given request matrix parameter has, or null if the parameter does not exist.
String	getMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
String	getParameter(String name) Returns the value of a request parameter as a String, or null if the parameter does not exist.
String	getParameter(String name, String defaultVal) Get an String parameter, with a fallback value.
Enumeration	getParameterNames() Returns an Enumeration of String objects containing the names of the parameters contained in this request.
Set<String>	getParameterNameSet() returns the parameter name set
String[]	getParameterValues(String name) Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
String	getProtocol() Returns the name and version of the protocol the message uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
String	getProtocolVersion() Returns the version of the protocol the message uses in the form majorVersion.minorVersion, for example, 1.1.
String	getQueryString() Returns the query string that is contained in the request URL after the path.
String	getRemoteAddr() Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
String	getRemoteHost() Returns the fully qualified name of the client or the last proxy that sent the request.
int	getRemotePort() Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
String	getRequestURI() Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
URL	getRequestUrl() Reconstructs the URL the client used to make the request.
boolean	getRequiredBooleanParameter(String name) Get an boolean parameter or throws an exception if parameter is not present
double	getRequiredDoubleParameter(String name) Get an double parameter or throws an exception if parameter is not present
float	getRequiredFloatParameter(String name) Get an float parameter or throws an exception if parameter is not present
int	getRequiredIntParameter(String name) Get an int parameter or throws an exception if parameter is not present
long	getRequiredLongParameter(String name) Get an long parameter or throws an exception if parameter is not present
String	getRequiredStringParameter(String name) Get an string parameter or throws an exception if parameter is not present
String	getScheme() Returns the name of the scheme used to make this request, for example, http or https.
String	getServerName() Returns the host name of the server to which the request was sent.
int	getServerPort() Returns the port number to which the request was sent.
String	getUserAgent() returns the User-Agent header parameter or null if the header is not set
boolean	isSecure() Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
protected boolean	onHeaderAdded(String headername, String headervalue)
protected boolean	onHeaderRemoved(String headername)
void	removeHopByHopHeaders() removes all hop-by-hop headers without Transfer-Encoding if set to chunked
void	removeMatrixParameter(String parameterName) removes a matrix parameter
void	removeParameter(String parameterName) remove a parameter
void	setAttribute(String name, Object o) Stores an attribute in this header.
void	setContentLength(int contentLength) sets the content length in bytes
void	setHost(String host) sets the Host header (e.g. www.gmx.com or www.gmx.com:9900).
void	setMatrixParameter(String parameterName, String parameterValue) sets a matrix parameter
void	setMethod(String method) Sets the name of the HTTP method
void	setParameter(String parameterName, String parameterValue) sets a parameter
void	setRequestURI(String requestUri) set the request uri part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
void	setRequestUrl(URL url) set the request url
void	setUserAgent(String userAgent) sets the User-Agent header
String	toString()

Methods inherited from class org.xlightweb.Header

addHeader, addHeaderLine, addHeaderlines, getAccept, getCharacterEncoding, getContentType, getDisposition, getDispositionParam, getDispositionType, getHeaderNames, getHeaders, getTransferEncoding, removeHeader, setContentType, setHeader, setTransferEncoding

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xlightweb.IHttpRequestHeader

getAccept

Methods inherited from interface org.xlightweb.IHttpMessageHeader

copyHeaderFrom, getAttribute, getAttributeNames, getAttributeNameSet, getContentLength, getProtocol, getProtocolVersion, removeHopByHopHeaders, setAttribute, setContentLength

Methods inherited from interface org.xlightweb.IHeader

addHeader, addHeaderLine, addHeaderlines, getCharacterEncoding, getContentType, getDisposition, getDispositionParam, getDispositionType, getHeaderNames, getHeaders, getTransferEncoding, removeHeader, setContentType, setHeader, setTransferEncoding

Constructor Detail

HttpRequestHeader

public HttpRequestHeader(String method,
                         String url)

constructor

Parameters:

method - the method

url - the url string

HttpRequestHeader

public HttpRequestHeader(String method,
                         String url,
                         String contentType)

constructor

Parameters:

method - the method

url - the url string

contentType - the content type

Method Detail

onHeaderAdded

protected final boolean onHeaderAdded(String headername,
                                      String headervalue)

onHeaderRemoved

protected final boolean onHeaderRemoved(String headername)

getHost

public final String getHost()

returns the Host header parameter or null if the header is not set

Specified by:

getHost in interface IHttpRequestHeader

Returns:

the Host header parameter or null if the header is not set

setHost

public final void setHost(String host)

sets the Host header (e.g. www.gmx.com or www.gmx.com:9900). If the port value is -1, it will be removed, automatically

Specified by:

setHost in interface IHttpRequestHeader

Parameters:

host - the Host header

getUserAgent

public final String getUserAgent()

returns the User-Agent header parameter or null if the header is not set

Specified by:

getUserAgent in interface IHttpRequestHeader

Returns:

the User-Agent header parameter or null if the header is not set

setUserAgent

public final void setUserAgent(String userAgent)

sets the User-Agent header

Specified by:

setUserAgent in interface IHttpRequestHeader

Parameters:

userAgent - the User-Agent header

getHeaderNameSet

public final Set<String> getHeaderNameSet()

Returns an set of all the header names. If the part has no headers, this method returns an empty Set.

Specified by:

getHeaderNameSet in interface IHeader

Returns:

an Set of all the header names

getHeaderList

public final List<String> getHeaderList(String headername)

Returns all the values of the specified header as an List of String objects.

Some headers, such as Accept-Language can be set by part producer as several headers each with a different value rather than sending the header as a comma separated list.

Specified by:

getHeaderList in interface IHeader

Parameters:

headername - a String specifying the header name

Returns:

an List containing the values of the requested header. If the part does not have any headers of that name return an empty enumeration.

getHeader

public final String getHeader(String headername)

Returns the value of the specified header as a String. If the part did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the part.

Specified by:

getHeader in interface IHeader

Parameters:

headername - a String specifying the header name

Returns:

a String containing the value of the requested header, or null if the part does not have a header of that name

containsHeader

public final boolean containsHeader(String headername)

Returns a boolean indicating whether the named header has already been set.

Specified by:

containsHeader in interface IHeader

Returns:

true if the named header has already been set; false otherwise

getRemoteHost

public final String getRemoteHost()

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address.

Specified by:

getRemoteHost in interface IHttpRequestHeader

Returns:

a String containing the fully qualified name of the client

getRemotePort

public final int getRemotePort()

Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.

Specified by:

getRemotePort in interface IHttpRequestHeader

Returns:

an integer specifying the port number

getRemoteAddr

public final String getRemoteAddr()

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.

Specified by:

getRemoteAddr in interface IHttpRequestHeader

Returns:

a String containing the IP address of the client that sent the request

getQueryString

public final String getQueryString()

Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string.

Specified by:

getQueryString in interface IHttpRequestHeader

Returns:

a String containing the query string or null if the URL contains no query string.

getRequestURI

public final String getRequestURI()

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.

Specified by:

getRequestURI in interface IHttpRequestHeader

Returns:

a String containing the part of the URL from the protocol name up to the query string

setRequestURI

public final void setRequestURI(String requestUri)

set the request uri part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.

Specified by:

setRequestURI in interface IHttpRequestHeader

Parameters:

requestUri - the request uri

getRequestUrl

public final URL getRequestUrl()

Reconstructs the URL the client used to make the request.

Specified by:

getRequestUrl in interface IHttpRequestHeader

Returns:

the URL

setRequestUrl

public final void setRequestUrl(URL url)

set the request url

Specified by:

setRequestUrl in interface IHttpRequestHeader

Parameters:

url - the request url

isSecure

public final boolean isSecure()

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

Specified by:

isSecure in interface IHttpRequestHeader

Returns:

a boolean indicating if the request was made using a secure channel

getScheme

public final String getScheme()

Returns the name of the scheme used to make this request, for example, http or https.

Specified by:

getScheme in interface IHttpRequestHeader

Returns:

a String containing the name of the scheme

getMethod

public final String getMethod()

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.

Specified by:

getMethod in interface IHttpRequestHeader

Returns:

a String specifying the name of the method

setMethod

public final void setMethod(String method)

Sets the name of the HTTP method

Specified by:

setMethod in interface IHttpRequestHeader

Parameters:

method - a String specifying the name of the method

getServerName

public final String getServerName()

Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.

Specified by:

getServerName in interface IHttpRequestHeader

Returns:

the server name

getServerPort

public final int getServerPort()

Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.

Specified by:

getServerPort in interface IHttpRequestHeader

Returns:

the server port

removeParameter

public final void removeParameter(String parameterName)

remove a parameter

Specified by:

removeParameter in interface IHttpRequestHeader

Parameters:

parameterName - the parameter name

setParameter

public final void setParameter(String parameterName,
                               String parameterValue)

sets a parameter

Specified by:

setParameter in interface IHttpRequestHeader

Parameters:

parameterName - the parameter name

parameterValue - the parameter value

addParameter

public final void addParameter(String parameterName,
                               String parameterValue)

adds a parameter

Specified by:

addParameter in interface IHttpRequestHeader

Parameters:

parameterName - the parameter name

parameterValue - the parameter value

getParameterNames

public final Enumeration getParameterNames()

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Specified by:

getParameterNames in interface IHttpRequestHeader

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParameterNameSet

public final Set<String> getParameterNameSet()

returns the parameter name set

Specified by:

getParameterNameSet in interface IHttpRequestHeader

Returns:

the parameter name set

getParameter

public final String getParameter(String name,
                                 String defaultVal)

Get an String parameter, with a fallback value.

Specified by:

getParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

defaultVal - the default value to use as fallback

Returns:

the value

getParameter

public final String getParameter(String name)

Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request.

Specified by:

getParameter in interface IHttpRequestHeader

Parameters:

name - a String specifying the name of the parameter

Returns:

a String representing the single value of the parameter

setMatrixParameter

public final void setMatrixParameter(String parameterName,
                                     String parameterValue)

sets a matrix parameter

Specified by:

setMatrixParameter in interface IHttpRequestHeader

Parameters:

parameterName - the parameter name

parameterValue - the parameter value

addMatrixParameter

public final void addMatrixParameter(String parameterName,
                                     String parameterValue)

adds a matrix parameter

Specified by:

addMatrixParameter in interface IHttpRequestHeader

Parameters:

parameterName - the parameter name

parameterValue - the parameter value

removeMatrixParameter

public final void removeMatrixParameter(String parameterName)

removes a matrix parameter

Specified by:

removeMatrixParameter in interface IHttpRequestHeader

Parameters:

parameterName - the parameter name

getMatrixParameterValues

public final String[] getMatrixParameterValues(String name)

Returns an array of String objects containing all of the values the given request matrix parameter has, or null if the parameter does not exist. If the natrix parameter has a single value, the array has a length of 1.

Specified by:

getMatrixParameterValues in interface IHttpRequestHeader

Parameters:

name - a String specifying the name of the matrix parameter

Returns:

an array of String objects containing the matrix parameter's values

getMatrixParameterNameSet

public final Set<String> getMatrixParameterNameSet()

returns the matrix parameter name set

Specified by:

getMatrixParameterNameSet in interface IHttpRequestHeader

Returns:

the matrix parameter name set

getMatrixParameter

public final String getMatrixParameter(String name)

Returns the value of a request matrix parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request.

Specified by:

getMatrixParameter in interface IHttpRequestHeader

Parameters:

name - a String specifying the name of the matrix parameter

Returns:

a String representing the single value of the matrix parameter

getParameterValues

public final String[] getParameterValues(String name)

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist. If the parameter has a single value, the array has a length of 1.

Specified by:

getParameterValues in interface IHttpRequestHeader

Parameters:

name - a String specifying the name of the parameter

Returns:

an array of String objects containing the parameter's values

getRequiredStringParameter

public final String getRequiredStringParameter(String name)
                                        throws BadMessageException

Get an string parameter or throws an exception if parameter is not present

Specified by:

getRequiredStringParameter in interface IHttpRequestHeader

Parameters:

name - the parameter name

Returns:

the value

Throws:

BadMessageException - if the parameter is not present

getIntParameter

public final Integer getIntParameter(String name)
                              throws BadMessageException

Get an Integer parameter, or null if not present.

Specified by:

getIntParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

Returns:

the value, or null

Throws:

BadMessageException - if the parameter value is not a number

getRequiredIntParameter

public final int getRequiredIntParameter(String name)
                                  throws BadMessageException

Get an int parameter or throws an exception if parameter is not present

Specified by:

getRequiredIntParameter in interface IHttpRequestHeader

Parameters:

name - the parameter name

Returns:

the value

Throws:

BadMessageException - if the parameter is not present or the parameter is not a number

getIntParameter

public final int getIntParameter(String name,
                                 int defaultVal)

Get an int parameter, with a fallback value.

Specified by:

getIntParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

defaultVal - the default value to use as fallback

Returns:

the value

getLongParameter

public final Long getLongParameter(String name)
                            throws BadMessageException

Get an Long parameter, or null if not present.

Specified by:

getLongParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

Returns:

the value, or null

Throws:

BadMessageException - if the parameter value is not a number

getRequiredLongParameter

public final long getRequiredLongParameter(String name)
                                    throws BadMessageException

Get an long parameter or throws an exception if parameter is not present

Specified by:

getRequiredLongParameter in interface IHttpRequestHeader

Parameters:

name - the parameter name

Returns:

the value

Throws:

BadMessageException - if the parameter is not present or the parameter is not a number

getLongParameter

public final long getLongParameter(String name,
                                   long defaultVal)

Get an long parameter, with a fallback value.

Specified by:

getLongParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

defaultVal - the default value to use as fallback

Returns:

the value

getDoubleParameter

public final Double getDoubleParameter(String name)
                                throws BadMessageException

Get an Double parameter, or null if not present.

Specified by:

getDoubleParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

Returns:

the value, or null

Throws:

BadMessageException - if the parameter is not a number

getRequiredDoubleParameter

public final double getRequiredDoubleParameter(String name)
                                        throws BadMessageException

Get an double parameter or throws an exception if parameter is not present

Specified by:

getRequiredDoubleParameter in interface IHttpRequestHeader

Parameters:

name - the parameter name

Returns:

the value

Throws:

BadMessageException - if the parameter is not present or the parameter value is not a number

getDoubleParameter

public final double getDoubleParameter(String name,
                                       double defaultVal)

Get an double parameter, with a fallback value.

Specified by:

getDoubleParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

defaultVal - the default value to use as fallback

Returns:

the value

getFloatParameter

public final Float getFloatParameter(String name)
                              throws BadMessageException

Get an Float parameter, or null if not present.

Specified by:

getFloatParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

Returns:

the value, or null

Throws:

BadMessageException - if the parameter value is not a number

getRequiredFloatParameter

public final float getRequiredFloatParameter(String name)
                                      throws BadMessageException

Get an float parameter or throws an exception if parameter is not present

Specified by:

getRequiredFloatParameter in interface IHttpRequestHeader

Parameters:

name - the parameter name

Returns:

the value

Throws:

BadMessageException - if the parameter is not present or the parameter value is not a number

getFloatParameter

public final float getFloatParameter(String name,
                                     float defaultVal)

Get an float parameter, with a fallback value.

Specified by:

getFloatParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

defaultVal - the default value to use as fallback

Returns:

the value

getBooleanParameter

public final Boolean getBooleanParameter(String name)

Get an Boolean parameter, or null if not present.

Specified by:

getBooleanParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

Returns:

the value, or null

getRequiredBooleanParameter

public final boolean getRequiredBooleanParameter(String name)
                                          throws BadMessageException

Get an boolean parameter or throws an exception if parameter is not present

Specified by:

getRequiredBooleanParameter in interface IHttpRequestHeader

Parameters:

name - the parameter name

Returns:

the value

Throws:

BadMessageException - if the parameter is not present

getBooleanParameter

public final boolean getBooleanParameter(String name,
                                         boolean defaultVal)

Get an boolean parameter, with a fallback value.

Specified by:

getBooleanParameter in interface IHttpRequestHeader

Parameters:

name - the name of the parameter

defaultVal - the default value to use as fallback

Returns:

the value

toString

public String toString()

Overrides:

toString in class Header

copy

public final IHttpRequestHeader copy()

creates a copy of this header

Specified by:

copy in interface IHttpMessageHeader

Specified by:

copy in interface IHttpRequestHeader

Returns:

return the copy

clone

protected Object clone()
                throws CloneNotSupportedException

Throws:

CloneNotSupportedException

getProtocolVersion

public String getProtocolVersion()

Returns the version of the protocol the message uses in the form majorVersion.minorVersion, for example, 1.1.

Specified by:

getProtocolVersion in interface IHttpMessageHeader

Returns:

a String containing the protocol version number

getProtocol

public String getProtocol()

Returns the name and version of the protocol the message uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.

Specified by:

getProtocol in interface IHttpMessageHeader

Returns:

a String containing the protocol name and version number

setAttribute

public final void setAttribute(String name,
                               Object o)

Stores an attribute in this header. Attributes are reset between messages.

Attribute names should follow the same conventions as package names.

Specified by:

setAttribute in interface IHttpMessageHeader

Parameters:

name - a String specifying the name of the attribute

o - the Object to be stored

getAttribute

public final Object getAttribute(String name)

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Attribute names should follow the same conventions as package names.

Specified by:

getAttribute in interface IHttpMessageHeader

Parameters:

name - a String specifying the name of the attribute

Returns:

an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNameSet

public final Set<String> getAttributeNameSet()

Returns an Set containing the names of the attributes available to this messaget. This method returns an empty Set if the request has no attributes available to it.

Specified by:

getAttributeNameSet in interface IHttpMessageHeader

Returns:

an Set of strings containing the names of the message's attributes

getAttributeNames

public final Enumeration getAttributeNames()

Returns an Enumeration containing the names of the attributes available to this message. This method returns an empty Enumeration if the message has no attributes available to it.

Specified by:

getAttributeNames in interface IHttpMessageHeader

Returns:

an Enumeration of strings containing the names of the message's attributes

getContentLength

public final int getContentLength()

Returns the length, in bytes, of the message body and made available by the input stream, or -1 if the length is not known.

Specified by:

getContentLength in interface IHttpMessageHeader

Returns:

an integer containing the length of the message body or -1 if the length is not known

setContentLength

public final void setContentLength(int contentLength)

sets the content length in bytes

Specified by:

setContentLength in interface IHttpMessageHeader

Parameters:

contentLength - the content length in bytes

copyHeaderFrom

public final void copyHeaderFrom(IHttpMessageHeader otherHeader,
                                 String... upperExcludenames)

copy the headers

Specified by:

copyHeaderFrom in interface IHttpMessageHeader

Parameters:

otherHeader - the other header

upperExcludenames - the header names to exclude

removeHopByHopHeaders

public final void removeHopByHopHeaders()

removes all hop-by-hop headers without Transfer-Encoding if set to chunked

Specified by:

removeHopByHopHeaders in interface IHttpMessageHeader