org.waarp.gateway.kernel.rest

Class RootOptionsRestMethodHandler

java.lang.Object

org.waarp.gateway.kernel.rest.RestMethodHandler

org.waarp.gateway.kernel.rest.RootOptionsRestMethodHandler

public class RootOptionsRestMethodHandler
extends RestMethodHandler

RestMethod handler to implement Root Options handler

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT

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

isBodyJsonDecode, methods, name, path, restConfiguration

Constructor Summary

Constructors

Constructor and Description
RootOptionsRestMethodHandler(RestConfiguration config)

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.
void	endParsingRequest(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) Called when all Data were passed to the handler
Object	getBody(HttpRestHandler handler, io.netty.buffer.ByteBuf body, RestArgument arguments, RestArgument result) Get data from BODY (supposedly a Json)
protected com.fasterxml.jackson.databind.node.ArrayNode	getDetailedAllow()
void	getFileUpload(HttpRestHandler handler, io.netty.handler.codec.http.multipart.FileUpload data, RestArgument arguments, RestArgument result) Get a new Http Uploaded File from BODY
void	optionsCommand(HttpRestHandler handler, RestArgument arguments, RestArgument result) Options command that all handler should implement
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)

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

getName, getPath, handleException, isBodyJsonDecoded, isMethodIncluded, sendOptionsResponse, setIntersectionMethods, setMethods

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final String ROOT

See Also:

Constant Field Values

Constructor Detail

RootOptionsRestMethodHandler

public RootOptionsRestMethodHandler(RestConfiguration config)

Method Detail

checkHandlerSessionCorrectness

public 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 void getFileUpload(HttpRestHandler handler,
                          io.netty.handler.codec.http.multipart.FileUpload data,
                          RestArgument arguments,
                          RestArgument result)
                   throws HttpIncorrectRequestException

Description copied from class: RestMethodHandler

Get a new Http Uploaded File from BODY

Specified by:

getFileUpload in class RestMethodHandler

Throws:

HttpIncorrectRequestException

getBody

public 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

endParsingRequest

public void endParsingRequest(HttpRestHandler handler,
                              RestArgument arguments,
                              RestArgument result,
                              Object body)
                       throws HttpIncorrectRequestException,
                              HttpInvalidAuthenticationException

Description copied from class: RestMethodHandler

Called when all Data were passed to the handler

Specified by:

endParsingRequest in class RestMethodHandler

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

sendResponse

public 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

optionsCommand

public void optionsCommand(HttpRestHandler handler,
                           RestArgument arguments,
                           RestArgument result)

Description copied from class: RestMethodHandler

Options command that all handler should implement

Overrides:

optionsCommand in class RestMethodHandler

getDetailedAllow

protected com.fasterxml.jackson.databind.node.ArrayNode getDetailedAllow()

Specified by:

getDetailedAllow in class RestMethodHandler

Returns:

the detail of the method handler