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.cocoon.components.modules.input;
19:
20: import org.apache.avalon.framework.configuration.Configuration;
21: import org.apache.avalon.framework.thread.ThreadSafe;
22: import org.apache.cocoon.environment.ObjectModelHelper;
23:
24: import java.util.Map;
25:
26: /**
27: * RequestModule provides access to Request object properties.
28: * To get access to request properties use XPath syntax, e.g. to get the request
29: * context path use <code>'contextPath'</code> as the attribute name.<br/>
30: * More complex expressions are also supported, e.g.:
31: * <pre>
32: * 'userPrincipal/name'
33: * </pre>
34: * will return the name property of the Principal object returned by the
35: * request.getUserPrincipal() method. If requested object is not found then
36: * an exception will be thrown.
37: *
38: * @author <a href="mailto:kpiroumian@apache.org">Konstantin Piroumian</a>
39: * @version $Id: RequestModule.java 433543 2006-08-22 06:22:54Z crossley $
40: */
41: public class RequestModule extends AbstractJXPathModule implements
42: ThreadSafe {
43:
44: protected Object getContextObject(Configuration modeConf,
45: Map objectModel) {
46:
47: return ObjectModelHelper.getRequest(objectModel);
48: }
49: }
|