mobile/android/thirdparty/ch/boye/httpclientandroidlib/protocol/HttpContext.java@6474c204b198 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/protocol/HttpContext.java
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib.protocol; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.util.HashMap; |
| michael@0 | 31 | |
| michael@0 | 32 | /** |
| michael@0 | 33 | * HttpContext represents execution state of an HTTP process. It is a structure |
| michael@0 | 34 | * that can be used to map an attribute name to an attribute value. Internally |
| michael@0 | 35 | * HTTP context implementations are usually backed by a {@link HashMap}. |
| michael@0 | 36 | * <p> |
| michael@0 | 37 | * The primary purpose of the HTTP context is to facilitate information sharing |
| michael@0 | 38 | * among various logically related components. HTTP context can be used |
| michael@0 | 39 | * to store a processing state for one message or several consecutive messages. |
| michael@0 | 40 | * Multiple logically related messages can participate in a logical session |
| michael@0 | 41 | * if the same context is reused between consecutive messages. |
| michael@0 | 42 | * |
| michael@0 | 43 | * @since 4.0 |
| michael@0 | 44 | */ |
| michael@0 | 45 | public interface HttpContext { |
| michael@0 | 46 | |
| michael@0 | 47 | /** The prefix reserved for use by HTTP components. "http." */ |
| michael@0 | 48 | public static final String RESERVED_PREFIX = "http."; |
| michael@0 | 49 | |
| michael@0 | 50 | /** |
| michael@0 | 51 | * Obtains attribute with the given name. |
| michael@0 | 52 | * |
| michael@0 | 53 | * @param id the attribute name. |
| michael@0 | 54 | * @return attribute value, or <code>null</code> if not set. |
| michael@0 | 55 | */ |
| michael@0 | 56 | Object getAttribute(String id); |
| michael@0 | 57 | |
| michael@0 | 58 | /** |
| michael@0 | 59 | * Sets value of the attribute with the given name. |
| michael@0 | 60 | * |
| michael@0 | 61 | * @param id the attribute name. |
| michael@0 | 62 | * @param obj the attribute value. |
| michael@0 | 63 | */ |
| michael@0 | 64 | void setAttribute(String id, Object obj); |
| michael@0 | 65 | |
| michael@0 | 66 | /** |
| michael@0 | 67 | * Removes attribute with the given name from the context. |
| michael@0 | 68 | * |
| michael@0 | 69 | * @param id the attribute name. |
| michael@0 | 70 | * @return attribute value, or <code>null</code> if not set. |
| michael@0 | 71 | */ |
| michael@0 | 72 | Object removeAttribute(String id); |
| michael@0 | 73 | |
| michael@0 | 74 | } |
