View Javadoc

1   /*
2    * Copyright [2006] [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.Configuration;
20  import org.opensaml.xml.io.UnmarshallerFactory;
21  
22  /**
23   * Base class for metadata providers.
24   */
25  public abstract class BaseMetadataProvider implements MetadataProvider {
26  
27      /** Whether metadata is required to be valid. */
28      private boolean requireValidMetadata;
29  
30      /** Unmarshaller factory used to get an unmarshaller for the metadata DOM. */
31      protected UnmarshallerFactory unmarshallerFactory;
32  
33      /** Filter applied to all metadata. */
34      private MetadataFilter mdFilter;
35  
36      /** Constructor. */
37      public BaseMetadataProvider() {
38          requireValidMetadata = false;
39          unmarshallerFactory = Configuration.getUnmarshallerFactory();
40      }
41  
42      /** {@inheritDoc} */
43      public boolean requireValidMetadata() {
44          return requireValidMetadata;
45      }
46  
47      /** {@inheritDoc} */
48      public void setRequireValidMetadata(boolean require) {
49          requireValidMetadata = require;
50      }
51  
52      /** {@inheritDoc} */
53      public MetadataFilter getMetadataFilter() {
54          return mdFilter;
55      }
56  
57      /** {@inheritDoc} */
58      public void setMetadataFilter(MetadataFilter newFilter) throws MetadataProviderException {
59          mdFilter = newFilter;
60      }
61  }