1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/protocol/HttpContext.java Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,74 @@ 1.4 +/* 1.5 + * ==================================================================== 1.6 + * Licensed to the Apache Software Foundation (ASF) under one 1.7 + * or more contributor license agreements. See the NOTICE file 1.8 + * distributed with this work for additional information 1.9 + * regarding copyright ownership. The ASF licenses this file 1.10 + * to you under the Apache License, Version 2.0 (the 1.11 + * "License"); you may not use this file except in compliance 1.12 + * with the License. You may obtain a copy of the License at 1.13 + * 1.14 + * http://www.apache.org/licenses/LICENSE-2.0 1.15 + * 1.16 + * Unless required by applicable law or agreed to in writing, 1.17 + * software distributed under the License is distributed on an 1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 1.19 + * KIND, either express or implied. See the License for the 1.20 + * specific language governing permissions and limitations 1.21 + * under the License. 1.22 + * ==================================================================== 1.23 + * 1.24 + * This software consists of voluntary contributions made by many 1.25 + * individuals on behalf of the Apache Software Foundation. For more 1.26 + * information on the Apache Software Foundation, please see 1.27 + * <http://www.apache.org/>. 1.28 + * 1.29 + */ 1.30 + 1.31 +package ch.boye.httpclientandroidlib.protocol; 1.32 + 1.33 +import java.util.HashMap; 1.34 + 1.35 +/** 1.36 + * HttpContext represents execution state of an HTTP process. It is a structure 1.37 + * that can be used to map an attribute name to an attribute value. Internally 1.38 + * HTTP context implementations are usually backed by a {@link HashMap}. 1.39 + * <p> 1.40 + * The primary purpose of the HTTP context is to facilitate information sharing 1.41 + * among various logically related components. HTTP context can be used 1.42 + * to store a processing state for one message or several consecutive messages. 1.43 + * Multiple logically related messages can participate in a logical session 1.44 + * if the same context is reused between consecutive messages. 1.45 + * 1.46 + * @since 4.0 1.47 + */ 1.48 +public interface HttpContext { 1.49 + 1.50 + /** The prefix reserved for use by HTTP components. "http." */ 1.51 + public static final String RESERVED_PREFIX = "http."; 1.52 + 1.53 + /** 1.54 + * Obtains attribute with the given name. 1.55 + * 1.56 + * @param id the attribute name. 1.57 + * @return attribute value, or <code>null</code> if not set. 1.58 + */ 1.59 + Object getAttribute(String id); 1.60 + 1.61 + /** 1.62 + * Sets value of the attribute with the given name. 1.63 + * 1.64 + * @param id the attribute name. 1.65 + * @param obj the attribute value. 1.66 + */ 1.67 + void setAttribute(String id, Object obj); 1.68 + 1.69 + /** 1.70 + * Removes attribute with the given name from the context. 1.71 + * 1.72 + * @param id the attribute name. 1.73 + * @return attribute value, or <code>null</code> if not set. 1.74 + */ 1.75 + Object removeAttribute(String id); 1.76 + 1.77 +}