org.miniauth.oauth.common

Class OAuthIncomingRequest

java.lang.Object

org.miniauth.common.RequestBase

org.miniauth.common.IncomingRequest

org.miniauth.oauth.common.OAuthIncomingRequest

All Implemented Interfaces:

Serializable

public class OAuthIncomingRequest
extends IncomingRequest

Provider side request, which is sent by a client, for services that use OAuth. Note that OAuthIncomingRequest does not represent a full request. It's just a partial wrapper for attributes that are needed for OAuth signature verification.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OAuthIncomingRequest()
protected	OAuthIncomingRequest(RequestBase request)
protected	OAuthIncomingRequest(String httpMethod, URI baseURI)
protected	OAuthIncomingRequest(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)
void	buildOAuthParamMap()
AccessIdentity	getAccessIdentity()
String	getAccessToken()
String	getAuthHeaderAuthorizationString()
String	getAuthParamTransmissionType()
String	getConumserKey()
OAuthParamMap	getOAuthParamMap()
protected void	initAuthParamTransmissionType()
boolean	isEndorsed() Returns true if this incoming request has been "endorsed" (e.g., by the client/caller) (e.g., if it includes the oauth_signature param in the case of OAuth, etc.).
IncomingRequest	prepare() Put this request object in a "ready" state.
protected RequestBase	setAuthHeader(Map<String,String> authHeader)
protected RequestBase	setAuthHeader(String authHeader)
protected RequestBase	setAuthHeaderAuthorizationString(String authHeaderAuthString)
protected RequestBase	setBaseURI(BaseURIInfo uriInfo)
protected RequestBase	setBaseURI(String baseUri)
protected RequestBase	setBaseURI(URI baseURI)
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()
IncomingRequest	verify() Put this request object in a "verified" state.

Methods inherited from class org.miniauth.common.IncomingRequest

isReady, isVerified, setAuthHeaderAuthorizationString, setReady, setVerified

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

OAuthIncomingRequest

protected OAuthIncomingRequest()

OAuthIncomingRequest

protected OAuthIncomingRequest(String httpMethod,
                    URI baseURI)

OAuthIncomingRequest

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

OAuthIncomingRequest

protected OAuthIncomingRequest(RequestBase request)

Method Detail

getAccessIdentity

public AccessIdentity getAccessIdentity()
                                 throws MiniAuthException

Throws:

MiniAuthException

getConumserKey

public String getConumserKey()
                      throws MiniAuthException

Throws:

MiniAuthException

getAccessToken

public String getAccessToken()
                      throws MiniAuthException

Throws:

MiniAuthException

initAuthParamTransmissionType

protected void initAuthParamTransmissionType()

getAuthParamTransmissionType

public String getAuthParamTransmissionType()

buildOAuthParamMap

public void buildOAuthParamMap()
                        throws MiniAuthException

Throws:

MiniAuthException

getOAuthParamMap

public OAuthParamMap getOAuthParamMap()

prepare

public IncomingRequest prepare()
                        throws MiniAuthException

Put this request object in a "ready" state. The request object can be verified only if it's in a ready state.

Specified by:

prepare in class IncomingRequest

Returns:

this object.

Throws:

MiniAuthException - if preparation fails, or the object cannot be put into the "ready" state.

verify

public IncomingRequest verify()
                       throws MiniAuthException

Put this request object in a "verified" state. This is the second of the two "state changing" operations. This can be called only if the current state == ready. Note that it does not actually "verify" anything. The verification should be done by the caller.

Overrides:

verify in class IncomingRequest

Returns:

this object.

Throws:

MiniAuthException - if the IncomingRequest cannot be put into the "verified" state.

isEndorsed

public boolean isEndorsed()
                   throws MiniAuthException

Returns true if this incoming request has been "endorsed" (e.g., by the client/caller) (e.g., if it includes the oauth_signature param in the case of OAuth, etc.). Endorsed==true does not mean it's verified.

Specified by:

isEndorsed in class IncomingRequest

Returns:

the "endorsement" state of this request.

Throws:

MiniAuthException

getAuthHeaderAuthorizationString

public String getAuthHeaderAuthorizationString()

Specified by:

getAuthHeaderAuthorizationString in class RequestBase

setHttpMethod

protected RequestBase setHttpMethod(String httpMethod)
                             throws MiniAuthException

Overrides:

setHttpMethod in class IncomingRequest

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(URI baseURI)
                          throws MiniAuthException

Overrides:

setBaseURI in class IncomingRequest

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(String baseUri)
                          throws MiniAuthException

Overrides:

setBaseURI in class IncomingRequest

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(BaseURIInfo uriInfo)
                          throws MiniAuthException

Overrides:

setBaseURI in class IncomingRequest

Throws:

MiniAuthException

setAuthHeader

protected RequestBase setAuthHeader(String authHeader)
                             throws MiniAuthException

Overrides:

setAuthHeader in class IncomingRequest

Throws:

MiniAuthException

setAuthHeaderAuthorizationString

protected RequestBase setAuthHeaderAuthorizationString(String authHeaderAuthString)
                                                throws MiniAuthException

Overrides:

setAuthHeaderAuthorizationString in class IncomingRequest

Throws:

MiniAuthException

setAuthHeader

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

Overrides:

setAuthHeader in class IncomingRequest

Throws:

MiniAuthException

addAuthHeaderParam

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

Overrides:

addAuthHeaderParam in class IncomingRequest

Throws:

MiniAuthException

setFormParams

protected RequestBase setFormParams(String formBody)
                             throws MiniAuthException

Overrides:

setFormParams in class IncomingRequest

Throws:

MiniAuthException

setFormParams

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

Overrides:

setFormParams in class IncomingRequest

Throws:

MiniAuthException

addFormParams

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

Overrides:

addFormParams in class IncomingRequest

Throws:

MiniAuthException

addFormParam

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

Overrides:

addFormParam in class IncomingRequest

Throws:

MiniAuthException

setQueryParams

protected RequestBase setQueryParams(String queryString)
                              throws MiniAuthException

Overrides:

setQueryParams in class IncomingRequest

Throws:

MiniAuthException

setQueryParams

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

Overrides:

setQueryParams in class IncomingRequest

Throws:

MiniAuthException

addQueryParams

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

Overrides:

addQueryParams in class IncomingRequest

Throws:

MiniAuthException

addQueryParam

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

Overrides:

addQueryParam in class IncomingRequest

Throws:

MiniAuthException

toString

public String toString()

Overrides:

toString in class RequestBase