public abstract class IncomingRequest extends RequestBase
| 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) |
| 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.
|
getAuthHeader, getAuthHeaderAuthorizationString, getAuthHeaderAuthorizationString, getAuthHeaderString, getBaseURI, getBaseURIInfo, getBaseURIString, getBaseURL, getFormParams, getFormParamString, getHttpMethod, getQueryParams, getQueryParamString, getURI, getURIString, getURL, toStringprotected IncomingRequest()
protected IncomingRequest(String httpMethod, URI baseURI, Map<String,String> authHeader, Map<String,String[]> formParams, Map<String,String[]> queryParams)
protected IncomingRequest(RequestBase request)
protected RequestBase setHttpMethod(String httpMethod) throws MiniAuthException
setHttpMethod in class RequestBaseMiniAuthExceptionprotected RequestBase setBaseURI(URI baseURI) throws MiniAuthException
setBaseURI in class RequestBaseMiniAuthExceptionprotected RequestBase setBaseURI(BaseURIInfo uriInfo) throws MiniAuthException
setBaseURI in class RequestBaseMiniAuthExceptionprotected RequestBase setBaseURI(String baseUri) throws MiniAuthException
setBaseURI in class RequestBaseMiniAuthExceptionprotected RequestBase setAuthHeader(String authHeader) throws MiniAuthException
setAuthHeader in class RequestBaseMiniAuthExceptionprotected RequestBase setAuthHeaderAuthorizationString(String authHeaderAuthString, String expectedAuthScheme) throws MiniAuthException
setAuthHeaderAuthorizationString in class RequestBaseMiniAuthExceptionprotected RequestBase setAuthHeaderAuthorizationString(String authHeaderAuthString) throws MiniAuthException
setAuthHeaderAuthorizationString in class RequestBaseMiniAuthExceptionprotected RequestBase setAuthHeader(Map<String,String> authHeader) throws MiniAuthException
setAuthHeader in class RequestBaseMiniAuthExceptionprotected RequestBase addAuthHeaderParam(String key, String value) throws MiniAuthException
addAuthHeaderParam in class RequestBaseMiniAuthExceptionprotected RequestBase setFormParams(String formBody) throws MiniAuthException
setFormParams in class RequestBaseMiniAuthExceptionprotected RequestBase setFormParams(Map<String,String[]> formParams) throws MiniAuthException
setFormParams in class RequestBaseMiniAuthExceptionprotected RequestBase addFormParams(Map<String,String[]> formParams) throws MiniAuthException
addFormParams in class RequestBaseMiniAuthExceptionprotected RequestBase addFormParam(String key, String value) throws MiniAuthException
addFormParam in class RequestBaseMiniAuthExceptionprotected RequestBase setQueryParams(String queryString) throws MiniAuthException
setQueryParams in class RequestBaseMiniAuthExceptionprotected RequestBase setQueryParams(Map<String,String[]> queryParams) throws MiniAuthException
setQueryParams in class RequestBaseMiniAuthExceptionprotected RequestBase addQueryParams(Map<String,String[]> queryParams) throws MiniAuthException
addQueryParams in class RequestBaseMiniAuthExceptionprotected RequestBase addQueryParam(String key, String value) throws MiniAuthException
addQueryParam in class RequestBaseMiniAuthExceptionpublic abstract IncomingRequest prepare() throws MiniAuthException
MiniAuthException - if preparation fails, or the object cannot be put into the "ready" state.public IncomingRequest verify() throws MiniAuthException
MiniAuthException - if the IncomingRequest cannot be put into the "verified" state.public boolean isReady()
isReady in class RequestBaseprotected void setReady(boolean ready)
ready - The ready state of this request.public boolean isVerified()
public void setVerified(boolean verified)
public abstract boolean isEndorsed()
throws MiniAuthException
MiniAuthException - TODOCopyright © 2013. All rights reserved.