com.contentful.java.cma

Class ModuleUploads.Async

java.lang.Object

com.contentful.java.cma.ModuleUploads.Async

Enclosing class:

ModuleUploads

public class ModuleUploads.Async
extends Object

Async module.

Constructor Summary

Constructors

Constructor and Description
Async()

Method Summary

Modifier and Type	Method and Description
CMACallback<CMAUpload>	create(InputStream stream, CMACallback<CMAUpload> callback)
CMACallback<CMAUpload>	create(InputStream stream, int chunkSize, CMACallback<CMAUpload> callback) Create a new upload, asynchronously.
CMACallback<CMAUpload>	create(String spaceId, String environmentId, InputStream stream, CMACallback<CMAUpload> callback)
CMACallback<CMAUpload>	create(String spaceId, String environmentId, InputStream stream, int chunkSize, CMACallback<CMAUpload> callback) Create a new upload, asynchronously.
CMACallback<Integer>	delete(CMAUpload upload, String environmentId, CMACallback<Integer> callback) Delete a given upload again, asynchronously.
CMACallback<CMAUpload>	fetchOne(String uploadId, String environmentId, CMACallback<CMAUpload> callback) Get information about the given upload, asynchronously.
CMACallback<CMAUpload>	fetchOne(String spaceId, String environmentId, String uploadId, CMACallback<CMAUpload> callback) Get information about the given upload, asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Detail

Async

public Async()

Method Detail

create

public CMACallback<CMAUpload> create(InputStream stream,
                                     int chunkSize,
                                     CMACallback<CMAUpload> callback)

Create a new upload, asynchronously.

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

Parameters:

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

callback - the callback to be informed about success or failure.

Returns:

the callback passed in.

Throws:

IllegalArgumentException - if configured spaceId is null.

IllegalArgumentException - if file is null.

IllegalStateException - if something in the transmittal went wrong.

CMANotWithEnvironmentsException - if environmentId was set using CMAClient.Builder.setEnvironmentId(String).

See Also:

CMAClient.Builder.setSpaceId(String)

create

public CMACallback<CMAUpload> create(InputStream stream,
                                     CMACallback<CMAUpload> callback)

create

public CMACallback<CMAUpload> create(String spaceId,
                                     String environmentId,
                                     InputStream stream,
                                     CMACallback<CMAUpload> callback)

create

public CMACallback<CMAUpload> create(String spaceId,
                                     String environmentId,
                                     InputStream stream,
                                     int chunkSize,
                                     CMACallback<CMAUpload> callback)

Create a new upload, asynchronously.

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

This method will override the configuration specified through CMAClient.Builder.setSpaceId(String) and will ignore CMAClient.Builder.setEnvironmentId(String).

Parameters:

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

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

callback - the callback to be informed about success or failure.

Returns:

the callback passed in.

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if file is null.

IllegalStateException - if something in the transmittal went wrong.

fetchOne

public CMACallback<CMAUpload> fetchOne(String uploadId,
                                       String environmentId,
                                       CMACallback<CMAUpload> callback)

Get information about the given upload, asynchronously.

Parameters:

uploadId - what id does the upload have?

callback - the callback to be informed about success or failure.

Returns:

the callback passed in.

Throws:

IllegalArgumentException - if configured spaceId is null.

IllegalArgumentException - if uploadId is null.

CMANotWithEnvironmentsException - if environmentId was set using CMAClient.Builder.setEnvironmentId(String).

See Also:

CMAClient.Builder.setSpaceId(String)

fetchOne

public CMACallback<CMAUpload> fetchOne(String spaceId,
                                       String environmentId,
                                       String uploadId,
                                       CMACallback<CMAUpload> callback)

Get information about the given upload, asynchronously.

This method will override the configuration specified through CMAClient.Builder.setSpaceId(String) and will ignore CMAClient.Builder.setEnvironmentId(String).

Parameters:

spaceId - which space is this upload hosted under?

uploadId - what id does the upload have?

callback - the callback to be informed about success or failure.

Returns:

the callback passed in.

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if uploadId is null.

delete

public CMACallback<Integer> delete(CMAUpload upload,
                                   String environmentId,
                                   CMACallback<Integer> callback)

Delete a given upload again, asynchronously.

Parameters:

upload - upload

callback - the callback to be informed about success or failure.

Returns:

the callback passed in.

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if uploadId is null.