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.components.flow.apples;
18:
19: import java.util.Set;
20:
21: import org.apache.cocoon.environment.Request;
22:
23: /**
24: * AppleRequest defines the services an AppleController can collect
25: * from the current request.
26: */
27: public interface AppleRequest {
28:
29: /**
30: * @return the wrapped cocoon environment Request
31: */
32: public Request getCocoonRequest();
33:
34: /**
35: * @return Set of String's listing all available sitemap-parameters passed.
36: */
37: public Set getSitemapParameterNames();
38:
39: /**
40: * Finds a named parameter in the request.
41: * @param key of parameter to lookup
42: * @return the parameter-value
43: */
44: public String getSitemapParameter(String key);
45:
46: /**
47: * Finds a named parameter in the request using the overloaded method
48: * {@link #getSitemapParameter(String)} but lets the returned value
49: * default to the second argument in case the delegation resulted into
50: * <code>null</code>
51: * @param key of parameter to lookup
52: * @param defaultValue return-value in case the lookup returned <code>null</code>
53: * @return the parameter-value or if that was null: the defaultValue passed.
54: */
55: public String getSitemapParameter(String key, String defaultValue);
56: }
|