edu.internet2.middleware.shibboleth.wayf.plugins.provider
Class ListFilter

java.lang.Object
  edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter

All Implemented Interfaces:

org.opensaml.saml2.metadata.provider.MetadataFilter

public class ListFilter
extends Object
implements org.opensaml.saml2.metadata.provider.MetadataFilter

See SDSJ-57. Explicit

Field Summary

private boolean	excludeEntries Set if this is a blacklist.
private Set<String>	filterEntities The list of entities.
private String	filterName The name of the filter (needed for debug).
private static Logger	LOG Log for any messages.

Constructor Summary

private	ListFilter() Only the protected constructor should be visible.
	ListFilter(Element config) Initialize the filter.

Method Summary

void	doFilter(org.opensaml.xml.XMLObject metadata) Apply the filter.
private void	filterEntities(org.opensaml.saml2.metadata.EntitiesDescriptor entities) Filter an EntitiesDescriptor .

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logger LOG

Log for any messages.

excludeEntries

private boolean excludeEntries

Set if this is a blacklist.

filterEntities

private final Set<String> filterEntities

The list of entities.

filterName

private final String filterName

The name of the filter (needed for debug).

Constructor Detail

ListFilter

private ListFilter()

Only the protected constructor should be visible.

ListFilter

public ListFilter(Element config)

Initialize the filter.

Parameters:

config - the configuration. The configuration looks liken this
<Filter identifier="WhiteList" type ="edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter" excludeEntries = "true">
<EntityId>foo</EntityId>
[...]
</Filter>


Method Detail

doFilter

public void doFilter(org.opensaml.xml.XMLObject metadata)
              throws org.opensaml.saml2.metadata.provider.FilterException

Apply the filter.

Specified by:

doFilter in interface org.opensaml.saml2.metadata.provider.MetadataFilter

Parameters:

metadata - what to filter.

Throws:

org.opensaml.saml2.metadata.provider.FilterException - if it sees any missed or bad bindings.

See Also:

MetadataFilter.doFilter(org.opensaml.xml.XMLObject)

filterEntities

private void filterEntities(org.opensaml.saml2.metadata.EntitiesDescriptor entities)

Filter an EntitiesDescriptor . We do this explictly for the Entities and call ourselves recursively for the EntitesDescriptors.

Parameters:

entities - what to check.