| /* |
| * ==================================================================== |
| * 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 org.apache.hc.core5.http.protocol; |
| |
| import org.apache.hc.core5.http.ProtocolVersion; |
| |
| /** |
| * 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> |
| * <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. |
| * </p> |
| * |
| * @since 4.0 |
| */ |
| public interface HttpContext { |
| |
| /** The prefix reserved for use by HTTP components. "http." */ |
| String RESERVED_PREFIX = "http."; |
| |
| /** |
| * Returns protocol version used in this context. |
| * |
| * @since 5.0 |
| */ |
| ProtocolVersion getProtocolVersion(); |
| |
| /** |
| * Sets protocol version used in this context. |
| * |
| * @since 5.0 |
| */ |
| void setProtocolVersion(ProtocolVersion version); |
| |
| /** |
| * Obtains attribute with the given name. |
| * |
| * @param id the attribute name. |
| * @return attribute value, or {@code null} 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. |
| * @return the previous value associated with <code>id</code>, or |
| * {@code null} if there was no mapping for <code>id</code>. |
| */ |
| Object 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} if not set. |
| */ |
| Object removeAttribute(String id); |
| |
| } |