com.contentful.java.cma

Class ModuleEntries.Async

java.lang.Object

com.contentful.java.cma.ModuleEntries.Async

Enclosing class:

ModuleEntries

public class ModuleEntries.Async
extends Object

Async module.

Constructor Summary

Constructors

Constructor and Description
Async()

Method Summary

Modifier and Type	Method and Description
CMACallback<CMAEntry>	archive(CMAEntry entry, CMACallback<CMAEntry> callback) Archive an Entry.
CMACallback<CMAEntry>	create(String contentTypeId, CMAEntry entry, CMACallback<CMAEntry> callback) Create a new Entry on the configured space and environment.
CMACallback<CMAEntry>	create(String spaceId, String environmentId, String contentTypeId, CMAEntry entry, CMACallback<CMAEntry> callback) Create a new entry in the given space and environment.
CMACallback<Integer>	delete(CMAEntry entry, CMACallback<Integer> callback) Delete an Entry.
CMACallback<CMAArray<CMAEntry>>	fetchAll(CMACallback<CMAArray<CMAEntry>> callback) Fetch all Entries from the configured space and environment.
CMACallback<CMAArray<CMAEntry>>	fetchAll(Map<String,String> query, CMACallback<CMAArray<CMAEntry>> callback) Fetch all entries in the space and environment matching the given query.
CMACallback<CMAArray<CMAEntry>>	fetchAll(String spaceId, String environmentId, CMACallback<CMAArray<CMAEntry>> callback) Fetch all entries from the given space and environment.
CMACallback<CMAArray<CMAEntry>>	fetchAll(String spaceId, String environmentId, Map<String,String> query, CMACallback<CMAArray<CMAEntry>> callback) Fetch all Entries from a Space with a query.
CMACallback<CMAArray<CMASnapshot>>	fetchAllSnapshots(CMAEntry entry, CMACallback<CMAArray<CMASnapshot>> callback) Fetch all snapshots of an entry.
CMACallback<CMAArray<CMASnapshot>>	fetchAllSnapshotsWithQuery(CMAEntry entry, Map<String,String> query, CMACallback<CMAArray<CMASnapshot>> callback) Fetch all snapshots of an entry asynchronously with query parameters.
CMACallback<CMAEntry>	fetchOne(String entryId, CMACallback<CMAEntry> callback) Fetch an Entry with the given entryId from the configured space and environment.
CMACallback<CMAEntry>	fetchOne(String spaceId, String environmentId, String entryId, CMACallback<CMAEntry> callback) Fetch an Entry with the given entryId from a Space.entry
CMACallback<CMASnapshot>	fetchOneSnapshot(CMAEntry entry, String snapshotId, CMACallback<CMASnapshot> callback) Fetch a specific snapshot of an entry.
CMACallback<CMAEntry>	patch(CMAEntry entry, List<Map<String,Object>> operations, CMACallback<CMAEntry> callback) Patch an Entry using JSON Patch operations.
CMACallback<CMAEntry>	patch(String spaceId, String environmentId, String entryId, Integer version, List<Map<String,Object>> operations, CMACallback<CMAEntry> callback) Patch an Entry using JSON Patch operations.
CMACallback<CMAEntry>	publish(CMAEntry entry, CMACallback<CMAEntry> callback) Publish an Entry.
CMACallback<CMAEntry>	publishLocale(CMAEntry entry, String locale, CMACallback<CMAEntry> callback) Publish an Entry for a specific locale.
CMACallback<CMAEntry>	unArchive(CMAEntry entry, CMACallback<CMAEntry> callback) Un-Archive an Entry.
CMACallback<CMAEntry>	unPublish(CMAEntry entry, CMACallback<CMAEntry> callback) Un-Publish an Entry.
CMACallback<CMAEntry>	unPublishLocale(CMAEntry entry, String locale, CMACallback<CMAEntry> callback) Un-Publish an Entry for a specific locale.
CMACallback<CMAEntry>	update(CMAEntry entry, CMACallback<CMAEntry> callback) Update an Entry.

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<CMAEntry> archive(CMAEntry entry,
                                     CMACallback<CMAEntry> callback)

Archive an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

create

public CMACallback<CMAEntry> create(String contentTypeId,
                                    CMAEntry entry,
                                    CMACallback<CMAEntry> callback)

Create a new Entry on the configured space and environment.

In case the given entry 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:

contentTypeId - Content Type ID

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured spaceId is null.

IllegalArgumentException - if configured entry is null.

IllegalArgumentException - if contentTypeId is null.

IllegalArgumentException - if entry is null.

See Also:

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

create

public CMACallback<CMAEntry> create(String spaceId,
                                    String environmentId,
                                    String contentTypeId,
                                    CMAEntry entry,
                                    CMACallback<CMAEntry> callback)

Create a new entry in the given space and environment.

In case the given entry 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

contentTypeId - Content Type ID

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

IllegalArgumentException - if contentTypeId is null.

IllegalArgumentException - if entry is null.

delete

public CMACallback<Integer> delete(CMAEntry entry,
                                   CMACallback<Integer> callback)

Delete an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if entry is null.

fetchAll

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

Fetch all Entries from the configured space and environment.

Parameters:

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured spaceId is null.

IllegalArgumentException - if configured environmentId is null.

See Also:

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

fetchAll

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

Fetch all entries in the space and environment matching the given query.

Parameters:

query - query to be performed

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured spaceId is null.

IllegalArgumentException - if configured environmentId is null.

See Also:

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

fetchAll

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

Fetch all entries from 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

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

fetchAll

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

Fetch all Entries from a Space with a query.

Parameters:

spaceId - Space ID

environmentId - Environment ID

query - Query

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

fetchOne

public CMACallback<CMAEntry> fetchOne(String entryId,
                                      CMACallback<CMAEntry> callback)

Fetch an Entry with the given entryId from the configured space and environment.

Parameters:

entryId - Entry ID

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured spaceId is null.

IllegalArgumentException - if configured environmentId is null.

fetchOne

public CMACallback<CMAEntry> fetchOne(String spaceId,
                                      String environmentId,
                                      String entryId,
                                      CMACallback<CMAEntry> callback)

Fetch an Entry with the given entryId from a Space.entry

Parameters:

spaceId - Space ID

environmentId - Environment ID

entryId - Entry ID

callback - Callback

Returns:

the given CMACallback instance

publish

public CMACallback<CMAEntry> publish(CMAEntry entry,
                                     CMACallback<CMAEntry> callback)

Publish an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

unArchive

public CMACallback<CMAEntry> unArchive(CMAEntry entry,
                                       CMACallback<CMAEntry> callback)

Un-Archive an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

unPublish

public CMACallback<CMAEntry> unPublish(CMAEntry entry,
                                       CMACallback<CMAEntry> callback)

Un-Publish an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

update

public CMACallback<CMAEntry> update(CMAEntry entry,
                                    CMACallback<CMAEntry> callback)

Update an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

patch

public CMACallback<CMAEntry> patch(CMAEntry entry,
                                   List<Map<String,Object>> operations,
                                   CMACallback<CMAEntry> callback)

Patch an Entry using JSON Patch operations.

Important Note: JSON Patch cannot perform operations on non-existing fields. If the field is defined on the Content Type but has not been set on the Entry yet, the API will return a validation error. Use the top-level field path with locale in the value instead.

Parameters:

entry - Entry containing the entry ID, space ID, environment ID, and version

operations - List of JSON Patch operations to apply

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if operations is null.

See Also:

ModuleEntries.patch(CMAEntry, java.util.List)

patch

public CMACallback<CMAEntry> patch(String spaceId,
                                   String environmentId,
                                   String entryId,
                                   Integer version,
                                   List<Map<String,Object>> operations,
                                   CMACallback<CMAEntry> callback)

Patch an Entry using JSON Patch operations.

Important Note: JSON Patch cannot perform operations on non-existing fields. If the field is defined on the Content Type but has not been set on the Entry yet, the API will return a validation error. Use the top-level field path with locale in the value instead.

Parameters:

spaceId - Space ID

environmentId - Environment ID

entryId - Entry ID

version - Entry version (must match current entry version)

operations - List of JSON Patch operations to apply

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

ModuleEntries.patch(String, String, String, Integer, java.util.List)

fetchAllSnapshots

public CMACallback<CMAArray<CMASnapshot>> fetchAllSnapshots(CMAEntry entry,
                                                            CMACallback<CMAArray<CMASnapshot>> callback)

Fetch all snapshots of an entry.

Parameters:

entry - the entry whose snapshots to be returned.

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

Returns:

a callback for an array of snapshots.

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

fetchAllSnapshotsWithQuery

public CMACallback<CMAArray<CMASnapshot>> fetchAllSnapshotsWithQuery(CMAEntry entry,
                                                                     Map<String,String> query,
                                                                     CMACallback<CMAArray<CMASnapshot>> callback)

Fetch all snapshots of an entry asynchronously with query parameters.

Parameters:

entry - the entry whose snapshots are to be returned.

query - additional query parameters to refine the results.

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

Returns:

a callback for an array of snapshots.

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

fetchOneSnapshot

public CMACallback<CMASnapshot> fetchOneSnapshot(CMAEntry entry,
                                                 String snapshotId,
                                                 CMACallback<CMASnapshot> callback)

Fetch a specific snapshot of an entry.

Parameters:

entry - the entry whose snapshot to be returned.

snapshotId - the snapshot to be returned.

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

Returns:

a callback for an array of snapshots.

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

IllegalArgumentException - if snapshotId is null.

publishLocale

public CMACallback<CMAEntry> publishLocale(CMAEntry entry,
                                           String locale,
                                           CMACallback<CMAEntry> callback)

Publish an Entry for a specific locale.

Parameters:

entry - Entry

locale - Locale to publish

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

IllegalArgumentException - if locale is null.

unPublishLocale

public CMACallback<CMAEntry> unPublishLocale(CMAEntry entry,
                                             String locale,
                                             CMACallback<CMAEntry> callback)

Un-Publish an Entry for a specific locale.

Parameters:

entry - Entry

locale - Locale to unpublish

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

IllegalArgumentException - if locale is null.