org.miniauth.common

Class OutgoingRequest

java.lang.Object

org.miniauth.common.RequestBase

org.miniauth.common.OutgoingRequest

All Implemented Interfaces:

Serializable

public abstract class OutgoingRequest
extends RequestBase

Client side request, which is being built by the client. Note that OutgoingRequest does not represent a full request. It's just a partial wrapper for attributes that are needed for auth handling. [ The "life cycle" of OutgoingRequest ] The request starts with an "init" state. Once all necessary attributes are added, the request can be put into a "ready" state. This can be accomplished by calling prepare() (depending on the implementation of a subclass). Generally, prepare() can be called more than once, if necessary (that is, because the object attributes have changed since the last prepare() call). Once the OutgoingRequest is in a ready state, one can call endorse(), which adds a signature, etc. to the request object (in the case of OAuth). If it is endorsed, then the OutgoingRequest object can no longer be changed. One can only get/retrieve relevant parameters from the object.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OutgoingRequest()
protected	OutgoingRequest(RequestBase request)
protected	OutgoingRequest(String httpMethod, URI baseURI)
protected	OutgoingRequest(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 OutgoingRequest	endorse(String signature) Put this request object in a "endorsed" state.
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 endorsed.
abstract OutgoingRequest	prepare(AccessIdentity accessIdentity) 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.

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

OutgoingRequest

protected OutgoingRequest()

OutgoingRequest

protected OutgoingRequest(String httpMethod,
               URI baseURI)

OutgoingRequest

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

OutgoingRequest

protected OutgoingRequest(RequestBase request)

Method Detail

isReady

public boolean isReady()

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

Specified by:

isReady in class RequestBase

Returns:

true if it is ready for endorsement.

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.

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(String 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

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 OutgoingRequest prepare(AccessIdentity accessIdentity)
                                 throws MiniAuthException

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

Parameters:

accessIdentity - Auth identity to use in "preparing" this request.

Returns:

this object.

Throws:

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

endorse

public abstract OutgoingRequest endorse(String signature)
                                 throws MiniAuthException

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

Parameters:

signature - Signature to use for endorsing. Could be null, if the auth scheme does not require signature.

Returns:

this object.

Throws:

MiniAuthException - if endorsement fails.

isEndorsed

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

Returns:

the "endorsement" state of this request.