Package se.swedenconnect.spring.saml.idp.settings

Class CredentialSettings

java.lang.Object

se.swedenconnect.spring.saml.idp.settings.AbstractSettings

se.swedenconnect.spring.saml.idp.settings.CredentialSettings

All Implemented Interfaces:

Serializable

public class CredentialSettings
extends AbstractSettings

Settings for Identity Provider credentials.

Author:

Martin Lindström

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CredentialSettings.Builder	A builder for CredentialSettings.

Nested classes/interfaces inherited from class se.swedenconnect.spring.saml.idp.settings.AbstractSettings

AbstractSettings.AbstractBuilder<T extends AbstractSettings,B extends AbstractSettings.AbstractBuilder<T,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CREDENTIAL	The IdP default credential.
static final String	ENCRYPT_CREDENTIAL	The IdP encryption credential.
static final String	FUTURE_SIGN_CERTIFICATE	A certificate that will be the future signing certificate.
static final String	METADATA_SIGN_CREDENTIAL	The SAML metadata signing credential.
static final String	PREVIOUS_ENCRYPT_CREDENTIAL	The previous IdP encryption credential.
static final String	SIGN_CREDENTIAL	The IdP signing credential.

Method Summary

Modifier and Type	Method	Description
static CredentialSettings.Builder	builder()	Constructs a new CredentialSettings.Builder with no settings.
PkiCredential	getDefaultCredential()	Gets the default IdP credential.
PkiCredential	getEncryptCredential()	Gets the encryption IdP credential.
X509Certificate	getFutureSignCertificate()	Gets the future IdP signing certificate.
PkiCredential	getMetadataSignCredential()	Gets the credential for signing metadata.
PkiCredential	getPreviousEncryptCredential()	Gets the previous encryption IdP credential.
PkiCredential	getSignCredential()	Gets the signing IdP credential.
static CredentialSettings.Builder	withSettings(Map<String,Object> settings)	Constructs a new CredentialSettings.Builder with the provided settings.

Methods inherited from class se.swedenconnect.spring.saml.idp.settings.AbstractSettings

equals, getSetting, getSettings, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CREDENTIAL

public static final String DEFAULT_CREDENTIAL

The IdP default credential. A PkiCredential.

See Also:

• Constant Field Values

SIGN_CREDENTIAL

public static final String SIGN_CREDENTIAL

The IdP signing credential. A PkiCredential.

See Also:

• Constant Field Values

FUTURE_SIGN_CERTIFICATE

public static final String FUTURE_SIGN_CERTIFICATE

A certificate that will be the future signing certificate. Is set before a key-rollover is performed. A X509Certificate.

See Also:

• Constant Field Values

ENCRYPT_CREDENTIAL

public static final String ENCRYPT_CREDENTIAL

The IdP encryption credential. A PkiCredential.

See Also:

• Constant Field Values

PREVIOUS_ENCRYPT_CREDENTIAL

public static final String PREVIOUS_ENCRYPT_CREDENTIAL

The previous IdP encryption credential. Assigned after a key-rollover. A PkiCredential.

See Also:

• Constant Field Values

METADATA_SIGN_CREDENTIAL

public static final String METADATA_SIGN_CREDENTIAL

The SAML metadata signing credential. A PkiCredential.

See Also:

• Constant Field Values

Method Details

getDefaultCredential

public PkiCredential getDefaultCredential()

Gets the default IdP credential.

Returns:

the credential or null if not assigned

getSignCredential

public PkiCredential getSignCredential()

Gets the signing IdP credential.

Returns:

the credential or null if none is assigned

getFutureSignCertificate

public X509Certificate getFutureSignCertificate()

Gets the future IdP signing certificate. Assigned before a key-rollover is performed.

Returns:

a certificate or null if none is assigned

getEncryptCredential

public PkiCredential getEncryptCredential()

Gets the encryption IdP credential.

Returns:

the credential or null if none is assigned

getPreviousEncryptCredential

public PkiCredential getPreviousEncryptCredential()

Gets the previous encryption IdP credential. Assigned after a key-rollover has been performed.

Returns:

the credential or null if none is assigned

getMetadataSignCredential

public PkiCredential getMetadataSignCredential()

Gets the credential for signing metadata.

Returns:

the credential or null if none has been assigned

builder

public static CredentialSettings.Builder builder()

Constructs a new CredentialSettings.Builder with no settings.

Returns:

the CredentialSettings.Builder

withSettings

public static CredentialSettings.Builder withSettings(Map<String,Object> settings)

Constructs a new CredentialSettings.Builder with the provided settings.

Parameters:

settings - the settings to initialize the builder

Returns:

the builder