org.opensaml.saml.metadata.resolver.filter.impl

Class SchemaValidationFilter

java.lang.Object

org.opensaml.saml.metadata.resolver.filter.impl.SchemaValidationFilter

All Implemented Interfaces:

MetadataFilter

public class SchemaValidationFilter
extends java.lang.Object
implements MetadataFilter

A metadata filter that schema validates an incoming metadata file.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private SAMLSchemaBuilder	samlSchemaBuilder SAML schema source.
private net.shibboleth.utilities.java.support.xml.SchemaBuilder	schemaBuilder Self-managed SchemaBuilder to support old extension schema parameter.

Constructor Summary

Constructors

Constructor and Description
SchemaValidationFilter(SAMLSchemaBuilder builder) Constructor.
SchemaValidationFilter(SAMLSchemaBuilder builder, java.lang.String[] extensionSchemas) Deprecated.

Method Summary

Modifier and Type	Method and Description
XMLObject	filter(XMLObject metadata) Filters the given metadata, perhaps to remove elements that are not wanted.

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

schemaBuilder

@Nullable
private net.shibboleth.utilities.java.support.xml.SchemaBuilder schemaBuilder

Self-managed SchemaBuilder to support old extension schema parameter.

samlSchemaBuilder

@Nonnull
private SAMLSchemaBuilder samlSchemaBuilder

SAML schema source.

Constructor Detail

SchemaValidationFilter

public SchemaValidationFilter(@Nonnull
                              SAMLSchemaBuilder builder)

Constructor.

Parameters:

builder - SAML schema source to use

SchemaValidationFilter

public SchemaValidationFilter(@Nonnull
                              SAMLSchemaBuilder builder,
                              @Nullable @NonnullElements
                              java.lang.String[] extensionSchemas)

Deprecated.

Constructor.

Specifying extension schemas should be done by explicitly injecting a pre-configured SchemaBuilder using the non-deprecated constructor. Using this version results in an internally constructed SchemaBuilder using classpath-based schema resolution of any extensions or imports, with other settings left to their defaults.

Parameters:

builder - SAML schema source to use

extensionSchemas - classpath-based location of metadata extension schemas

Method Detail

filter

@Nullable
public XMLObject filter(@Nullable
                                  XMLObject metadata)
                           throws FilterException

Filters the given metadata, perhaps to remove elements that are not wanted.

Specified by:

filter in interface MetadataFilter

Parameters:

metadata - the metadata to be filtered.

Returns:

the filtered XMLObject, which may or may not be the same as the XMLObject instance passed in to the method. Maybe be null, for example if the top-level element was removed by the filter.

Throws:

FilterException - thrown if an error occurs during the filtering process