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.

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

Modifier and Type	Method	Description
default <T> T	PkiCredential.transform(Function<PkiCredential,T> transformFunction)	Transforms the credential to another format, for example an JWK or a KeyPair.

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
static PkiCredential	PkiCredentialFactory.createCredential(PemCredentialConfiguration configuration, ConfigurationResourceLoader resourceLoader)	Creates a PkiCredential based on a PemCredentialConfiguration.
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 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.

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

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.
Algorithm	JwkTransformerFunction.DefaultAlgorithmFunction.apply(PkiCredential credential)	If the credential metadata property jose-alg is assigned to an Algorithm or string, an Algorithm is returned, otherwise null.
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.
Set<KeyOperation>	JwkTransformerFunction.DefaultKeyOpsFunction.apply(PkiCredential credential)	Returns a Set of KeyOperations if the metadata property key-ops is assigned to any of the following: A Collection of KeyOperation objects. A single KeyOperation object. An array of KeyOperation objects. A comma separated string with key operations (see valid string values in KeyOperation).
KeyUse	JwkTransformerFunction.DefaultKeyUseFunction.apply(PkiCredential credential)	Will use the key-use property from the metadata, and if not present, use the certificate to calculate the usage.

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)	Assigns the function that returns the JOSE algorithm.
void	JwkTransformerFunction.setKeyIdFunction(Function<PkiCredential,String> keyIdFunction)	Assigns the function that returns the key ID property (JWK kid property).
void	JwkTransformerFunction.setKeyOpsFunction(Function<PkiCredential,Set<KeyOperation>> keyOpsFunction)	Assigns the function that returns a set of KeyOperations.
void	JwkTransformerFunction.setKeyUseFunction(Function<PkiCredential,KeyUse> keyUseFunction)	Assigns the function that returns the key use property (JWK use property).

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

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

Modifier and Type	Method	Description
X509Credential	OpenSamlCredentialTransformerFunction.apply(PkiCredential credential)	Transforms the supplied PkiCredential into an X509Credential.
String	OpenSamlCredentialTransformerFunction.DefaultEntityIdFunction.apply(PkiCredential credential)	Accesses the entity-id metadata property from the supplied credential.

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)	Assigns the function that gets the SAML entity ID to add to the OpenSAML credential.

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.