edu.illinois.ncsa.file.service

Class FilesResource

java.lang.Object

edu.illinois.ncsa.file.service.FilesResource

@Path(value="/files")
public class FilesResource
extends Object

Constructor Summary

Constructors

Constructor and Description
FilesResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteFile(String id) delete the file with given id
List<FileDescriptor>	getAllFileDescriptors(int size, int page) get all file-descriptors
javax.ws.rs.core.Response	getFile(String id) get the file with given id
FileDescriptor	getFileDescriptor(String id) get a file-descriptor with given id
String	getForm() get a file-descriptor with given id
FileDescriptor	uploadFile(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input) upload a file

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesResource

public FilesResource()

Method Detail

getAllFileDescriptors

@GET
 @Produces(value="application/json")
public List<FileDescriptor> getAllFileDescriptors(@QueryParam(value="size") @DefaultValue(value="100")
                                                                                            int size,
                                                                                            @QueryParam(value="page") @DefaultValue(value="0")
                                                                                            int page)

get all file-descriptors

Returns:

list of FileDescriptor

getForm

@GET
 @Path(value="form")
 @Produces(value="text/html")
public String getForm()

get a file-descriptor with given id

Parameters:

id - file-desciptor id

Returns:

a FileDescriptor

getFileDescriptor

@GET
 @Path(value="{id}")
 @Produces(value="application/json")
public FileDescriptor getFileDescriptor(@PathParam(value="id")
                                                                                                       String id)

get a file-descriptor with given id

Parameters:

id - file-desciptor id

Returns:

a FileDescriptor

getFile

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

get the file with given id

Parameters:

id - file-descriptor id

Returns:

file

uploadFile

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="application/json")
public FileDescriptor uploadFile(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input)
                                                                                                             throws IOException

upload a file

Parameters:

input - form data with file and other information

Returns:

generated new FileDescriptor

Throws:

IOException

deleteFile

@DELETE
 @Path(value="{id}")
public javax.ws.rs.core.Response deleteFile(@PathParam(value="id")
                                                                         String id)

delete the file with given id

Parameters:

id - file-descriptor id

Returns:

response with 200 and a message