com.contentful.java.cma

Class ModuleRoles

java.lang.Object

com.contentful.java.cma.ModuleRoles

public class ModuleRoles
extends Object

This module contains all the role options available to this SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModuleRoles.Async Handler for asynchronous requests.

Constructor Summary

Constructors

Constructor and Description
ModuleRoles(retrofit2.Retrofit retrofit, Executor callbackExecutor, String spaceId, String environmentId, boolean environmentIdConfigured) Create a new role module.

Method Summary

Modifier and Type	Method and Description
ModuleRoles.Async	async() Use all functionalities of this module asynchronously.
CMARole	create(CMARole role) Create a new role.
CMARole	create(String spaceId, CMARole role) Create a new role.
protected ServiceRoles	createService(retrofit2.Retrofit retrofit) Initialize retrofit with the current service.
int	delete(CMARole role) Delete the given role instance.
CMAArray<CMARole>	fetchAll() Fetch all roles of the configured space.
CMAArray<CMARole>	fetchAll(Map<String,String> query) Fetch specific roles of the configured space.
CMAArray<CMARole>	fetchAll(String spaceId) Fetch all roles of this space.
CMAArray<CMARole>	fetchAll(String spaceId, Map<String,String> query) Fetch specific roles of this space.
CMARole	fetchOne(String roleId) Fetches one role by its id from Contentful.
CMARole	fetchOne(String spaceId, String roleId) Fetches one role by its id from Contentful.
CMARole	update(CMARole role) Update the given role instance on Contentful.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleRoles

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

Create a new role module.

Parameters:

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

callbackExecutor - to tell on which thread it should run.

spaceId - id of the space to be configured.

environmentId - id of the environment to be configured.

environmentIdConfigured - internal helper to see if environment was set.

Method Detail

createService

protected ServiceRoles createService(retrofit2.Retrofit retrofit)

Initialize retrofit with the current service.

Parameters:

retrofit - the instance to use the service with.

Returns:

a populated instance of the service to be used.

async

public ModuleRoles.Async async()

Use all functionalities of this module asynchronously.

Returns:

an asynchronous handling instance.

fetchAll

public CMAArray<CMARole> fetchAll()

Fetch all roles of the configured space.

Returns:

the array of roles.

Throws:

IllegalArgumentException - if configured spaceId is null.

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

See Also:

CMAClient.Builder.setSpaceId(String)

fetchAll

public CMAArray<CMARole> fetchAll(String spaceId)

Fetch all roles of this space.

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

Parameters:

spaceId - the space identifier identifying the space.

Returns:

the array of roles.

Throws:

IllegalArgumentException - if spaceId is null.

fetchAll

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

Fetch specific roles of the configured space.

Parameters:

query - the search criteria to search for.

Returns:

the array of roles.

Throws:

IllegalArgumentException - if configured spaceId is null.

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

See Also:

CMAClient.Builder.setSpaceId(String)

fetchAll

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

Fetch specific roles of this space.

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

Parameters:

spaceId - the space identifier identifying the space.

query - the search criteria to search for.

Returns:

the array of roles.

Throws:

IllegalArgumentException - if spaceId is null.

fetchOne

public CMARole fetchOne(String roleId)

Fetches one role by its id from Contentful.

Parameters:

roleId - the id of the role to be found.

Returns:

null if no role was found, otherwise the found role.

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if role id is null.

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

See Also:

CMAClient.Builder.setSpaceId(String)

fetchOne

public CMARole fetchOne(String spaceId,
                        String roleId)

Fetches one role by its id from Contentful.

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

Parameters:

spaceId - the space this role is hosted by.

roleId - the id of the role to be found.

Returns:

null if no role was found, otherwise the found role.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if role id is null.

create

public CMARole create(CMARole role)

Create a new role.

Parameters:

role - the new role to be created.

Returns:

the newly created role.

Throws:

IllegalArgumentException - if the configured space id is null.

IllegalArgumentException - if role is null.

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

See Also:

CMAClient.Builder.setSpaceId(String)

create

public CMARole create(String spaceId,
                      CMARole role)

Create a new role.

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

Parameters:

spaceId - the space id to host the role.

role - the new role to be created.

Returns:

the newly created role.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if role is null.

update

public CMARole update(CMARole role)

Update the given role instance on Contentful.

Please make sure that the instance provided is fetched from Contentful. Otherwise you will get an exception thrown.

Parameters:

role - the role fetched from Contentful, updated by caller, to be updated.

Returns:

the updated role.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if role is null.

IllegalArgumentException - if role id is null.

IllegalArgumentException - if role does not have a version attached.

delete

public int delete(CMARole role)

Delete the given role instance.

Please make sure that the instance provided is fetched from Contentful. Otherwise you will get an exception thrown.

Parameters:

role - the role fetched from Contentful, updated by caller, to be deleted.

Returns:

the code of the response (204 means success).

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if role id is null.