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.selection;
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: import org.apache.cocoon.environment.ObjectModelHelper;
24:
25: import java.util.Map;
26:
27: /**
28: * A <code>Selector</code> that matches a string against a configurable request parameter's value.
29: *
30: * <p><b>Global and local configuration</b></p>
31: * <table border="1">
32: * <tr><td><code>parameter-name</code></td><td>Name of the request
33: * parameter whose value to 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: * @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
39: * @author <a href="mailto:crafterm@apache.org">Marcus Crafter</a>
40: * @version CVS $Id: RequestParameterSelector.java 433543 2006-08-22 06:22:54Z crossley $
41: */
42: public class RequestParameterSelector extends AbstractSwitchSelector
43: implements Configurable {
44:
45: protected String defaultName;
46:
47: public void configure(Configuration config)
48: throws ConfigurationException {
49: this .defaultName = config.getChild("parameter-name").getValue(
50: null);
51: }
52:
53: public Object getSelectorContext(Map objectModel,
54: Parameters parameters) {
55:
56: String name = parameters.getParameter("parameter-name",
57: this .defaultName);
58:
59: if (name == null) {
60: getLogger().warn("No parameter name given -- failing.");
61: return null;
62: }
63:
64: return ObjectModelHelper.getRequest(objectModel).getParameter(
65: name);
66: }
67:
68: public boolean select(String expression, Object selectorContext) {
69: if (selectorContext == null) {
70: getLogger().debug(
71: "Request parameter '" + selectorContext
72: + "' not set -- failing.");
73: return false;
74: }
75:
76: return selectorContext.equals(expression);
77: }
78: }
|