001// Copyright 2011 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.services.assets;
016
017import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration;
018
019/**
020 * Identifies which content types are compressable. In general, content types are assumed to be compressable. The
021 * configuration of the service identifies exceptions, which are usually image file formats.
022 * <p>
023 * The configuration maps content types to boolean values (true for compressable).
024 * 
025 * @since 5.3
026 */
027@UsesMappedConfiguration(boolean.class)
028public interface CompressionAnalyzer
029{
030    /**
031     * For a given MIME type, is the content compressable via GZip?
032     * 
033     * @param contentType
034     *            MIME content type, possibly included attributes such as encoding type
035     * @return true if the content is not "naturally" compressed
036     */
037    boolean isCompressable(String contentType);
038}