net.oauth.server

Class HttpRequestMessage

java.lang.Object

net.oauth.OAuthMessage

net.oauth.server.HttpRequestMessage

public class HttpRequestMessage
extends OAuthMessage

An HttpServletRequest, encapsulated as an OAuthMessage.

Author:

John Kristian

Field Summary

Fields inherited from class net.oauth.OAuthMessage

AUTH_SCHEME, DELETE, GET, method, POST, PUT, URL

Constructor Summary

Constructors

Constructor and Description
HttpRequestMessage(javax.servlet.http.HttpServletRequest request, String URL)

Method Summary

Modifier and Type	Method and Description
InputStream	getBodyAsStream() Get a stream from which to read the body of the HTTP request or response.
String	getBodyEncoding() The character encoding of the body of this message.
static List<OAuth.Parameter>	getParameters(javax.servlet.http.HttpServletRequest request)

Methods inherited from class net.oauth.OAuthMessage

addParameter, addParameter, addParameters, addRequiredParameters, completeParameters, decodeAuthorization, dump, getAuthorizationHeader, getBodyType, getConsumerKey, getDump, getHeader, getHeaders, getParameter, getParameterMap, getParameters, getSignature, getSignatureMethod, getToken, readAll, readBodyAsString, requireParameters, sign, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequestMessage

public HttpRequestMessage(javax.servlet.http.HttpServletRequest request,
                          String URL)

Method Detail

getBodyAsStream

public InputStream getBodyAsStream()
                            throws IOException

Description copied from class: OAuthMessage

Get a stream from which to read the body of the HTTP request or response. This is designed to support efficient streaming of a large message. The caller must close the returned stream, to release the underlying resources such as the TCP connection for an HTTP response.

Overrides:

getBodyAsStream in class OAuthMessage

Returns:

a stream from which to read the body, or null to indicate there is no body.

Throws:

IOException

getBodyEncoding

public String getBodyEncoding()

Description copied from class: OAuthMessage

The character encoding of the body of this message.

Overrides:

getBodyEncoding in class OAuthMessage

Returns:

the name of an encoding, or "ISO-8859-1" if no charset has been specified.

getParameters

public static List<OAuth.Parameter> getParameters(javax.servlet.http.HttpServletRequest request)