001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2010–2011 ApexIdentity Inc. 015 * Portions Copyright 2011-2015 ForgeRock AS. 016 */ 017 018package org.forgerock.http.decoder; 019 020import java.io.IOException; 021import java.io.InputStream; 022import java.util.Collections; 023import java.util.Map; 024 025import org.forgerock.http.util.CaseInsensitiveMap; 026import org.forgerock.http.util.Indexed; 027import org.forgerock.http.util.Loader; 028 029/** 030 * Decodes an HTTP message entity input stream. 031 */ 032public interface Decoder extends Indexed<String> { 033 034 /** Mapping of supported codings to associated decoders. */ 035 Map<String, Decoder> SERVICES = Collections.unmodifiableMap(new CaseInsensitiveMap<>(Loader.loadMap( 036 String.class, Decoder.class))); 037 038 /** 039 * Returns the coding that the decoder supports, as it would appear in the {@code Content-Encoding} header. 040 * 041 * @return The coding that the decoder supports, as it would appear in the {@code Content-Encoding} header. 042 */ 043 @Override 044 String getKey(); 045 046 /** 047 * Returns an instance of an input stream that decodes the specified input. 048 * 049 * @param in 050 * The input stream to be decoded. 051 * @return an input stream exposing the decoded content. 052 * @throws IOException 053 * If an I/O exception occurs during decoding. 054 */ 055 InputStream decode(InputStream in) throws IOException; 056}