co.cask.cdap.examples.fileset

Class FileSetService.FileSetHandler

java.lang.Object

co.cask.cdap.internal.api.AbstractProgramDatasetConfigurable

co.cask.cdap.internal.api.AbstractPluginConfigurable<HttpServiceConfigurer>

co.cask.cdap.api.service.http.AbstractHttpServiceHandler

co.cask.cdap.examples.fileset.FileSetService.FileSetHandler

All Implemented Interfaces:

ProgramLifecycle<HttpServiceContext>, HttpServiceHandler

Enclosing class:

FileSetService

public static class FileSetService.FileSetHandler
extends AbstractHttpServiceHandler

A handler that allows reading and writing files.

Constructor Summary

Constructors

Constructor and Description
FileSetHandler()

Method Summary

Modifier and Type	Method and Description
void	create(HttpServiceRequest request, HttpServiceResponder responder, String set, String clone) Create a new file set.
void	drop(HttpServiceRequest request, HttpServiceResponder responder, String set) Drop an existing file set.
void	properties(HttpServiceRequest request, HttpServiceResponder responder, String set) Responds with the properties of an existing file set.
void	read(HttpServiceRequest request, HttpServiceResponder responder, String set, String filePath) Responds with the content of the file specified by the request.
void	truncate(HttpServiceRequest request, HttpServiceResponder responder, String set) Truncate an existing file set.
void	update(HttpServiceRequest request, HttpServiceResponder responder, String set) Update the properties of a file set.
HttpContentConsumer	write(HttpServiceRequest request, HttpServiceResponder responder, String set, String filePath) Upload the content for a new file at the location specified by thee request.

Methods inherited from class co.cask.cdap.api.service.http.AbstractHttpServiceHandler

configure, configure, destroy, getConfigurer, getContext, initialize, setProperties

Methods inherited from class co.cask.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class co.cask.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, addStream, addStream, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSetHandler

public FileSetHandler()

Method Detail

read

@GET
 @Path(value="{fileset}")
public void read(HttpServiceRequest request,
                                                HttpServiceResponder responder,
                                                @PathParam(value="fileset")
                                                String set,
                                                @QueryParam(value="path")
                                                String filePath)

Responds with the content of the file specified by the request.

Parameters:

set - the name of the file set

filePath - the relative path within the file set

write

@PUT
 @Path(value="{fileset}")
public HttpContentConsumer write(HttpServiceRequest request,
                                                                HttpServiceResponder responder,
                                                                @PathParam(value="fileset")
                                                                String set,
                                                                @QueryParam(value="path")
                                                                String filePath)

Upload the content for a new file at the location specified by thee request.

Parameters:

set - the name of the file set

filePath - the relative path within the file set

create

@POST
 @Path(value="{fileset}/create")
public void create(HttpServiceRequest request,
                                                          HttpServiceResponder responder,
                                                          @PathParam(value="fileset")
                                                          String set,
                                                          @Nullable @QueryParam(value="clone")
                                                          String clone)
                                                   throws DatasetManagementException

Create a new file set. The properties for the new dataset can be given as JSON in the body of the request. Alternatively the request can specify the name of an existing dataset as a query parameter; in that case, a copy of the properties of that dataset is used to create the new file set. If neither a body nor a clone parameter is present, the dataset is created with empty (that is, default) properties.

Parameters:

set - the name of the file set

clone - the name of an existing dataset. If present, its properties are used for the new dataset.

Throws:

DatasetManagementException

update

@POST
 @Path(value="{fileset}/update")
public void update(HttpServiceRequest request,
                                                          HttpServiceResponder responder,
                                                          @PathParam(value="fileset")
                                                          String set)
                                                   throws DatasetManagementException

Update the properties of a file set. The new properties must be be given as JSON in the body of the request. If no properties are given, the dataset is updated with empty properties.

Parameters:

set - the name of the file set

Throws:

DatasetManagementException

drop

@POST
 @Path(value="{fileset}/drop")
public void drop(HttpServiceRequest request,
                                                      HttpServiceResponder responder,
                                                      @PathParam(value="fileset")
                                                      String set)
                                               throws DatasetManagementException

Drop an existing file set.

Parameters:

set - the name of the file set to drop

Throws:

DatasetManagementException

truncate

@POST
 @Path(value="{fileset}/truncate")
public void truncate(HttpServiceRequest request,
                                                              HttpServiceResponder responder,
                                                              @PathParam(value="fileset")
                                                              String set)
                                                       throws DatasetManagementException

Truncate an existing file set. This will delete all files under the file set's base path.

Parameters:

set - the name of the file set to truncate

Throws:

DatasetManagementException

properties

@POST
 @Path(value="{fileset}/properties")
public void properties(HttpServiceRequest request,
                                                                  HttpServiceResponder responder,
                                                                  @PathParam(value="fileset")
                                                                  String set)
                                                           throws DatasetManagementException

Responds with the properties of an existing file set. The properties are returned in JSON format.

Parameters:

set - the name of the file set

Throws:

DatasetManagementException