View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.hc.core5.http;
29  
30  import java.io.Closeable;
31  
32  /**
33   * 'Classic' {@link HttpResponse} message that can enclose {@link HttpEntity}.
34   *
35   * @since 5.0
36   */
37  public interface ClassicHttpResponse extends HttpResponse, Closeable {
38  
39      /**
40       * Obtains the message entity, if available.
41       *
42       * @return  the message entity, or {@code null} if not available
43       */
44      HttpEntity getEntity();
45  
46      /**
47       * Sets an entity for this message.
48       * <p>
49       * Please note that if an entity has already been set it is responsibility of the caller
50       * to ensure release of the resources that may be associated with that entity.
51       *
52       * @param entity    the entity to set of this message, or {@code null} to unset
53       */
54      void setEntity(HttpEntity entity);
55  
56  }