org.waarp.gateway.kernel.rest

Class HttpRestHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<io.netty.handler.codec.http.HttpObject>

org.waarp.gateway.kernel.rest.HttpRestHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

Direct Known Subclasses:

HttpRestR66Handler

public abstract class HttpRestHandler
extends io.netty.channel.SimpleChannelInboundHandler<io.netty.handler.codec.http.HttpObject>

Handler for HTTP Rest support

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HttpRestHandler.HttpCleanChannelFutureListener
static class	HttpRestHandler.METHOD

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
protected RestArgument	arguments Arguments received
protected io.netty.buffer.ByteBuf	cumulativeBody Cumulative chunks
protected DbSession	dbSession
protected io.netty.handler.codec.http.multipart.HttpPostRequestDecoder	decoder
static RestConfiguration	defaultConfiguration
static io.netty.handler.codec.http.multipart.HttpDataFactory	factory
static io.netty.channel.group.ChannelGroup	group
protected RestMethodHandler	handler
protected Object	jsonObject JSON decoded object
protected io.netty.handler.codec.http.HttpRequest	request
protected RestArgument	response The only structure that might be needed is: ARGS_COOKIE (subset)
RestConfiguration	restConfiguration
HashMap<String,RestMethodHandler>	restHashMap
protected RootOptionsRestMethodHandler	rootHandler
protected io.netty.handler.codec.http.HttpResponseStatus	status
static String	TempPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpRestHandler(RestConfiguration config)

Method Summary

Modifier and Type	Method and Description
protected void	bodyChunk(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpContent chunk) Method that get a chunk of data
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
protected void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpObject msg)
protected abstract void	checkConnection(io.netty.channel.ChannelHandlerContext ctx) To be used for instance to check correctness of connection Note that ARG_METHOD is only set from current request.
protected void	clean() Clean method Override if needed
protected void	createDecoder() Create the decoder
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
protected void	finalizeSend(io.netty.channel.ChannelHandlerContext ctx)
protected void	forceClosing(io.netty.channel.ChannelHandlerContext ctx) To allow quick answer even if in very bad shape
protected Object	getBodyJsonArgs(io.netty.buffer.ByteBuf data) Get Body args as JSON body
DbSession	getDbSession()
protected RestMethodHandler	getHandler() Could be overwritten if necessary
io.netty.handler.codec.http.HttpRequest	getRequest()
io.netty.handler.codec.http.FullHttpResponse	getResponse(io.netty.buffer.ByteBuf content)
io.netty.handler.codec.http.HttpResponseStatus	getStatus()
protected void	initialize() Called at the beginning of every new request Override if needed
static void	initialize(String tempPath) Initialize the Disk support
boolean	isWillClose()
protected void	readAllHttpData() Read all InterfaceHttpData from finished transfer
protected void	readHttpData(io.netty.handler.codec.http.multipart.InterfaceHttpData data) Read one Data
protected void	readHttpDataChunkByChunk() Read request by chunk and getting values from chunk to chunk
protected void	setCookies(io.netty.handler.codec.http.FullHttpResponse httpResponse) Method to set Cookies in httpResponse from response ObjectNode
void	setStatus(io.netty.handler.codec.http.HttpResponseStatus status)
void	setWillClose(boolean willClose)

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

factory

public static final io.netty.handler.codec.http.multipart.HttpDataFactory factory

TempPath

public static String TempPath

group

public static io.netty.channel.group.ChannelGroup group

defaultConfiguration

public static final RestConfiguration defaultConfiguration

restHashMap

public HashMap<String,RestMethodHandler> restHashMap

restConfiguration

public final RestConfiguration restConfiguration

rootHandler

protected final RootOptionsRestMethodHandler rootHandler

decoder

protected io.netty.handler.codec.http.multipart.HttpPostRequestDecoder decoder

status

protected io.netty.handler.codec.http.HttpResponseStatus status

request

protected io.netty.handler.codec.http.HttpRequest request

handler

protected RestMethodHandler handler

dbSession

protected DbSession dbSession

arguments

protected RestArgument arguments

Arguments received

response

protected RestArgument response

The only structure that might be needed is: ARGS_COOKIE (subset)

jsonObject

protected Object jsonObject

JSON decoded object

cumulativeBody

protected io.netty.buffer.ByteBuf cumulativeBody

Cumulative chunks

Constructor Detail

HttpRestHandler

protected HttpRestHandler(RestConfiguration config)

Method Detail

initialize

public static void initialize(String tempPath)

Initialize the Disk support

Parameters:

tempPath - system temp directory

Throws:

IOException

CryptoException

channelActive

public final void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                         throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

clean

protected final void clean()

Clean method

Override if needed

initialize

protected final void initialize()

Called at the beginning of every new request

Override if needed

getDbSession

public final DbSession getDbSession()

Returns:

the DbSession associated with the current request (might be Admin dbSession if none)

checkConnection

protected abstract void checkConnection(io.netty.channel.ChannelHandlerContext ctx)
                                 throws HttpInvalidAuthenticationException

To be used for instance to check correctness of connection
Note that ARG_METHOD is only set from current request. It might be also set from URI or HEADER and therefore should be done in this method.

Parameters:

ctx -

Throws:

HttpInvalidAuthenticationException

setCookies

protected final void setCookies(io.netty.handler.codec.http.FullHttpResponse httpResponse)

Method to set Cookies in httpResponse from response ObjectNode

Parameters:

httpResponse -

getHandler

protected final RestMethodHandler getHandler()
                                      throws HttpMethodNotAllowedRequestException,
                                             HttpForbiddenRequestException

Could be overwritten if necessary

Returns:

RestMethodHandler associated with the current context

Throws:

HttpIncorrectRequestException

HttpMethodNotAllowedRequestException

HttpForbiddenRequestException

channelRead0

protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                            io.netty.handler.codec.http.HttpObject msg)

Specified by:

channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<io.netty.handler.codec.http.HttpObject>

createDecoder

protected final void createDecoder()
                            throws HttpIncorrectRequestException

Create the decoder

Throws:

HttpIncorrectRequestException

readAllHttpData

protected final void readAllHttpData()
                              throws HttpIncorrectRequestException

Read all InterfaceHttpData from finished transfer

Throws:

HttpIncorrectRequestException

readHttpData

protected final void readHttpData(io.netty.handler.codec.http.multipart.InterfaceHttpData data)
                           throws HttpIncorrectRequestException

Read one Data

Parameters:

data -

Throws:

HttpIncorrectRequestException

forceClosing

protected final void forceClosing(io.netty.channel.ChannelHandlerContext ctx)

To allow quick answer even if in very bad shape

Parameters:

ctx -

getResponse

public final io.netty.handler.codec.http.FullHttpResponse getResponse(io.netty.buffer.ByteBuf content)

Parameters:

content -

Returns:

the Http Response according to the status and the content if not null (setting the CONTENT_LENGTH)

bodyChunk

protected final void bodyChunk(io.netty.channel.ChannelHandlerContext ctx,
                               io.netty.handler.codec.http.HttpContent chunk)
                        throws HttpIncorrectRequestException,
                               HttpInvalidAuthenticationException,
                               HttpNotFoundRequestException

Method that get a chunk of data

Parameters:

ctx -

chunk -

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

HttpNotFoundRequestException

finalizeSend

protected final void finalizeSend(io.netty.channel.ChannelHandlerContext ctx)

getBodyJsonArgs

protected final Object getBodyJsonArgs(io.netty.buffer.ByteBuf data)
                                throws HttpIncorrectRequestException

Get Body args as JSON body

Parameters:

data -

Throws:

HttpIncorrectRequestException

readHttpDataChunkByChunk

protected final void readHttpDataChunkByChunk()
                                       throws HttpIncorrectRequestException

Read request by chunk and getting values from chunk to chunk

Throws:

HttpIncorrectRequestException

exceptionCaught

public final void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                                  Throwable cause)

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

getStatus

public final io.netty.handler.codec.http.HttpResponseStatus getStatus()

Returns:

the status

setStatus

public final void setStatus(io.netty.handler.codec.http.HttpResponseStatus status)

Parameters:

status - the status to set

getRequest

public final io.netty.handler.codec.http.HttpRequest getRequest()

Returns:

the request

isWillClose

public final boolean isWillClose()

Returns:

the willClose

setWillClose

public final void setWillClose(boolean willClose)

Parameters:

willClose - the willClose to set