KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > common > web > resource > ResourceFilter


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the
11  * License.
12  *
13  * The Original Code is Riot.
14  *
15  * The Initial Developer of the Original Code is
16  * Neteye GmbH.
17  * Portions created by the Initial Developer are Copyright (C) 2006
18  * the Initial Developer. All Rights Reserved.
19  *
20  * Contributor(s):
21  * Felix Gnass [fgnass at neteye dot de]
22  *
23  * ***** END LICENSE BLOCK ***** */

24 package org.riotfamily.common.web.resource;
25
26 import java.io.FilterReader JavaDoc;
27 import java.io.Reader JavaDoc;
28
29 import javax.servlet.http.HttpServletRequest JavaDoc;
30
31 /**
32  * Interface that allows to filter resources that are served by a
33  * ResourceController.
34  *
35  * @see org.riotfamily.common.web.resource.ResourceController#setFilters
36  */

37 public interface ResourceFilter {
38
39     /**
40      * Returns whether the filter should be applied to the resource denoted
41      * by the given path.
42      */

43     public boolean matches(String JavaDoc path);
44     
45     /**
46      * Returns a FilterReader that does the actual filtering.
47      */

48     public FilterReader JavaDoc createFilterReader(Reader JavaDoc in, HttpServletRequest JavaDoc request);
49
50 }
51
Popular Tags