com.slickqa.client.impl

Class FilesApiPart

java.lang.Object

com.slickqa.client.impl.ApiPart<StoredFile>

com.slickqa.client.impl.FilesApiPart

All Implemented Interfaces:

FilesApi, FilesQueryApi, QueryAndCreateApi<StoredFile>, RetrieveUpdateDeleteApi<StoredFile>, ParentApiPart

public class FilesApiPart
extends ApiPart<StoredFile>
implements FilesQueryApi, FilesApi

Created by jcorbett on 1/17/15.

Field Summary

Fields inherited from class com.slickqa.client.impl.ApiPart

listType, mapper, parent, type

Constructor Summary

Constructors

Constructor and Description
FilesApiPart(ParentApiPart parent)
FilesApiPart(ParentApiPart parent, com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Methods

Modifier and Type	Method and Description
StoredFile	addChunk(byte[] data) Add a "chunk" of data to a stored file.
StoredFile	createAndUpload(Path localPath) Create a new StoredFile in slick, and upload the content from a local file path.
StoredFile	createAndUpload(String filename, String mimetype, InputStream stream) Create a new StoredFile in slick, and upload the content from an InputStream.

Methods inherited from class com.slickqa.client.impl.ApiPart

create, delete, findOrCreate, get, getList, getParent, getSlickClient, getWebTarget, getWebTargetForRequest, makeRequest, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.slickqa.client.apiparts.FilesQueryApi

create

Methods inherited from interface com.slickqa.client.apiparts.FilesApi

get, update

Constructor Detail

FilesApiPart

public FilesApiPart(ParentApiPart parent)

FilesApiPart

public FilesApiPart(ParentApiPart parent,
            com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Detail

createAndUpload

public StoredFile createAndUpload(Path localPath)
                           throws SlickError

Description copied from interface: FilesQueryApi

Create a new StoredFile in slick, and upload the content from a local file path. The mime type will be guessed based on file extension.

Specified by:

createAndUpload in interface FilesQueryApi

Parameters:

localPath - The local path to open the file and upload it.

Returns:

A StoredFile (with id) if everything was successful.

Throws:

SlickError - if an IO Exception occurs or there is a problem talking with slick.

createAndUpload

public StoredFile createAndUpload(String filename,
                         String mimetype,
                         InputStream stream)
                           throws SlickError

Description copied from interface: FilesQueryApi

Create a new StoredFile in slick, and upload the content from an InputStream.

Specified by:

createAndUpload in interface FilesQueryApi

Parameters:

filename - The name of the file (used in creating the StoredFile).

mimetype - The mime type of the file.

stream - The input stream to read from.

Returns:

The StoredFile saved by slick.

Throws:

SlickError - if an error reading the steam occurs, or if any error occurs while creating the object or uploading the content.

addChunk

public StoredFile addChunk(byte[] data)
                    throws SlickError

Description copied from interface: FilesApi

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.

Specified by:

addChunk in interface FilesApi

Parameters:

data - The "chunk" of data to upload

Returns:

The uploaded StoredFile

Throws:

SlickError - if an error occurs talking to slick.