Package org.craftercms.profile.services.impl

Class TenantServiceRestClient

java.lang.Object

org.craftercms.commons.rest.AbstractRestClientBase

org.craftercms.profile.services.impl.AbstractProfileRestClientBase

org.craftercms.profile.services.impl.TenantServiceRestClient

All Implemented Interfaces:

TenantService

public class TenantServiceRestClient
extends AbstractProfileRestClientBase
implements TenantService

REST client implementation of TenantService.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static final org.springframework.core.ParameterizedTypeReference<List<Tenant>>	tenantListTypeRef

Fields inherited from class org.craftercms.profile.services.impl.AbstractProfileRestClientBase

accessTokenIdResolver

Fields inherited from class org.craftercms.commons.rest.AbstractRestClientBase

baseUrl, extension, restTemplate

Constructor Summary

Constructors

Constructor	Description
TenantServiceRestClient(String baseUrl, org.springframework.web.client.RestTemplate restTemplate, AccessTokenIdResolver accessTokenIdResolver)

Method Summary

Modifier and Type	Method	Description
Tenant	addAttributeDefinitions(String tenantName, Collection<AttributeDefinition> attributeDefinitions)	Adds the given attribute definitions to the specified tenant.
Tenant	addRoles(String tenantName, Collection<String> roles)	Adds the given roles to the specified tenant.
Tenant	createTenant(Tenant tenant)	Creates the given tenant, failing if it already has been created.
void	deleteTenant(String name)	Deletes a tenant.
List<Tenant>	getAllTenants()	Returns a list with all the tenants.
Tenant	getTenant(String name)	Returns a tenant.
long	getTenantCount()	Returns the total number of tenants.
Tenant	removeAttributeDefinitions(String tenantName, Collection<String> attributeNames)	Removes the given attribute definitions from the specified tenant.
Tenant	removeRoles(String tenantName, Collection<String> roles)	Removes the given roles from the specified tenant.
Tenant	updateAttributeDefinitions(String tenantName, Collection<AttributeDefinition> attributeDefinitions)	Updates the given attribute definitions of the specified tenant.
Tenant	updateTenant(Tenant tenant)	Updates the given tenant.
Tenant	verifyNewProfiles(String tenantName, boolean verify)	Sets if new profiles for the specified tenant should be verified or not.

Methods inherited from class org.craftercms.profile.services.impl.AbstractProfileRestClientBase

createBaseParams, doGetForObject, doGetForObject, doGetForObject, doGetForObject, doPostForLocation, doPostForObject, doPostForUpload, getAbsoluteUrlWithAccessTokenIdParam, handleException, handleRestServiceException

Methods inherited from class org.craftercms.commons.rest.AbstractRestClientBase

getAbsoluteUrl, setExtension

Methods inherited from class java.lang.Object

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

Field Details

tenantListTypeRef

public static final org.springframework.core.ParameterizedTypeReference<List<Tenant>> tenantListTypeRef

Constructor Details

TenantServiceRestClient

public TenantServiceRestClient(String baseUrl,
 org.springframework.web.client.RestTemplate restTemplate,
 AccessTokenIdResolver accessTokenIdResolver)

Method Details

createTenant

public Tenant createTenant(Tenant tenant)
                    throws ProfileException

Description copied from interface: TenantService

Creates the given tenant, failing if it already has been created.

Specified by:

createTenant in interface TenantService

Parameters:

tenant - the tenant to create

Returns:

the created tenant

Throws:

ProfileException

getTenant

public Tenant getTenant(String name)
                 throws ProfileException

Description copied from interface: TenantService

Returns a tenant.

Specified by:

getTenant in interface TenantService

Parameters:

name - the tenant's name

Returns:

the tenant

Throws:

ProfileException

updateTenant

public Tenant updateTenant(Tenant tenant)
                    throws ProfileException

Description copied from interface: TenantService

Updates the given tenant.

Specified by:

updateTenant in interface TenantService

Parameters:

tenant - the tenant to update

Returns:

the updated tenant

Throws:

ProfileException

deleteTenant

public void deleteTenant(String name)
                  throws ProfileException

Description copied from interface: TenantService

Deletes a tenant.

Specified by:

deleteTenant in interface TenantService

Parameters:

name - the tenant's name

Throws:

ProfileException

getTenantCount

public long getTenantCount()
                    throws ProfileException

Description copied from interface: TenantService

Returns the total number of tenants.

Specified by:

getTenantCount in interface TenantService

Returns:

the number of tenants

Throws:

ProfileException

getAllTenants

public List<Tenant> getAllTenants()
                           throws ProfileException

Description copied from interface: TenantService

Returns a list with all the tenants.

Specified by:

getAllTenants in interface TenantService

Returns:

a list with al the tenants.

Throws:

ProfileException

verifyNewProfiles

public Tenant verifyNewProfiles(String tenantName,
 boolean verify)
                         throws ProfileException

Description copied from interface: TenantService

Sets if new profiles for the specified tenant should be verified or not.

Specified by:

verifyNewProfiles in interface TenantService

Parameters:

tenantName - the tenant's name

verify - true to verify new profiles through email, false otherwise

Returns:

the tenant

Throws:

ProfileException

addRoles

public Tenant addRoles(String tenantName,
 Collection<String> roles)
                throws ProfileException

Description copied from interface: TenantService

Adds the given roles to the specified tenant.

Specified by:

addRoles in interface TenantService

Parameters:

tenantName - the tenant's name

roles - the roles to add

Returns:

the tenant

Throws:

ProfileException

removeRoles

public Tenant removeRoles(String tenantName,
 Collection<String> roles)
                   throws ProfileException

Description copied from interface: TenantService

Removes the given roles from the specified tenant.

Specified by:

removeRoles in interface TenantService

Parameters:

tenantName - the tenant's name

roles - the roles to remove

Returns:

the tenant

Throws:

ProfileException

addAttributeDefinitions

public Tenant addAttributeDefinitions(String tenantName,
 Collection<AttributeDefinition> attributeDefinitions)
                               throws ProfileException

Description copied from interface: TenantService

Adds the given attribute definitions to the specified tenant.

Specified by:

addAttributeDefinitions in interface TenantService

Parameters:

tenantName - the tenant's name

attributeDefinitions - the definitions to add

Returns:

the tenant

Throws:

ProfileException

updateAttributeDefinitions

public Tenant updateAttributeDefinitions(String tenantName,
 Collection<AttributeDefinition> attributeDefinitions)
                                  throws ProfileException

Description copied from interface: TenantService

Updates the given attribute definitions of the specified tenant.

Specified by:

updateAttributeDefinitions in interface TenantService

Parameters:

tenantName - the tenant's name

attributeDefinitions - the definitions to update (should have the same name as definitions that the tenant already has)

Returns:

the tenant

Throws:

ProfileException

removeAttributeDefinitions

public Tenant removeAttributeDefinitions(String tenantName,
 Collection<String> attributeNames)
                                  throws ProfileException

Description copied from interface: TenantService

Removes the given attribute definitions from the specified tenant.

Specified by:

removeAttributeDefinitions in interface TenantService

Parameters:

tenantName - the tenant's name

attributeNames - the name of the attributes whose definitions should be removed

Returns:

the tenant

Throws:

ProfileException