org.springframework.web.servlet.resource.ResourceTransformerChain Maven / Gradle / Ivy
/*
* Copyright 2002-2018 the original author or 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 org.springframework.web.servlet.resource;
import java.io.IOException;
import javax.servlet.http.HttpServletRequest;
import org.springframework.core.io.Resource;
/**
* A contract for invoking a chain of {@link ResourceTransformer ResourceTransformers} where each resolver
* is given a reference to the chain allowing it to delegate when necessary.
*
* @author Rossen Stoyanchev
* @since 4.1
*/
public interface ResourceTransformerChain {
/**
* Return the {@code ResourceResolverChain} that was used to resolve the
* {@code Resource} being transformed. This may be needed for resolving
* related resources, e.g. links to other resources.
*/
ResourceResolverChain getResolverChain();
/**
* Transform the given resource.
* @param request the current request
* @param resource the candidate resource to transform
* @return the transformed or the same resource, never {@code null}
* @throws IOException if transformation fails
*/
Resource transform(HttpServletRequest request, Resource resource) throws IOException;
}