01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.matching;
18:
19: import org.apache.avalon.framework.configuration.Configurable;
20: import org.apache.avalon.framework.configuration.Configuration;
21: import org.apache.avalon.framework.configuration.ConfigurationException;
22: import org.apache.avalon.framework.parameters.Parameters;
23:
24: import org.apache.cocoon.environment.ObjectModelHelper;
25:
26: import java.util.Map;
27:
28: /**
29: * Matches a request header (e.g. "referer") against a regular expression.
30: *
31: * <p><b>Global and local configuration</b></p>
32: * <table border="1">
33: * <tr><td><code>header-name</code></td><td>Name of the request header to
34: * match against</td></tr>
35: * </table>
36: *
37: * @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
38: * @version CVS $Id: RegexpHeaderMatcher.java 433543 2006-08-22 06:22:54Z crossley $
39: */
40:
41: public class RegexpHeaderMatcher extends AbstractRegexpMatcher
42: implements Configurable {
43: private String defaultParam;
44:
45: public void configure(Configuration config)
46: throws ConfigurationException {
47:
48: this .defaultParam = config.getChild("header-name").getValue(
49: null);
50: }
51:
52: protected String getMatchString(Map objectModel,
53: Parameters parameters) {
54:
55: String paramName = parameters.getParameter("header-name",
56: this .defaultParam);
57: if (paramName == null) {
58: getLogger().warn("No header name given. FAILING");
59: return null;
60: }
61:
62: String result = ObjectModelHelper.getRequest(objectModel)
63: .getHeader(paramName);
64: if (result == null) {
65: if (getLogger().isDebugEnabled()) {
66: getLogger()
67: .debug("Header '" + paramName + "' not set.");
68: }
69: }
70:
71: return result;
72: }
73: }
|