Package se.swedenconnect.security.credential.factory

Class PkiCredentialFactory

java.lang.Object

se.swedenconnect.security.credential.factory.PkiCredentialFactory

public class PkiCredentialFactory
extends Object

Factory class for creating PkiCredential instances. It can either be used statically, or instantiated with a resource loader and loaders for credentials or keystores (or a credential bundles object).

Author:

Martin Lindström

Constructor Summary

Constructors

Constructor	Description
PkiCredentialFactory(Function<String,PkiCredential> credentialProvider, Function<String,KeyStore> keyStoreProvider, ConfigurationResourceLoader resourceLoader, boolean useCache)	Constructor assigning the CredentialBundles, credential and keystore providers.
PkiCredentialFactory(CredentialBundles credentialBundles, ConfigurationResourceLoader resourceLoader, boolean useCache)	Constructor assigning the CredentialBundles and ConfigurationResourceLoader.

Method Summary

Modifier and Type	Method	Description
PkiCredential	createCredential(PemCredentialConfiguration configuration)	Creates a PkiCredential based on a PemCredentialConfiguration.
static PkiCredential	createCredential(PemCredentialConfiguration configuration, ConfigurationResourceLoader resourceLoader)	Creates a PkiCredential based on a PemCredentialConfiguration.
PkiCredential	createCredential(PkiCredentialConfiguration configuration)	Creates a PkiCredential based on the supplied PkiCredentialConfiguration.
static PkiCredential	createCredential(PkiCredentialConfiguration configuration, ConfigurationResourceLoader resourceLoader, Function<String,PkiCredential> credentialProvider, Function<String,KeyStore> keyStoreProvider, Function<String,KeyStoreReloader> keyStoreReloaderProvider)	Creates a PkiCredential based on the supplied PkiCredentialConfiguration.
PkiCredential	createCredential(StoreCredentialConfiguration configuration)	Creates a PkiCredential based on a StoreCredentialConfiguration.
static PkiCredential	createCredential(StoreCredentialConfiguration configuration, ConfigurationResourceLoader resourceLoader, Function<String,KeyStore> keyStoreProvider, Function<String,KeyStoreReloader> keyStoreReloaderProvider)	Creates a PkiCredential based on a StoreCredentialConfiguration.
PkiCredentialCollection	createCredentialCollection(PkiCredentialCollectionConfiguration configuration)	Creates a PkiCredentialCollection based on the supplied PkiCredentialCollectionConfiguration.
static PkiCredentialCollection	createCredentialCollection(PkiCredentialCollectionConfiguration configuration, ConfigurationResourceLoader resourceLoader, Function<String,PkiCredential> credentialProvider, Function<String,KeyStore> keyStoreProvider, Function<String,KeyStoreReloader> keyStoreReloaderProvider)	Creates a PkiCredentialCollection based on the supplied PkiCredentialCollectionConfiguration.

Methods inherited from class java.lang.Object

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

Constructor Details

PkiCredentialFactory

public PkiCredentialFactory(@Nullable
 Function<String,PkiCredential> credentialProvider,
 @Nullable
 Function<String,KeyStore> keyStoreProvider,
 @Nullable
 ConfigurationResourceLoader resourceLoader,
 boolean useCache)

Constructor assigning the CredentialBundles, credential and keystore providers.

Parameters:

credentialProvider - for loading credentials

keyStoreProvider - for loading keystores

resourceLoader - for loading resources

useCache - whether caches will be used

PkiCredentialFactory

public PkiCredentialFactory(@Nullable
 CredentialBundles credentialBundles,
 @Nullable
 ConfigurationResourceLoader resourceLoader,
 boolean useCache)

Constructor assigning the CredentialBundles and ConfigurationResourceLoader.

Parameters:

credentialBundles - the credentials bundles to use

resourceLoader - for loading resources

useCache - whether caches will be used

Method Details

createCredential

@Nonnull
public static PkiCredential createCredential(@Nonnull
 PkiCredentialConfiguration configuration,
 @Nullable
 ConfigurationResourceLoader resourceLoader,
 @Nullable
 Function<String,PkiCredential> credentialProvider,
 @Nullable
 Function<String,KeyStore> keyStoreProvider,
 @Nullable
 Function<String,KeyStoreReloader> keyStoreReloaderProvider)
                                      throws IllegalArgumentException,
IOException,
NoSuchCredentialException,
NoSuchKeyStoreException,
CertificateException,
KeyException,
KeyStoreException,
NoSuchProviderException

Creates a PkiCredential based on the supplied PkiCredentialConfiguration.

Parameters:

configuration - the configuration

resourceLoader - loader for readning files, if null, a DefaultConfigurationResourceLoader will be used

credentialProvider - if the supplied configuration object contains a credential bundle reference, this provider must be supplied

keyStoreProvider - if the supplied configuration object contains a key store reference, this provider must be supplied

keyStoreReloaderProvider - if store references are used, and those key stores are "reloadable", a function that resolves references to a KeyStoreReloader may be supplied. If not, credentials will not be reloadable

Returns:

a PkiCredential

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

NoSuchCredentialException - if a bundle is used in the supplied configuration, and it does not exist

NoSuchKeyStoreException - if a reference to a key store can not be found

CertificateException - for certificate decoding errors

KeyException - for key decoding errors

KeyStoreException - for errors unlocking the key store

NoSuchProviderException - if a referenced provider does not exist

createCredential

@Nonnull
public PkiCredential createCredential(@Nonnull
 PkiCredentialConfiguration configuration)
                               throws IllegalArgumentException,
IOException,
NoSuchCredentialException,
NoSuchKeyStoreException,
CertificateException,
KeyException,
KeyStoreException,
NoSuchProviderException

Creates a PkiCredential based on the supplied PkiCredentialConfiguration.

Parameters:

configuration - the configuration

Returns:

a PkiCredential

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

NoSuchCredentialException - if a bundle is used in the supplied configuration, and it does not exist

NoSuchKeyStoreException - if a reference to a key store can not be found

CertificateException - for certificate decoding errors

KeyException - for key decoding errors

KeyStoreException - for errors unlocking the key store

NoSuchProviderException - if a referenced provider does not exist

createCredential

@Nonnull
public static PkiCredential createCredential(@Nonnull
 PemCredentialConfiguration configuration,
 @Nullable
 ConfigurationResourceLoader resourceLoader)
                                      throws IllegalArgumentException,
IOException,
CertificateException,
KeyException

Creates a PkiCredential based on a PemCredentialConfiguration.

Parameters:

configuration - the configuration

resourceLoader - loader for readning files, if null, a DefaultConfigurationResourceLoader will be used

Returns:

a PkiCredential

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

CertificateException - for certificate decoding errors

KeyException - for key decoding errors

createCredential

@Nonnull
public PkiCredential createCredential(@Nonnull
 PemCredentialConfiguration configuration)
                               throws IllegalArgumentException,
IOException,
CertificateException,
KeyException

Creates a PkiCredential based on a PemCredentialConfiguration.

Parameters:

configuration - the configuration

Returns:

a PkiCredential

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

CertificateException - for certificate decoding errors

KeyException - for key decoding errors

createCredential

@Nonnull
public static PkiCredential createCredential(@Nonnull
 StoreCredentialConfiguration configuration,
 @Nullable
 ConfigurationResourceLoader resourceLoader,
 @Nullable
 Function<String,KeyStore> keyStoreProvider,
 @Nullable
 Function<String,KeyStoreReloader> keyStoreReloaderProvider)
                                      throws IllegalArgumentException,
IOException,
NoSuchKeyStoreException,
KeyStoreException,
NoSuchProviderException,
CertificateException

Creates a PkiCredential based on a StoreCredentialConfiguration.

Parameters:

configuration - the configuration

resourceLoader - loader for readning files, if null, a DefaultConfigurationResourceLoader will be used

keyStoreProvider - if store references are used, a function that resolves references to key stores must be supplied

keyStoreReloaderProvider - if store references are used, and those key stores are "reloadable", a function that resolves references to a KeyStoreReloader may be supplied. If not, it will be assumed that the key store may be reloaded using the key password (which then must be the same as the store password)

Returns:

a PkiCredential

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

NoSuchKeyStoreException - if a reference to a key store can not be found

KeyStoreException - for errors unlocking the key store

NoSuchProviderException - if a referenced provider does not exist

CertificateException - for certificate decoding errors

createCredential

@Nonnull
public PkiCredential createCredential(@Nonnull
 StoreCredentialConfiguration configuration)
                               throws IllegalArgumentException,
IOException,
NoSuchKeyStoreException,
KeyStoreException,
NoSuchProviderException,
CertificateException

Creates a PkiCredential based on a StoreCredentialConfiguration.

Parameters:

configuration - the configuration

Returns:

a PkiCredential

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

NoSuchKeyStoreException - if a reference to a key store can not be found

KeyStoreException - for errors unlocking the key store

NoSuchProviderException - if a referenced provider does not exist

CertificateException - for certificate decoding errors

createCredentialCollection

@Nonnull
public static PkiCredentialCollection createCredentialCollection(@Nonnull
 PkiCredentialCollectionConfiguration configuration,
 @Nullable
 ConfigurationResourceLoader resourceLoader,
 @Nullable
 Function<String,PkiCredential> credentialProvider,
 @Nullable
 Function<String,KeyStore> keyStoreProvider,
 @Nullable
 Function<String,KeyStoreReloader> keyStoreReloaderProvider)
                                                          throws IllegalArgumentException,
IOException,
NoSuchCredentialException,
NoSuchKeyStoreException,
CertificateException,
KeyException,
KeyStoreException,
NoSuchProviderException

Creates a PkiCredentialCollection based on the supplied PkiCredentialCollectionConfiguration.

Parameters:

configuration - the configuration

resourceLoader - loader for readning files, if null, a DefaultConfigurationResourceLoader will be used

credentialProvider - if the supplied configuration object contains a credential bundle reference, this provider must be supplied

keyStoreProvider - if the supplied configuration object contains a key store reference, this provider must be supplied

keyStoreReloaderProvider - if store references are used, and those key stores are "reloadable", a function that resolves references to a KeyStoreReloader may be supplied. If not, credentials will not be reloadable

Returns:

a PkiCredentialCollection

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

NoSuchCredentialException - if a bundle is used in the supplied configuration, and it does not exist

NoSuchKeyStoreException - if a reference to a key store can not be found

CertificateException - for certificate decoding errors

KeyException - for key decoding errors

KeyStoreException - for errors unlocking the key store

NoSuchProviderException - if a referenced provider does not exist

createCredentialCollection

@Nonnull
public PkiCredentialCollection createCredentialCollection(@Nonnull
 PkiCredentialCollectionConfiguration configuration)
                                                   throws IllegalArgumentException,
IOException,
NoSuchCredentialException,
NoSuchKeyStoreException,
CertificateException,
KeyException,
KeyStoreException,
NoSuchProviderException

Creates a PkiCredentialCollection based on the supplied PkiCredentialCollectionConfiguration.

Parameters:

configuration - the configuration

Returns:

a PkiCredentialCollection

Throws:

IllegalArgumentException - for invalid configuration settings

IOException - if a referenced file can not be read

NoSuchCredentialException - if a bundle is used in the supplied configuration, and it does not exist

NoSuchKeyStoreException - if a reference to a key store can not be found

CertificateException - for certificate decoding errors

KeyException - for key decoding errors

KeyStoreException - for errors unlocking the key store

NoSuchProviderException - if a referenced provider does not exist