org.miniauth.common

Class RequestBase

java.lang.Object

org.miniauth.common.RequestBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IncomingRequest, OutgoingRequest

public abstract class RequestBase
extends Object
implements Serializable

Base class for "Incoming" and "Outgoing" request beans.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestBase()
protected	RequestBase(RequestBase request)
protected	RequestBase(String httpMethod, URI baseURI)
protected	RequestBase(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)
Map<String,String>	getAuthHeader()
abstract String	getAuthHeaderAuthorizationString()
protected String	getAuthHeaderAuthorizationString(String authScheme)
String	getAuthHeaderString()
URI	getBaseURI()
BaseURIInfo	getBaseURIInfo()
String	getBaseURIString()
URL	getBaseURL()
Map<String,String[]>	getFormParams()
String	getFormParamString()
String	getHttpMethod()
Map<String,String[]>	getQueryParams()
String	getQueryParamString()
URI	getURI()
String	getURIString()
URL	getURL()
abstract boolean	isReady() Returns true if the request is in a state where the main operations can be performed.
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)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestBase

protected RequestBase()

RequestBase

protected RequestBase(String httpMethod,
           URI baseURI)

RequestBase

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

RequestBase

protected RequestBase(RequestBase request)

Method Detail

getHttpMethod

public String getHttpMethod()

setHttpMethod

protected RequestBase setHttpMethod(String httpMethod)
                             throws MiniAuthException

Throws:

MiniAuthException

getBaseURI

public URI getBaseURI()

getBaseURL

public URL getBaseURL()

getBaseURIInfo

public BaseURIInfo getBaseURIInfo()

getBaseURIString

public String getBaseURIString()

getURI

public URI getURI()

getURL

public URL getURL()

getURIString

public String getURIString()

setBaseURI

protected RequestBase setBaseURI(URI baseURI)
                          throws MiniAuthException

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(BaseURIInfo uriInfo)
                          throws MiniAuthException

Throws:

MiniAuthException

setBaseURI

protected RequestBase setBaseURI(String baseUri)
                          throws MiniAuthException

Throws:

MiniAuthException

getAuthHeader

public Map<String,String> getAuthHeader()

getAuthHeaderString

public String getAuthHeaderString()

getAuthHeaderAuthorizationString

public abstract String getAuthHeaderAuthorizationString()

getAuthHeaderAuthorizationString

protected String getAuthHeaderAuthorizationString(String authScheme)

setAuthHeader

protected RequestBase setAuthHeader(String authHeader)
                             throws MiniAuthException

Throws:

MiniAuthException

setAuthHeaderAuthorizationString

protected RequestBase setAuthHeaderAuthorizationString(String authHeaderAuthString)
                                                throws MiniAuthException

Throws:

MiniAuthException

setAuthHeaderAuthorizationString

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

Throws:

MiniAuthException

setAuthHeader

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

Throws:

MiniAuthException

addAuthHeaderParam

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

Throws:

MiniAuthException

getFormParams

public Map<String,String[]> getFormParams()

getFormParamString

public String getFormParamString()

setFormParams

protected RequestBase setFormParams(String formBody)
                             throws MiniAuthException

Throws:

MiniAuthException

setFormParams

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

Throws:

MiniAuthException

addFormParams

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

Throws:

MiniAuthException

addFormParam

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

Throws:

MiniAuthException

getQueryParams

public Map<String,String[]> getQueryParams()

getQueryParamString

public String getQueryParamString()

setQueryParams

protected RequestBase setQueryParams(String queryString)
                              throws MiniAuthException

Throws:

MiniAuthException

setQueryParams

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

Throws:

MiniAuthException

addQueryParams

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

Throws:

MiniAuthException

addQueryParam

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

Throws:

MiniAuthException

isReady

public abstract boolean isReady()

Returns true if the request is in a state where the main operations can be performed. Its meaning changes depending on whether this object is an instanceOf IncomingRequest or OutgoingRequest.

Returns:

true if it is ready.

toString

public String toString()

Overrides:

toString in class Object