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: */
18: package org.apache.lenya.cms.cocoon.components.modules.input;
19:
20: import java.util.Map;
21:
22: import org.apache.avalon.framework.configuration.Configuration;
23: import org.apache.avalon.framework.configuration.ConfigurationException;
24: import org.apache.cocoon.components.modules.input.AbstractInputModule;
25: import org.apache.cocoon.environment.ObjectModelHelper;
26: import org.apache.cocoon.environment.Request;
27:
28: /**
29: * <p>The linking module is a utility to add parameters to link URLs,
30: * depending on request parameters. Supported attributes:</p>
31: * <ul>
32: * <li><code>rev</code> - inserts the parameter <code>,rev=...</code>
33: * if a request parameter <code>lenya.revision</code> is present.</li>
34: * </ul>
35: */
36: public class LinkingModule extends AbstractInputModule {
37:
38: protected static final String ATTRIBUTE_REVISION = "rev";
39: protected static final String REQUEST_PARAM_REVISION = "lenya.revision";
40:
41: public Object getAttribute(String name, Configuration modeConf,
42: Map objectModel) throws ConfigurationException {
43:
44: if (name.equals(ATTRIBUTE_REVISION)) {
45: Request request = ObjectModelHelper.getRequest(objectModel);
46: String revision = request
47: .getParameter(REQUEST_PARAM_REVISION);
48: if (revision != null) {
49: return ",rev=" + revision;
50: } else {
51: return "";
52: }
53: } else {
54: throw new ConfigurationException("The attribute [" + name
55: + "] is not supported.");
56: }
57: }
58:
59: }
|