org.miniauth.common

Class IncomingRequest

java.lang.Object

org.miniauth.common.RequestBase

org.miniauth.common.IncomingRequest

All Implemented Interfaces:

Serializable

public abstract class IncomingRequest
extends RequestBase

Provider side request, which is sent by a client. Note that IncomingRequest does not represent a full request. It's just a partial wrapper for attributes that are needed for auth handling. [ The "life cycle" of IncomingRequest ] IncomingRequest goes through a similar life cycle as OutgoingRequest. However, its requirement is not as strict as that of OutgoingRequest. It starts with an "init" or constructed state. Once necessary attributes have been added, the object can be declared as being "ready". If the request is in a ready state, then it can be made "verified". Even after setVerified() is called, however, its internal attributes can be modified, in which case, the verified flag is set back to false.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IncomingRequest()
protected	IncomingRequest(RequestBase request)
protected	IncomingRequest(String httpMethod, URI baseURI)
protected	IncomingRequest(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)
abstract 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.).
boolean	isReady() Returns true if the request is in a state where it can be verified.
boolean	isVerified() Returns true if this request has been verified.
abstract 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	setAuthHeaderAuthorizationString(String authHeaderAuthString, String expectedAuthScheme)
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)
protected void	setReady(boolean ready) Sets the "ready" state.
void	setVerified(boolean verified)
IncomingRequest	verify() Put this request object in a "verified" state.

Methods inherited from class org.miniauth.common.RequestBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IncomingRequest

protected IncomingRequest()

IncomingRequest

protected IncomingRequest(String httpMethod,
               URI baseURI)

IncomingRequest

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

IncomingRequest

protected IncomingRequest(RequestBase request)

Method Detail

setHttpMethod

protected RequestBase setHttpMethod(String httpMethod)
                             throws MiniAuthException

Overrides:

setHttpMethod in class RequestBase

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(URI baseURI)
                          throws MiniAuthException

Overrides:

setBaseURI in class RequestBase

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(BaseURIInfo uriInfo)
                          throws MiniAuthException

Overrides:

setBaseURI in class RequestBase

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(String baseUri)
                          throws MiniAuthException

Overrides:

setBaseURI in class RequestBase

Throws:

MiniAuthException

setAuthHeader

protected RequestBase setAuthHeader(String authHeader)
                             throws MiniAuthException

Overrides:

setAuthHeader in class RequestBase

Throws:

MiniAuthException

setAuthHeaderAuthorizationString

protected RequestBase setAuthHeaderAuthorizationString(String authHeaderAuthString,
                                           String expectedAuthScheme)
                                                throws MiniAuthException

Overrides:

setAuthHeaderAuthorizationString in class RequestBase

Throws:

MiniAuthException

setAuthHeaderAuthorizationString

protected RequestBase setAuthHeaderAuthorizationString(String authHeaderAuthString)
                                                throws MiniAuthException

Overrides:

setAuthHeaderAuthorizationString in class RequestBase

Throws:

MiniAuthException

setAuthHeader

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

Overrides:

setAuthHeader in class RequestBase

Throws:

MiniAuthException

addAuthHeaderParam

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

Overrides:

addAuthHeaderParam in class RequestBase

Throws:

MiniAuthException

setFormParams

protected RequestBase setFormParams(String formBody)
                             throws MiniAuthException

Overrides:

setFormParams in class RequestBase

Throws:

MiniAuthException

setFormParams

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

Overrides:

setFormParams in class RequestBase

Throws:

MiniAuthException

addFormParams

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

Overrides:

addFormParams in class RequestBase

Throws:

MiniAuthException

addFormParam

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

Overrides:

addFormParam in class RequestBase

Throws:

MiniAuthException

setQueryParams

protected RequestBase setQueryParams(String queryString)
                              throws MiniAuthException

Overrides:

setQueryParams in class RequestBase

Throws:

MiniAuthException

setQueryParams

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

Overrides:

setQueryParams in class RequestBase

Throws:

MiniAuthException

addQueryParams

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

Overrides:

addQueryParams in class RequestBase

Throws:

MiniAuthException

addQueryParam

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

Overrides:

addQueryParam in class RequestBase

Throws:

MiniAuthException

prepare

public abstract 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.

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. (It does not actually "verify" anything.) This is the second of the two "state changing" operations. This can be called only if the current state == ready.

Returns:

this object.

Throws:

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

isReady

public boolean isReady()

Returns true if the request is in a state where it can be verified.

Specified by:

isReady in class RequestBase

Returns:

true if it is ready for verification.

setReady

protected void setReady(boolean ready)

Sets the "ready" state. If it is true, then it can be endorsed.

Parameters:

ready - The ready state of this request.

isVerified

public boolean isVerified()

Returns true if this request has been verified. (e.g., if its oauth_signature param has been verified in the case of OAuth, etc.).

Returns:

the "verification" state of this request.

setVerified

public void setVerified(boolean verified)

isEndorsed

public abstract boolean isEndorsed()
                            throws MiniAuthException

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

Returns:

the "endorsement" state of this request.

Throws:

MiniAuthException - TODO