com.boomi.restlet.auth

Class RestEncodingAuthorizationProvider

java.lang.Object

com.boomi.restlet.auth.RestEncodingAuthorizationProvider

All Implemented Interfaces:

AuthorizationProvider

public abstract class RestEncodingAuthorizationProvider
extends Object
implements AuthorizationProvider

An abstract class for authorization providers that encode a specific rest-like path string into the authorization.

Constructor Summary

Constructors

Constructor and Description
RestEncodingAuthorizationProvider()

Method Summary

Modifier and Type	Method and Description
protected abstract String	encode(String rest) Encode the rest-like string using this AuthorizationProvider's mechanisms.
static String	formatAuthorizationCredentials(String path, String methodName, String contentMd5, String contentType, String date) Formats the given components for a rest auth request.
org.restlet.data.ChallengeResponse	getChallengeResponse(org.restlet.data.Request request, Map<String,Object> headers) Construct a ChallengeResponse based on the settings in this provider.
protected abstract org.restlet.data.ChallengeScheme	getChallengeScheme() The ChallengeScheme associated with this specific implementation.
protected abstract String	getDateKey() Once we've found or created a date, we should store it into the http headers using this key.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestEncodingAuthorizationProvider

public RestEncodingAuthorizationProvider()

Method Detail

getChallengeResponse

public org.restlet.data.ChallengeResponse getChallengeResponse(org.restlet.data.Request request,
                                                               Map<String,Object> headers)
                                                        throws GeneralSecurityException

Description copied from interface: AuthorizationProvider

Construct a ChallengeResponse based on the settings in this provider.

Specified by:

getChallengeResponse in interface AuthorizationProvider

Parameters:

request - The request involved. May or may not need to be referenced when constructing the response.

headers - The associated headers. Also may or may not need to be referenced.

Returns:

a new ChallengeResponse

Throws:

GeneralSecurityException - if any errors occurred while constructing the response.

getChallengeScheme

protected abstract org.restlet.data.ChallengeScheme getChallengeScheme()

The ChallengeScheme associated with this specific implementation.

Returns:

the appropriate ChallengeScheme definition

getDateKey

protected abstract String getDateKey()

Once we've found or created a date, we should store it into the http headers using this key.

Returns:

the key describing where to store the date

encode

protected abstract String encode(String rest)
                          throws GeneralSecurityException

Encode the rest-like string using this AuthorizationProvider's mechanisms.

Parameters:

rest - the rest-like source string

Returns:

the resulting encoded string

Throws:

GeneralSecurityException - if encoding fails

formatAuthorizationCredentials

public static String formatAuthorizationCredentials(String path,
                                                    String methodName,
                                                    String contentMd5,
                                                    String contentType,
                                                    String date)

Formats the given components for a rest auth request.