org.waarp.gateway.kernel.http

Class HttpRequestHandler

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.http.HttpRequestHandler

All Implemented Interfaces:

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

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

Nested Class Summary

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 String	baseStaticPath
protected AbstractHttpBusinessRequest	businessRequest
protected String	cookieSession
protected io.netty.handler.codec.http.multipart.HttpPostRequestDecoder	decoder
protected String	errorMesg
protected HttpPage	httpPage
protected HttpPageHandler	httpPageHandler
protected io.netty.handler.codec.http.HttpMethod	method
protected io.netty.handler.codec.http.HttpRequest	request
protected HttpSession	session
protected io.netty.handler.codec.http.HttpResponseStatus	status
protected boolean	willClose

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpRequestHandler(String baseStaticPath, String cookieSession, HttpPageHandler httpPageHandler)

Method Summary

Modifier and Type	Method and Description
protected void	addBusinessCookie(io.netty.handler.codec.http.FullHttpResponse response, Set<String> cookieNames) Method to add specific Cookies from business definition Override if needed
protected abstract void	beforeSimplePage(io.netty.channel.ChannelHandlerContext ctx) Called before simple Page is called (Menu or HTML)
abstract void	businessValidRequestAfterAllDataReceived(io.netty.channel.ChannelHandlerContext ctx) Validate all data as they should be all received (done before the isRequestValid)
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
protected void	clean() Clean method Override if needed
protected void	createNewSessionAtConnection(io.netty.channel.ChannelHandlerContext ctx) Default session creation
protected void	delete(io.netty.channel.ChannelHandlerContext ctx) Method that get delete data
protected abstract void	error(io.netty.channel.ChannelHandlerContext ctx) Called when an error is raised.
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
protected void	finalData(io.netty.channel.ChannelHandlerContext ctx) Method that will use the result and send back the result
protected abstract void	finalDelete(io.netty.channel.ChannelHandlerContext ctx) Method that will use the uploaded file and prepare the result
protected abstract void	finalGet(io.netty.channel.ChannelHandlerContext ctx) Method that will use the uploaded file and send back the result (this method must send back the answer using for instance a ChunkedInput handler and should try to call clean(), but taking into consideration that it will erase all data, so it must be ensured that all data are sent through the wire before calling it.
protected abstract void	finalPost(io.netty.channel.ChannelHandlerContext ctx) Method that will use the post result and prepare the result
protected abstract void	finalPostUpload(io.netty.channel.ChannelHandlerContext ctx) Method that will use the uploaded file and prepare the result
protected abstract void	finalPut(io.netty.channel.ChannelHandlerContext ctx) Method that will use the put result and prepare the result
protected void	forceClosing(io.netty.channel.ChannelHandlerContext ctx) To allow quick answer even if in very bad shape
protected void	getCookieArgs() set values from Cookies
protected void	getFile(io.netty.channel.ChannelHandlerContext ctx) Method that get "get" data, answer has to be written in the business part finalGet
protected abstract String	getFilename()
protected void	getHeaderArgs() set values from Header
protected String	getNewCookieSession() Default Session Cookie generator
protected io.netty.handler.codec.http.FullHttpResponse	getResponse(io.netty.buffer.ByteBuf buf)
protected void	getUriArgs() set values from URI
protected void	initialize() Called at the beginning of every new request Override if needed
protected abstract boolean	isCookieValid(io.netty.handler.codec.http.cookie.Cookie cookie) Could be used for other method (as validation of an authent cookie)
protected void	post(io.netty.channel.ChannelHandlerContext ctx) Method that get post data
protected void	postChunk(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpContent chunk) Method that get a chunk of data
protected void	prepareError(io.netty.channel.ChannelHandlerContext ctx, String message) Utility to prepare error
protected void	readHttpData(io.netty.handler.codec.http.multipart.InterfaceHttpData data, io.netty.channel.ChannelHandlerContext ctx) Read one Data
protected void	readHttpDataAllReceive(io.netty.channel.ChannelHandlerContext ctx) Read all InterfaceHttpData from finished transfer
protected void	readHttpDataChunkByChunk(io.netty.channel.ChannelHandlerContext ctx) Read request by chunk and getting values from chunk to chunk
protected void	setCookieEncoder(io.netty.handler.codec.http.FullHttpResponse response) Method to set Cookies in response
protected boolean	setErrorPage(io.netty.channel.ChannelHandlerContext ctx) Instantiate the page and the businessRequest handler
protected void	writeErrorPage(io.netty.channel.ChannelHandlerContext ctx) Write an error page
protected void	writeSimplePage(io.netty.channel.ChannelHandlerContext ctx) Write a simple page from current httpPage and businessRequest

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

baseStaticPath

protected final String baseStaticPath

cookieSession

protected final String cookieSession

httpPageHandler

protected final HttpPageHandler httpPageHandler

session

protected HttpSession session

decoder

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

httpPage

protected HttpPage httpPage

businessRequest

protected AbstractHttpBusinessRequest businessRequest

status

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

errorMesg

protected String errorMesg

request

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

method

protected io.netty.handler.codec.http.HttpMethod method

willClose

protected volatile boolean willClose

Constructor Detail

HttpRequestHandler

protected HttpRequestHandler(String baseStaticPath,
                             String cookieSession,
                             HttpPageHandler httpPageHandler)

Parameters:

baseStaticPath -

cookieSession -

httpPageHandler -

Method Detail

clean

protected void clean()

Clean method

Override if needed

initialize

protected void initialize()

Called at the beginning of every new request

Override if needed

getUriArgs

protected void getUriArgs()
                   throws HttpIncorrectRequestException

set values from URI

Throws:

HttpIncorrectRequestException

getHeaderArgs

protected void getHeaderArgs()
                      throws HttpIncorrectRequestException

set values from Header

Throws:

HttpIncorrectRequestException

getCookieArgs

protected void getCookieArgs()
                      throws HttpIncorrectRequestException

set values from Cookies

Throws:

HttpIncorrectRequestException

checkConnection

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

To be used for instance to check correctness of connection

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

error

protected abstract void error(io.netty.channel.ChannelHandlerContext ctx)

Called when an error is raised. Note that clean() will be called just after.

Parameters:

ctx -

channelRead0

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

Specified by:

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

Throws:

Exception

prepareError

protected void prepareError(io.netty.channel.ChannelHandlerContext ctx,
                            String message)
                     throws HttpIncorrectRequestException

Utility to prepare error

Parameters:

ctx -

message -

Throws:

HttpIncorrectRequestException

setErrorPage

protected boolean setErrorPage(io.netty.channel.ChannelHandlerContext ctx)

Instantiate the page and the businessRequest handler

Parameters:

ctx -

Returns:

True if initialized

writeErrorPage

protected void writeErrorPage(io.netty.channel.ChannelHandlerContext ctx)

Write an error page

Parameters:

ctx -

forceClosing

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

To allow quick answer even if in very bad shape

Parameters:

ctx -

writeSimplePage

protected void writeSimplePage(io.netty.channel.ChannelHandlerContext ctx)
                        throws HttpIncorrectRequestException

Write a simple page from current httpPage and businessRequest

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

isCookieValid

protected abstract boolean isCookieValid(io.netty.handler.codec.http.cookie.Cookie cookie)

Could be used for other method (as validation of an authent cookie)

Parameters:

cookie -

Returns:

True if this cookie is valid

addBusinessCookie

protected void addBusinessCookie(io.netty.handler.codec.http.FullHttpResponse response,
                                 Set<String> cookieNames)

Method to add specific Cookies from business definition

Override if needed

Parameters:

response -

cookieNames -

setCookieEncoder

protected void setCookieEncoder(io.netty.handler.codec.http.FullHttpResponse response)

Method to set Cookies in response

Parameters:

response -

getResponse

protected io.netty.handler.codec.http.FullHttpResponse getResponse(io.netty.buffer.ByteBuf buf)

Parameters:

buf - might be null

Returns:

the Http Response according to the status

getFilename

protected abstract String getFilename()

Returns:

the filename used for this request

beforeSimplePage

protected abstract void beforeSimplePage(io.netty.channel.ChannelHandlerContext ctx)
                                  throws HttpIncorrectRequestException

Called before simple Page is called (Menu or HTML)

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

finalData

protected void finalData(io.netty.channel.ChannelHandlerContext ctx)
                  throws HttpIncorrectRequestException

Method that will use the result and send back the result

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

finalDelete

protected abstract void finalDelete(io.netty.channel.ChannelHandlerContext ctx)
                             throws HttpIncorrectRequestException

Method that will use the uploaded file and prepare the result

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

finalGet

protected abstract void finalGet(io.netty.channel.ChannelHandlerContext ctx)
                          throws HttpIncorrectRequestException

Method that will use the uploaded file and send back the result
(this method must send back the answer using for instance a ChunkedInput handler and should try to call clean(), but taking into consideration that it will erase all data, so it must be ensured that all data are sent through the wire before calling it. Note however that when the connection is closed or when a new request on the same connection occurs, the clean method is automatically called. The usage of a HttpCleanChannelFutureListener on the last write might be useful.)

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

finalPostUpload

protected abstract void finalPostUpload(io.netty.channel.ChannelHandlerContext ctx)
                                 throws HttpIncorrectRequestException

Method that will use the uploaded file and prepare the result

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

finalPost

protected abstract void finalPost(io.netty.channel.ChannelHandlerContext ctx)
                           throws HttpIncorrectRequestException

Method that will use the post result and prepare the result

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

finalPut

protected abstract void finalPut(io.netty.channel.ChannelHandlerContext ctx)
                          throws HttpIncorrectRequestException

Method that will use the put result and prepare the result

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

businessValidRequestAfterAllDataReceived

public abstract void businessValidRequestAfterAllDataReceived(io.netty.channel.ChannelHandlerContext ctx)
                                                       throws HttpIncorrectRequestException

Validate all data as they should be all received (done before the isRequestValid)

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

getFile

protected void getFile(io.netty.channel.ChannelHandlerContext ctx)
                throws HttpIncorrectRequestException

Method that get "get" data, answer has to be written in the business part finalGet

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

delete

protected void delete(io.netty.channel.ChannelHandlerContext ctx)
               throws HttpIncorrectRequestException

Method that get delete data

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

post

protected void post(io.netty.channel.ChannelHandlerContext ctx)
             throws HttpIncorrectRequestException

Method that get post data

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

postChunk

protected void postChunk(io.netty.channel.ChannelHandlerContext ctx,
                         io.netty.handler.codec.http.HttpContent chunk)
                  throws HttpIncorrectRequestException

Method that get a chunk of data

Parameters:

ctx -

chunk -

Throws:

HttpIncorrectRequestException

exceptionCaught

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

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

Throws:

Exception

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

readHttpDataAllReceive

protected void readHttpDataAllReceive(io.netty.channel.ChannelHandlerContext ctx)
                               throws HttpIncorrectRequestException

Read all InterfaceHttpData from finished transfer

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

readHttpDataChunkByChunk

protected void readHttpDataChunkByChunk(io.netty.channel.ChannelHandlerContext ctx)
                                 throws HttpIncorrectRequestException

Read request by chunk and getting values from chunk to chunk

Parameters:

ctx -

Throws:

HttpIncorrectRequestException

readHttpData

protected void readHttpData(io.netty.handler.codec.http.multipart.InterfaceHttpData data,
                            io.netty.channel.ChannelHandlerContext ctx)
                     throws HttpIncorrectRequestException

Read one Data

Parameters:

data -

ctx -

Throws:

HttpIncorrectRequestException

getNewCookieSession

protected String getNewCookieSession()

Default Session Cookie generator

Returns:

the new session cookie value

createNewSessionAtConnection

protected void createNewSessionAtConnection(io.netty.channel.ChannelHandlerContext ctx)

Default session creation

Parameters:

ctx -

channelActive

public 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