cloud.altemista.fwk.core.rest.security

Class DigestAuthRestTemplate

java.lang.Object

org.springframework.http.client.support.HttpAccessor

org.springframework.http.client.support.InterceptingHttpAccessor

org.springframework.web.client.RestTemplate

cloud.altemista.fwk.core.rest.security.DigestAuthRestTemplate

All Implemented Interfaces:

org.springframework.web.client.RestOperations

public class DigestAuthRestTemplate
extends org.springframework.web.client.RestTemplate

DigestAuthRestTemplate is RestClientTemplate for Digest Authentication. This class could be assigned to user session and re-used until user session is valid. Or used as singleton when client application uses only one Credential object to authenticate against REST services.

Author:

NTT DATA

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DigestAuthRestTemplate.DigestRequestCallback RequestCallback wrapper that adds the digest solution header to the request headers
protected static class	DigestAuthRestTemplate.DigestResponseErrorHandler ResponseErrorHandler wrapper that handles the HTTP 401 Unauthorized errors
protected static class	DigestAuthRestTemplate.UnauthorizedException Exception thrown by the DigestResponseErrorHandler when HTTP 401 Unauthorized occurs

Field Summary

Fields inherited from class org.springframework.http.client.support.HttpAccessor

logger

Constructor Summary

Constructors

Constructor and Description
DigestAuthRestTemplate(org.apache.http.auth.Credentials credentials) Constructor with a set of credentials.
DigestAuthRestTemplate(String username, String password) Convenience constructor from user name and password; will use the same credentials for all requests.

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.Header	createSolution(URI url, org.springframework.http.HttpMethod method, String challenge) Creates the digest solution of an authentication challenge
protected <T> T	doExecute(URI url, org.springframework.http.HttpMethod method, org.springframework.web.client.RequestCallback pRequestCallback, org.springframework.web.client.ResponseExtractor<T> responseExtractor)
void	setErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)

Methods inherited from class org.springframework.web.client.RestTemplate

acceptHeaderRequestCallback, delete, delete, delete, exchange, exchange, exchange, exchange, exchange, exchange, exchange, exchange, execute, execute, execute, getErrorHandler, getForEntity, getForEntity, getForEntity, getForObject, getForObject, getForObject, getMessageConverters, getUriTemplateHandler, handleResponse, headersExtractor, headForHeaders, headForHeaders, headForHeaders, httpEntityCallback, httpEntityCallback, optionsForAllow, optionsForAllow, optionsForAllow, patchForObject, patchForObject, patchForObject, postForEntity, postForEntity, postForEntity, postForLocation, postForLocation, postForLocation, postForObject, postForObject, postForObject, put, put, put, responseEntityExtractor, setDefaultUriVariables, setMessageConverters, setUriTemplateHandler

Methods inherited from class org.springframework.http.client.support.InterceptingHttpAccessor

getInterceptors, getRequestFactory, setInterceptors, setRequestFactory

Methods inherited from class org.springframework.http.client.support.HttpAccessor

createRequest, getClientHttpRequestInitializers, setClientHttpRequestInitializers

Methods inherited from class java.lang.Object

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

Constructor Detail

DigestAuthRestTemplate

public DigestAuthRestTemplate(org.apache.http.auth.Credentials credentials)

Constructor with a set of credentials.

Parameters:

credentials - the set of credentials, consisting of a security principal and a secret (password)

DigestAuthRestTemplate

public DigestAuthRestTemplate(String username,
                              String password)

Convenience constructor from user name and password; will use the same credentials for all requests.

Parameters:

username - the user name

password - the password

Method Detail

setErrorHandler

public void setErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)

Overrides:

setErrorHandler in class org.springframework.web.client.RestTemplate

doExecute

protected <T> T doExecute(URI url,
                          org.springframework.http.HttpMethod method,
                          org.springframework.web.client.RequestCallback pRequestCallback,
                          org.springframework.web.client.ResponseExtractor<T> responseExtractor)

Overrides:

doExecute in class org.springframework.web.client.RestTemplate

createSolution

protected org.apache.http.Header createSolution(URI url,
                                                org.springframework.http.HttpMethod method,
                                                String challenge)
                                         throws org.apache.http.auth.MalformedChallengeException,
                                                org.apache.http.auth.AuthenticationException

Creates the digest solution of an authentication challenge

Parameters:

url - the fully-expanded URL to connect to

method - the HTTP method to execute (GET, POST, etc.)

challenge - the challenge of the HTTP 401 Unauthorized response

Returns:

the solution header

Throws:

org.apache.http.auth.MalformedChallengeException - if the authentication challenge is malformed

org.apache.http.auth.AuthenticationException - if authorization string cannot be generated