opensaml::saml2md::MetadataFilter Class Reference

A metadata filter is used to process metadata after resolution and unmarshalling. More...

#include <saml/saml2/metadata/MetadataFilter.h>

List of all members.

Public Member Functions

virtual const char * getId () const =0
 Returns an identifying string for the filter.
virtual void doFilter (xmltooling::XMLObject &xmlObject) const
virtual void doFilter (const MetadataFilterContext *ctx, xmltooling::XMLObject &xmlObject) const
 Filters the given metadata.

Detailed Description

A metadata filter is used to process metadata after resolution and unmarshalling.

Some filters might remove everything but identity provider 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.


Member Function Documentation

virtual void opensaml::saml2md::MetadataFilter::doFilter ( const MetadataFilterContext ctx,
xmltooling::XMLObject &  xmlObject 
) const [virtual]

Filters the given metadata.

Exceptions should generally not be thrown to signal the removal of information, only for systemic processing failure.

Parameters:
ctx context interface, or nullptr
xmlObject the metadata to be filtered
virtual void opensaml::saml2md::MetadataFilter::doFilter ( xmltooling::XMLObject &  xmlObject  )  const [virtual]
Deprecated:
Filters the given metadata. Exceptions should generally not be thrown to signal the removal of information, only for systemic processing failure.
Parameters:
xmlObject the metadata to be filtered
virtual const char* opensaml::saml2md::MetadataFilter::getId (  )  const [pure virtual]

Returns an identifying string for the filter.

Returns:
the ID string

The documentation for this class was generated from the following file:

Generated on 9 Jan 2013 for opensaml-2.5.2 by  doxygen 1.6.1