| Package | Description |
|---|---|
| org.miniauth.basic.builder |
MiniAuth Basic-auth builder classes.
|
| org.miniauth.builder |
MiniAuth Core module Builder package.
|
| org.miniauth.common |
Package for common classes.
|
| org.miniauth.exception |
Package for various exception types.
|
| org.miniauth.service |
Package for "request wrapper" related interfaces/classes.
|
| org.miniauth.signature |
Signature-related Package.
|
| org.miniauth.util |
Package for various utility classes, for example,
for parsing form params or for base64 encoding/decoding strings.
|
| Modifier and Type | Method and Description |
|---|---|
String |
BasicAuthStringBuilder.generateAuthorizationString(String transmissionType,
Map<String,String> authCredential,
String httpMethod,
URI baseURI,
Map<String,String> authHeader,
Map<String,String[]> requestParams) |
String |
BasicAuthStringBuilder.generateAuthorizationString(String transmissionType,
Map<String,String> authCredential,
String httpMethod,
URI baseURI,
Map<String,String> authHeader,
Map<String,String[]> formParams,
Map<String,String[]> queryParams) |
| Modifier and Type | Method and Description |
|---|---|
String |
AuthStringBuilder.generateAuthorizationString(String transmissionType,
Map<String,String> authCredential,
String httpMethod,
URI baseURI,
Map<String,String> authHeader,
Map<String,String[]> requestParams) |
String |
AuthStringBuilder.generateAuthorizationString(String transmissionType,
Map<String,String> authCredential,
String httpMethod,
URI baseURI,
Map<String,String> authHeader,
Map<String,String[]> formParams,
Map<String,String[]> queryParams) |
| Modifier and Type | Method and Description |
|---|---|
protected RequestBase |
RequestBase.addAuthHeaderParam(String key,
String value) |
protected RequestBase |
OutgoingRequest.addAuthHeaderParam(String key,
String value) |
protected RequestBase |
IncomingRequest.addAuthHeaderParam(String key,
String value) |
protected RequestBase |
RequestBase.addFormParam(String key,
String value) |
protected RequestBase |
OutgoingRequest.addFormParam(String key,
String value) |
protected RequestBase |
IncomingRequest.addFormParam(String key,
String value) |
protected RequestBase |
RequestBase.addFormParams(Map<String,String[]> formParams) |
protected RequestBase |
OutgoingRequest.addFormParams(Map<String,String[]> formParams) |
protected RequestBase |
IncomingRequest.addFormParams(Map<String,String[]> formParams) |
protected RequestBase |
RequestBase.addQueryParam(String key,
String value) |
protected RequestBase |
OutgoingRequest.addQueryParam(String key,
String value) |
protected RequestBase |
IncomingRequest.addQueryParam(String key,
String value) |
protected RequestBase |
RequestBase.addQueryParams(Map<String,String[]> queryParams) |
protected RequestBase |
OutgoingRequest.addQueryParams(Map<String,String[]> queryParams) |
protected RequestBase |
IncomingRequest.addQueryParams(Map<String,String[]> queryParams) |
static String |
BaseURIInfo.buildBaseURIString(String uriScheme,
String userInfo,
String host,
int port,
String path) |
URI |
BaseURIInfo.buildURI()
Builds the URI according to the OAuth the requirements.
|
URI |
BaseURIInfo.buildURI(Map<String,String[]> queryParams)
Builds the URI according to the OAuth the requirements after adding the queryParams.
|
URI |
BaseURIInfo.buildURI(String query)
Builds the URI according to the OAuth the requirements after adding the query string to the base URI.
|
URI |
BaseURIInfo.buildURI(String query,
String fragment)
Builds the URI according to the OAuth the requirements.
|
String |
BaseURIInfo.buildURIString()
Builds a URL string.
|
String |
BaseURIInfo.buildURIString(Map<String,String[]> queryParams)
Builds a URL string after appending the given query parameter.
|
String |
BaseURIInfo.buildURIString(Map<String,String[]> queryParams,
String fragment)
Builds a URL string after appending the given query parameter.
|
String |
BaseURIInfo.buildURIString(String query)
Builds a URL string after appending the given query string.
|
String |
BaseURIInfo.buildURIString(String query,
String fragment)
Builds a URL string after adding the given query and fragment string.
|
URL |
BaseURIInfo.buildURL()
Builds the URL according to the OAuth the requirements.
|
URL |
BaseURIInfo.buildURL(Map<String,String[]> queryParams)
Builds the URL according to the OAuth the requirements after adding the queryParams.
|
URL |
BaseURIInfo.buildURL(Map<String,String[]> queryParams,
String fragment)
Builds the URL according to the OAuth the requirements after adding the queryParams.
|
URL |
BaseURIInfo.buildURL(String query)
Builds the URL according to the OAuth the requirements after adding the query string to the base URI.
|
URL |
BaseURIInfo.buildURL(String query,
String fragment)
Builds the URL according to the OAuth the requirements.
|
static BaseURIInfo |
BaseURIInfo.create(URL url) |
static URI |
BaseURIInfo.createBaseURI(URL url) |
static URL |
BaseURIInfo.createURL(URI baseURI,
Map<String,String[]> queryParams)
Create URL from baseURI and queryParams.
|
static URL |
BaseURIInfo.createURL(URI baseURI,
Map<String,String[]> queryParams,
String fragment)
Create URL from baseURI and queryParams.
|
static URL |
BaseURIInfo.createURL(URI baseURI,
String query)
Create URL from baseURI and query.
|
static URL |
BaseURIInfo.createURL(URI baseURI,
String query,
String fragment)
Create URL from baseURI and query.
|
abstract OutgoingRequest |
OutgoingRequest.endorse(String signature)
Put this request object in a "endorsed" state.
|
abstract boolean |
IncomingRequest.isEndorsed()
Returns true if this request has been "endorsed"
(e.g., if it includes the oauth_signature param in the case of OAuth, etc.).
|
abstract IncomingRequest |
IncomingRequest.prepare()
Put this request object in a "ready" state.
|
abstract OutgoingRequest |
OutgoingRequest.prepare(AccessIdentity accessIdentity)
Put this request object in a "ready" state.
|
protected RequestBase |
RequestBase.setAuthHeader(Map<String,String> authHeader) |
protected RequestBase |
OutgoingRequest.setAuthHeader(Map<String,String> authHeader) |
protected RequestBase |
IncomingRequest.setAuthHeader(Map<String,String> authHeader) |
protected RequestBase |
RequestBase.setAuthHeader(String authHeader) |
protected RequestBase |
OutgoingRequest.setAuthHeader(String authHeader) |
protected RequestBase |
IncomingRequest.setAuthHeader(String authHeader) |
protected RequestBase |
RequestBase.setAuthHeaderAuthorizationString(String authHeaderAuthString) |
protected RequestBase |
OutgoingRequest.setAuthHeaderAuthorizationString(String authHeaderAuthString) |
protected RequestBase |
IncomingRequest.setAuthHeaderAuthorizationString(String authHeaderAuthString) |
protected RequestBase |
RequestBase.setAuthHeaderAuthorizationString(String authHeaderAuthString,
String expectedAuthScheme) |
protected RequestBase |
OutgoingRequest.setAuthHeaderAuthorizationString(String authHeaderAuthString,
String expectedAuthScheme) |
protected RequestBase |
IncomingRequest.setAuthHeaderAuthorizationString(String authHeaderAuthString,
String expectedAuthScheme) |
protected RequestBase |
RequestBase.setBaseURI(BaseURIInfo uriInfo) |
protected RequestBase |
OutgoingRequest.setBaseURI(BaseURIInfo uriInfo) |
protected RequestBase |
IncomingRequest.setBaseURI(BaseURIInfo uriInfo) |
protected RequestBase |
RequestBase.setBaseURI(String baseUri) |
protected RequestBase |
OutgoingRequest.setBaseURI(String baseUri) |
protected RequestBase |
IncomingRequest.setBaseURI(String baseUri) |
protected RequestBase |
RequestBase.setBaseURI(URI baseURI) |
protected RequestBase |
OutgoingRequest.setBaseURI(URI baseURI) |
protected RequestBase |
IncomingRequest.setBaseURI(URI baseURI) |
protected RequestBase |
RequestBase.setFormParams(Map<String,String[]> formParams) |
protected RequestBase |
OutgoingRequest.setFormParams(Map<String,String[]> formParams) |
protected RequestBase |
IncomingRequest.setFormParams(Map<String,String[]> formParams) |
protected RequestBase |
RequestBase.setFormParams(String formBody) |
protected RequestBase |
OutgoingRequest.setFormParams(String formBody) |
protected RequestBase |
IncomingRequest.setFormParams(String formBody) |
protected RequestBase |
RequestBase.setHttpMethod(String httpMethod) |
protected RequestBase |
OutgoingRequest.setHttpMethod(String httpMethod) |
protected RequestBase |
IncomingRequest.setHttpMethod(String httpMethod) |
protected RequestBase |
RequestBase.setQueryParams(Map<String,String[]> queryParams) |
protected RequestBase |
OutgoingRequest.setQueryParams(Map<String,String[]> queryParams) |
protected RequestBase |
IncomingRequest.setQueryParams(Map<String,String[]> queryParams) |
protected RequestBase |
RequestBase.setQueryParams(String queryString) |
protected RequestBase |
OutgoingRequest.setQueryParams(String queryString) |
protected RequestBase |
IncomingRequest.setQueryParams(String queryString) |
IncomingRequest |
IncomingRequest.verify()
Put this request object in a "verified" state.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AuthSignatureException
Exception while generating OAuth signatures.
|
class |
BadRequestException
Input error.
|
class |
CredentialStoreException
Failure to store or retrieve auth credentials.
|
class |
InternalErrorException
Any generic exception.
|
class |
InvalidCredentialException
Auth error.
|
class |
InvalidInputException
Invalid request input exception.
|
class |
InvalidStateException
Similar to IlligalStateException
except that this inherits from MiniAuthException.
|
class |
UnauthorizedException
Auth error.
|
class |
ValidationException
Data format error, etc.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
RequestEndorser.endorse(AccessCredential credential,
OutgoingRequest request)
Returns true if the request has been successfully "endorsed".
|
boolean |
EndorserService.endorse(OutgoingRequest request)
Returns true if the request has been successfully "endorsed".
|
boolean |
RequestVerifier.verify(AccessCredential credential,
IncomingRequest request)
Returns true if the request is valid and verified.
|
boolean |
VerifierService.verify(IncomingRequest request)
Returns true if the request is valid and verified.
|
| Modifier and Type | Method and Description |
|---|---|
String |
SignatureGenerator.generate(Map<String,String> authCredential,
String httpMethod,
URI baseUri,
Map<String,String> authHeader,
Map<String,String[]> requestParams) |
String |
SignatureGenerator.generate(Map<String,String> authCredential,
String httpMethod,
URI baseUri,
Map<String,String> authHeader,
Map<String,String[]> formParams,
Map<String,String[]> queryParams) |
Map<String,Object> |
SignatureGenerator.generateOAuthParams(Map<String,String> authCredential,
String httpMethod,
URI baseUri,
Map<String,String> authHeader,
Map<String,String[]> requestParams) |
Map<String,Object> |
SignatureGenerator.generateOAuthParams(Map<String,String> authCredential,
String httpMethod,
URI baseUri,
Map<String,String> authHeader,
Map<String,String[]> formParams,
Map<String,String[]> queryParams) |
boolean |
SignatureVerifier.verify(Map<String,String> authCredential,
String httpMethod,
URI baseUri,
Map<String,String> authHeader,
Map<String,String[]> requestParams) |
boolean |
SignatureVerifier.verify(Map<String,String> authCredential,
String httpMethod,
URI baseUri,
Map<String,String> authHeader,
Map<String,String[]> formParams,
Map<String,String[]> queryParams) |
| Modifier and Type | Method and Description |
|---|---|
static String |
AuthHeaderUtil.buildAuthString(Map<String,String> authHeader) |
static String |
FormParamUtil.buildUrlEncodedFormParamString(Map<String,String[]> params) |
static Map<String,String> |
AuthHeaderUtil.getAuthParams(Map<String,String[]> headers) |
static String |
AuthHeaderUtil.getAuthScheme(Map<String,String> header) |
static String |
AuthHeaderUtil.getAuthScheme(String authHeader) |
static Map<String,String> |
AuthHeaderUtil.parseAuthParams(String authHeader) |
static Map<String,String> |
AuthHeaderUtil.parseAuthParamsFromAuthorizationString(String authHeaderAuthString) |
static Map<String,String> |
AuthHeaderUtil.parseAuthParamsFromAuthorizationString(String authHeaderAuthString,
String expectedAuthScheme) |
static Map<String,String[]> |
QueryParamUtil.parseQueryParams(String queryString) |
static Map<String,String[]> |
FormParamUtil.parseUrlEncodedFormBody(String formBody) |
static Map<String,String[]> |
FormParamUtil.parseUrlEncodedFormParams(String contentType,
String formBody) |
Copyright © 2013. All rights reserved.