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.reactive.resource;
018
019import reactor.core.publisher.Mono;
020
021import org.springframework.core.io.Resource;
022import org.springframework.web.server.ServerWebExchange;
023
024/**
025 * An abstraction for transforming the content of a resource.
026 *
027 * @author Rossen Stoyanchev
028 * @since 5.0
029 */
030@FunctionalInterface
031public interface ResourceTransformer {
032
033        /**
034         * Transform the given resource.
035         * @param exchange the current exchange
036         * @param resource the resource to transform
037         * @param transformerChain the chain of remaining transformers to delegate to
038         * @return the transformed resource (never empty)
039         */
040        Mono<Resource> transform(ServerWebExchange exchange, Resource resource,
041                        ResourceTransformerChain transformerChain);
042
043}