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

Class TransfersHandler

java.lang.Object

io.cdap.http.AbstractHttpHandler

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

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

All Implemented Interfaces:

io.cdap.http.HttpHandler

@Path(value="/v2/transfers/")
public class TransfersHandler
extends AbstractRestDbHandler

This is the AbstractRestDbHandler handling all requests made on the transfer collection REST entry point.

Field Summary

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

crud

Constructor Summary

Constructors

Constructor and Description
TransfersHandler(byte crud) Initializes the handler with the given CRUD mask.

Method Summary

Modifier and Type	Method and Description
void	createTransfer(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder) Method called to create a new transfer on the server.
void	filterTransfer(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String limitStr, String offsetStr, String orderStr, String ruleID, String partner, String statusStr, String filename, String startTrans, String stopTrans) Method called to obtain a list of transfer entry matching the different filters given as parameters of the query.
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

TransfersHandler

public TransfersHandler(byte crud)

Initializes the handler with the given CRUD mask.

Parameters:

crud - the CRUD mask for this handler

Method Detail

filterTransfer

@GET
 @Consumes(value="application/x-www-form-urlencoded")
public void filterTransfer(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="ascId")
                                                                                      String orderStr,
                                                                                      @QueryParam(value="ruleID") @DefaultValue(value="")
                                                                                      String ruleID,
                                                                                      @QueryParam(value="partner") @DefaultValue(value="")
                                                                                      String partner,
                                                                                      @QueryParam(value="status") @DefaultValue(value="")
                                                                                      String statusStr,
                                                                                      @QueryParam(value="filename") @DefaultValue(value="")
                                                                                      String filename,
                                                                                      @QueryParam(value="startTrans") @DefaultValue(value="")
                                                                                      String startTrans,
                                                                                      @QueryParam(value="stopTrans") @DefaultValue(value="")
                                                                                      String stopTrans)

Method called to obtain a list of transfer entry matching the different filters given as parameters of the query. The response is sent as a JSON array containing all the requested entries, 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

limitStr - maximum number of entries allowed in the response

offsetStr - 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

ruleID - filter transfers that use this rule

partner - filter transfers that have this partner

statusStr - filter transfers currently in one of these statuses

filename - filter transfers of a particular file

startTrans - lower bound for the transfers' starting date

stopTrans - upper bound for the transfers' starting date

createTransfer

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

Method called to create a new transfer on the server. 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