public class JobManagerJobEnvironmentHandler extends AbstractRestHandler<RestfulGateway,EmptyRequestBody,EnvironmentInfo,JobMessageParameters> implements JsonArchivist
log, MAPPER
leaderRetriever, logger, responseHeaders, timeout
Constructor and Description |
---|
JobManagerJobEnvironmentHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
Time timeout,
Map<String,String> responseHeaders,
MessageHeaders<EmptyRequestBody,EnvironmentInfo,JobMessageParameters> messageHeaders) |
Modifier and Type | Method and Description |
---|---|
Collection<ArchivedJson> |
archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo)
Returns a
Collection of ArchivedJson s containing JSON responses and their
respective REST URL for a given job. |
protected CompletableFuture<EnvironmentInfo> |
handleRequest(HandlerRequest<EmptyRequestBody> request,
RestfulGateway gateway)
This method is called for every incoming request and returns a
CompletableFuture
containing a the response. |
getMessageHeaders, respondToRequest
closeAsync, closeHandlerAsync, respondAsLeader
channelRead0
acceptInboundMessage, channelRead
channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered
ensureNotSharable, handlerAdded, handlerRemoved, isSharable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close
public JobManagerJobEnvironmentHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,EnvironmentInfo,JobMessageParameters> messageHeaders)
protected CompletableFuture<EnvironmentInfo> handleRequest(@Nonnull HandlerRequest<EmptyRequestBody> request, @Nonnull RestfulGateway gateway) throws RestHandlerException
AbstractRestHandler
CompletableFuture
containing a the response.
Implementations may decide whether to throw RestHandlerException
s or fail the
returned CompletableFuture
with a RestHandlerException
.
Failing the future with another exception type or throwing unchecked exceptions is
regarded as an implementation error as it does not allow us to provide a meaningful HTTP
status code. In this case a HttpResponseStatus.INTERNAL_SERVER_ERROR
will be
returned.
handleRequest
in class AbstractRestHandler<RestfulGateway,EmptyRequestBody,EnvironmentInfo,JobMessageParameters>
request
- request that should be handledgateway
- leader gatewayRestHandlerException
- if the handling failedpublic Collection<ArchivedJson> archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo) throws IOException
JsonArchivist
Collection
of ArchivedJson
s containing JSON responses and their
respective REST URL for a given job.
The collection should contain one entry for every response that could be generated for the given job, for example one entry for each task. The REST URLs should be unique and must not contain placeholders.
archiveJsonWithPath
in interface JsonArchivist
executionGraphInfo
- AccessExecutionGraph
-related information for which the
responses should be generatedIOException
- thrown if the JSON generation failsCopyright © 2014–2024 The Apache Software Foundation. All rights reserved.