org.waarp.openr66.protocol.http.rest.handler

Class HttpRestAbstractR66Handler

java.lang.Object

org.waarp.gateway.kernel.rest.RestMethodHandler

org.waarp.openr66.protocol.http.rest.handler.HttpRestAbstractR66Handler

Direct Known Subclasses:

HttpRestBandwidthR66Handler, HttpRestBusinessR66Handler, HttpRestConfigR66Handler, HttpRestControlR66Handler, HttpRestInformationR66Handler, HttpRestLogR66Handler, HttpRestServerR66Handler

public abstract class HttpRestAbstractR66Handler
extends RestMethodHandler

Common method implementation for Action Rest R66 handlers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRestAbstractR66Handler.ACTIONS_TYPE

Field Summary

Fields inherited from class org.waarp.gateway.kernel.rest.RestMethodHandler

isBodyJsonDecode, methods, name, path, restConfiguration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpRestAbstractR66Handler(String path, RestConfiguration config, HttpRestHandler.METHOD... method)

Method Summary

Modifier and Type	Method and Description
void	checkHandlerSessionCorrectness(HttpRestHandler handler, RestArgument arguments, RestArgument result) Check the session (arguments, result) vs handler correctness, called before any BODY elements but after URI and HEADER.
Object	getBody(HttpRestHandler handler, io.netty.buffer.ByteBuf body, RestArgument arguments, RestArgument result) Get data from BODY (supposedly a Json)
void	getFileUpload(HttpRestHandler handler, io.netty.handler.codec.http.multipart.FileUpload data, RestArgument arguments, RestArgument result) Get a new Http Uploaded File from BODY
io.netty.handler.codec.http.HttpResponseStatus	handleException(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body, Exception exception) Called when an exception occurs
io.netty.channel.ChannelFuture	sendResponse(HttpRestHandler handler, io.netty.channel.ChannelHandlerContext ctx, RestArgument arguments, RestArgument result, Object body, io.netty.handler.codec.http.HttpResponseStatus status) Send a response (correct or not)
protected void	setError(HttpRestHandler handler, RestArgument result, io.netty.handler.codec.http.HttpResponseStatus code)
protected void	setError(HttpRestHandler handler, RestArgument result, JsonPacket packet, io.netty.handler.codec.http.HttpResponseStatus code)
protected void	setOk(HttpRestHandler handler, RestArgument result, JsonPacket packet, io.netty.handler.codec.http.HttpResponseStatus code)

Methods inherited from class org.waarp.gateway.kernel.rest.RestMethodHandler

endParsingRequest, getDetailedAllow, getName, getPath, isBodyJsonDecoded, isMethodIncluded, optionsCommand, sendOptionsResponse, setIntersectionMethods, setMethods

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRestAbstractR66Handler

protected HttpRestAbstractR66Handler(String path,
                                     RestConfiguration config,
                                     HttpRestHandler.METHOD... method)

Parameters:

path -

method -

Method Detail

checkHandlerSessionCorrectness

public final void checkHandlerSessionCorrectness(HttpRestHandler handler,
                                                 RestArgument arguments,
                                                 RestArgument result)
                                          throws HttpForbiddenRequestException

Description copied from class: RestMethodHandler

Check the session (arguments, result) vs handler correctness, called before any BODY elements but after URI and HEADER.

Specified by:

checkHandlerSessionCorrectness in class RestMethodHandler

Throws:

HttpForbiddenRequestException

getFileUpload

public final void getFileUpload(HttpRestHandler handler,
                                io.netty.handler.codec.http.multipart.FileUpload data,
                                RestArgument arguments,
                                RestArgument result)

Description copied from class: RestMethodHandler

Get a new Http Uploaded File from BODY

Specified by:

getFileUpload in class RestMethodHandler

setError

protected final void setError(HttpRestHandler handler,
                              RestArgument result,
                              io.netty.handler.codec.http.HttpResponseStatus code)

setError

protected final void setError(HttpRestHandler handler,
                              RestArgument result,
                              JsonPacket packet,
                              io.netty.handler.codec.http.HttpResponseStatus code)

setOk

protected final void setOk(HttpRestHandler handler,
                           RestArgument result,
                           JsonPacket packet,
                           io.netty.handler.codec.http.HttpResponseStatus code)

handleException

public io.netty.handler.codec.http.HttpResponseStatus handleException(HttpRestHandler handler,
                                                                      RestArgument arguments,
                                                                      RestArgument result,
                                                                      Object body,
                                                                      Exception exception)

Description copied from class: RestMethodHandler

Called when an exception occurs

Overrides:

handleException in class RestMethodHandler

Returns:

the status to used in sendReponse

sendResponse

public final io.netty.channel.ChannelFuture sendResponse(HttpRestHandler handler,
                                                         io.netty.channel.ChannelHandlerContext ctx,
                                                         RestArgument arguments,
                                                         RestArgument result,
                                                         Object body,
                                                         io.netty.handler.codec.http.HttpResponseStatus status)

Description copied from class: RestMethodHandler

Send a response (correct or not)

Specified by:

sendResponse in class RestMethodHandler

Returns:

The ChannelFuture if this response will need the channel to be closed, else null

getBody

public final Object getBody(HttpRestHandler handler,
                            io.netty.buffer.ByteBuf body,
                            RestArgument arguments,
                            RestArgument result)
                     throws HttpIncorrectRequestException

Description copied from class: RestMethodHandler

Get data from BODY (supposedly a Json)

Specified by:

getBody in class RestMethodHandler

Returns:

the object related to BODY decoding

Throws:

HttpIncorrectRequestException