View Javadoc
1   /*
2    * Copyright 2002-2014 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.springframework.web.servlet.resource;
17  
18  
19  import java.io.IOException;
20  import javax.servlet.http.HttpServletRequest;
21  
22  import org.springframework.core.io.Resource;
23  
24  /**
25   * An abstraction for transforming the content of a resource.
26   *
27   * @author Jeremy Grelle
28   * @author Rossen Stoyanchev
29   * @since 4.1
30   */
31  public interface ResourceTransformer {
32  
33  	/**
34  	 * Transform the given resource.
35  	 *
36  	 * @param request the current request
37  	 * @param resource the resource to transform
38  	 * @param transformerChain the chain of remaining transformers to delegate to
39  	 * @return the transformed resource, never {@code null}
40  	 *
41  	 * @throws IOException if the transformation fails
42  	 */
43  	Resource transform(HttpServletRequest request, Resource resource, ResourceTransformerChain transformerChain)
44  			throws IOException;
45  
46  }