com.sun.jersey.oauth.signature

Interface OAuthRequest

All Known Implementing Classes:

OAuthServerRequest

public interface OAuthRequest

Interface to be implemented as a wrapper around an HTTP request, so that digital signature can be generated and/or verified.

Author:

Paul C. Bryan

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeaderValue(String name, String value) Adds a header with the given name and value.
List<String>	getHeaderValues(String name) Returns the value(s) of the specified request header.
Set<String>	getParameterNames() Returns an Set of String objects containing the names of the parameters contained in the request.
List<String>	getParameterValues(String name) Returns an List of String objects containing the values of the specified request parameter, or null if the parameter does not exist.
String	getRequestMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
URL	getRequestURL() Returns the URL of the request, including protocol, server name, optional port number, and server path.

Method Detail

getRequestMethod

String getRequestMethod()

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

Returns:

the name of the method with which this request was made.

getRequestURL

URL getRequestURL()

Returns the URL of the request, including protocol, server name, optional port number, and server path.

Returns:

the request URL.

getParameterNames

Set<String> getParameterNames()

Returns an Set of String objects containing the names of the parameters contained in the request.

Returns:

the names of the parameters.

getParameterValues

List<String> getParameterValues(String name)

Returns an List of String objects containing the values of the specified request parameter, or null if the parameter does not exist. For HTTP requests, parameters are contained in the query string and/or posted form data.

Parameters:

name - the name of the parameter.

Returns:

the values of the parameter.

getHeaderValues

List<String> getHeaderValues(String name)

Returns the value(s) of the specified request header. If the request did not include a header of the specified name, this method returns null.

Parameters:

name - the header name.

Returns:

the value(s) of the requested header, or null if none exist.

addHeaderValue

void addHeaderValue(String name,
                  String value)
                    throws IllegalStateException

Adds a header with the given name and value.

Parameters:

name - the name of the header.

value - the header value.

Throws:

IllegalStateException - if this method cannot be implemented.