org.waarp.gateway.kernel.rest

Class DataModelRestMethodHandler<E extends AbstractDbData>

java.lang.Object

org.waarp.gateway.kernel.rest.RestMethodHandler

org.waarp.gateway.kernel.rest.DataModelRestMethodHandler<E>

Direct Known Subclasses:

DbConfigurationR66RestMethodHandler, DbHostAuthR66RestMethodHandler, DbHostConfigurationR66RestMethodHandler, DbRuleR66RestMethodHandler, DbTaskRunnerR66RestMethodHandler

public abstract class DataModelRestMethodHandler<E extends AbstractDbData>
extends RestMethodHandler

Generic Rest Model handler for Data model (CRUD access to a database table)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataModelRestMethodHandler.COMMAND_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	DataModelRestMethodHandler(String name, RestConfiguration config, HttpRestHandler.METHOD... method)

Method Summary

Modifier and Type	Method and Description
protected abstract void	checkAuthorization(HttpRestHandler handler, RestArgument arguments, RestArgument result, HttpRestHandler.METHOD method)
void	checkHandlerSessionCorrectness(HttpRestHandler handler, RestArgument arguments, RestArgument result) allowed: GET iff name or name/id, PUT iff name/id, POST iff name (no id), DELETE iff name/id and allowed
protected abstract E	createItem(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) To be used only in create mode.
protected void	delete(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) delete one item
void	endParsingRequest(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) Called when all Data were passed to the handler
protected void	getAll(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) Get all items, according to a possible filter
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
protected abstract E	getItem(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) For Read or Update, should include a select() from the database.
protected abstract E	getItemPreparedStatement(DbPreparedStatement statement)
protected void	getOne(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) Get one item according to id
protected abstract DbPreparedStatement	getPreparedStatement(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) For getAll access
abstract String	getPrimaryPropertyName()
protected void	post(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) Create one item
protected void	put(HttpRestHandler handler, RestArgument arguments, RestArgument result, Object body) Update one item according to id
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	setOk(HttpRestHandler handler, RestArgument result)

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

getDetailedAllow, getName, getPath, handleException, 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

DataModelRestMethodHandler

protected DataModelRestMethodHandler(String name,
                                     RestConfiguration config,
                                     HttpRestHandler.METHOD... method)

Method Detail

checkAuthorization

protected abstract void checkAuthorization(HttpRestHandler handler,
                                           RestArgument arguments,
                                           RestArgument result,
                                           HttpRestHandler.METHOD method)
                                    throws HttpForbiddenRequestException

Throws:

HttpForbiddenRequestException

checkHandlerSessionCorrectness

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

allowed: GET iff name or name/id, PUT iff name/id, POST iff name (no id), DELETE iff name/id and allowed

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,
                              HttpNotFoundRequestException

Description copied from class: RestMethodHandler

Called when all Data were passed to the handler

Specified by:

endParsingRequest in class RestMethodHandler

Throws:

HttpIncorrectRequestException

HttpNotFoundRequestException

HttpInvalidAuthenticationException

getItem

protected abstract E getItem(HttpRestHandler handler,
                             RestArgument arguments,
                             RestArgument result,
                             Object body)
                      throws HttpIncorrectRequestException,
                             HttpInvalidAuthenticationException,
                             HttpNotFoundRequestException

For Read or Update, should include a select() from the database. Shall not be used for Create. JSON_ID should be checked for the primary id.

Parameters:

handler -

arguments -

result -

body -

Returns:

the Object E according to URI and other arguments

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

HttpNotFoundRequestException

createItem

protected abstract E createItem(HttpRestHandler handler,
                                RestArgument arguments,
                                RestArgument result,
                                Object body)
                         throws HttpIncorrectRequestException,
                                HttpInvalidAuthenticationException

To be used only in create mode. No insert should be done into the database.

Parameters:

handler -

arguments -

result -

body -

Returns:

a new Object E according to URI and other arguments

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

getPreparedStatement

protected abstract DbPreparedStatement getPreparedStatement(HttpRestHandler handler,
                                                            RestArgument arguments,
                                                            RestArgument result,
                                                            Object body)
                                                     throws HttpIncorrectRequestException,
                                                            HttpInvalidAuthenticationException

For getAll access

Parameters:

handler -

arguments -

result -

body -

Returns:

the associated preparedStatement

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

getItemPreparedStatement

protected abstract E getItemPreparedStatement(DbPreparedStatement statement)
                                       throws HttpIncorrectRequestException,
                                              HttpNotFoundRequestException

Parameters:

statement -

Returns:

the Object E according to statement (using next) or null if no more item

Throws:

HttpIncorrectRequestException

HttpNotFoundRequestException

getPrimaryPropertyName

public abstract String getPrimaryPropertyName()

Returns:

the primary property name used in the uri for Get,Put,Delete for unique access

setOk

protected void setOk(HttpRestHandler handler,
                     RestArgument result)

getAll

protected void getAll(HttpRestHandler handler,
                      RestArgument arguments,
                      RestArgument result,
                      Object body)
               throws HttpIncorrectRequestException,
                      HttpInvalidAuthenticationException,
                      HttpNotFoundRequestException

Get all items, according to a possible filter

Parameters:

handler -

arguments -

result -

body -

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

HttpNotFoundRequestException

getOne

protected void getOne(HttpRestHandler handler,
                      RestArgument arguments,
                      RestArgument result,
                      Object body)
               throws HttpIncorrectRequestException,
                      HttpInvalidAuthenticationException,
                      HttpNotFoundRequestException

Get one item according to id

Parameters:

handler -

arguments -

result -

body -

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

HttpNotFoundRequestException

put

protected void put(HttpRestHandler handler,
                   RestArgument arguments,
                   RestArgument result,
                   Object body)
            throws HttpIncorrectRequestException,
                   HttpInvalidAuthenticationException,
                   HttpNotFoundRequestException

Update one item according to id

Parameters:

handler -

arguments -

result -

body -

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

HttpNotFoundRequestException

post

protected void post(HttpRestHandler handler,
                    RestArgument arguments,
                    RestArgument result,
                    Object body)
             throws HttpIncorrectRequestException,
                    HttpInvalidAuthenticationException

Create one item

Parameters:

handler -

arguments -

result -

body -

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

delete

protected void delete(HttpRestHandler handler,
                      RestArgument arguments,
                      RestArgument result,
                      Object body)
               throws HttpIncorrectRequestException,
                      HttpInvalidAuthenticationException,
                      HttpNotFoundRequestException

delete one item

Parameters:

handler -

arguments -

result -

body -

Throws:

HttpIncorrectRequestException

HttpInvalidAuthenticationException

HttpNotFoundRequestException

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