gecko/mobile/android/base/httpclientandroidlib/entity/ContentLengthStrategy.java

58 lines
2.1 KiB
Java

/*
* ====================================================================
* 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 ch.boye.httpclientandroidlib.entity;
import ch.boye.httpclientandroidlib.HttpException;
import ch.boye.httpclientandroidlib.HttpMessage;
/**
* Represents a strategy to determine length of the enclosed content entity
* based on properties of the HTTP message.
*
* @since 4.0
*/
public interface ContentLengthStrategy {
public static final int IDENTITY = -1;
public static final int CHUNKED = -2;
/**
* Returns length of the given message in bytes. The returned value
* must be a non-negative number, {@link #IDENTITY} if the end of the
* message will be delimited by the end of connection, or {@link #CHUNKED}
* if the message is chunk coded
*
* @param message
* @return content length, {@link #IDENTITY}, or {@link #CHUNKED}
*
* @throws HttpException in case of HTTP protocol violation
*/
long determineLength(HttpMessage message) throws HttpException;
}