com.atlassian.asap.core.keys.privatekey

Class StringPrivateKeyProvider

java.lang.Object

com.atlassian.asap.core.keys.privatekey.StringPrivateKeyProvider

All Implemented Interfaces:

KeyProvider<PrivateKey>

public class StringPrivateKeyProvider
extends Object
implements KeyProvider<PrivateKey>

Reads a single private key from a String. The key and the key identifier are construction arguments, and the provider only provides that particular key identifier. This provider can be used for private keys obtained from arbitrary sources, like an application-specific configuration file. If the key is provided via a classpath resource, or a file, or an environment variable, or a system property, then please use one of the specialised private key providers for those scenarios.

See also DataUriKeyProvider, which can be used for a similar purpose but only when the key is provided in the data URI format. StringPrivateKeyProvider also allows other formats, like PEM keys.

Constructor Summary

Constructors

Constructor and Description
StringPrivateKeyProvider(KeyReader keyReader, String key, String keyId) Creates an instance that provides a single key read from a String.

Method Summary

Modifier and Type	Method and Description
PrivateKey	getKey(ValidatedKeyId keyId) Provides a Key for a validated key identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringPrivateKeyProvider

public StringPrivateKeyProvider(KeyReader keyReader,
                                String key,
                                String keyId)

Creates an instance that provides a single key read from a String. It attempts to parse the key at construction time. If the key is not parseable, it will fail at retrieval time.

Parameters:

keyReader - the key reader to parse the key

key - the actual private key

keyId - the key identifier

Method Detail

getKey

public PrivateKey getKey(ValidatedKeyId keyId)
                  throws CannotRetrieveKeyException

Description copied from interface: KeyProvider

Provides a Key for a validated key identifier.

Specified by:

getKey in interface KeyProvider<PrivateKey>

Parameters:

keyId - 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.