com.slickqa.client.apiparts

Interface FilesApi

All Known Implementing Classes:

FilesApiPart

public interface FilesApi

Api defining retrieving, updating and Deleting the files in slick. Also look at FilesQueryApi.

Author:

Created by Jason Corbett on 4/17/14.

Method Summary

Methods

Modifier and Type	Method and Description
StoredFile	addChunk(byte[] data) Add a "chunk" of data to a stored file.
StoredFile	get() Retrieve a specific stored file (not the content) based on the id.
StoredFile	update(StoredFile storedFile) Update the metadata of a stored file in slick.

Method Detail

get

StoredFile get()
               throws SlickError

Retrieve a specific stored file (not the content) based on the id.

Returns:

The stored file from slick.

Throws:

SlickError - if an error occurs talking to slick.

addChunk

StoredFile addChunk(byte[] data)
                    throws SlickError

Add a "chunk" of data to a stored file. This will cause slick to update the length of the file. The size of the chunk of data to upload is important. You should use the default chunk size (which will be set when the stored file was created). It will almost always be 262144 in length. The only reason to upload a chunk of a different size is if this is the last chunk, and there isn't that much data left to upload.

Parameters:

data - The "chunk" of data to upload

Returns:

The uploaded StoredFile

Throws:

SlickError - if an error occurs talking to slick.

update

StoredFile update(StoredFile storedFile)
                  throws SlickError

Update the metadata of a stored file in slick. Warning, use this with caution. You should not change the chunk size, or the id. The length of the file will be set when you add chunks to the file. The only thing you should update is the mime type, the name, or the md5sum.

Parameters:

storedFile - The updates to the stored file.

Returns:

The updated stored file from slick.

Throws:

SlickError - if an error occurs talking to slick.