jsimple.oauth.model

Class OAuthRequest

java.lang.Object

jsimple.oauth.model.OAuthRequest

public class OAuthRequest
extends java.lang.Object

The representation of an OAuth HttpRequest.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
OAuthRequest(java.lang.String verb, java.lang.String url) Construct an OAuthRequest to apply to specified verb against the specified resource URL.
OAuthRequest(java.lang.String verb, java.lang.String baseUrl, TextualPath resourcePath) Construct an OAuthRequest to apply to specified verb against the specified resource.

Method Summary

Modifier and Type	Method and Description
void	addBodyParameter(java.lang.String key, java.lang.String value) Add a body Parameter (for POST/ PUT Requests)
void	addHeader(java.lang.String key, java.lang.String value) Add an HTTP Header to the Request
void	addOAuthParameter(java.lang.String key, java.lang.String value) Adds an OAuth parameter.
void	addPayload(byte[] payload) Overloaded version for byte arrays
void	addPayload(ByteArrayRange payload) Overloaded version for byte arrays
void	addPayload(File filePayload) Overloaded version for byte arrays
void	addPayload(java.lang.String payload) Add body payload.
void	addQueryStringParameter(java.lang.String key, java.lang.String value) Add a query string parameter
void	addQueryStringParameters(HttpRequestParams params) Add the passed parameters to the query string
ParameterList	getBodyParams() Obtains a ParameterList of the body parameters.
java.lang.String	getCompleteUrl() Returns the complete url (host + resource + encoded querystring parameters).
Map<java.lang.String,java.lang.String>	getHeaders() Returns the connection headers as a Map
Map<java.lang.String,java.lang.String>	getOauthParameters() Returns the Map containing the key-value pair of parameters.
ParameterList	getQueryStringParams() Get a ParameterList with the query string parameters.
java.lang.String	getSanitizedUrl() Returns the URL without the port and the query string part.
java.lang.String	getUrl() Obtains the URL of the HTTP request.
java.lang.String	getVerb() Returns the HTTP Verb
OAuthResponse	send() Execute the request and return a OAuthResponse
void	setTimeout(int timeoutInMillis) Sets the timeout for the underlying HttpRequest
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

OAuthRequest

public OAuthRequest(java.lang.String verb,
                    java.lang.String url)

Construct an OAuthRequest to apply to specified verb against the specified resource URL.

Parameters:

verb - HTTP verb/method

url - resource URL

OAuthRequest

public OAuthRequest(java.lang.String verb,
                    java.lang.String baseUrl,
                    TextualPath resourcePath)

Construct an OAuthRequest to apply to specified verb against the specified resource.

Parameters:

verb - HTTP verb/method

baseUrl - base URL, including server/port and optionally start of path; this should NOT end with a / character

resourcePath - path to resource on server, which will be appended to baseUrl

Method Detail

addOAuthParameter

public void addOAuthParameter(java.lang.String key,
                              java.lang.String value)

Adds an OAuth parameter.

Parameters:

key - name of the parameter

value - value of the parameter

Throws:

java.lang.IllegalArgumentException - if the parameter is not an OAuth parameter

getOauthParameters

public Map<java.lang.String,java.lang.String> getOauthParameters()

Returns the Map containing the key-value pair of parameters.

Returns:

parameters as map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

send

public OAuthResponse send()

Execute the request and return a OAuthResponse

Returns:

Http Response

Throws:

java.lang.RuntimeException - if the connection cannot be created.

getCompleteUrl

public java.lang.String getCompleteUrl()

Returns the complete url (host + resource + encoded querystring parameters).

Returns:

the complete url.

addHeader

public void addHeader(java.lang.String key,
                      java.lang.String value)

Add an HTTP Header to the Request

Parameters:

key - the header name

value - the header value

addBodyParameter

public void addBodyParameter(java.lang.String key,
                             java.lang.String value)

Add a body Parameter (for POST/ PUT Requests)

Parameters:

key - the parameter name

value - the parameter value

addQueryStringParameter

public void addQueryStringParameter(java.lang.String key,
                                    java.lang.String value)

Add a query string parameter

Parameters:

key - the parameter name

value - the parameter value

addQueryStringParameters

public void addQueryStringParameters(HttpRequestParams params)

Add the passed parameters to the query string

Parameters:

params - parameters

addPayload

public void addPayload(java.lang.String payload)

Add body payload.

This method is used when the HTTP body is not a form-url-encoded string, but another thing. Like for example XML.

Note: The contents are not part of the OAuth signature

Parameters:

payload - the body of the request

addPayload

public void addPayload(byte[] payload)

Overloaded version for byte arrays

Parameters:

payload -

addPayload

public void addPayload(ByteArrayRange payload)

Overloaded version for byte arrays

Parameters:

payload -

addPayload

public void addPayload(File filePayload)

Overloaded version for byte arrays

Parameters:

filePayload -

getQueryStringParams

public ParameterList getQueryStringParams()

Get a ParameterList with the query string parameters.

Returns:

a ParameterList containing the query string parameters.

Throws:

OAuthException - if the request URL is not valid.

getBodyParams

public ParameterList getBodyParams()

Obtains a ParameterList of the body parameters.

Returns:

a ParameterListcontaining the body parameters.

getUrl

public java.lang.String getUrl()

Obtains the URL of the HTTP request.

Returns:

the original URL of the HTTP request

getSanitizedUrl

public java.lang.String getSanitizedUrl()

Returns the URL without the port and the query string part.

Returns:

the OAuth-sanitized URL

getVerb

public java.lang.String getVerb()

Returns the HTTP Verb

Returns:

the verb

getHeaders

public Map<java.lang.String,java.lang.String> getHeaders()

Returns the connection headers as a Map

Returns:

map of headers

setTimeout

public void setTimeout(int timeoutInMillis)

Sets the timeout for the underlying HttpRequest

Parameters:

timeoutInMillis - duration of the timeout