blob: c2b70ccea864b874c5ef01a22cbd8b077ebd74da (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package ch.boye.httpclientandroidlib.protocol;
/**
* HttpContext represents execution state of an HTTP process. It is a structure
* that can be used to map an attribute name to an attribute value.
* <p/>
* The primary purpose of the HTTP context is to facilitate information sharing
* among various logically related components. HTTP context can be used
* to store a processing state for one message or several consecutive messages.
* Multiple logically related messages can participate in a logical session
* if the same context is reused between consecutive messages.
* <p>/
* IMPORTANT: Please note HTTP context implementation, even when thread safe,
* may not be used concurrently by multiple threads, as the context may contain
* thread unsafe attributes.
*
* @since 4.0
*/
public interface HttpContext {
/** The prefix reserved for use by HTTP components. "http." */
public static final String RESERVED_PREFIX = "http.";
/**
* Obtains attribute with the given name.
*
* @param id the attribute name.
* @return attribute value, or <code>null</code> if not set.
*/
Object getAttribute(String id);
/**
* Sets value of the attribute with the given name.
*
* @param id the attribute name.
* @param obj the attribute value.
*/
void setAttribute(String id, Object obj);
/**
* Removes attribute with the given name from the context.
*
* @param id the attribute name.
* @return attribute value, or <code>null</code> if not set.
*/
Object removeAttribute(String id);
}
|
