com.evrythng.java.wrapper.service

Class FilesService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.FilesService

public class FilesService
extends EvrythngServiceBase

This class provides a wrapper around version 2 of the Files REST API (/files).

Constructor Summary

Constructors

Constructor and Description
FilesService(ApiManager apiManager)

Method Summary

Modifier and Type	Method and Description
File	createFileRecordWithUploadUrl(String fileName, String fileType, boolean privateAccess, String... tags) Creates a metadata record for the given filename, with an 'uploadUrl' that can be used by a client to upload a file using HTTP PUT.
boolean	deleteFileById(String id) Deletes a File metadata record by id.
EvrythngApiBuilder.Builder<File>	fileCreator(File file) EvrythngApiBuilder.Builder that creates a new File instance when it is executed.
EvrythngApiBuilder.Builder<Boolean>	fileDeleter(String id) EvrythngApiBuilder.Builder that deletes a File by id when executed.
EvrythngApiBuilder.Builder<File>	fileReader(String id) EvrythngApiBuilder.Builder that returns a single File instance by id when executed.
EvrythngApiBuilder.Builder<List<File>>	filesReader(String filter) EvrythngApiBuilder.Builder that returns a a list of File instances by filter when executed.
File	findFileById(String id) Looks up a File metadata record by id.
List<File>	findFilesByFilter(String filter) Looks up a list of File metadata records based on the provided filter.

Methods inherited from class com.evrythng.java.wrapper.core.EvrythngServiceBase

absoluteUri, delete, deleteMultiple, encodeBase64, get, getConfig, iterator, mqttUrl, onBuilderCreated, post, post, postAsynchronously, postMultipart, postMultipart, put, put, putMultipart, putMultipart, putMultiple, urlEncodePathPart

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesService

public FilesService(ApiManager apiManager)

Method Detail

createFileRecordWithUploadUrl

public File createFileRecordWithUploadUrl(String fileName,
                                          String fileType,
                                          boolean privateAccess,
                                          String... tags)

Creates a metadata record for the given filename, with an 'uploadUrl' that can be used by a client to upload a file using HTTP PUT. The 'uploadUrl' expires after 30 minutes, regardless of whether the file will have 'public' or 'private' access.

Parameters:

fileName - name of the file to be uploaded.

fileType - mime-type of file to be uploaded, e.g. text/plain, image/jpg, etc.

privateAccess - flag indicating whether or not the file should be privately accessible on remote storage. A value of false means the file will be accessible with a public URL.

Returns:

a File metadata instance, with an 'uploadUrl' attribute.

findFileById

public File findFileById(String id)

Looks up a File metadata record by id. The returned object will have a 'contentUrl' attribute that can be used by a client to download the remote file using HTTP GET. The 'contentUrl' expires after 30 minutes if the file was marked as 'private'.

Parameters:

id - id of the file to retrieve metadata for.

Returns:

a File metadata instance, with an 'contentUrl' attribute.

deleteFileById

public boolean deleteFileById(String id)

Deletes a File metadata record by id. This method will also delete the actual physical file on remote storage.

Parameters:

id - id of the file to be deleted.

Returns:

boolean response indicating whether the delete operation succeeded or failed.

findFilesByFilter

public List<File> findFilesByFilter(String filter)

Looks up a list of File metadata records based on the provided filter.

Parameters:

filter - filter string to be used as criteria for looking up File records.

Returns:

list of File metadata records based on the provided filter.

fileCreator

public EvrythngApiBuilder.Builder<File> fileCreator(File file)

EvrythngApiBuilder.Builder that creates a new File instance when it is executed.

Parameters:

file - File to be created.

Returns:

EvrythngApiBuilder.Builder to create a new File.

fileReader

public EvrythngApiBuilder.Builder<File> fileReader(String id)

EvrythngApiBuilder.Builder that returns a single File instance by id when executed.

Parameters:

id - id of File to find.

Returns:

EvrythngApiBuilder.Builder to find a File by id.

filesReader

public EvrythngApiBuilder.Builder<List<File>> filesReader(String filter)

EvrythngApiBuilder.Builder that returns a a list of File instances by filter when executed.

Parameters:

filter - filter criteria to apply. Supported are 'tags=tag1,tag2' and 'name=filename'.

Returns:

EvrythngApiBuilder.Builder to find a list of Files by filter.

fileDeleter

public EvrythngApiBuilder.Builder<Boolean> fileDeleter(String id)

EvrythngApiBuilder.Builder that deletes a File by id when executed.

Parameters:

id - id of File to delete.

Returns:

EvrythngApiBuilder.Builder to delete a File by id.