blob: b49edafbfd8d1eb0d16379e85aad9d05e6e997bc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.processing.rendering;
import com.yahoo.component.AbstractComponent;
import com.yahoo.processing.Request;
import com.yahoo.processing.Response;
import com.yahoo.processing.execution.Execution;
import java.io.OutputStream;
import java.util.concurrent.CompletableFuture;
/**
* Renders a response to a stream. The renderers are cloned just before
* rendering, and must therefore obey the following contract:
*
* <ol>
* <li>At construction time, only final members shall be initialized, and these
* must refer to immutable data only.</li>
* <li>State mutated during rendering shall be initialized in the init method.</li>
* </ol>
*
* @author Tony Vaagenes
* @author Steinar Knutsen
*/
public abstract class Renderer<RESPONSE extends Response> extends AbstractComponent implements Cloneable {
/**
* Used to create a separate instance for each result to render.
*/
@SuppressWarnings("unchecked")
@Override
public Renderer<RESPONSE> clone() {
return (Renderer<RESPONSE>) super.clone();
}
/**
* Initializes the mutable state, see the contract in the class
* documentation. Called on the clone just before rendering.
*/
public void init() {
}
/**
* Render a response to a stream. The stream also exposes a ByteBuffer API
* for efficient transactions to JDisc. The returned future will throw the
* exception causing failure wrapped in an ExecutionException if rendering
* was not successful.
*
* @param stream a stream API bridge to JDisc
* @param response the response to render
* @param execution the execution which created this response
* @param request the request matching the response
* @return a {@link CompletableFuture} containing a boolean where true indicates a successful rendering
*/
public abstract CompletableFuture<Boolean> renderResponse(OutputStream stream, RESPONSE response,
Execution execution, Request request);
/**
* Name of the output encoding, if applicable.
*
* @return the encoding of the output if applicable, e.g. "utf-8"
*/
public abstract String getEncoding();
/**
* The MIME type of the rendered content sent to the client.
*
* @return The mime type of the data written to the writer, e.g. "text/plain"
*/
public abstract String getMimeType();
}
|
