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 org.apache.hc.core5.annotation.Contract; 31 import org.apache.hc.core5.annotation.ThreadingBehavior; 32 33 /** 34 * Represents a strategy to determine length of the enclosed content entity 35 * based on properties of the HTTP message. 36 * 37 * @since 4.0 38 */ 39 @Contract(threading = ThreadingBehavior.STATELESS) 40 public interface ContentLengthStrategy { 41 42 /** 43 * Message body chunk coded 44 */ 45 long CHUNKED = -1; 46 47 /** 48 * Message body not explicitly delineated. Legal for HTTP response messages 49 * and illegal for HTTP request messages. 50 */ 51 long UNDEFINED = -Long.MAX_VALUE; 52 53 /** 54 * Returns length of the given message in bytes. The returned value 55 * must be a non-negative number, {@link #CHUNKED} if the message is 56 * chunk coded, or {@link #UNDEFINED} if the message is not explicitly 57 * delineated. 58 * 59 * @param message HTTP message 60 * @return content length, {@link #UNDEFINED}, or {@link #CHUNKED} 61 * 62 * @throws HttpException in case of HTTP protocol violation 63 */ 64 long determineLength(HttpMessage message) throws HttpException; 65 66 }