001/*
002 * Copyright 2002-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.servlet.resource;
018
019import java.io.IOException;
020
021import javax.servlet.http.HttpServletRequest;
022
023import org.springframework.core.io.Resource;
024
025/**
026 * An abstraction for transforming the content of a resource.
027 *
028 * @author Jeremy Grelle
029 * @author Rossen Stoyanchev
030 * @since 4.1
031 */
032@FunctionalInterface
033public interface ResourceTransformer {
034
035        /**
036         * Transform the given resource.
037         * @param request the current request
038         * @param resource the resource to transform
039         * @param transformerChain the chain of remaining transformers to delegate to
040         * @return the transformed resource (never {@code null})
041         * @throws IOException if the transformation fails
042         */
043        Resource transform(HttpServletRequest request, Resource resource, ResourceTransformerChain transformerChain)
044                        throws IOException;
045
046}