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

Class LimitsHandler

java.lang.Object

io.cdap.http.AbstractHttpHandler

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

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

All Implemented Interfaces:

io.cdap.http.HttpHandler

@Path(value="/v2/limits/")
public class LimitsHandler
extends AbstractRestDbHandler

This is the AbstractRestDbHandler handling all requests made on the bandwidth limits REST entry point.

Field Summary

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

crud

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deleteLimits(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder) Method called to remove any bandwidth limits in place on this host.
void	getLimits(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder) Method called to obtain a description of the host's current bandwidth limits.
void	initializeLimits(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder) Method called to initiate the entry for this host in the bandwidth limits database.
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.
void	updateLimits(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder) Method called to update this host's bandwidth limits in the database and configuration.

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

LimitsHandler

public LimitsHandler(byte crud)

Initializes the handler with the given CRUD mask.

Parameters:

crud - the CRUD mask for this handler

Method Detail

getLimits

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

Method called to obtain a description of the host's current bandwidth limits.

Parameters:

request - the HttpRequest made on the resource

responder - the HttpResponder which sends the reply to the request

initializeLimits

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

Method called to initiate the entry for this host in the bandwidth limits database. If the host already has limits set in its configuration, they will be replaced by these new ones.

Parameters:

request - the HttpRequest made on the resource

responder - the HttpResponder which sends the reply to the request

updateLimits

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

Method called to update this host's bandwidth limits in the database and configuration.

Parameters:

request - the HttpRequest made on the resource

responder - the HttpResponder which sends the reply to the request

deleteLimits

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

Method called to remove any bandwidth limits in place on this host. Also removes any limits set in the configuration.

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