com.contentful.java.cma

Class ModuleEntries

java.lang.Object

com.contentful.java.cma.ModuleEntries

public class ModuleEntries
extends Object

Entries Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModuleEntries(retrofit2.Retrofit retrofit, Executor callbackExecutor, String spaceId, String environmentId, boolean environmentIdConfigured) Create entries module.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleEntries

public ModuleEntries(retrofit2.Retrofit retrofit,
                     Executor callbackExecutor,
                     String spaceId,
                     String environmentId,
                     boolean environmentIdConfigured)

Create entries module.

Parameters:

retrofit - the retrofit instance to be used to create the service.

callbackExecutor - to tell on which thread it should run.

spaceId - the space to be used when not given.

environmentId - the environment to be used when not given.

environmentIdConfigured - internal helper to see if environment was set.

Method Detail

createService

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

archive

public CMAEntry archive(CMAEntry entry)

Archive an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

create

public CMAEntry create(String contentTypeId,
                       CMAEntry entry)

Create a new Entry in 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

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

IllegalArgumentException - if contentTypeId is null.

IllegalArgumentException - if entry is null.

See Also:

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

create

public CMAEntry create(String spaceId,
                       String environmentId,
                       String contentTypeId,
                       CMAEntry entry)

Create a new Entry.

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

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

IllegalArgumentException - if contentTypeId is null.

IllegalArgumentException - if entry is null.

delete

public Integer delete(CMAEntry entry)

Delete an Entry.

Parameters:

entry - Entry ID

Returns:

Integer representing the success (204) of the action

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

IllegalArgumentException - if entryId is null.

IllegalArgumentException - if entry is null.

fetchAll

public CMAArray<CMAEntry> fetchAll()

Fetch all Entries from the configured space and environment.

This fetch uses the default parameter defined in DefaultQueryParameter.FETCH.

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

See Also:

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

fetchAll

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

Fetch all entries matching the query from the configured space and environment.

This fetch uses the default parameter defined in DefaultQueryParameter.FETCH

Parameters:

query - the criteria to filter on.

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

See Also:

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

fetchAll

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

Fetch all entries from the given space and environment.

This fetch uses the default parameter defined in DefaultQueryParameter.FETCH

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

Parameters:

spaceId - Space ID

environmentId - Environment ID

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

fetchAll

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

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

Parameters:

spaceId - Space ID

environmentId - Environment ID

query - Query

Returns:

CMAArray of entries matching the query.

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

fetchOne

public CMAEntry fetchOne(String entryId)

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

Parameters:

entryId - Entry ID

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

IllegalArgumentException - if entry id is null.

See Also:

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

fetchOne

public CMAEntry fetchOne(String spaceId,
                         String environmentId,
                         String entryId)

Fetch an entry with the given entryId from the given environment and space.

Parameters:

spaceId - Space ID

environmentId - Environment ID

entryId - Entry ID

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if environment id is null.

IllegalArgumentException - if entry id is null.

publish

public CMAEntry publish(CMAEntry entry)

Publish an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

unArchive

public CMAEntry unArchive(CMAEntry entry)

Un-Archive an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

unPublish

public CMAEntry unPublish(CMAEntry entry)

Un-Publish an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

update

public CMAEntry update(CMAEntry entry)

Update an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

IllegalArgumentException - if entry's version is null.

patch

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

Patch an Entry using JSON Patch operations.

This method allows partial updates to an entry using JSON Patch format (RFC 6902). The operations parameter should contain a list of patch operations, each with:

• "op": the operation type (e.g., "add", "remove", "replace", "move", "copy", "test")
• "path": the JSON pointer to the field to modify
• "value": the new value (for add/replace 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 when you try to perform an operation on this field. The accepted workaround is to pass the entire sub-object to the top-most existing field, including locale and initial value.

Example:

 // This may result in a validation error if 'description' field is undefined:
 List<Map<String, Object>> operations = Arrays.asList(
     Map.of("op", "add", "path", "/fields/description/en-US", "value", "initial value")
 );

 // If 'description' field is not defined on Entry, but defined in the Content Type,
 // make sure to provide the locale in the payload:
 List<Map<String, Object>> operations = Arrays.asList(
     Map.of("op", "add", "path", "/fields/description", "value",
     Map.of("en-US", "initial value"))
 );
 

Parameters:

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

operations - List of JSON Patch operations to apply

Returns:

CMAEntry result instance with updated fields

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

IllegalArgumentException - if entry's version is null.

IllegalArgumentException - if operations is null.

See Also:

JSON Patch RFC 6902

patch

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

Patch an Entry using JSON Patch operations.

This method allows partial updates to an entry using JSON Patch format (RFC 6902).

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

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 when you try to perform an operation on this field. The accepted workaround is to pass the entire sub-object to the top-most existing field, including locale and initial value.

Example:

 // This may result in a validation error if 'description' field is undefined:
 List<Map<String, Object>> operations = Arrays.asList(
     Map.of("op", "add", "path", "/fields/description/en-US", "value", "initial value")
 );

 // If 'description' field is not defined on Entry, but defined in the Content Type,
 // make sure to provide the locale in the payload:
 List<Map<String, Object>> operations = Arrays.asList(
     Map.of("op", "add", "path", "/fields/description",
     "value", Map.of("en-US", "initial value"))
 );
 

Parameters:

spaceId - Space ID

environmentId - Environment ID

entryId - Entry ID

version - Entry version (from entry.getSystem().getVersion()) - must match current entry version

operations - List of JSON Patch operations to apply

Returns:

CMAEntry result instance with updated fields

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

IllegalArgumentException - if entryId is null.

IllegalArgumentException - if version is null.

IllegalArgumentException - if operations is null.

See Also:

JSON Patch RFC 6902

fetchAllSnapshots

public CMAArray<CMASnapshot> fetchAllSnapshots(CMAEntry entry)

Fetch all snapshots of an entry.

Parameters:

entry - the entry whose snapshots to be returned.

Returns:

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 CMAArray<CMASnapshot> fetchAllSnapshotsWithQuery(CMAEntry entry,
                                                        Map<String,String> query)

Fetch all snapshots of an entry with additional query parameters.

Parameters:

entry - the entry whose snapshots are to be returned.

query - additional query parameters to refine the results.

Returns:

an array of snapshots matching the query.

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

fetchOneSnapshot

public CMASnapshot fetchOneSnapshot(CMAEntry entry,
                                    String snapshotId)

Fetch a specific snapshot of an entry.

Parameters:

entry - the entry whose snapshot to be returned.

snapshotId - the snapshot to be returned.

Returns:

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 CMAEntry publishLocale(CMAEntry entry,
                              String locale)

Publish an Entry for a specific locale.

Parameters:

entry - Entry

locale - Locale to publish

Returns:

CMAEntry result 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 CMAEntry unPublishLocale(CMAEntry entry,
                                String locale)

Un-Publish an Entry for a specific locale.

Parameters:

entry - Entry

locale - Locale to unpublish

Returns:

CMAEntry result 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.

async

public ModuleEntries.Async async()

Returns:

a module with a set of asynchronous methods.