se.litsec.opensaml.saml2.metadata

Class MetadataUtils

java.lang.Object

se.litsec.opensaml.saml2.metadata.MetadataUtils

public class MetadataUtils
extends Object

Utility methods for accessing metadata elements.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Method Summary

Modifier and Type	Method and Description
static Optional<EntityAttributes>	getEntityAttributes(EntityDescriptor ed) Returns the EntityAttributes element that is placed as an extension to the supplied entity descriptor.
static List<X509Credential>	getMetadataCertificates(EntityDescriptor ed, UsageType usageType) Utility that extracs certificates found under the KeyDescriptor elements of a metadata record.
static <T> Optional<T>	getMetadataExtension(Extensions extensions, Class<T> clazz) Finds the first extension matching the supplied type.
static <T> List<T>	getMetadataExtensions(Extensions extensions, Class<T> clazz) Finds all extensions matching the supplied type.
static Optional<String>	getUiDescription(EntityDescriptor ed, String language) Utility method that returns the mdui:Description element for the given language tag from the SSO descriptor extension of the supplied entity descriptor.
static List<Description>	getUiDescriptions(EntityDescriptor ed) Utility method that returns a list of the mdui:Description element found in the SSO descriptor extension of the supplied entity descriptor.
static Optional<String>	getUiDisplayName(EntityDescriptor ed, String language) Utility method that returns the mdui:DisplayName element for the given language tag from the SSO descriptor extension of the supplied entity descriptor.
static List<DisplayName>	getUiDisplayNames(EntityDescriptor ed) Utility method that returns a list of the mdui:DisplayName element found in the SSO descriptor extension of the supplied entity descriptor.

Methods inherited from class java.lang.Object

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

Method Detail

getMetadataExtension

public static <T> Optional<T> getMetadataExtension(Extensions extensions,
                                                   Class<T> clazz)

Finds the first extension matching the supplied type.

Type Parameters:

T - the type of the extension

Parameters:

extensions - the Extensions to search

clazz - the extension type

Returns:

the matching extension

getMetadataExtensions

public static <T> List<T> getMetadataExtensions(Extensions extensions,
                                                Class<T> clazz)

Finds all extensions matching the supplied type.

Type Parameters:

T - the type of the extension

Parameters:

extensions - the Extensions to search

clazz - the extension type

Returns:

a (possibly empty) list of extensions elements of the given type

getEntityAttributes

public static Optional<EntityAttributes> getEntityAttributes(EntityDescriptor ed)

Returns the EntityAttributes element that is placed as an extension to the supplied entity descriptor.

Parameters:

ed - the entity descriptor

Returns:

the EntityAttributes element

getUiDisplayNames

public static List<DisplayName> getUiDisplayNames(EntityDescriptor ed)

Utility method that returns a list of the mdui:DisplayName element found in the SSO descriptor extension of the supplied entity descriptor.

Parameters:

ed - the entity descriptor

Returns:

a (possibly empty) list of DisplayName elements

getUiDisplayName

public static Optional<String> getUiDisplayName(EntityDescriptor ed,
                                                String language)

Utility method that returns the mdui:DisplayName element for the given language tag from the SSO descriptor extension of the supplied entity descriptor.

Parameters:

ed - the entity descriptor

language - the language tag

Returns:

the display name for the given language

getUiDescriptions

public static List<Description> getUiDescriptions(EntityDescriptor ed)

Utility method that returns a list of the mdui:Description element found in the SSO descriptor extension of the supplied entity descriptor.

Parameters:

ed - the entity descriptor

Returns:

a (possibly empty) list of Description elements

getUiDescription

public static Optional<String> getUiDescription(EntityDescriptor ed,
                                                String language)

Utility method that returns the mdui:Description element for the given language tag from the SSO descriptor extension of the supplied entity descriptor.

Parameters:

ed - the entity descriptor

language - the language tag

Returns:

the description for the given language

getMetadataCertificates

public static List<X509Credential> getMetadataCertificates(EntityDescriptor ed,
                                                           UsageType usageType)

Utility that extracs certificates found under the KeyDescriptor elements of a metadata record.

If UsageType.SIGNING is supplied, the method will return all certificates with usage type signing, but also those that does not have a usage. And the same goes for encryption.

Parameters:

ed - the metadata record

usageType - the requested usage type

Returns:

a list of credentials