com.contentful.java.cma

Class ModuleUploads

java.lang.Object

com.contentful.java.cma.ModuleUploads

public final class ModuleUploads
extends java.lang.Object

Upload Module.

This module will take care of all `upload.contentful.com` related issues, as in directly uploading a file to Contentful, receiving it's id.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModuleUploads.Async Async module.

Constructor Summary

Constructors

Constructor and Description
ModuleUploads(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor)

Method Summary

Modifier and Type	Method and Description
ModuleUploads.Async	async()
CMAUpload	create(java.lang.String spaceId, java.io.InputStream stream) Create a new upload.
protected com.contentful.java.cma.ServiceUploads	createService(retrofit2.Retrofit retrofit)
int	delete(java.lang.String spaceId, java.lang.String uploadId) Delete a given upload again.
CMAUpload	fetchOne(java.lang.String spaceId, java.lang.String uploadId) Get information about the given upload.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleUploads

public ModuleUploads(retrofit2.Retrofit retrofit,
                     java.util.concurrent.Executor callbackExecutor)

Method Detail

createService

protected com.contentful.java.cma.ServiceUploads createService(retrofit2.Retrofit retrofit)

create

public CMAUpload create(java.lang.String spaceId,
                        java.io.InputStream stream)
                 throws java.io.IOException

Create a new upload.

Once an upload is created, you can use it in CMAClient#assets for creating an asset based on a local file.

Parameters:

spaceId - a nonnull id representing the space to add the upload to.

stream - the actual binary representation of the upload. Cannot be null.

Returns:

the upload created, containing the id to be used further on.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if stream is null.

java.io.IOException - if the stream could not be read.

fetchOne

public CMAUpload fetchOne(java.lang.String spaceId,
                          java.lang.String uploadId)

Get information about the given upload.

Parameters:

spaceId - which space is this upload hosted under?

uploadId - what id does the upload have?

Returns:

an CMAUpload based on this id and space combination.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if uploadId is null.

delete

public int delete(java.lang.String spaceId,
                  java.lang.String uploadId)

Delete a given upload again.

Parameters:

spaceId - space id of the upload.

uploadId - id of the upload

Returns:

response code, 204 on success.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if uploadId is null.

async

public ModuleUploads.Async async()

Returns:

a module with a set of asynchronous methods.