com.joyent.http.signature.apache.httpclient

Class HttpSignatureAuthenticationStrategy

java.lang.Object

com.joyent.http.signature.apache.httpclient.HttpSignatureAuthenticationStrategy

All Implemented Interfaces:

org.apache.http.client.AuthenticationStrategy

public class HttpSignatureAuthenticationStrategy
extends Object
implements org.apache.http.client.AuthenticationStrategy

AuthenticationStrategy implementation that allows the Apache HTTP Client to authenticate via the HTTP Signature scheme.

Since:

2.0.3

Author:

Elijah Zupancic

Constructor Summary

Constructors

Constructor and Description
HttpSignatureAuthenticationStrategy(org.apache.http.auth.AuthScheme authScheme, org.apache.http.auth.Credentials credentials) Creates a new instance using the passed authentication scheme.
HttpSignatureAuthenticationStrategy(org.apache.http.config.Lookup<org.apache.http.auth.AuthSchemeProvider> authSchemeProviderLookup, org.apache.http.auth.Credentials credentials) Create a new instance using a provider found via a Lookup.

Method Summary

Methods

Modifier and Type	Method and Description
void	authFailed(org.apache.http.HttpHost authhost, org.apache.http.auth.AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
void	authSucceeded(org.apache.http.HttpHost authhost, org.apache.http.auth.AuthScheme authScheme, org.apache.http.protocol.HttpContext context)
Map<String,org.apache.http.Header>	getChallenges(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)
boolean	isAuthenticationRequested(org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context) Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.
Queue<org.apache.http.auth.AuthOption>	select(Map<String,org.apache.http.Header> challenges, org.apache.http.HttpHost authhost, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSignatureAuthenticationStrategy

public HttpSignatureAuthenticationStrategy(org.apache.http.config.Lookup<org.apache.http.auth.AuthSchemeProvider> authSchemeProviderLookup,
                                   org.apache.http.auth.Credentials credentials)

Create a new instance using a provider found via a Lookup.

Parameters:

authSchemeProviderLookup - Lookup that will return an AuthScheme when asked for "Signatures"

credentials - credentials containing the HTTP Signature username and fingerprint

HttpSignatureAuthenticationStrategy

public HttpSignatureAuthenticationStrategy(org.apache.http.auth.AuthScheme authScheme,
                                   org.apache.http.auth.Credentials credentials)

Creates a new instance using the passed authentication scheme.

Parameters:

authScheme - authentication scheme to use to authenticate requests (expecting HttpSignatureAuthScheme)

credentials - credentials containing the HTTP Signature username and fingerprint

Method Detail

isAuthenticationRequested

public boolean isAuthenticationRequested(org.apache.http.HttpHost authhost,
                                org.apache.http.HttpResponse response,
                                org.apache.http.protocol.HttpContext context)

Determines if the given HTTP response response represents an authentication challenge that was sent back as a result of authentication failure.

Specified by:

isAuthenticationRequested in interface org.apache.http.client.AuthenticationStrategy

Parameters:

authhost - authentication host.

response - HTTP response.

context - HTTP context.

Returns:

true if user authentication is required, false otherwise.

getChallenges

public Map<String,org.apache.http.Header> getChallenges(org.apache.http.HttpHost authhost,
                                               org.apache.http.HttpResponse response,
                                               org.apache.http.protocol.HttpContext context)
                                                 throws org.apache.http.auth.MalformedChallengeException

Specified by:

getChallenges in interface org.apache.http.client.AuthenticationStrategy

Throws:

org.apache.http.auth.MalformedChallengeException

select

public Queue<org.apache.http.auth.AuthOption> select(Map<String,org.apache.http.Header> challenges,
                                            org.apache.http.HttpHost authhost,
                                            org.apache.http.HttpResponse response,
                                            org.apache.http.protocol.HttpContext context)
                                              throws org.apache.http.auth.MalformedChallengeException

Specified by:

select in interface org.apache.http.client.AuthenticationStrategy

Throws:

org.apache.http.auth.MalformedChallengeException

authSucceeded

public void authSucceeded(org.apache.http.HttpHost authhost,
                 org.apache.http.auth.AuthScheme authScheme,
                 org.apache.http.protocol.HttpContext context)

Specified by:

authSucceeded in interface org.apache.http.client.AuthenticationStrategy

authFailed

public void authFailed(org.apache.http.HttpHost authhost,
              org.apache.http.auth.AuthScheme authScheme,
              org.apache.http.protocol.HttpContext context)

Specified by:

authFailed in interface org.apache.http.client.AuthenticationStrategy