org.glassfish.grizzly.http.ContentEncoding Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.grizzly.http;
import org.glassfish.grizzly.Connection;
/**
* Abstraction, which represents HTTP content-encoding.
* Implementation should take care of HTTP content encoding and decoding.
*
* @see GZipContentEncoding
*
* @author Alexey Stashok
*/
public interface ContentEncoding {
/**
* Get the ContentEncoding name.
*
* @return the ContentEncoding name.
*/
String getName();
/**
* Get the ContentEncoding aliases.
*
* @return the ContentEncoding aliases.
*/
String[] getAliases();
/**
* Method should implement the logic, which decides if HTTP packet with
* the specific {@link HttpHeader} should be decoded using this ContentEncoding.
*
* @param header HTTP packet header.
* @return true, if this ContentEncoding should be used to
* decode the HTTP packet, or false otherwise.
*/
boolean wantDecode(HttpHeader header);
/**
* Method should implement the logic, which decides if HTTP packet with
* the specific {@link HttpHeader} should be encoded using this ContentEncoding.
*
* @param header HTTP packet header.
* @return true, if this ContentEncoding should be used to
* encode the HTTP packet, or false otherwise.
*/
boolean wantEncode(HttpHeader header);
/**
* Decode HTTP packet content represented by {@link HttpContent}.
*
* @param connection {@link Connection}.
* @param httpContent {@link HttpContent} to decode.
*
* @return {@link ParsingResult}, which represents the result of decoding.
*/
ParsingResult decode(Connection connection, HttpContent httpContent);
/**
* Encode HTTP packet content represented by {@link HttpContent}.
*
* @param connection {@link Connection}.
* @param httpContent {@link HttpContent} to encode.
*
* @return encoded {@link HttpContent}.
*/
HttpContent encode(Connection connection, HttpContent httpContent);
}