com.atlassian.asap.core.keys.publickey

Class HttpPublicKeyProvider

java.lang.Object

com.atlassian.asap.core.keys.publickey.HttpPublicKeyProvider

All Implemented Interfaces:

KeyProvider<PublicKey>

public class HttpPublicKeyProvider
extends Object
implements KeyProvider<PublicKey>

Reads public keys from web servers using the HTTPS protocol.

Constructor Summary

Constructors

Constructor and Description
HttpPublicKeyProvider(URI baseUrl, org.apache.http.client.HttpClient httpClient, PemReader pemReader) Create a new HttpPublicKeyProvider instance.

Method Summary

Modifier and Type	Method and Description
static org.apache.http.client.HttpClient	defaultHttpClient() Constructs the HTTP client used by the provider if no other HttpClient is provided.
static org.apache.http.impl.client.HttpClientBuilder	defaultHttpClientBuilder() Configures the HTTP client used by the provider with the necessary connection manager and request/cache config.
PublicKey	getKey(ValidatedKeyId validatedKeyId) Provides a Key for a validated key identifier.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpPublicKeyProvider

public HttpPublicKeyProvider(URI baseUrl,
                             org.apache.http.client.HttpClient httpClient,
                             PemReader pemReader)

Create a new HttpPublicKeyProvider instance.

Parameters:

baseUrl - the base url of the public key server

httpClient - the http client to use for communicating with the public key server

pemReader - the pem key reader to use for reading public keys in pem format

Method Detail

getKey

public PublicKey getKey(ValidatedKeyId validatedKeyId)
                 throws CannotRetrieveKeyException

Description copied from interface: KeyProvider

Provides a Key for a validated key identifier.

Specified by:

getKey in interface KeyProvider<PublicKey>

Parameters:

validatedKeyId - the validated keyId of interest which is safe from directory traversal

Returns:

the relevant key if found

Throws:

CannotRetrieveKeyException - if the key couldn't be retrieved or found.

defaultHttpClient

public static org.apache.http.client.HttpClient defaultHttpClient()

Constructs the HTTP client used by the provider if no other HttpClient is provided. Uses the builder from defaultHttpClientBuilder().

Returns:

a new HttpClient

defaultHttpClientBuilder

public static org.apache.http.impl.client.HttpClientBuilder defaultHttpClientBuilder()

Configures the HTTP client used by the provider with the necessary connection manager and request/cache config. You can use this to extend the configuration, e.g. adding interceptors for Zipkin.

Returns:

a configured HttpClientBuilder

Since:

2.11

toString

public String toString()

Overrides:

toString in class Object