org.apache.flink.runtime.rest.handler.util

Class HandlerUtils

java.lang.Object

org.apache.flink.runtime.rest.handler.util.HandlerUtils

public class HandlerUtils
extends Object

Utilities for the REST handlers.

Constructor Summary

Constructors

Constructor and Description
HandlerUtils()

Method Summary

Modifier and Type	Method and Description
static void	sendErrorResponse(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, ErrorResponseBody errorMessage, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus statusCode) Sends the given error response and status code to the given channel.
static <P extends ResponseBody> void	sendResponse(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, P response, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus statusCode) Sends the given response and status code to the given channel.
static void	sendResponse(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, String message, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus statusCode) Sends the given response and status code to the given channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HandlerUtils

public HandlerUtils()

Method Detail

sendResponse

public static <P extends ResponseBody> void sendResponse(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                         org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest,
                                                         P response,
                                                         org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus statusCode)

Sends the given response and status code to the given channel.

Type Parameters:

P - type of the response

Parameters:

channelHandlerContext - identifying the open channel

httpRequest - originating http request

response - which should be sent

statusCode - of the message to send

sendErrorResponse

public static void sendErrorResponse(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                     org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest,
                                     ErrorResponseBody errorMessage,
                                     org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus statusCode)

Sends the given error response and status code to the given channel.

Parameters:

channelHandlerContext - identifying the open channel

httpRequest - originating http request

errorMessage - which should be sent

statusCode - of the message to send

sendResponse

public static void sendResponse(@Nonnull
                                org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                @Nonnull
                                org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest,
                                @Nonnull
                                String message,
                                @Nonnull
                                org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus statusCode)

Sends the given response and status code to the given channel.

Parameters:

channelHandlerContext - identifying the open channel

httpRequest - originating http request

message - which should be sent

statusCode - of the message to send