org.attribyte.api.http

Class Request

java.lang.Object

org.attribyte.api.http.Request

public final class Request
extends java.lang.Object

An immutable HTTP request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Method The HTTP methods.

Field Summary

Fields

Modifier and Type	Field and Description
<any>	attributes An immutable map of attributes.
ByteString	body The request body.
boolean	caseSensitiveParameters If the request has parameters, are they case-sensitive?
static java.lang.String	FORM_ENCODED_CONTENT_TYPE The expected value for a form encoded header: application/x-www-form-urlencoded.
<any>	headers An immutable map of headers.
Request.Method	method The request method.
<any>	parameters An immutable map of parameters.
static java.lang.String	REMOTE_ADDR The name of an attribute that may hold the remote address.
java.net.URI	uri The request URI.

Method Summary

Modifier and Type	Method and Description
Request	addHeaders(java.util.Collection<Header> headers) Adds headers to the existing headers, replacing any that are duplicated.
static byte[]	bodyFromInputStream(java.io.InputStream is, int maxBytesRead) Reads the request body from an input stream.
ByteString	getBody() Gets the request body, if any.
java.lang.String	getCharset(java.lang.String defaultCharset) Gets the charset specified with the request Content-Type header, if any.
java.lang.String	getContentType() Gets the value of the Content-Type header.
Header	getHeader(java.lang.String name) Gets a header.
java.util.Collection<Header>	getHeaders() Gets all headers.
java.lang.String	getHeaderValue(java.lang.String name) Gets the first header value.
<any>	getHeaderValueList(java.lang.String name) Gets an immutable list of values for a header.
java.lang.String[]	getHeaderValues(java.lang.String name) Gets all values for a header.
static java.lang.String	getHostURL(java.lang.String uri) Gets a URL for the host portion of a URI without decoding.
Request.Method	getMethod() Gets the HTTP method.
java.util.Collection<Parameter>	getParameters() Gets all parameters.
java.lang.String	getParameterValue(java.lang.String name) Gets the first parameter value.
<any>	getParameterValueList(java.lang.String name) Gets an immutable list of values for a parameter.
java.lang.String[]	getParameterValues(java.lang.String name) Gets all values for a parameter.
java.util.List<java.lang.String>	getPathComponents() Gets the components of the path (separated by '/').
static java.util.List<java.lang.String>	getPathComponents(java.lang.String uri) Gets the components of the path (separated by '/').
java.lang.String	getQueryString() Gets the decoded query string.
java.lang.String	getRawQueryString() Gets the raw query string, without decoding.
java.lang.String	getRemoteAddr() Gets the IP address of the client that sent the request.
java.lang.String	getRequestPath() Gets the path component of the request URI.
static java.lang.String	getRequestPath(java.lang.String uri) Gets the path component of a URI.
java.lang.String	getServerName() Gets the server name (as specified in the Host header.
java.net.URI	getURI() Gets the URI.
boolean	isFormEncoded() Determine if the request is encoded as a form application/x-www-form-urlencoded
static java.util.Map<java.lang.String,Parameter>	parseParameters(java.lang.String queryString) Parse parameters from a query string.
static java.util.Map<java.lang.String,Parameter>	parseParameters(java.lang.String queryString, boolean caseSensitiveNames) Parse parameters from a query string.
static java.util.Map<java.lang.String,Parameter>	parseParametersPreserveNameCase(java.lang.String queryString) Parse parameters from a query string, preserving case in parameter names.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FORM_ENCODED_CONTENT_TYPE

public static final java.lang.String FORM_ENCODED_CONTENT_TYPE

The expected value for a form encoded header: application/x-www-form-urlencoded.

See Also:

Constant Field Values

REMOTE_ADDR

public static final java.lang.String REMOTE_ADDR

The name of an attribute that may hold the remote address.

See Also:

Constant Field Values

method

public final Request.Method method

The request method.

uri

public final java.net.URI uri

The request URI.

headers

public final <any> headers

An immutable map of headers.

Keys are lower-cased.

parameters

public final <any> parameters

An immutable map of parameters.

If caseSensitiveParameters == false, map keys are lower-cased.

attributes

public final <any> attributes

An immutable map of attributes.

body

public final ByteString body

The request body. May be null.

caseSensitiveParameters

public final boolean caseSensitiveParameters

If the request has parameters, are they case-sensitive?

Method Detail

getMethod

public Request.Method getMethod()

Gets the HTTP method.

Returns:

The method.

getQueryString

public java.lang.String getQueryString()

Gets the decoded query string.

Returns:

The decoded query string or null if none.

getRawQueryString

public java.lang.String getRawQueryString()

Gets the raw query string, without decoding.

Returns:

The query string or null if none.

getRequestPath

public java.lang.String getRequestPath()

Gets the path component of the request URI.

Path always begins with '/' and is never null.

Returns:

The path.

getRequestPath

public static final java.lang.String getRequestPath(java.lang.String uri)
                                             throws InvalidURIException

Gets the path component of a URI.

Path always begins with '/' and is never null. Components are decoded.

Parameters:

uri - The URI.

Returns:

The path.

Throws:

InvalidURIException - if URI is invalid.

getHostURL

public static final java.lang.String getHostURL(java.lang.String uri)
                                         throws InvalidURIException

Gets a URL for the host portion of a URI without decoding.

Includes the protocol, if specified. Never ends with '/'.

Parameters:

uri - The URI.

Returns:

The host URL.

Throws:

InvalidURIException

getURI

public java.net.URI getURI()

Gets the URI.

Returns:

The URI.

getHeaderValue

public java.lang.String getHeaderValue(java.lang.String name)

Gets the first header value.

Parameters:

name - The header name.

Returns:

The value or null if none.

getHeaderValues

public java.lang.String[] getHeaderValues(java.lang.String name)

Gets all values for a header.

Parameters:

name - The header name.

Returns:

The values or null if none.

getHeaderValueList

public <any> getHeaderValueList(java.lang.String name)

Gets an immutable list of values for a header.

Parameters:

name - The header name.

Returns:

The values or null if none.

getHeader

public Header getHeader(java.lang.String name)

Gets a header.

Parameters:

name - The header name.

Returns:

The header or null if none.

getParameterValue

public java.lang.String getParameterValue(java.lang.String name)

Gets the first parameter value.

Parameters:

name - The parameter name.

Returns:

The value or null if none.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Gets all values for a parameter.

Parameters:

name - The parameter name.

Returns:

The values or null if none.

getParameterValueList

public <any> getParameterValueList(java.lang.String name)

Gets an immutable list of values for a parameter.

Parameters:

name - The parameter name.

Returns:

The immutable list of values.

getHeaders

public java.util.Collection<Header> getHeaders()

Gets all headers.

Returns:

An unmodifiable collection of headers.

getParameters

public java.util.Collection<Parameter> getParameters()

Gets all parameters.

Returns:

An unmodifiable collection of parameters.

getBody

public ByteString getBody()

Gets the request body, if any.

Returns:

The body, or null if none.

getContentType

public java.lang.String getContentType()

Gets the value of the Content-Type header.

Returns:

The content type, or null if none.

getCharset

public java.lang.String getCharset(java.lang.String defaultCharset)

Gets the charset specified with the request Content-Type header, if any.

Parameters:

defaultCharset - The default charset to return if none is specified in the header.

Returns:

The charset or the default charset.

isFormEncoded

public boolean isFormEncoded()

Determine if the request is encoded as a form application/x-www-form-urlencoded

Returns:

Is the request encoded as a form?

getRemoteAddr

public java.lang.String getRemoteAddr()

Gets the IP address of the client that sent the request.

Returns:

The IP address or null if unavailable.

getServerName

public java.lang.String getServerName()

Gets the server name (as specified in the Host header.

Returns:

The server name, excluding any port, or null if unspecified.

getPathComponents

public java.util.List<java.lang.String> getPathComponents()

Gets the components of the path (separated by '/').

Returns:

The path components, or empty list if none.

getPathComponents

public static final java.util.List<java.lang.String> getPathComponents(java.lang.String uri)
                                                                throws InvalidURIException

Gets the components of the path (separated by '/').

Parameters:

uri - The URI.

Returns:

The path components, or empty list if none.

Throws:

InvalidURIException - on invalid URI.

addHeaders

public Request addHeaders(java.util.Collection<Header> headers)

Adds headers to the existing headers, replacing any that are duplicated.

Parameters:

headers - The headers to add.

Returns:

The request with additional headers added.

bodyFromInputStream

public static final byte[] bodyFromInputStream(java.io.InputStream is,
                                               int maxBytesRead)
                                        throws java.io.IOException

Reads the request body from an input stream.

Reads the body up to the specified maximum number of bytes. If byte limit is exceeded, continues to read the rest of the stream, ignoring the data.

Parameters:

is - The input stream.

maxBytesRead - The maximum bytes read.

Returns:

The body.

Throws:

java.io.IOException - on input exception, or data limit exceeded.

parseParameters

public static final java.util.Map<java.lang.String,Parameter> parseParameters(java.lang.String queryString)

Parse parameters from a query string.

Case is ignored for all names - all are converted to lower-case.

Parameters:

queryString - The query string.

Returns:

The map of parameters.

parseParametersPreserveNameCase

public static final java.util.Map<java.lang.String,Parameter> parseParametersPreserveNameCase(java.lang.String queryString)

Parse parameters from a query string, preserving case in parameter names.

Parameters:

queryString - The query string.

Returns:

The map of parameters.

parseParameters

public static final java.util.Map<java.lang.String,Parameter> parseParameters(java.lang.String queryString,
                                                                              boolean caseSensitiveNames)

Parse parameters from a query string.

Query string should already be unescaped.

Parameters:

queryString - The query string.

caseSensitiveNames - Should case be preserved for parameter names?

Returns:

The map of parameters.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object