org.wisdom.api.content.ContentEncodingHelper Maven / Gradle / Ivy
/*
* #%L
* Wisdom-Framework
* %%
* Copyright (C) 2013 - 2014 Wisdom Framework
* %%
* 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
*
* 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.
* #L%
*/
package org.wisdom.api.content;
import org.wisdom.api.http.Context;
import org.wisdom.api.http.Renderable;
import org.wisdom.api.http.Result;
import org.wisdom.api.router.Route;
import java.util.List;
import java.util.Map;
/**
* A helper object to ease the decision process about to encode or not to encode the current request. This object
* just wraps this logic in a separated object, following the single responsibility principle.
*/
public interface ContentEncodingHelper {
/**
* Parses a string to return an ordered list according to the Accept_Encoding HTTP Header grammar.
*
* @param headerContent String to parse. Should be an Accept_Encoding header.
* @return An ordered list of encodings, empty if the Accept-Encoding header is not used.
*/
public List parseAcceptEncodingHeader(String headerContent);
/**
* Checks whether the given result should be encoded or not.
*
* @param context the context
* @param result the result
* @param renderable the renderable
* @return {@literal true} if the result must be encoded, {@literal false} otherwise.
*/
public boolean shouldEncode(Context context, Result result, Renderable renderable);
public boolean shouldEncodeWithRoute(Route route);
public boolean shouldEncodeWithSize(Route route, Renderable renderable);
public boolean shouldEncodeWithMimeType(Renderable renderable);
public boolean shouldEncodeWithHeaders(Map headers);
}