ai.djl.serving.util

Class NettyUtils

java.lang.Object

ai.djl.serving.util.NettyUtils

public final class NettyUtils
extends java.lang.Object

A utility class that handling Netty request and response.

Method Summary

Modifier and Type	Method and Description
static void	addFormData(io.netty.handler.codec.http.multipart.InterfaceHttpData data, ai.djl.modality.Input input) Parses form data and added to the Input object.
static void	closeOnFlush(io.netty.channel.Channel ch) Closes the specified channel after all queued write requests are flushed.
static byte[]	getBytes(io.netty.buffer.ByteBuf buf) Returns the bytes for the specified ByteBuf.
static int	getIntParameter(io.netty.handler.codec.http.QueryStringDecoder decoder, java.lang.String key, int def) Read the parameter's integer value for the key from the uri.
static java.lang.String	getParameter(io.netty.handler.codec.http.QueryStringDecoder decoder, java.lang.String key, java.lang.String def) Reads the parameter's value for the key from the uri.
static java.lang.String	getRequestId(io.netty.channel.Channel channel) Returns the request ID for the specified channel.
static void	requestReceived(io.netty.channel.Channel channel, io.netty.handler.codec.http.HttpRequest request) Updates session when a HTTP request is received.
static void	sendError(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpResponseStatus status, java.lang.Throwable t) Sends error to client with HTTP status and exception.
static void	sendError(io.netty.channel.ChannelHandlerContext ctx, java.lang.Throwable t) Sends error to client with exception.
static void	sendHttpResponse(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.FullHttpResponse resp, boolean keepAlive) Send HTTP response to client.
static void	sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx, java.lang.Object obj) Sends the json object to client.
static void	sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx, java.lang.Object obj, io.netty.handler.codec.http.HttpResponseStatus status) Sends the json string to client with specified status.
static void	sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx, java.lang.String json) Sends the json string to client.
static void	sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx, java.lang.String json, io.netty.handler.codec.http.HttpResponseStatus status) Sends the json object to client with specified status.

Methods inherited from class java.lang.Object

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

Method Detail

requestReceived

public static void requestReceived(io.netty.channel.Channel channel,
                                   io.netty.handler.codec.http.HttpRequest request)

Updates session when a HTTP request is received.

Parameters:

channel - the connection channel

request - the HTTP request

getRequestId

public static java.lang.String getRequestId(io.netty.channel.Channel channel)

Returns the request ID for the specified channel.

Parameters:

channel - the connection channel

Returns:

the request ID for the specified channel

sendJsonResponse

public static void sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx,
                                    java.lang.Object obj)

Sends the json object to client.

Parameters:

ctx - the connection context

obj - the object to be sent

sendJsonResponse

public static void sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx,
                                    java.lang.Object obj,
                                    io.netty.handler.codec.http.HttpResponseStatus status)

Sends the json string to client with specified status.

Parameters:

ctx - the connection context

obj - the object to be sent

status - the HTTP status

sendJsonResponse

public static void sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx,
                                    java.lang.String json)

Sends the json string to client.

Parameters:

ctx - the connection context

json - the json string

sendJsonResponse

public static void sendJsonResponse(io.netty.channel.ChannelHandlerContext ctx,
                                    java.lang.String json,
                                    io.netty.handler.codec.http.HttpResponseStatus status)

Sends the json object to client with specified status.

Parameters:

ctx - the connection context

json - the json object

status - the HTTP status

sendError

public static void sendError(io.netty.channel.ChannelHandlerContext ctx,
                             java.lang.Throwable t)

Sends error to client with exception.

Parameters:

ctx - the connection context

t - the exception to be send

sendError

public static void sendError(io.netty.channel.ChannelHandlerContext ctx,
                             io.netty.handler.codec.http.HttpResponseStatus status,
                             java.lang.Throwable t)

Sends error to client with HTTP status and exception.

Parameters:

ctx - the connection context

status - the HTTP status

t - the exception to be send

sendHttpResponse

public static void sendHttpResponse(io.netty.channel.ChannelHandlerContext ctx,
                                    io.netty.handler.codec.http.FullHttpResponse resp,
                                    boolean keepAlive)

Send HTTP response to client.

Parameters:

ctx - ChannelHandlerContext

resp - HttpResponse to send

keepAlive - if keep the connection

closeOnFlush

public static void closeOnFlush(io.netty.channel.Channel ch)

Closes the specified channel after all queued write requests are flushed.

Parameters:

ch - the channel to be closed

getBytes

public static byte[] getBytes(io.netty.buffer.ByteBuf buf)

Returns the bytes for the specified ByteBuf.

Parameters:

buf - the ByteBuf to read

Returns:

the bytes for the specified ByteBuf

getParameter

public static java.lang.String getParameter(io.netty.handler.codec.http.QueryStringDecoder decoder,
                                            java.lang.String key,
                                            java.lang.String def)

Reads the parameter's value for the key from the uri.

Parameters:

decoder - the QueryStringDecoder parsed from uri

key - the parameter key

def - the default value

Returns:

the parameter's value

getIntParameter

public static int getIntParameter(io.netty.handler.codec.http.QueryStringDecoder decoder,
                                  java.lang.String key,
                                  int def)

Read the parameter's integer value for the key from the uri.

Parameters:

decoder - the QueryStringDecoder parsed from uri

key - the parameter key

def - the default value

Returns:

the parameter's integer value

Throws:

java.lang.NumberFormatException - exception is thrown when the parameter-value is not numeric.

addFormData

public static void addFormData(io.netty.handler.codec.http.multipart.InterfaceHttpData data,
                               ai.djl.modality.Input input)

Parses form data and added to the Input object.

Parameters:

data - the form data

input - the Input object to be added to