com.joyent.http.signature.apache.httpclient

Class HttpSignatureConfigurator

java.lang.Object

com.joyent.http.signature.apache.httpclient.HttpSignatureConfigurator

public class HttpSignatureConfigurator
extends Object

Configuration helper class for configuring a HttpClientBuilder to use HTTP Signatures authentication.

Since:

2.0.5

Author:

Elijah Zupancic

Constructor Summary

Constructors

Constructor and Description
HttpSignatureConfigurator(KeyPair keyPair, org.apache.http.auth.Credentials credentials, boolean useNativeCodeToSign) Deprecated. Prefer HttpSignatureConfigurator(KeyPair, Credentials, ThreadLocalSigner) if configuration of Signer algorithm, hashes, or providers is required.
HttpSignatureConfigurator(KeyPair keyPair, org.apache.http.auth.Credentials credentials, ThreadLocalSigner signer) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	configure(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder) Configures a HttpClientBuilder to use HTTP Signature authentication.
org.apache.http.client.AuthenticationStrategy	getAuthenticationStrategy()
org.apache.http.auth.AuthScheme	getAuthScheme()
org.apache.http.auth.Credentials	getCredentials()
KeyPair	getKeyPair()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSignatureConfigurator

@Deprecated
public HttpSignatureConfigurator(KeyPair keyPair,
                                             org.apache.http.auth.Credentials credentials,
                                             boolean useNativeCodeToSign)

Deprecated. Prefer HttpSignatureConfigurator(KeyPair, Credentials, ThreadLocalSigner) if configuration of Signer algorithm, hashes, or providers is required.

Creates a new instance.

Parameters:

keyPair - public/private keypair object used to sign HTTP requests

credentials - credentials containing a username

useNativeCodeToSign - true to enable native code acceleration of cryptographic singing

HttpSignatureConfigurator

public HttpSignatureConfigurator(KeyPair keyPair,
                                 org.apache.http.auth.Credentials credentials,
                                 ThreadLocalSigner signer)

Creates a new instance.

Parameters:

keyPair - public/private keypair object used to sign HTTP requests

credentials - credentials containing a username

signer - For use with http signature

Method Detail

configure

public void configure(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)

Configures a HttpClientBuilder to use HTTP Signature authentication.

Parameters:

httpClientBuilder - build to configure

getKeyPair

public KeyPair getKeyPair()

getCredentials

public org.apache.http.auth.Credentials getCredentials()

getAuthScheme

public org.apache.http.auth.AuthScheme getAuthScheme()

getAuthenticationStrategy

public org.apache.http.client.AuthenticationStrategy getAuthenticationStrategy()