com.contentful.java.cma

Class ModuleAssets.Async

java.lang.Object

com.contentful.java.cma.ModuleAssets.Async

Enclosing class:

ModuleAssets

public class ModuleAssets.Async
extends Object

Async module.

Constructor Summary

Constructors

Constructor and Description
Async()

Method Summary

Modifier and Type	Method and Description
CMACallback<CMAAsset>	archive(CMAAsset asset, CMACallback<CMAAsset> callback) Archive an Asset.
CMACallback<CMAAsset>	create(CMAAsset asset, CMACallback<CMAAsset> callback) Create a new Asset in the configured space and environment.
CMACallback<CMAAsset>	create(String spaceId, String environmentId, CMAAsset asset, CMACallback<CMAAsset> callback) Create a new Asset in the given space and environment.
CMACallback<Integer>	delete(CMAAsset asset, CMACallback<Integer> callback) Delete an Asset.
CMACallback<CMAArray<CMAAsset>>	fetchAll(CMACallback<CMAArray<CMAAsset>> callback) Fetch all Assets from the configured space and environmentS.
CMACallback<CMAArray<CMAAsset>>	fetchAll(Map<String,String> query, CMACallback<CMAArray<CMAAsset>> callback) Fetch all Assets.
CMACallback<CMAArray<CMAAsset>>	fetchAll(String spaceId, String environmentId, CMACallback<CMAArray<CMAAsset>> callback) Fetch all Assets from a Space's Environment.
CMACallback<CMAArray<CMAAsset>>	fetchAll(String spaceId, String environmentId, Map<String,String> query, CMACallback<CMAArray<CMAAsset>> callback) Fetch all Assets from a Space's Environment with a query.
CMACallback<CMAAsset>	fetchOne(String assetId, CMACallback<CMAAsset> callback) Fetch an Asset with the given assetId from the configured space.
CMACallback<CMAAsset>	fetchOne(String spaceId, String environmentId, String assetId, CMACallback<CMAAsset> callback) Fetch an Asset with the given assetId from a the given space and environment.
CMACallback<Integer>	process(CMAAsset asset, String locale, CMACallback<Integer> callback) Process an Asset.
CMACallback<CMAAsset>	publish(CMAAsset asset, CMACallback<CMAAsset> callback) Publish an Asset.
CMACallback<CMAAsset>	unArchive(CMAAsset asset, CMACallback<CMAAsset> callback) Un-Archive an Asset.
CMACallback<CMAAsset>	unPublish(CMAAsset asset, CMACallback<CMAAsset> callback) Un-Publish an Asset.
CMACallback<CMAAsset>	update(CMAAsset asset, CMACallback<CMAAsset> callback) Update an Asset.

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

archive

public CMACallback<CMAAsset> archive(CMAAsset asset,
                                     CMACallback<CMAAsset> callback)

Archive an Asset.

Parameters:

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset id is null.

IllegalArgumentException - if asset space id is null.

create

public CMACallback<CMAAsset> create(CMAAsset asset,
                                    CMACallback<CMAAsset> callback)

Create a new Asset in the configured space and environment.

In case the given asset has an ID associated with it, that ID will be used, otherwise the server will auto-generate an ID that will be contained in the response upon success.

Parameters:

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset id is null.

IllegalArgumentException - if asset space id is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

create

public CMACallback<CMAAsset> create(String spaceId,
                                    String environmentId,
                                    CMAAsset asset,
                                    CMACallback<CMAAsset> callback)

Create a new Asset in the given space and environment.

In case the given asset has an ID associated with it, that ID will be used, otherwise the server will auto-generate an ID that will be contained in the response upon success.

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

Parameters:

spaceId - Space ID

environmentId - Environment ID

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset id is null.

IllegalArgumentException - if asset space id is null.

IllegalArgumentException - if asset environment id is null.

delete

public CMACallback<Integer> delete(CMAAsset asset,
                                   CMACallback<Integer> callback)

Delete an Asset.

Parameters:

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if assetId is null.

fetchAll

public CMACallback<CMAArray<CMAAsset>> fetchAll(CMACallback<CMAArray<CMAAsset>> callback)

Fetch all Assets from the configured space and environmentS.

Parameters:

callback - Callback

Returns:

the given CMACallback instance.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

fetchAll

public CMACallback<CMAArray<CMAAsset>> fetchAll(Map<String,String> query,
                                                CMACallback<CMAArray<CMAAsset>> callback)

Fetch all Assets.

Parameters:

query - The query to narrow down the results.

callback - Callback

Returns:

the given CMACallback instance

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

fetchAll

public CMACallback<CMAArray<CMAAsset>> fetchAll(String spaceId,
                                                String environmentId,
                                                CMACallback<CMAArray<CMAAsset>> callback)

Fetch all Assets from a Space's Environment.

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

Parameters:

spaceId - Space ID

environmentId - Environment ID

callback - Callback

Returns:

the given CMACallback instance

fetchAll

public CMACallback<CMAArray<CMAAsset>> fetchAll(String spaceId,
                                                String environmentId,
                                                Map<String,String> query,
                                                CMACallback<CMAArray<CMAAsset>> callback)

Fetch all Assets from a Space's Environment with a query.

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

Parameters:

spaceId - Space ID

environmentId - Environment ID

query - Query

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

fetchOne

public CMACallback<CMAAsset> fetchOne(String assetId,
                                      CMACallback<CMAAsset> callback)

Fetch an Asset with the given assetId from the configured space.

Parameters:

assetId - Asset ID

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

IllegalArgumentException - if asset id is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

fetchOne

public CMACallback<CMAAsset> fetchOne(String spaceId,
                                      String environmentId,
                                      String assetId,
                                      CMACallback<CMAAsset> callback)

Fetch an Asset with the given assetId from a the given space and environment.

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

Parameters:

spaceId - Space ID

environmentId - Environment ID

assetId - Asset ID

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

IllegalArgumentException - if assetId is null.

process

public CMACallback<Integer> process(CMAAsset asset,
                                    String locale,
                                    CMACallback<Integer> callback)

Process an Asset.

Parameters:

asset - Asset

locale - Locale

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset has no id.

IllegalArgumentException - if asset has no space.

IllegalArgumentException - if locale is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

publish

public CMACallback<CMAAsset> publish(CMAAsset asset,
                                     CMACallback<CMAAsset> callback)

Publish an Asset.

Parameters:

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset has no id.

IllegalArgumentException - if asset has no space id.

unArchive

public CMACallback<CMAAsset> unArchive(CMAAsset asset,
                                       CMACallback<CMAAsset> callback)

Un-Archive an Asset.

Parameters:

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset id is empty.

IllegalArgumentException - if asset's space id is empty.

unPublish

public CMACallback<CMAAsset> unPublish(CMAAsset asset,
                                       CMACallback<CMAAsset> callback)

Un-Publish an Asset.

Parameters:

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset's id is not set.

IllegalArgumentException - if asset's space id is not set.

update

public CMACallback<CMAAsset> update(CMAAsset asset,
                                    CMACallback<CMAAsset> callback)

Update an Asset.

Parameters:

asset - Asset

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if asset is null.

IllegalArgumentException - if asset's id is null.

IllegalArgumentException - if asset's space id is null.

IllegalArgumentException - if asset's version is null.