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.persistence;
18:
19: /**
20: * A request data store is a component that manages data that is
21: * linked to the current request.
22: * With the setRequestData() method you can link any object to the
23: * current request. This object can be fetched via getRequestData()
24: * as long as the request is running. This data is not available
25: * in any sub-request (cocoon: protocol calls).
26: * If you want to share data between the main request and any sub-request
27: * than you have to use the setGlobalRequestData etc. methods.
28: *
29: * This component is a replacement for the request lifecycle and
30: * global request lifecycle components.
31: *
32: * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
33: *
34: * @version CVS $Id: RequestDataStore.java 433543 2006-08-22 06:22:54Z crossley $
35: * @since 2.1.1
36: */
37: public interface RequestDataStore {
38:
39: String ROLE = RequestDataStore.class.getName();
40:
41: Object getRequestData(String key);
42:
43: void removeRequestData(String key);
44:
45: void setRequestData(String key, Object value);
46:
47: Object getGlobalRequestData(String key);
48:
49: void removeGlobalRequestData(String key);
50:
51: void setGlobalRequestData(String key, Object value);
52: }
|