KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > matching > WildcardHeaderMatcher


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
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 package org.apache.cocoon.matching;
17
18 import org.apache.avalon.framework.configuration.Configurable;
19 import org.apache.avalon.framework.configuration.Configuration;
20 import org.apache.avalon.framework.configuration.ConfigurationException;
21 import org.apache.avalon.framework.parameters.Parameters;
22
23 import org.apache.cocoon.environment.ObjectModelHelper;
24
25 import java.util.Map JavaDoc;
26
27 /**
28  * Matches a request header (e.g. "referer") against a wildcard expression.
29  *
30  * <p><b>Global and local configuration</b></p>
31  * <table border="1">
32  * <tr><td><code>header-name</code></td><td>Name of the request header to
33  * match against</td></tr>
34  * </table>
35  *
36  * @author <a HREF="mailto:haul@apache.org">Christian Haul</a>
37  * @author <a HREF="mailto:sylvain@apache.org">Sylvain Wallez</a>
38  * @version CVS $Id: WildcardHeaderMatcher.java 30932 2004-07-29 17:35:38Z vgritsenko $
39  */
40 public class WildcardHeaderMatcher extends AbstractWildcardMatcher
41     implements Configurable
42 {
43     private String JavaDoc defaultParam;
44
45     public void configure(Configuration config) throws ConfigurationException {
46         // Check old name
47 this.defaultParam = config.getChild("parameter-name").getValue(null);
48         if (defaultParam != null) {
49             getLogger().warn("'parameter-name' is deprecated. Please use 'header-name'");
50         }
51         // Load with new one
52 this.defaultParam = config.getChild("header-name").getValue(this.defaultParam);
53     }
54
55     protected String JavaDoc getMatchString(Map JavaDoc objectModel, Parameters parameters) {
56
57         // Check old name
58 String JavaDoc paramName = parameters.getParameter("parameter-name", null);
59         if (paramName != null) {
60             getLogger().warn("'parameter-name' is deprecated. Please use 'header-name'");
61         } else {
62             paramName = this.defaultParam;
63         }
64
65         // Load with new one.
66 paramName = parameters.getParameter("header-name", paramName);
67
68         if (paramName == null) {
69             getLogger().warn("No header name given. FAILING");
70             return null;
71         }
72
73         String JavaDoc result = ObjectModelHelper.getRequest(objectModel).getHeader(paramName);
74         if (result == null) {
75             getLogger().debug("Header '" + paramName + "' not set.");
76         }
77
78         return result;
79     }
80 }
81
Popular Tags