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 attribute against a regular expression.
30: *
31: * <p><b>Global and local configuration</b></p>
32: * <tableborder="1">
33: * <tr><td><code>attribute-name</code></td><td>String identifying the request attribute</td></tr>
34: * </table>
35: *
36: * @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
37: * @version CVS $Id: RegexpRequestAttributeMatcher.java 433543 2006-08-22 06:22:54Z crossley $
38: */
39: public class RegexpRequestAttributeMatcher extends
40: AbstractRegexpMatcher implements Configurable {
41: private String defaultParam;
42:
43: public void configure(Configuration config)
44: throws ConfigurationException {
45: this .defaultParam = config.getChild("attribute-name").getValue(
46: null);
47: if (getLogger().isDebugEnabled()) {
48: getLogger().debug(
49: "Default attribute-name is = '" + this .defaultParam
50: + "'");
51: }
52: }
53:
54: protected String getMatchString(Map objectModel,
55: Parameters parameters) {
56:
57: String paramName = parameters.getParameter("attribute-name",
58: this .defaultParam);
59: if (paramName == null) {
60: getLogger().warn("No attribute name given. FAILING");
61: return null;
62: }
63:
64: Object result = ObjectModelHelper.getRequest(objectModel)
65: .getAttribute(paramName);
66: if (result == null) {
67: getLogger().debug(
68: "Request attribute '" + paramName + "' not set.");
69: return null;
70: }
71:
72: return result.toString();
73: }
74: }
|