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

Class TransferIdHandler

java.lang.Object

io.cdap.http.AbstractHttpHandler

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

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

All Implemented Interfaces:

io.cdap.http.HttpHandler

@Path(value="/v2/transfers//{id}")
public class TransferIdHandler
extends AbstractRestDbHandler

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

Field Summary

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

crud

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cancelTransfer(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String uri) Method called to cancel a staged or running transfer.
void	getTransfer(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String uri) Method called to obtain the information on the transfer whose id was given in the request's URI.
void	options(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String uri) Method called to get a list of all allowed HTTP methods on this entry point.
void	restartTransfer(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String uri) Method called to restart a paused transfer.
void	stopTransfer(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String uri) Method called to pause a staged or running transfer.
void	subOptions(io.netty.handler.codec.http.HttpRequest request, io.cdap.http.HttpResponder responder, String uri, String ep)

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

TransferIdHandler

public TransferIdHandler(byte crud)

Initializes the handler with the given CRUD mask.

Parameters:

crud - the CRUD mask for this handler

Method Detail

getTransfer

@GET
 @Consumes(value="*/*")
public void getTransfer(io.netty.handler.codec.http.HttpRequest request,
                                                     io.cdap.http.HttpResponder responder,
                                                     @PathParam(value="id")
                                                     String uri)
                                              throws UnsupportedEncodingException

Method called to obtain the information on the transfer whose id was given in the request's URI. The requested transfer is sent back in JSON format, unless an unexpected error prevents it or if the request id does not exist.

**NOTE:** The uri parameter refers to the concatenation of the transfer's id, and the name of the host to which the transfer was requested, separated by an underscore character.

Parameters:

request - the HttpRequest made to the resource

responder - the HttpResponder which sends the reply to the request

uri - the transfer's unique identifier

Throws:

UnsupportedEncodingException

restartTransfer

@Path(value="restart")
 @PUT
 @Consumes(value="*/*")
public void restartTransfer(io.netty.handler.codec.http.HttpRequest request,
                                                                                 io.cdap.http.HttpResponder responder,
                                                                                 @PathParam(value="id")
                                                                                 String uri)
                                                                          throws UnsupportedEncodingException

Method called to restart a paused transfer.

**NOTE:** The uri parameter refers to the concatenation of the transfer's id, and the name of the host to which the transfer was requested, separated by an underscore character.

Parameters:

request - the HttpRequest made to the resource

responder - the HttpResponder which sends the reply to the request

uri - the transfer's unique identifier

Throws:

UnsupportedEncodingException

stopTransfer

@Path(value="stop")
 @PUT
 @Consumes(value="*/*")
public void stopTransfer(io.netty.handler.codec.http.HttpRequest request,
                                                                           io.cdap.http.HttpResponder responder,
                                                                           @PathParam(value="id")
                                                                           String uri)
                                                                    throws UnsupportedEncodingException

Method called to pause a staged or running transfer.

**NOTE:** The uri parameter refers to the concatenation of the transfer's id, and the name of the host to which the transfer was requested, separated by an underscore character.

Parameters:

request - the HttpRequest made to the resource

responder - the HttpResponder which sends the reply to the request

uri - the transfer's unique identifier

Throws:

UnsupportedEncodingException

cancelTransfer

@Path(value="cancel")
 @PUT
 @Consumes(value="*/*")
public void cancelTransfer(io.netty.handler.codec.http.HttpRequest request,
                                                                               io.cdap.http.HttpResponder responder,
                                                                               @PathParam(value="id")
                                                                               String uri)
                                                                        throws UnsupportedEncodingException

Method called to cancel a staged or running transfer.

**NOTE:** The uri parameter refers to the concatenation of the transfer's id, and the name of the host to which the transfer was requested, separated by an underscore character.

Parameters:

request - the HttpRequest made to the resource

responder - the HttpResponder which sends the reply to the request

uri - the transfer's unique identifier

Throws:

UnsupportedEncodingException

options

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

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.

**NOTE:** The uri parameter refers to the concatenation of the transfer's id, and the name of the host to which the transfer was requested, separated by an underscore character.

Parameters:

request - the HttpRequest made to the resource

responder - the HttpResponder which sends the reply to the request

uri - the transfer's unique identifier

subOptions

@Path(value="{ep}")
 @OPTIONS
 @Consumes(value="*/*")
public void subOptions(io.netty.handler.codec.http.HttpRequest request,
                                                                             io.cdap.http.HttpResponder responder,
                                                                             @PathParam(value="id")
                                                                             String uri,
                                                                             @PathParam(value="ep")
                                                                             String ep)