michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.entity;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpException;
michael@0: import ch.boye.httpclientandroidlib.HttpMessage;
michael@0: 
michael@0: /**
michael@0:  * Represents a strategy to determine length of the enclosed content entity
michael@0:  * based on properties of the HTTP message.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface ContentLengthStrategy {
michael@0: 
michael@0:     public static final int IDENTITY         = -1;
michael@0:     public static final int CHUNKED          = -2;
michael@0: 
michael@0:     /**
michael@0:      * Returns length of the given message in bytes. The returned value
michael@0:      * must be a non-negative number, {@link #IDENTITY} if the end of the
michael@0:      * message will be delimited by the end of connection, or {@link #CHUNKED}
michael@0:      * if the message is chunk coded
michael@0:      *
michael@0:      * @param message
michael@0:      * @return content length, {@link #IDENTITY}, or {@link #CHUNKED}
michael@0:      *
michael@0:      * @throws HttpException in case of HTTP protocol violation
michael@0:      */
michael@0:     long determineLength(HttpMessage message) throws HttpException;
michael@0: 
michael@0: }