Package se.swedenconnect.security.credential.opensaml

Class KeyDescriptorTransformerFunction

java.lang.Object

se.swedenconnect.security.credential.opensaml.KeyDescriptorTransformerFunction

All Implemented Interfaces:

Function<PkiCredential,KeyDescriptor>

public class KeyDescriptorTransformerFunction
extends Object
implements Function<PkiCredential,KeyDescriptor>

Function that transform a PkiCredential into an OpenSAML KeyDescriptor.

Author:

Martin Lindström

Field Summary

Fields

Modifier and Type	Field	Description
static final BiFunction<PkiCredential,UsageType,List<EncryptionMethod>>	defaultEncryptionMethodsFunction	The default function for getting md:EncryptionMethod objects to be added to the md:KeyDescriptor.
static final Function<PkiCredential,String>	defaultKeyNameFunction	The default function for calculating the ds:keyName.
static final Function<PkiCredential,UsageType>	defaultUsageTypeFunction	The default function for getting the usage type (use attribute).

Constructor Summary

Constructors

Constructor	Description
KeyDescriptorTransformerFunction()	Constructor.

Method Summary

Modifier and Type	Method	Description
KeyDescriptor	apply(PkiCredential credential)	Given the supplied PkiCredential, the method creates an OpenSAML KeyDescriptor for inclusion in an EntityDescriptor.
static KeyDescriptorTransformerFunction	function()	Creates a 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.
KeyDescriptorTransformerFunction	withKeyNameFunction(Function<PkiCredential,String> keyNameFunction)	Customizes this function with a function that calculates the ds:KeyName.
KeyDescriptorTransformerFunction	withUsageTypeFunction(Function<PkiCredential,UsageType> usageTypeFunction)	Customizes this function with a function that gets the use attribute.

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

defaultKeyNameFunction

public static final Function<PkiCredential,String> defaultKeyNameFunction

The default function for calculating the ds:keyName. It uses the PkiCredential.getName().

defaultUsageTypeFunction

public static final Function<PkiCredential,UsageType> defaultUsageTypeFunction

The default function for getting the usage type (use attribute). It checks if the metadata property PkiCredential.Metadata.USAGE_PROPERTY is assigned, and set to either PkiCredential.Metadata.USAGE_SIGNING or PkiCredential.Metadata.USAGE_ENCRYPTION.

defaultEncryptionMethodsFunction

public static final BiFunction<PkiCredential,UsageType,List<EncryptionMethod>> defaultEncryptionMethodsFunction

The default function for getting md:EncryptionMethod objects to be added to the md:KeyDescriptor. If the usage for the credential is encryption (or unspecified), and the metadata property OpenSamlMetadataProperties.ENCRYPTION_METHODS has been assigned, these values are used to create md:EncryptionMethod elements.

Constructor Details

KeyDescriptorTransformerFunction

public KeyDescriptorTransformerFunction()

Constructor.

Method Details

function

public static KeyDescriptorTransformerFunction function()

Creates a KeyDescriptorTransformerFunction.

Returns:

a KeyDescriptorTransformerFunction

apply

@Nonnull
public KeyDescriptor apply(@Nonnull
 PkiCredential credential)

Given the supplied PkiCredential, the method creates an OpenSAML KeyDescriptor for inclusion in an EntityDescriptor.

Unless changed with the withXXX method, the method will process the following parameters:

• The credential name - The name, as given by PkiCredential.getName() will be used as value for the ds:KeyName element. See defaultKeyNameFunction.
• The usage - If the metadata property PkiCredential.Metadata.USAGE_PROPERTY is assigned, and set to either PkiCredential.Metadata.USAGE_SIGNING or PkiCredential.Metadata.USAGE_ENCRYPTION, the use attribute of the md:KeyDescriptor element will be set accordingly. See defaultUsageTypeFunction.
• Encryption methods - If the usage for the credential is encryption (or unspecified), and the metadata property OpenSamlMetadataProperties.ENCRYPTION_METHODS has been assigned, these values are used to create, and add, md:EncryptionMethod elements to the resulting md:KeyDescriptor. See defaultEncryptionMethodsFunction.

Specified by:

apply in interface Function<PkiCredential,KeyDescriptor>

Parameters:

credential - the credential

Returns:

a KeyDescriptor

withKeyNameFunction

@Nonnull
public KeyDescriptorTransformerFunction withKeyNameFunction(@Nonnull
 Function<PkiCredential,String> keyNameFunction)

Customizes this function with a function that calculates the ds:KeyName.

The default is defaultKeyNameFunction.

Parameters:

keyNameFunction - the function

Returns:

this instance

withUsageTypeFunction

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

Customizes this function with a function that gets the use attribute.

The default is defaultUsageTypeFunction.

Parameters:

usageTypeFunction - the function

Returns:

this instance

withEncryptionMethodsFunction

@Nonnull
public KeyDescriptorTransformerFunction withEncryptionMethodsFunction(@Nonnull
 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.

Parameters:

encryptionMethodsFunction - the function

Returns:

this instance