net.shibboleth.metadata.dom.saml

Class SAMLMetadataSupport

java.lang.Object

net.shibboleth.metadata.dom.saml.SAMLMetadataSupport

@ThreadSafe
public final class SAMLMetadataSupport
extends Object

Helper class for dealing with SAML metadata.

Field Summary

Fields

Modifier and Type	Field and Description
static QName	CACHE_DURATION_ATTRIB_NAME cacheDuration attribute name.
static QName	ENTITIES_DESCRIPTOR_NAME EntitiesDescriptor element name.
static QName	ENTITY_DESCRIPTOR_NAME EntityDescriptor element name.
static QName	EXTENSIONS_NAME Extensions element name.
static String	MD_NS SAML Metadata namespace URI.
static String	MD_PREFIX Default SAML Metadata namespace prefix.
static QName	VALID_UNTIL_ATTRIB_NAME validUntil attribute name.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SAMLMetadataSupport() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDescriptorExtension(Element descriptor, Element extension) Adds a given extension to a given descriptor.
static List<Element>	getDescriptorExtensionList(Element descriptor, QName extensionName) Gets a list of all instances of an extension element for a given descriptor.
static Element	getDescriptorExtensions(Element descriptor, QName extensionName) Gets the first instance of an extension element for a given descriptor.
static boolean	isEntitiesDescriptor(Element e) Checks if the given element is an EntitiesDescriptor.
static boolean	isEntityDescriptor(Element e) Checks if the given element is an EntityDescriptor.
static boolean	isEntityOrEntitiesDescriptor(Element e) Check if the given element is an EntityDescriptor or EntitiesDescriptor.

Methods inherited from class java.lang.Object

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

Field Detail

MD_NS

public static final String MD_NS

SAML Metadata namespace URI.

See Also:

Constant Field Values

MD_PREFIX

public static final String MD_PREFIX

Default SAML Metadata namespace prefix.

See Also:

Constant Field Values

ENTITIES_DESCRIPTOR_NAME

public static final QName ENTITIES_DESCRIPTOR_NAME

EntitiesDescriptor element name.

ENTITY_DESCRIPTOR_NAME

public static final QName ENTITY_DESCRIPTOR_NAME

EntityDescriptor element name.

EXTENSIONS_NAME

public static final QName EXTENSIONS_NAME

Extensions element name.

VALID_UNTIL_ATTRIB_NAME

public static final QName VALID_UNTIL_ATTRIB_NAME

validUntil attribute name.

CACHE_DURATION_ATTRIB_NAME

public static final QName CACHE_DURATION_ATTRIB_NAME

cacheDuration attribute name.

Constructor Detail

SAMLMetadataSupport

private SAMLMetadataSupport()

Constructor.

Method Detail

isEntityOrEntitiesDescriptor

public static boolean isEntityOrEntitiesDescriptor(@Nullable
                                   Element e)

Check if the given element is an EntityDescriptor or EntitiesDescriptor.

Parameters:

e - element to check

Returns:

true if the element is an EntityDescriptor or EntitiesDescriptor

isEntitiesDescriptor

public static boolean isEntitiesDescriptor(@Nullable
                           Element e)

Checks if the given element is an EntitiesDescriptor.

Parameters:

e - element to check

Returns:

true if the element is an EntitiesDescriptor, false otherwise

isEntityDescriptor

public static boolean isEntityDescriptor(@Nullable
                         Element e)

Checks if the given element is an EntityDescriptor.

Parameters:

e - element to check

Returns:

true if the element is an EntityDescriptor, false otherwise

getDescriptorExtensionList

@Nonnull
public static List<Element> getDescriptorExtensionList(@Nonnull
                                               Element descriptor,
                                               @Nonnull
                                               QName extensionName)

Gets a list of all instances of an extension element for a given descriptor. An empty list is returned if the descriptor has no extensions, or if it has no extensions of the requested type.

Parameters:

descriptor - the descriptor, never null

extensionName - name of the extension element, never null

Returns:

a possibly empty list of all extension instances

getDescriptorExtensions

public static Element getDescriptorExtensions(@Nullable
                              Element descriptor,
                              @Nullable
                              QName extensionName)

Gets the first instance of an extension element for a given descriptor.

Parameters:

descriptor - the descriptor, never null

extensionName - the name of the extension element, never null

Returns:

the first instance of the extension element or null if either argument is null, or no such element exists as an extension of the descriptor

addDescriptorExtension

public static void addDescriptorExtension(@Nullable
                          Element descriptor,
                          @Nullable
                          Element extension)

Adds a given extension to a given descriptor. If the given descriptor does not yet have an extensions element then one is added, otherwise the given extension is added as after any existing extensions.

Parameters:

descriptor - descriptor to which the extension will be added

extension - extension to be added to the descriptor