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.util.Set;
31
32 /**
33 * Details of an entity transmitted by a message.
34 *
35 * @since 5.0
36 */
37 public interface EntityDetails {
38
39 /**
40 * Gets length of this entity, if known.
41 *
42 * @return the length of this entity, may be {@code 0}.
43 */
44 long getContentLength();
45
46 /**
47 * Gets content type of this entity, if known.
48 *
49 * @return the content type of this entity, may be {@code null}.
50 */
51 String getContentType();
52
53 /**
54 * Gets content encoding of this entity, if known.
55 *
56 * @return the content encoding of this entity, may be {@code null}.
57 */
58 String getContentEncoding();
59
60 /**
61 * Tests the chunked transfer hint for this entity.
62 * <p>
63 * The behavior of wrapping entities is implementation dependent,
64 * but should respect the primary purpose.
65 * </p>
66 * @return the chunked transfer hint for this entity.
67 */
68 boolean isChunked();
69
70 /**
71 * Gets the preliminary declaration of trailing headers.
72 *
73 * @return the preliminary declaration of trailing headers.
74 */
75 Set<String> getTrailerNames();
76
77 }