1 /*
2 * Licensed under the Apache License, Version 2.0 (the "License");
3 * you may not use this file except in compliance with the License.
4 * You may obtain a copy of the License at
5 *
6 * http://www.apache.org/licenses/LICENSE-2.0
7 *
8 * Unless required by applicable law or agreed to in writing, software
9 * distributed under the License is distributed on an "AS IS" BASIS,
10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 * See the License for the specific language governing permissions and
12 * limitations under the License.
13 *
14 */
15
16 package org.esigate;
17
18 import java.io.IOException;
19 import java.io.Writer;
20
21 import org.esigate.impl.DriverRequest;
22
23 /**
24 * Content rendering strategy.
25 *
26 * @author Stanislav Bernatskyi
27 */
28 public interface Renderer {
29
30 /**
31 * Renders provided source and writes results to the output.
32 *
33 *
34 * @param originalRequest
35 * request received by esigate.
36 * @param src
37 * source to be rendered
38 * @param out
39 * output destination. This writer is not thread-safe, use proper synchronization if writing output from
40 * multiple threads.
41 * @throws IOException
42 * @throws HttpErrorPage
43 */
44 void render(DriverRequest originalRequest, String src, Writer out) throws IOException, HttpErrorPage;
45 }