org.waarp.openr66.protocol.http.restv2.dbhandlers

Class AbstractRestDbHandler

java.lang.Object

io.cdap.http.AbstractHttpHandler

org.waarp.openr66.protocol.http.restv2.dbhandlers.AbstractRestDbHandler

All Implemented Interfaces:

io.cdap.http.HttpHandler

Direct Known Subclasses:

HostConfigHandler, HostIdHandler, HostsHandler, LimitsHandler, RuleIdHandler, RulesHandler, ServerHandler, TransferIdHandler, TransfersHandler

public abstract class AbstractRestDbHandler
extends io.cdap.http.AbstractHttpHandler

This abstract class represents a handler for the WaarpR66 REST API. A handler can handle one or multiple entry points with multiple methods each.

To assign an entry point to a handler, use the Path annotation with the URI as value. This annotation can also be used on methods of the handler to create entry points below the handler's one.

For each entry point, all the desired HTTP methods must be assigned a corresponding Java method using the appropriate HttpMethod. These methods must all have an HttpRequest and a HttpResponder as their first 2 parameters, which correspond respectively to the request and its reply. The methods may also have other parameters marked with the PathParam annotation, meaning that these parameters correspond to the {id} given in the URI of the request. Some parameters may also be marked with the QueryParam an annotation, in which case the parameter marked is referring to the query parameter whose name is given in the annotation's parameter. A query parameter can be given a default value with the DefaultValue which will be assigned to the parameter when the request does not contain a value for it.

These methods should also be annotated with the Consumes annotation to indicate the expected content type of the request. Finally, each method should also be annotated with the RequiredRole annotation to make the method only accessible to users with the specified RoleDefault.ROLE or higher.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte	crud A byte mask defining which HTTP methods are allowed on the handler.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRestDbHandler(byte crud) Initializes the handler with the given CRUD mask.

Method Summary

Modifier and Type	Method and Description
boolean	checkCRUD(io.netty.handler.codec.http.HttpRequest request) Checks whether the HttpRequest given can be made on the handler in accordance with the handler's CRUD configuration.

Methods inherited from class io.cdap.http.AbstractHttpHandler

destroy, init, sendInternalRequest

Methods inherited from class java.lang.Object

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

Field Detail

crud

protected final byte crud

A byte mask defining which HTTP methods are allowed on the handler.

Constructor Detail

AbstractRestDbHandler

protected AbstractRestDbHandler(byte crud)

Initializes the handler with the given CRUD mask.

Parameters:

crud - the CRUD mask for this handler

Method Detail

checkCRUD

public boolean checkCRUD(io.netty.handler.codec.http.HttpRequest request)

Checks whether the HttpRequest given can be made on the handler in accordance with the handler's CRUD configuration.

Parameters:

request - the HTTP request to check

Returns:

true if the request is active, false otherwise.