Uses of Interface
se.swedenconnect.security.credential.PkiCredential

Packages that use PkiCredential

Package	Description
se.swedenconnect.security.credential	Generic support for X.509 credentials.
se.swedenconnect.security.credential.bundle	Support for credential "bundles".
se.swedenconnect.security.credential.container	Support for credential containers.
se.swedenconnect.security.credential.factory	Spring factory beans for creating credential objects.
se.swedenconnect.security.credential.nimbus	Nimbus add-ons for credentials support.
se.swedenconnect.security.credential.opensaml	Credentials defined for use with OpenSAML/Shibboleth.
se.swedenconnect.security.credential.pkcs11	Interfaces and classes for handling PKCS#11 providers.
se.swedenconnect.security.credential.spring.config	Spring support for configuring credentials.
se.swedenconnect.security.credential.spring.factory	Spring factory classes for credentials.

Uses of PkiCredential in se.swedenconnect.security.credential

Subinterfaces of PkiCredential in se.swedenconnect.security.credential

Modifier and Type	Interface	Description
interface	ReloadablePkiCredential	An interface for credentials are "testable" and "reloadable".

Classes in se.swedenconnect.security.credential that implement PkiCredential

Modifier and Type	Class	Description
class	AbstractPkiCredential	Abstract base class for classes implementing the PkiCredential interface.
class	AbstractReloadablePkiCredential	Abstract base class for reloadable credentials.
class	BasicCredential	A basic implementation of the PkiCredential interface.
class	KeyStoreCredential	A KeyStore implementation of the PkiCredential and ReloadablePkiCredential interfaces.

Fields in se.swedenconnect.security.credential with type parameters of type PkiCredential

Modifier and Type	Field	Description
static Predicate<PkiCredential>	PkiCredentialCollection.encryptionUsage	Predicate that checks if the credential has the PkiCredential.Metadata.USAGE_ENCRYPTION usage.
static Predicate<PkiCredential>	PkiCredentialCollection.forFutureSigning	Predicate that tells if a credential is intended to be the signing credential in the future.
static Predicate<PkiCredential>	PkiCredentialCollection.isActive	Predicate that checks if the credential is "active", meaning that the current time is within the PkiCredential.Metadata.ACTIVE_FROM_PROPERTY and PkiCredential.Metadata.ACTIVE_TO_PROPERTY properties.
static Predicate<PkiCredential>	PkiCredentialCollection.isEc	Predicate that tells whether a credential holds an EC key.
static Predicate<PkiCredential>	PkiCredentialCollection.isHardwareCredential	Predicate that tells whether a credential is a hardware credential, i.e., stored on an HSM.
static Predicate<PkiCredential>	PkiCredentialCollection.isNotYetActive	Predicate that tells whether the credential is "not yet active", meaning that the PkiCredential.Metadata.ACTIVE_FROM_PROPERTY setting is after the current time.
static Predicate<PkiCredential>	PkiCredentialCollection.isRsa	Predicate that tells whether a credential holds an RSA key.
static Predicate<PkiCredential>	PkiCredentialCollection.noLongerActive	Predicate that checks if the credential is no longer active, meaning that a PkiCredential.Metadata.ACTIVE_TO_PROPERTY setting is before the current time.
static Predicate<PkiCredential>	PkiCredentialCollection.signatureUsage	Predicate that checks if the credential has the PkiCredential.Metadata.USAGE_SIGNING usage.
static Predicate<PkiCredential>	PkiCredentialCollection.unspecifiedUsage	Predicate that checks if the credential does not have a specified usage.

Methods in se.swedenconnect.security.credential that return PkiCredential

Modifier and Type	Method	Description
PkiCredential	PkiCredentialCollection.getCredential(Predicate<PkiCredential> predicate)	Returns the first credential of the collection whose properties meet the supplied Predicate.
PkiCredential	PkiCredentialCollection.getCredentialForSigning()	Method that finds a credential suitable for signing.

Methods in se.swedenconnect.security.credential that return types with arguments of type PkiCredential

Modifier and Type	Method	Description
List<PkiCredential>	PkiCredentialCollection.getCredentials()	Gets an unmodifiable list of all credentials held in the collection.
List<PkiCredential>	PkiCredentialCollection.getCredentials(Predicate<PkiCredential> predicate)	Returns all credentials whose properties meet the supplied Predicate.
List<PkiCredential>	PkiCredentialCollection.getCredentialsForEncryption()	Method that finds credentials suitable for encryption (and decryption).
static Predicate<PkiCredential>	PkiCredentialCollection.keyId(String kid)	Method that returns a Predicate that checks if a credential has a given key ID.
List<PkiCredential>	PkiCredentialCollection.removeCredentials(Predicate<PkiCredential> predicate)	Removes all credentials matching the supplied Predicate.
static Predicate<PkiCredential>	PkiCredentialCollection.usage(String usage)	Method that returns a Predicate that checks if a credential has a given usage.

Methods in se.swedenconnect.security.credential with parameters of type PkiCredential

Modifier and Type	Method	Description
void	PkiCredentialCollection.addCredential(PkiCredential credential)	Adds a credential to the collection.

Method parameters in se.swedenconnect.security.credential with type arguments of type PkiCredential

Modifier and Type	Method	Description
PkiCredential	PkiCredentialCollection.getCredential(Predicate<PkiCredential> predicate)	Returns the first credential of the collection whose properties meet the supplied Predicate.
List<PkiCredential>	PkiCredentialCollection.getCredentials(Predicate<PkiCredential> predicate)	Returns all credentials whose properties meet the supplied Predicate.
List<PkiCredential>	PkiCredentialCollection.removeCredentials(Predicate<PkiCredential> predicate)	Removes all credentials matching the supplied Predicate.
default <T> T	PkiCredential.transform(Function<PkiCredential,T> transformFunction)	Transforms the credential to another format, for example an JWK or a KeyPair.

Constructor parameters in se.swedenconnect.security.credential with type arguments of type PkiCredential

Modifier	Constructor	Description
	PkiCredentialCollection(List<PkiCredential> credentials)	Constructor.

Uses of PkiCredential in se.swedenconnect.security.credential.bundle

Methods in se.swedenconnect.security.credential.bundle that return PkiCredential

Modifier and Type	Method	Description
PkiCredential	CredentialBundles.getCredential(String id)	Gets the PkiCredential registered under the given ID.
PkiCredential	DefaultCredentialBundleRegistry.getCredential(String id)	Gets the PkiCredential registered under the given ID.

Methods in se.swedenconnect.security.credential.bundle that return types with arguments of type PkiCredential

Modifier and Type	Method	Description
default Function<String,PkiCredential>	CredentialBundles.getCredentialProvider()	Gets a function that provides a credential based on an identifier.

Methods in se.swedenconnect.security.credential.bundle with parameters of type PkiCredential

Modifier and Type	Method	Description
void	CredentialBundleRegistry.registerCredential(String id, PkiCredential credential)	Registers a credential.
void	DefaultCredentialBundleRegistry.registerCredential(String id, PkiCredential credential)	Registers a credential.

Uses of PkiCredential in se.swedenconnect.security.credential.container

Classes in se.swedenconnect.security.credential.container that implement PkiCredential

Modifier and Type	Class	Description
class	ManagedPkiCredential	A managed PkiCredential is used when a PkiCredentialContainer returns credentials.

Methods in se.swedenconnect.security.credential.container that return PkiCredential

Modifier and Type	Method	Description
protected abstract PkiCredential	AbstractKeyStorePkiCredentialContainer.getCredentialFromAlias(String alias)	Gets the credential for a specific alias from the credential container.
PkiCredential	HsmPkiCredentialContainer.getCredentialFromAlias(String alias)	Gets the credential for a specific alias from the credential container.
PkiCredential	SoftPkiCredentialContainer.getCredentialFromAlias(String alias)	Gets the credential for a specific alias from the credential container.

Constructors in se.swedenconnect.security.credential.container with parameters of type PkiCredential

Modifier	Constructor	Description
	ManagedPkiCredential(PkiCredential managedCredential, Consumer<PkiCredential> destroyCallback, Consumer<X509Certificate[]> updateCertificateCallback)	Constructor setting the credential to be managed and callbacks to be used by the underlying container.

Constructor parameters in se.swedenconnect.security.credential.container with type arguments of type PkiCredential

Modifier	Constructor	Description
	ManagedPkiCredential(PkiCredential managedCredential, Consumer<PkiCredential> destroyCallback, Consumer<X509Certificate[]> updateCertificateCallback)	Constructor setting the credential to be managed and callbacks to be used by the underlying container.

Uses of PkiCredential in se.swedenconnect.security.credential.factory

Methods in se.swedenconnect.security.credential.factory that return PkiCredential

Modifier and Type	Method	Description
PkiCredential	PkiCredentialFactory.createCredential(PemCredentialConfiguration configuration)	Creates a PkiCredential based on a PemCredentialConfiguration.
static PkiCredential	PkiCredentialFactory.createCredential(PemCredentialConfiguration configuration, ConfigurationResourceLoader resourceLoader)	Creates a PkiCredential based on a PemCredentialConfiguration.
PkiCredential	PkiCredentialFactory.createCredential(PkiCredentialConfiguration configuration)	Creates a PkiCredential based on the supplied PkiCredentialConfiguration.
static PkiCredential	PkiCredentialFactory.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	PkiCredentialFactory.createCredential(StoreCredentialConfiguration configuration)	Creates a PkiCredential based on a StoreCredentialConfiguration.
static PkiCredential	PkiCredentialFactory.createCredential(StoreCredentialConfiguration configuration, ConfigurationResourceLoader resourceLoader, Function<String,KeyStore> keyStoreProvider, Function<String,KeyStoreReloader> keyStoreReloaderProvider)	Creates a PkiCredential based on a StoreCredentialConfiguration.
protected PkiCredential	PkiCredentialFactoryBean.createInstance()	Deprecated, for removal: This API element is subject to removal in a future version. Invokes PkiCredentialFactory.createCredential(PkiCredentialConfiguration, ConfigurationResourceLoader, Function, Function, Function).

Method parameters in se.swedenconnect.security.credential.factory with type arguments of type PkiCredential

Modifier and Type	Method	Description
static PkiCredential	PkiCredentialFactory.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.
static PkiCredentialCollection	PkiCredentialFactory.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.

Constructor parameters in se.swedenconnect.security.credential.factory with type arguments of type PkiCredential

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

Uses of PkiCredential in se.swedenconnect.security.credential.nimbus

Fields in se.swedenconnect.security.credential.nimbus with type parameters of type PkiCredential

Modifier and Type	Field	Description
static final Function<PkiCredential,Algorithm>	JwkTransformerFunction.defaultAlgorithmFunction	Default algorithm for getting the JOSE algorithm.
static final Function<PkiCredential,Set<KeyOperation>>	JwkTransformerFunction.defaultKeyOpsFunction	Default function for getting the key operation property.
static final Function<PkiCredential,KeyUse>	JwkTransformerFunction.defaultKeyUseFunction	Default function for getting the key use.

Methods in se.swedenconnect.security.credential.nimbus with parameters of type PkiCredential

Modifier and Type	Method	Description
JWK	JwkTransformerFunction.apply(PkiCredential credential)	Transforms the supplied PkiCredential into an JWK.
String	JwkTransformerFunction.DefaultKeyIdFunction.apply(PkiCredential credential)	If the credential metadata contains a key-id, this is used, otherwise the function attempts to calculate the RFC 7638 thumbprint, and finally the serial number of the certificate is used for key id-calculation.

Method parameters in se.swedenconnect.security.credential.nimbus with type arguments of type PkiCredential

Modifier and Type	Method	Description
void	JwkTransformerFunction.setAlgorithmFunction(Function<PkiCredential,Algorithm> algorithmFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use JwkTransformerFunction.withAlgorithmFunction(Function) instead
void	JwkTransformerFunction.setKeyIdFunction(Function<PkiCredential,String> keyIdFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use JwkTransformerFunction.withKeyIdFunction(Function) instead
void	JwkTransformerFunction.setKeyOpsFunction(Function<PkiCredential,Set<KeyOperation>> keyOpsFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use JwkTransformerFunction.withKeyOpsFunction(Function) instead
void	JwkTransformerFunction.setKeyUseFunction(Function<PkiCredential,KeyUse> keyUseFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use JwkTransformerFunction.withKeyUseFunction(Function) instead
JwkTransformerFunction	JwkTransformerFunction.withAlgorithmFunction(Function<PkiCredential,Algorithm> algorithmFunction)	Customizes this function with a function that returns the JOSE algorithm.
JwkTransformerFunction	JwkTransformerFunction.withKeyIdFunction(Function<PkiCredential,String> keyIdFunction)	Customizes the function with a custom function for calculating the key ID property (JWK kid property).
JwkTransformerFunction	JwkTransformerFunction.withKeyOpsFunction(Function<PkiCredential,Set<KeyOperation>> keyOpsFunction)	Customizes this function with a function that returns a set of KeyOperations.
JwkTransformerFunction	JwkTransformerFunction.withKeyUseFunction(Function<PkiCredential,KeyUse> keyUseFunction)	Customizes this function with a function for getting the key use property (JWK use property).

Uses of PkiCredential in se.swedenconnect.security.credential.opensaml

Fields in se.swedenconnect.security.credential.opensaml with type parameters of type PkiCredential

Modifier and Type	Field	Description
static final BiFunction<PkiCredential,UsageType,List<EncryptionMethod>>	KeyDescriptorTransformerFunction.defaultEncryptionMethodsFunction	The default function for getting md:EncryptionMethod objects to be added to the md:KeyDescriptor.
static final Function<PkiCredential,String>	OpenSamlCredentialTransformerFunction.defaultEntityIdFunction	Accesses the entity-id metadata property from the supplied credential.
static final Function<PkiCredential,String>	KeyDescriptorTransformerFunction.defaultKeyNameFunction	The default function for calculating the ds:keyName.
static final Function<PkiCredential,UsageType>	KeyDescriptorTransformerFunction.defaultUsageTypeFunction	The default function for getting the usage type (use attribute).
static final Function<PkiCredential,UsageType>	OpenSamlCredentialTransformerFunction.defaultUsageTypeFunction	Determines the credential usage.

Methods in se.swedenconnect.security.credential.opensaml with parameters of type PkiCredential

Modifier and Type	Method	Description
KeyDescriptor	KeyDescriptorTransformerFunction.apply(PkiCredential credential)	Given the supplied PkiCredential, the method creates an OpenSAML KeyDescriptor for inclusion in an EntityDescriptor.
X509Credential	OpenSamlCredentialTransformerFunction.apply(PkiCredential credential)	Transforms the supplied PkiCredential into an X509Credential.

Method parameters in se.swedenconnect.security.credential.opensaml with type arguments of type PkiCredential

Modifier and Type	Method	Description
void	OpenSamlCredentialTransformerFunction.setEntityIdFunction(Function<PkiCredential,String> entityIdFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use OpenSamlCredentialTransformerFunction.withEntityIdFunction(Function) instead
KeyDescriptorTransformerFunction	KeyDescriptorTransformerFunction.withEncryptionMethodsFunction(BiFunction<PkiCredential,UsageType,List<EncryptionMethod>> encryptionMethodsFunction)	Customizes this function with a function that returns a list of md:EncryptionMethod elements for inclusion in the md:KeyDescriptor.
OpenSamlCredentialTransformerFunction	OpenSamlCredentialTransformerFunction.withEntityIdFunction(Function<PkiCredential,String> entityIdFunction)	Customizes this function with a function that gets the entityID for the credential.
KeyDescriptorTransformerFunction	KeyDescriptorTransformerFunction.withKeyNameFunction(Function<PkiCredential,String> keyNameFunction)	Customizes this function with a function that calculates the ds:KeyName.
KeyDescriptorTransformerFunction	KeyDescriptorTransformerFunction.withUsageTypeFunction(Function<PkiCredential,UsageType> usageTypeFunction)	Customizes this function with a function that gets the use attribute.
OpenSamlCredentialTransformerFunction	OpenSamlCredentialTransformerFunction.withUsageTypeFunction(Function<PkiCredential,UsageType> usageTypeFunction)	Customizes this function with a function the gets the credential usage type.

Constructors in se.swedenconnect.security.credential.opensaml with parameters of type PkiCredential

Modifier	Constructor	Description
	OpenSamlCredential(PkiCredential credential)	Constructor setting up the OpenSAML credential by assigning a PkiCredential instance.

Uses of PkiCredential in se.swedenconnect.security.credential.pkcs11

Classes in se.swedenconnect.security.credential.pkcs11 that implement PkiCredential

Modifier and Type	Class	Description
class	Pkcs11Credential	A PKCS#11 credential implementation of the PkiCredential and ReloadablePkiCredential interfaces.

Uses of PkiCredential in se.swedenconnect.security.credential.spring.config

Methods in se.swedenconnect.security.credential.spring.config that return PkiCredential

Modifier and Type	Method	Description
PkiCredential	PkiCredentialReference.get()	Resolves a reference to a PkiCredential using the CredentialBundles bean.

Uses of PkiCredential in se.swedenconnect.security.credential.spring.factory

Methods in se.swedenconnect.security.credential.spring.factory that return PkiCredential

Modifier and Type	Method	Description
protected PkiCredential	PkiCredentialFactoryBean.createInstance()	Invokes PkiCredentialFactory.createCredential(PkiCredentialConfiguration, ConfigurationResourceLoader, Function, Function, Function).

Method parameters in se.swedenconnect.security.credential.spring.factory with type arguments of type PkiCredential

Modifier and Type	Method	Description
void	PkiCredentialFactoryBean.setCredentialProvider(Function<String,PkiCredential> credentialProvider)	If a configuration is used that has a credential reference, a credential provider is needed.