io.micronaut.http.server.netty.HttpCompressionStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-http-server-netty Show documentation

Natively Cloud Native

There is a newer version: 4.7.9

Show newest version

/*
 * Copyright 2017-2020 original authors
 *
 * Licensed 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
 *
 * https://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.
 */
package io.micronaut.http.server.netty;

import io.micronaut.core.util.Toggleable;
import io.netty.handler.codec.compression.StandardCompressionOptions;
import io.netty.handler.codec.http.HttpResponse;

/**
 * Determines if a given http message should be compressed. It should
 * be assumed the client allows for compressed responses.
 *
 * @author James Kleeh
 * @since 1.2.0
 */
public interface HttpCompressionStrategy extends Toggleable {
    /**
     * @param response The HTTP response
     * @return True if the response should be compressed
     */
    boolean shouldCompress(HttpResponse response);

    /**
     * @return The compression level (0-9)
     */
    default int getCompressionLevel() {
        return StandardCompressionOptions.gzip().compressionLevel();
    }
}