View Javadoc

1   /*
2    * Copyright 2008 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.util.resource;
18  
19  /** A {@link Resource} whose contents may be run through a filter as it is being read. */
20  public abstract class AbstractFilteredResource implements Resource {
21  
22      /** Associated resource filter. */
23      private ResourceFilter resourceFilter;
24      
25      /** Constructor. */
26      protected AbstractFilteredResource(){
27          
28      }
29  
30      /**
31       * Constructor.
32       * 
33       * @param filter the filter used on the resource
34       */
35      protected AbstractFilteredResource(ResourceFilter filter) {
36          resourceFilter = filter;
37      }
38  
39      /**
40       * Gets the resource filter associated with this resource.
41       * 
42       * @return resource filter associated with this resource
43       */
44      public ResourceFilter getResourceFilter() {
45          return resourceFilter;
46      }
47  }