org.miniauth.oauth.common

Class OAuthOutgoingRequest

java.lang.Object

org.miniauth.common.RequestBase

org.miniauth.common.OutgoingRequest

org.miniauth.oauth.common.OAuthOutgoingRequest

All Implemented Interfaces:

Serializable

public class OAuthOutgoingRequest
extends OutgoingRequest

Client side request, which is being built by the client, for services that require OAuth. Note that OAuthOutgoingRequest does not represent a full request. It's just a partial wrapper for attributes that are needed for OAuth signing.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OAuthOutgoingRequest()
protected	OAuthOutgoingRequest(RequestBase request)
protected	OAuthOutgoingRequest(String httpMethod, URI baseURI)
protected	OAuthOutgoingRequest(String httpMethod, URI baseURI, Map<String,String> authHeader, Map<String,String[]> formParams, Map<String,String[]> queryParams)

Method Summary

Methods

Modifier and Type	Method and Description
protected RequestBase	addAuthHeaderParam(String key, String value)
protected RequestBase	addFormParam(String key, String value)
protected RequestBase	addFormParams(Map<String,String[]> formParams)
protected RequestBase	addQueryParam(String key, String value)
protected RequestBase	addQueryParams(Map<String,String[]> queryParams)
protected void	buildOAuthParamMap()
protected void	buildOAuthParamMap(AccessIdentity accessIdentity)
void	endorse(OAuthParamMap oauthParamMap)
OutgoingRequest	endorse(String signature) "Sign" this request object, and put this request in a "endorsed" state.
AccessIdentity	getAccessIdentity()
String	getAccessToken()
String	getAuthHeaderAuthorizationString()
String	getAuthParamTransmissionType()
String	getConumserKey()
OAuthParamMap	getOauthParamMap()
protected void	initAuthParamTransmissionType()
boolean	isEndorsed() Returns true if this request has been "endorsed" (e.g., if it includes the oauth_signature param in the case of OAuth, etc.).
HttpURLConnection	openEndorsedURLConnection() Opens an HttpURLConnection based on this outgoing request information.
OutgoingRequest	prepare(AccessIdentity accessIdentity) Put this request object in a "ready" state.
protected OAuthOutgoingRequest	setAccessIdentity(AccessIdentity accessIdentity)
protected OAuthOutgoingRequest	setAccessToken(String accessToken)
protected RequestBase	setAuthHeader(Map<String,String> authHeader)
protected RequestBase	setAuthHeader(String authHeader)
protected RequestBase	setAuthHeaderAuthorizationString(String authHeaderAuthString)
protected void	setAuthParamTransmissionType(String authParamTransmissionType)
protected RequestBase	setBaseURI(BaseURIInfo uriInfo)
protected RequestBase	setBaseURI(String baseUri)
protected RequestBase	setBaseURI(URI baseURI)
protected OAuthOutgoingRequest	setConsumerKey(String consumerKey)
protected void	setEndorsed(boolean endorsed)
protected RequestBase	setFormParams(Map<String,String[]> formParams)
protected RequestBase	setFormParams(String formBody)
protected RequestBase	setHttpMethod(String httpMethod)
protected RequestBase	setQueryParams(Map<String,String[]> queryParams)
protected RequestBase	setQueryParams(String queryString)
String	toString()

Methods inherited from class org.miniauth.common.OutgoingRequest

isReady, setAuthHeaderAuthorizationString, setReady

Methods inherited from class org.miniauth.common.RequestBase

getAuthHeader, getAuthHeaderAuthorizationString, getAuthHeaderString, getBaseURI, getBaseURIInfo, getBaseURIString, getBaseURL, getFormParams, getFormParamString, getHttpMethod, getQueryParams, getQueryParamString, getURI, getURIString, getURL

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthOutgoingRequest

protected OAuthOutgoingRequest()

OAuthOutgoingRequest

protected OAuthOutgoingRequest(String httpMethod,
                    URI baseURI)

OAuthOutgoingRequest

protected OAuthOutgoingRequest(String httpMethod,
                    URI baseURI,
                    Map<String,String> authHeader,
                    Map<String,String[]> formParams,
                    Map<String,String[]> queryParams)

OAuthOutgoingRequest

protected OAuthOutgoingRequest(RequestBase request)

Method Detail

getAccessIdentity

public AccessIdentity getAccessIdentity()
                                 throws MiniAuthException

Throws:

MiniAuthException

setAccessIdentity

protected OAuthOutgoingRequest setAccessIdentity(AccessIdentity accessIdentity)
                                          throws MiniAuthException

Throws:

MiniAuthException

getConumserKey

public String getConumserKey()
                      throws MiniAuthException

Throws:

MiniAuthException

setConsumerKey

protected OAuthOutgoingRequest setConsumerKey(String consumerKey)
                                       throws MiniAuthException

Throws:

MiniAuthException

getAccessToken

public String getAccessToken()
                      throws MiniAuthException

Throws:

MiniAuthException

setAccessToken

protected OAuthOutgoingRequest setAccessToken(String accessToken)
                                       throws MiniAuthException

Throws:

MiniAuthException

initAuthParamTransmissionType

protected void initAuthParamTransmissionType()

setAuthParamTransmissionType

protected void setAuthParamTransmissionType(String authParamTransmissionType)
                                     throws MiniAuthException

Throws:

MiniAuthException

getAuthParamTransmissionType

public String getAuthParamTransmissionType()

buildOAuthParamMap

protected void buildOAuthParamMap()
                           throws MiniAuthException

Throws:

MiniAuthException

buildOAuthParamMap

protected void buildOAuthParamMap(AccessIdentity accessIdentity)
                           throws MiniAuthException

Throws:

MiniAuthException

getOauthParamMap

public OAuthParamMap getOauthParamMap()

prepare

public OutgoingRequest prepare(AccessIdentity accessIdentity)
                        throws MiniAuthException

Put this request object in a "ready" state. This is the first of the two "state changing" operations.

Specified by:

prepare in class OutgoingRequest

Parameters:

accessIdentity - A pair of consumer key/token to use in "preparing" this request.

Returns:

this object.

Throws:

MiniAuthException

endorse

public void endorse(OAuthParamMap oauthParamMap)
             throws MiniAuthException

Throws:

MiniAuthException

endorse

public OutgoingRequest endorse(String signature)
                        throws MiniAuthException

"Sign" this request object, and put this request in a "endorsed" state. This is the second of the two "state changing" operations. This can be called only if the current state == ready.

Specified by:

endorse in class OutgoingRequest

Parameters:

signature - Signature to use for signing this request.

Returns:

this object.

Throws:

MiniAuthException

isEndorsed

public boolean isEndorsed()

Returns true if this request has been "endorsed" (e.g., if it includes the oauth_signature param in the case of OAuth, etc.). Note that the request can be endorsed only if it is "ready". Also, once it's endorsed, it cannot be endorsed again or it cannot be changed.

Specified by:

isEndorsed in class OutgoingRequest

Returns:

the "endorsement" state of this request.

setEndorsed

protected void setEndorsed(boolean endorsed)

getAuthHeaderAuthorizationString

public String getAuthHeaderAuthorizationString()

Specified by:

getAuthHeaderAuthorizationString in class RequestBase

setHttpMethod

protected RequestBase setHttpMethod(String httpMethod)
                             throws MiniAuthException

Overrides:

setHttpMethod in class OutgoingRequest

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(URI baseURI)
                          throws MiniAuthException

Overrides:

setBaseURI in class OutgoingRequest

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(String baseUri)
                          throws MiniAuthException

Overrides:

setBaseURI in class OutgoingRequest

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(BaseURIInfo uriInfo)
                          throws MiniAuthException

Overrides:

setBaseURI in class OutgoingRequest

Throws:

MiniAuthException

setAuthHeader

protected RequestBase setAuthHeader(String authHeader)
                             throws MiniAuthException

Overrides:

setAuthHeader in class OutgoingRequest

Throws:

MiniAuthException

setAuthHeaderAuthorizationString

protected RequestBase setAuthHeaderAuthorizationString(String authHeaderAuthString)
                                                throws MiniAuthException

Overrides:

setAuthHeaderAuthorizationString in class OutgoingRequest

Throws:

MiniAuthException

setAuthHeader

protected RequestBase setAuthHeader(Map<String,String> authHeader)
                             throws MiniAuthException

Overrides:

setAuthHeader in class OutgoingRequest

Throws:

MiniAuthException

addAuthHeaderParam

protected RequestBase addAuthHeaderParam(String key,
                             String value)
                                  throws MiniAuthException

Overrides:

addAuthHeaderParam in class OutgoingRequest

Throws:

MiniAuthException

setFormParams

protected RequestBase setFormParams(String formBody)
                             throws MiniAuthException

Overrides:

setFormParams in class OutgoingRequest

Throws:

MiniAuthException

setFormParams

protected RequestBase setFormParams(Map<String,String[]> formParams)
                             throws MiniAuthException

Overrides:

setFormParams in class OutgoingRequest

Throws:

MiniAuthException

addFormParams

protected RequestBase addFormParams(Map<String,String[]> formParams)
                             throws MiniAuthException

Overrides:

addFormParams in class OutgoingRequest

Throws:

MiniAuthException

addFormParam

protected RequestBase addFormParam(String key,
                       String value)
                            throws MiniAuthException

Overrides:

addFormParam in class OutgoingRequest

Throws:

MiniAuthException

setQueryParams

protected RequestBase setQueryParams(String queryString)
                              throws MiniAuthException

Overrides:

setQueryParams in class OutgoingRequest

Throws:

MiniAuthException

setQueryParams

protected RequestBase setQueryParams(Map<String,String[]> queryParams)
                              throws MiniAuthException

Overrides:

setQueryParams in class OutgoingRequest

Throws:

MiniAuthException

addQueryParams

protected RequestBase addQueryParams(Map<String,String[]> queryParams)
                              throws MiniAuthException

Overrides:

addQueryParams in class OutgoingRequest

Throws:

MiniAuthException

addQueryParam

protected RequestBase addQueryParam(String key,
                        String value)
                             throws MiniAuthException

Overrides:

addQueryParam in class OutgoingRequest

Throws:

MiniAuthException

openEndorsedURLConnection

public HttpURLConnection openEndorsedURLConnection()
                                            throws MiniAuthException,
                                                   IOException

Opens an HttpURLConnection based on this outgoing request information.

Returns:

the HttpURLConnection opened from the URL specified by this request.

Throws:

MiniAuthException

IOException

toString

public String toString()

Overrides:

toString in class RequestBase