Package se.swedenconnect.security.credential.opensaml

Class OpenSamlCredentialTransformerFunction

java.lang.Object

se.swedenconnect.security.credential.opensaml.OpenSamlCredentialTransformerFunction

All Implemented Interfaces:

Function<PkiCredential,X509Credential>

public class OpenSamlCredentialTransformerFunction
extends Object
implements Function<PkiCredential,X509Credential>

Function that transform a PkiCredential into an OpenSAML X509Credential.

Author:

Martin Lindström

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<PkiCredential,String>	defaultEntityIdFunction	Accesses the entity-id metadata property from the supplied credential.
static final Function<PkiCredential,UsageType>	defaultUsageTypeFunction	Determines the credential usage.

Constructor Summary

Constructors

Constructor	Description
OpenSamlCredentialTransformerFunction()	Constructor.

Method Summary

Modifier and Type	Method	Description
X509Credential	apply(PkiCredential credential)	Transforms the supplied PkiCredential into an X509Credential.
static OpenSamlCredentialTransformerFunction	function()	Creates a OpenSamlCredentialTransformerFunction.
void	setEntityIdFunction(Function<PkiCredential,String> entityIdFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use withEntityIdFunction(Function) instead
OpenSamlCredentialTransformerFunction	withEntityIdFunction(Function<PkiCredential,String> entityIdFunction)	Customizes this function with a function that gets the entityID for the credential.
OpenSamlCredentialTransformerFunction	withUsageTypeFunction(Function<PkiCredential,UsageType> usageTypeFunction)	Customizes this function with a function the gets the credential usage type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

defaultEntityIdFunction

public static final Function<PkiCredential,String> defaultEntityIdFunction

Accesses the entity-id metadata property from the supplied credential.

defaultUsageTypeFunction

public static final Function<PkiCredential,UsageType> defaultUsageTypeFunction

Determines the credential usage.

Constructor Details

OpenSamlCredentialTransformerFunction

public OpenSamlCredentialTransformerFunction()

Constructor.

Method Details

function

@Nonnull
public static OpenSamlCredentialTransformerFunction function()

Creates a OpenSamlCredentialTransformerFunction.

Returns:

a a OpenSamlCredentialTransformerFunction

apply

@Nonnull
public X509Credential apply(@Nonnull
 PkiCredential credential)

Transforms the supplied PkiCredential into an X509Credential.

Specified by:

apply in interface Function<PkiCredential,X509Credential>

withEntityIdFunction

@Nonnull
public OpenSamlCredentialTransformerFunction withEntityIdFunction(@Nonnull
 Function<PkiCredential,String> entityIdFunction)

Customizes this function with a function that gets the entityID for the credential.

The default implementation is the defaultEntityIdFunction.

Parameters:

entityIdFunction - the function

Returns:

this instance

setEntityIdFunction

@Deprecated(since="2.1.0",
            forRemoval=true)
public void setEntityIdFunction(@Nonnull
 Function<PkiCredential,String> entityIdFunction)

Deprecated, for removal: This API element is subject to removal in a future version.

use withEntityIdFunction(Function) instead

Assigns the function that gets the SAML entity ID to add to the OpenSAML credential.

The default implementation is the defaultEntityIdFunction.

Parameters:

entityIdFunction - the function

withUsageTypeFunction

@Nonnull
public OpenSamlCredentialTransformerFunction withUsageTypeFunction(@Nonnull
 Function<PkiCredential,UsageType> usageTypeFunction)

Customizes this function with a function the gets the credential usage type.

The default implementation is the defaultUsageTypeFunction.

Parameters:

usageTypeFunction - the function

Returns:

this instance