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

Class RulesHandler

java.lang.Object

io.cdap.http.AbstractHttpHandler

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

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

All Implemented Interfaces:

io.cdap.http.HttpHandler

@Path(value="/v2/rules/")
public class RulesHandler
extends AbstractRestDbHandler

This is the AbstractRestDbHandler handling all operations on the host's transfer rule database.

Field Summary

Fields inherited from class org.waarp.openr66.protocol.http.restv2.dbhandlers.AbstractRestDbHandler

crud

Constructor Summary

Constructors

Constructor and Description
RulesHandler(byte crud)

Method Summary

Modifier and Type	Method and Description
void	addRule(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder) Method called to add a new transfer rule in the server database.
void	filterRules(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String limitStr, String offsetStr, String orderStr, String modeTransStr) Method called to obtain a list of transfer rules based on the filters in the query parameters.
void	options(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder) Method called to get a list of all allowed HTTP methods on this entry point.

Methods inherited from class org.waarp.openr66.protocol.http.restv2.dbhandlers.AbstractRestDbHandler

checkCRUD

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

Constructor Detail

RulesHandler

public RulesHandler(byte crud)

Method Detail

filterRules

@GET
 @Consumes(value="application/x-www-form-urlencoded")
public void filterRules(io.netty.handler.codec.http.HttpRequest request,
                                                                                   io.cdap.http.HttpResponder responder,
                                                                                   @QueryParam(value="limit") @DefaultValue(value="20")
                                                                                   String limitStr,
                                                                                   @QueryParam(value="offset") @DefaultValue(value="0")
                                                                                   String offsetStr,
                                                                                   @QueryParam(value="order") @DefaultValue(value="ascName")
                                                                                   String orderStr,
                                                                                   @QueryParam(value="modeTrans") @DefaultValue(value="")
                                                                                   String modeTransStr)

Method called to obtain a list of transfer rules based on the filters in the query parameters.

Parameters:

request - the HttpRequest made on the resource

responder - the HttpResponder which sends the reply to the request

limitStr - the maximum number of entries allowed in the response

offsetStr - the index of the first accepted entry in the list of all valid answers

orderStr - the criteria used to sort the entries and the way of ordering them

modeTransStr - only keep rules that use this transfer mode

addRule

@POST
 @Consumes(value="application/json")
public void addRule(io.netty.handler.codec.http.HttpRequest request,
                                                               io.cdap.http.HttpResponder responder)

Method called to add a new transfer rule in the server database. The reply will contain the created entry in JSON format, unless an unexpected error prevents it or if the request is invalid.

Parameters:

request - the HttpRequest made on the resource

responder - the HttpResponder which sends the reply to the request.

options

@OPTIONS
 @Consumes(value="*/*")
public void options(io.netty.handler.codec.http.HttpRequest request,
                                                     io.cdap.http.HttpResponder responder)

Method called to get a list of all allowed HTTP methods on this entry point. The HTTP methods are sent as an array in the reply's headers.

Parameters:

request - the HttpRequest made on the resource

responder - The HttpResponder which sends the reply to the request.