Class StoreCredentialConfigurationProperties

java.lang.Object

se.swedenconnect.security.credential.config.properties.AbstractBaseCredentialConfigurationProperties

se.swedenconnect.security.credential.config.properties.StoreCredentialConfigurationProperties

All Implemented Interfaces:

BaseCredentialConfiguration, StoreCredentialConfiguration

public class StoreCredentialConfigurationProperties
extends AbstractBaseCredentialConfigurationProperties
implements StoreCredentialConfiguration

Configuration properties for creating a PkiCredential backed by a Java KeyStore.

Author:

Martin Lindström

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StoreCredentialConfigurationProperties.KeyConfigurationProperties	Configuration properties for a key pair entry.

Nested classes/interfaces inherited from interface StoreCredentialConfiguration

StoreCredentialConfiguration.KeyConfiguration

Constructor Summary

Constructors

Constructor	Description
StoreCredentialConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
StoreCredentialConfigurationProperties.KeyConfigurationProperties	getKey()	Gets the configuration for the key pair entry of the store.
Boolean	getMonitor()	Gets whether the credential should be prepared for monitoring.
StoreConfigurationProperties	getStore()	Gets the configuration for the KeyStore holding the key pair entry.
String	getStoreReference()	Gets the key store reference.
int	hashCode()
StoreCredentialConfiguration.KeyConfiguration	key()	Configuration for the key pair entry of the store.
Optional<Boolean>	monitor()	Whether the credential should be prepared for monitoring.
void	setKey(StoreCredentialConfigurationProperties.KeyConfigurationProperties key)	Assigns the configuration for the key pair entry of the store.
void	setMonitor(Boolean monitor)	Assigns whether the credential should be prepared for monitoring.
void	setStore(StoreConfigurationProperties store)	Assigns the configuration for the KeyStore holding the key pair entry.
void	setStoreReference(String storeReference)	Assigns the key store reference.
Optional<StoreConfiguration>	store()	Configuration for the KeyStore holding the key pair entry.
Optional<String>	storeReference()	As an alternative to giving the key store configuration, a reference to a key store configuration may be given.

Methods inherited from class AbstractBaseCredentialConfigurationProperties

activeFrom, activeTo, expiresAt, getActiveFrom, getActiveTo, getExpiresAt, getIssuedAt, getKeyId, getMetadata, getName, getUsage, issuedAt, keyId, metadata, name, setActiveFrom, setActiveTo, setExpiresAt, setIssuedAt, setKeyId, setName, setUsage, usage

Methods inherited from class Object

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

Methods inherited from interface BaseCredentialConfiguration

activeFrom, activeTo, expiresAt, issuedAt, keyId, metadata, name, usage

Constructor Details

StoreCredentialConfigurationProperties

public StoreCredentialConfigurationProperties()

Method Details

getStore

@Nullable
public StoreConfigurationProperties getStore()

Gets the configuration for the KeyStore holding the key pair entry.

Returns:

the store configuration

setStore

public void setStore(@Nullable
 StoreConfigurationProperties store)

Assigns the configuration for the KeyStore holding the key pair entry.

Parameters:

store - the store configuration

getStoreReference

@Nullable
public String getStoreReference()

Gets the key store reference.

Returns:

the store reference

setStoreReference

public void setStoreReference(@Nullable
 String storeReference)

Assigns the key store reference.

Parameters:

storeReference - the store reference

getMonitor

@Nullable
public Boolean getMonitor()

Gets whether the credential should be prepared for monitoring.

Returns:

whether to monitor the credential

setMonitor

public void setMonitor(@Nullable
 Boolean monitor)

Assigns whether the credential should be prepared for monitoring.

Parameters:

monitor - whether to monitor the credential

getKey

@Nullable
public StoreCredentialConfigurationProperties.KeyConfigurationProperties getKey()

Gets the configuration for the key pair entry of the store.

Returns:

the key configuration

setKey

public void setKey(@Nullable
 StoreCredentialConfigurationProperties.KeyConfigurationProperties key)

Assigns the configuration for the key pair entry of the store.

Parameters:

key - the key configuration

store

public Optional<StoreConfiguration> store()

Configuration for the KeyStore holding the key pair entry.

Specified by:

store in interface StoreCredentialConfiguration

Returns:

key store configuration

storeReference

public Optional<String> storeReference()

As an alternative to giving the key store configuration, a reference to a key store configuration may be given. This feature may be used when one key store holds several keys.

Specified by:

storeReference in interface StoreCredentialConfiguration

Returns:

a key store reference

monitor

public Optional<Boolean> monitor()

Whether the credential should be prepared for monitoring. If set, a test function and a KeyStoreReloader will be assigned.

If not present, the default should be true for PKCS#11 stores, and false otherwise

Specified by:

monitor in interface StoreCredentialConfiguration

Returns:

whether the credential should be prepared for monitoring

key

public StoreCredentialConfiguration.KeyConfiguration key()

Configuration for the key pair entry of the store.

Specified by:

key in interface StoreCredentialConfiguration

Returns:

the key entry configuration

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractBaseCredentialConfigurationProperties

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBaseCredentialConfigurationProperties