- All Known Implementing Classes:
XMLObject, either an
Some example 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.
If a filter wishes to completely remove the top-level document element, or otherwise indicate that it
has successfully produced an empty data set from the input document,
null may be returned
by the filter's
filter(XMLObject, MetadataFilterContext) method.
filter@Nullable XMLObject filter
(@Nullable XMLObject metadata, @Nonnull MetadataFilterContext context) throws FilterExceptionFilters the given metadata, perhaps to remove elements that are not wanted.
metadata- the metadata to be filtered.
context- the metadata filter context
- 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.
FilterException- thrown if an error occurs during the filtering process