Package net.shibboleth.oidc.metadata.filter

Interface MetadataFilter<T>

Type Parameters:

T - The metadata type.

public interface MetadataFilter<T>

A metadata filter is used to process a metadata document after it has been acquired from a metadata source.

Some example SAML filters might remove everything but identity providers roles, decreasing the data a service provider needs to work with, or a filter could be used to perform integrity checking on the retrieved metadata by verifying a digital signature.

Some example OIDC filters might throw a filter exception or return null if the metadata no longer supports, for example, the ES-algorithms.

If a filter wishes to completely remove the metadata, or otherwise indicate that it has successfully produced an empty data set from the input metadata, null may be returned by the filter's filter(Object, MetadataFilterContext) method.

Method Summary

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

Method Detail

filter

@Nullable
T filter(@Nullable
         T metadata,
         @Nonnull
         MetadataFilterContext context)
  throws FilterException

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

Parameters:

metadata - the metadata to be filtered.

context - the metadata filter context

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