KickJava   Java API By Example, From Geeks To Geeks.

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


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 parameter against a wildcard expression.
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 parameter 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  * @author <a HREF="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
39  * @version CVS $Id: WildcardRequestParameterMatcher.java 30932 2004-07-29 17:35:38Z vgritsenko $
40  */
41 public class WildcardRequestParameterMatcher extends AbstractWildcardMatcher
42     implements Configurable
43 {
44     private String JavaDoc defaultParam;
45
46     public void configure(Configuration config) throws ConfigurationException {
47         this.defaultParam = config.getChild("parameter-name").getValue(null);
48     }
49
50     protected String JavaDoc getMatchString(Map JavaDoc objectModel, Parameters parameters) {
51
52         String JavaDoc paramName = parameters.getParameter("parameter-name", this.defaultParam);
53         if (paramName == null) {
54             getLogger().warn("No parameter name given. FAILING");
55             return null;
56         }
57
58         String JavaDoc result = ObjectModelHelper.getRequest(objectModel).getParameter(paramName);
59         if (result == null) {
60             getLogger().debug("Parameter '" + paramName + "' not set.");
61         }
62
63         return result;
64     }
65 }
66
Popular Tags