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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.processing.handler;
import com.yahoo.component.annotation.Inject;
import com.yahoo.component.ComponentId;
import com.yahoo.component.ComponentSpecification;
import com.yahoo.component.chain.Chain;
import com.yahoo.component.chain.ChainedComponent;
import com.yahoo.component.chain.model.ChainsModelBuilder;
import com.yahoo.component.provider.ComponentRegistry;
import com.yahoo.container.core.ChainsConfig;
import com.yahoo.container.jdisc.ContentChannelOutputStream;
import com.yahoo.container.jdisc.HttpRequest;
import com.yahoo.container.jdisc.HttpResponse;
import com.yahoo.container.jdisc.LoggingRequestHandler;
import com.yahoo.container.logging.AccessLog;
import com.yahoo.jdisc.Metric;
import com.yahoo.jdisc.handler.ContentChannel;
import com.yahoo.processing.Processor;
import com.yahoo.processing.Request;
import com.yahoo.processing.Response;
import com.yahoo.processing.execution.Execution;
import com.yahoo.processing.execution.ResponseReceiver;
import com.yahoo.processing.execution.chain.ChainRegistry;
import com.yahoo.processing.rendering.AsynchronousSectionedRenderer;
import com.yahoo.processing.rendering.ProcessingRenderer;
import com.yahoo.processing.rendering.Renderer;
import com.yahoo.processing.request.CompoundName;
import com.yahoo.processing.request.ErrorMessage;
import com.yahoo.processing.request.Properties;
import java.util.Map;
import java.util.concurrent.Executor;
import static com.yahoo.component.chain.ChainsConfigurer.prepareChainRegistry;
/**
* Superclass of handlers invoking some kind of processing chain.
* <p>
* COMPONENT: The type of the processing components of which this executes a chain
*
* @author bratseth
* @author Tony Vaagenes
* @author Steinar Knutsen
*/
@SuppressWarnings("deprecation") // super class is deprecated
public abstract class AbstractProcessingHandler<COMPONENT extends Processor> extends LoggingRequestHandler {
private final static CompoundName freezeListenerKey = CompoundName.from("processing.freezeListener");
public final static String DEFAULT_RENDERER_ID = "default";
private final Executor renderingExecutor;
private final ChainRegistry<COMPONENT> chainRegistry;
private final ComponentRegistry<Renderer> renderers;
private final Renderer defaultRenderer;
public AbstractProcessingHandler(ChainRegistry<COMPONENT> chainRegistry,
ComponentRegistry<Renderer> renderers,
Executor executor,
AccessLog ignored,
Metric metric) {
super(executor, metric, true);
renderingExecutor = executor;
this.chainRegistry = chainRegistry;
this.renderers = renderers;
// Default is the one with id "default", or the ProcessingRenderer if there is no such renderer
Renderer defaultRenderer = renderers.getComponent(ComponentSpecification.fromString(DEFAULT_RENDERER_ID));
if (defaultRenderer == null) {
defaultRenderer = new ProcessingRenderer();
renderers.register(ComponentId.fromString(DEFAULT_RENDERER_ID), defaultRenderer);
}
this.defaultRenderer = defaultRenderer;
}
public AbstractProcessingHandler(ChainRegistry<COMPONENT> chainRegistry,
ComponentRegistry<Renderer> renderers,
Executor executor,
AccessLog ignored) {
this(chainRegistry, renderers, executor, ignored, null);
}
public AbstractProcessingHandler(ChainsConfig processingChainsConfig,
ComponentRegistry <COMPONENT> chainedComponents,
ComponentRegistry<Renderer> renderers,
Executor executor,
AccessLog ignored) {
this(processingChainsConfig, chainedComponents, renderers, executor, ignored, null);
}
@Inject
public AbstractProcessingHandler(ChainsConfig processingChainsConfig,
ComponentRegistry<COMPONENT> chainedComponents,
ComponentRegistry<Renderer> renderers,
Executor executor,
AccessLog ignored,
Metric metric) {
this(createChainRegistry(processingChainsConfig, chainedComponents), renderers, executor, ignored, metric);
}
/** Throws UnsupportedOperationException: Call handle(request, channel instead) */
@Override
public HttpResponse handle(HttpRequest request) {
throw new UnsupportedOperationException("Call handle(request, channel) instead");
}
@Override
public HttpResponse handle(HttpRequest request, ContentChannel channel) {
com.yahoo.processing.Request processingRequest = new com.yahoo.processing.Request();
populate("", request.propertyMap(), processingRequest.properties());
populate("context.", request.getJDiscRequest().context(), processingRequest.properties());
processingRequest.properties().set(Request.JDISC_REQUEST, request);
FreezeListener freezeListener = new FreezeListener(processingRequest, renderers, defaultRenderer, channel, renderingExecutor);
processingRequest.properties().set(freezeListenerKey, freezeListener);
Chain<COMPONENT> chain = chainRegistry.getComponent(resolveChainId(processingRequest.properties()));
if (chain == null)
throw new IllegalArgumentException("Chain '" + processingRequest.properties().get("chain") + "' not found");
Execution execution = createExecution(chain, processingRequest);
freezeListener.setExecution(execution);
Response processingResponse = execution.process(processingRequest);
return freezeListener.getHttpResponse(processingResponse);
}
public Execution createExecution(Chain<COMPONENT> chain, Request processingRequest) {
int traceLevel = processingRequest.properties().getInteger("tracelevel", 0);
return Execution.createRoot(chain, traceLevel, new Execution.Environment<>(chainRegistry));
}
public ChainRegistry<COMPONENT> getChainRegistry() { return chainRegistry; }
public ComponentRegistry<Renderer> getRenderers() { return renderers; }
/**
* For internal use only
*/
@SuppressWarnings("unchecked")
public Renderer<Response> getRendererCopy(ComponentSpecification spec) {
Renderer<Response> renderer = getRenderers().getComponent(spec);
if (renderer == null) throw new IllegalArgumentException("No renderer with spec: " + spec);
return perRenderingCopy(renderer);
}
private static Renderer<Response> perRenderingCopy(Renderer<Response> renderer) {
Renderer<Response> copy = renderer.clone();
copy.init();
return copy;
}
private static Renderer selectRenderer(com.yahoo.processing.Request processingRequest,
ComponentRegistry<Renderer> renderers, Renderer defaultRenderer) {
Renderer renderer = null;
// TODO: Support setting a particular renderer instead of just selecting by name?
String rendererId = processingRequest.properties().getString("format");
if (rendererId != null && !"".equals(rendererId)) {
renderer = renderers.getComponent(ComponentSpecification.fromString(rendererId));
if (renderer == null)
processingRequest.errors().add(new ErrorMessage("Could not find renderer","Requested '" + rendererId +
"', has " + renderers.allComponents()));
}
if (renderer == null)
renderer = defaultRenderer;
return renderer;
}
private static <COMPONENT extends ChainedComponent> ChainRegistry<COMPONENT> createChainRegistry(
ChainsConfig processingChainsConfig,
ComponentRegistry<COMPONENT> availableComponents) {
ChainRegistry<COMPONENT> chainRegistry = new ChainRegistry<>();
prepareChainRegistry(chainRegistry, ChainsModelBuilder.buildFromConfig(processingChainsConfig), availableComponents);
chainRegistry.freeze();
return chainRegistry;
}
private String resolveChainId(Properties properties) {
return properties.getString(Request.CHAIN,"default");
}
private void populate(String prefixName, Map<String,?> parameters,Properties properties) {
for (Map.Entry<String,?> entry : parameters.entrySet())
properties.set(CompoundName.from(prefixName + entry.getKey()), entry.getValue());
}
private static class FreezeListener implements Runnable, ResponseReceiver {
/** Used to create the renderer */
private final com.yahoo.processing.Request request;
private final ComponentRegistry<Renderer> renderers;
private final Renderer defaultRenderer;
private final ContentChannel channel;
private final Executor renderingExecutor;
/** Used to render */
private Execution execution;
private Response response;
/** The renderer used in this, or null if not created yet */
private Renderer<Response> renderer = null;
public FreezeListener(com.yahoo.processing.Request request, ComponentRegistry<Renderer> renderers,
Renderer defaultRenderer, ContentChannel channel, Executor renderingExecutor) {
this.request = request;
this.renderers = renderers;
this.defaultRenderer = defaultRenderer;
this.channel = channel;
this.renderingExecutor = renderingExecutor;
}
/** Expected to be called once before run is called */
@Override
public void setResponse(Response response) { this.response = response; }
/** Expected to be called once before run is called */
public void setExecution(Execution execution) { this.execution = execution; }
/** Returns and lazily creates the renderer of this. May be called even if run is never called. */
public Renderer getRenderer() {
if (renderer == null)
renderer = perRenderingCopy(selectRenderer(request, renderers, defaultRenderer));
return renderer;
}
/** Returns and lazily creates the http response of this. May be called even if run is never called. */
private HttpResponse getHttpResponse(Response processingResponse) {
int status = 200; // true status is determined asynchronously in ProcessingResponse.complete()
return new ProcessingResponse(status, request, processingResponse, getRenderer(), renderingExecutor, execution);
}
@Override
public void run() {
if (execution == null || response == null)
throw new NullPointerException("Uninitialized freeze listener");
if (channel instanceof LazyContentChannel)
((LazyContentChannel)channel).setHttpResponse(getHttpResponse(response));
// Render if we have a renderer capable of it
if (getRenderer() instanceof AsynchronousSectionedRenderer) {
((AsynchronousSectionedRenderer) getRenderer()).renderResponseBeforeHandover(
new ContentChannelOutputStream(channel), response, execution, request);
}
}
}
}
|
