Package se.swedenconnect.security.credential.spring.factory

Class PkiCredentialFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<PkiCredential>

se.swedenconnect.security.credential.spring.factory.PkiCredentialFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<PkiCredential>, InitializingBean

Direct Known Subclasses:

PkiCredentialFactoryBean

public class PkiCredentialFactoryBean
extends AbstractFactoryBean<PkiCredential>

A FactoryBean for creating PkiCredential objects.

Author:

Martin Lindström

See Also:

• PkiCredentialFactory

Field Summary

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
PkiCredentialFactoryBean(String bundle)	Constructor accepting a String which is a reference to a registered PkiCredential.
PkiCredentialFactoryBean(PemCredentialConfiguration configuration)	Constructor aceepting a PemCredentialConfiguration.
PkiCredentialFactoryBean(PkiCredentialConfiguration configuration)	Constructor aceepting a PkiCredentialConfiguration.
PkiCredentialFactoryBean(StoreCredentialConfiguration configuration)	Constructor aceepting a StoreCredentialConfiguration.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected PkiCredential	createInstance()	Invokes PkiCredentialFactory.createCredential(PkiCredentialConfiguration, ConfigurationResourceLoader, Function, Function, Function).
protected PkiCredentialConfiguration	getConfiguration()	Returns the underlying configuration.
Class<?>	getObjectType()
void	setCredentialBundles(CredentialBundles credentialBundles)	Assigns the CredentialBundles bean for resolving references to credentials and key stores.
void	setCredentialProvider(Function<String,PkiCredential> credentialProvider)	If a configuration is used that has a credential reference, a credential provider is needed.
void	setKeyStoreProvider(Function<String,KeyStore> keyStoreProvider)	If a store configuration is used that has a store reference, a key store provider is needed.
void	setKeyStoreReloaderProvider(Function<String,KeyStoreReloader> keyStoreReloaderProvider)	If a store configuration is used that has a store reference, and that reference points to a ReloadablePkiCredential, a resolver function for getting a KeyStoreReloader may be needed.

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Constructor Details

PkiCredentialFactoryBean

public PkiCredentialFactoryBean(@Nonnull
 PkiCredentialConfiguration configuration)

Constructor aceepting a PkiCredentialConfiguration.

Parameters:

configuration - the configuration

PkiCredentialFactoryBean

public PkiCredentialFactoryBean(@Nonnull
 String bundle)

Constructor accepting a String which is a reference to a registered PkiCredential.

Parameters:

bundle - bundle reference

PkiCredentialFactoryBean

public PkiCredentialFactoryBean(@Nonnull
 StoreCredentialConfiguration configuration)

Constructor aceepting a StoreCredentialConfiguration.

Parameters:

configuration - the configuration

PkiCredentialFactoryBean

public PkiCredentialFactoryBean(@Nonnull
 PemCredentialConfiguration configuration)

Constructor aceepting a PemCredentialConfiguration.

Parameters:

configuration - the configuration

Method Details

setCredentialBundles

public void setCredentialBundles(@Nonnull
 CredentialBundles credentialBundles)

Assigns the CredentialBundles bean for resolving references to credentials and key stores.

Also see setCredentialProvider(Function) and setKeyStoreProvider(Function).

Parameters:

credentialBundles - the credential bundles bean

setCredentialProvider

public void setCredentialProvider(@Nonnull
 Function<String,PkiCredential> credentialProvider)

If a configuration is used that has a credential reference, a credential provider is needed.

An alternative to assigned this function, is to assign a CredentialBundles, see setCredentialBundles(CredentialBundles).

Parameters:

credentialProvider - provides a PkiCredential based on its registered ID

setKeyStoreProvider

public void setKeyStoreProvider(@Nonnull
 Function<String,KeyStore> keyStoreProvider)

If a store configuration is used that has a store reference, a key store provider is needed.

An alternative to assigned this function, is to assign a CredentialBundles, see setCredentialBundles(CredentialBundles).

Parameters:

keyStoreProvider - provides a KeyStore based on its registered ID

setKeyStoreReloaderProvider

public void setKeyStoreReloaderProvider(@Nonnull
 Function<String,KeyStoreReloader> keyStoreReloaderProvider)

If a store configuration is used that has a store reference, and that reference points to a ReloadablePkiCredential, a resolver function for getting a KeyStoreReloader may be needed.

Parameters:

keyStoreReloaderProvider - provides a KeyStoreReloader based on a key stores' registered ID

createInstance

@Nonnull
protected PkiCredential createInstance()
                                throws Exception

Invokes PkiCredentialFactory.createCredential(PkiCredentialConfiguration, ConfigurationResourceLoader, Function, Function, Function).

Specified by:

createInstance in class AbstractFactoryBean<PkiCredential>

Throws:

Exception

getObjectType

@Nonnull
public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<PkiCredential>

Specified by:

getObjectType in class AbstractFactoryBean<PkiCredential>

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractFactoryBean<PkiCredential>

Throws:

Exception

getConfiguration

protected PkiCredentialConfiguration getConfiguration()

Returns the underlying configuration.

Returns:

the underlying configuration