edu.illinois.ncsa.datawolf.service

Class DatasetsResource

java.lang.Object

edu.illinois.ncsa.datawolf.service.DatasetsResource

@Path(value="/datasets")
public class DatasetsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
DatasetsResource()

Method Summary

Methods

Modifier and Type	Method and Description
String	createDataset(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input) Create dataset from zip file.
boolean	deleteDataset(String datasetId) Mark dataset as deleted
javax.ws.rs.core.Response	deleteFile(String datasetId, String fileDescriptorId) get the file with given id
Dataset	getDataset(String datasetId) Get a dataset by Id
List<Dataset>	getDatasets(int size, int page, String email, String pattern, boolean showdeleted) Get all datasets
javax.ws.rs.core.Response	getDatasetZip(String datasetId) Get a dataset in zip with all other files by Id
javax.ws.rs.core.Response	getFile(String datasetId, String fileDescriptorId) get the file with given id
FileDescriptor	getFileDescriptor(String datasetId, String fileDescriptorId) Get a FileDescriptor by dataset-Id and filedescriptor-id
javax.ws.rs.core.Response	purgeDataset(String datasetId) Delete dataset from repository

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetsResource

public DatasetsResource()

Method Detail

createDataset

@POST
@Consumes(value="multipart/form-data")
@Produces(value="text/plain")
public String createDataset(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input)

Create dataset from zip file. It expects the following form:

Parameters:

input - a dataset created from Zip or from a file(s)

Returns:

datasetId

getDatasets

@GET
@Produces(value="application/json")
public List<Dataset> getDatasets(@QueryParam(value="size")@DefaultValue(value="-1")
                                     int size,
                                     @QueryParam(value="page")@DefaultValue(value="0")
                                     int page,
                                     @QueryParam(value="email")@DefaultValue(value="")
                                     String email,
                                     @QueryParam(value="pattern")@DefaultValue(value="")
                                     String pattern,
                                     @QueryParam(value="showdeleted")@DefaultValue(value="false")
                                     boolean showdeleted)

Get all datasets

Parameters:

size - number of datasets per page

page - page number starting 0

email - email of creator

pattern - filename pattern such as %.msh

Returns:

getDataset

@GET
@Path(value="{dataset-id}")
@Produces(value="application/json")
public Dataset getDataset(@PathParam(value="dataset-id")
                                   String datasetId)

Get a dataset by Id

Parameters:

datasetId - id of dataset to retrieve

Returns:

a dataset in JSON

deleteDataset

@DELETE
@Path(value="{dataset-id}")
@Produces(value="application/json")
public boolean deleteDataset(@PathParam(value="dataset-id")@DefaultValue(value="")
                                         String datasetId)
                      throws Exception

Mark dataset as deleted

Parameters:

datasetId - id of dataset to delete

Throws:

Exception

purgeDataset

@PUT
@Path(value="{dataset-id}/purge")
public javax.ws.rs.core.Response purgeDataset(@PathParam(value="dataset-id")@DefaultValue(value="")
                                              String datasetId)

Delete dataset from repository

Parameters:

datasetId - id of dataset to delete from repository

Returns:

response message from delete operation

getDatasetZip

@GET
@Path(value="{dataset-id}/zip")
@Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getDatasetZip(@PathParam(value="dataset-id")
                                                        String datasetId)

Get a dataset in zip with all other files by Id

Parameters:

datasetId - dataset Id

Returns:

a dataset in zip

getFileDescriptor

@GET
@Path(value="{dataset-id}/{filedescriptor-id}")
@Produces(value="application/json")
public FileDescriptor getFileDescriptor(@PathParam(value="dataset-id")
                                                 String datasetId,
                                                 @PathParam(value="filedescriptor-id")
                                                 String fileDescriptorId)

Get a FileDescriptor by dataset-Id and filedescriptor-id

Parameters:

datasetId - dataset Id

fileDescriptorId - filedescriptor Id

Returns:

a FileDescriptor in JSON

getFile

@GET
@Path(value="{dataset-id}/{filedescriptor-id}/file")
@Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getFile(@PathParam(value="dataset-id")
                                                  String datasetId,
                                                  @PathParam(value="filedescriptor-id")
                                                  String fileDescriptorId)

get the file with given id

Parameters:

id - file-descriptor id

Returns:

file

deleteFile

@GET
@Path(value="{dataset-id}/{filedescriptor-id}/delete")
@Produces(value="application/json")
public javax.ws.rs.core.Response deleteFile(@PathParam(value="dataset-id")
                                                     String datasetId,
                                                     @PathParam(value="filedescriptor-id")
                                                     String fileDescriptorId)

get the file with given id

Parameters:

id - file-descriptor id

Returns:

file