View Javadoc

1   /*
2    * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.saml2.metadata.provider;
18  
19  import org.opensaml.xml.XMLObject;
20  
21  /**
22   * A metadata filter is used to process a metadata document after it has been unmarshalled into object.
23   * 
24   * Some example filters might remove everything but identity providers roles, decreasing the data a service provider
25   * needs to work with, or a filter could be used to perform integrity checking on the retrieved metadata by verifying
26   * a digital signature.
27   */
28  public interface MetadataFilter {
29  
30      /**
31       * Filters the given metadata, perhaps to remove elements that are not wanted.
32       * 
33       * @param metadata the metadata to be filtered.
34       * 
35       * @throws FilterException thrown if an error occurs during the filtering process
36       */
37      public void doFilter(XMLObject metadata) throws FilterException;
38  }