service.tut.pori.fileservice.reference

Class ClientService

java.lang.Object

service.tut.pori.fileservice.reference.ClientService

@HTTPService(name="fsrc")
public class ClientService
extends java.lang.Object

Reference implementation for client API methods. This class defines the APIs available for file storage. Note that the file storage API is a "light-weight" service provided to enable analysis of arbitrary files not located on external providers. For a proper, backed up, cloud storage one should take a look at the one of the external providers supported by the front-end service (e.g. Facebook, Twitter, Picasa, FSIO), and use the synchronization methods for importing the content to the front-end service.

Implementation Service path fs

See Also:

FileService

Constructor Summary

Constructors

Constructor and Description
ClientService()

Method Summary

Modifier and Type	Method and Description
Response	addFile(AuthenticationParameter authenticatedUser, InputStreamParameter file, StringParameter filename) This method allows an authenticated user to upload a file directly using HTTP Post.
void	deleteFile(AuthenticationParameter authenticatedUser, LongParameter fileId) This method can be used to delete one or more files.
Response	listFiles(AuthenticationParameter authenticatedUser, LongParameter fileId, Limits limits) List all or a subset of the files user has uploaded to the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientService

public ClientService()

Method Detail

addFile

@HTTPServiceMethod(name="addFile",
                   acceptedMethods="POST")
public Response addFile(@HTTPAuthenticationParameter(required=false)
                                                                                                        AuthenticationParameter authenticatedUser,
                                                                                                        @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                        InputStreamParameter file,
                                                                                                        @HTTPMethodParameter(name="filename",required=false)
                                                                                                        StringParameter filename)

This method allows an authenticated user to upload a file directly using HTTP Post. Note that this method does not implement HTTP PUT, i.e. the file will not be available in a user defined URI regardless of the given filename. The uploaded file can only be accessed using the returned URL. The URL is generally a static link, and you can use the List Files method to retrieve up-to-date URLs. The File Service stores the files in binary format, and thus enforces no limits on the file type. The maximum file size depends on the features of the system to where the front-end service has been deployed - the File Service itself imposes no limits on file sizes. In general files larger than 2 GB should be avoided. Note that simply uploading a file will not start the analysis process. One must pass the received URL link to the Content Storage service to initialize the file analysis.

Parameters:

authenticatedUser - Note: this method requires authentication, but for the reference implementation, anonymous access is granted.

file - file contents

filename - Optional filename for the uploaded data. The filename is processed simply as metadata and omitting the parameter has no effect on the file upload.

Returns:

See FileList

deleteFile

@HTTPServiceMethod(name="deleteFile",
                   acceptedMethods="DELETE")
public void deleteFile(@HTTPAuthenticationParameter(required=false)
                                                                                                            AuthenticationParameter authenticatedUser,
                                                                                                            @HTTPMethodParameter(name="file_id")
                                                                                                            LongParameter fileId)

This method can be used to delete one or more files. Non-existent file IDs will be ignored.

Parameters:

authenticatedUser - Note: this method requires authentication, but for the reference implementation, anonymous access is granted.

fileId -

listFiles

@HTTPServiceMethod(name="listFiles",
                   acceptedMethods="GET")
public Response listFiles(@HTTPAuthenticationParameter(required=false)
                                                                                                           AuthenticationParameter authenticatedUser,
                                                                                                           @HTTPMethodParameter(name="file_id",required=false)
                                                                                                           LongParameter fileId,
                                                                                                           @HTTPMethodParameter(name="limits",required=false)
                                                                                                           Limits limits)

List all or a subset of the files user has uploaded to the system.

Parameters:

authenticatedUser - Note: this method requires authentication, but for the reference implementation, anonymous access is granted.

fileId - Optional file ID filter for retrieving a subset of the uploaded files. If ID is not given, all files will be retrieved respecting the optional limits parameter.

limits - paging limits

Returns:

See FileList