Package org.craftercms.profile.controllers.rest

Class TenantController

java.lang.Object

org.craftercms.profile.controllers.rest.TenantController

@Controller
@RequestMapping("/api/1/tenant")
public class TenantController
extends Object

REST controller for the tenant service.

Author:

avasquez

Constructor Summary

Constructors

Constructor	Description
TenantController(TenantService tenantService)

Method Summary

Modifier and Type	Method	Description
Tenant	addAttributeDefinitions(String tenantName, Collection<AttributeDefinition> attributeDefinitions)
Tenant	addRoles(String tenantName, Collection<String> roles)
Tenant	createTenant(Tenant tenant)
void	deleteTenant(String name)
List<Tenant>	getAllTenants()
Tenant	getTenant(String name)
long	getTenantCount()
Tenant	removeAttributeDefinitions(String tenantName, Collection<String> attributeNames)
Tenant	removeRoles(String tenantName, Collection<String> roles)
Tenant	updateAttributeDefinitions(String tenantName, Collection<AttributeDefinition> attributeDefinitions)
Tenant	updateTenant(Tenant tenant)
Tenant	verifyNewProfiles(String tenantName, boolean verify)

Methods inherited from class java.lang.Object

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

Constructor Details

TenantController

public TenantController(TenantService tenantService)

Method Details

createTenant

@RequestMapping(value="/create",
                method=POST)
@ResponseBody
public Tenant createTenant(@RequestBody
 Tenant tenant)
                    throws ProfileException

Throws:

ProfileException

getTenant

@RequestMapping(value="/{name}",
                method=GET)
@ResponseBody
public Tenant getTenant(@PathVariable("name")
 String name)
                 throws ProfileException

Throws:

ProfileException

updateTenant

@RequestMapping(value="/update",
                method=POST)
@ResponseBody
public Tenant updateTenant(@RequestBody
 Tenant tenant)
                    throws ProfileException

Throws:

ProfileException

deleteTenant

@RequestMapping(value="/{name}/delete",
                method=POST)
@ResponseStatus(OK)
public void deleteTenant(@PathVariable("name")
 String name)
                  throws ProfileException

Throws:

ProfileException

getTenantCount

@RequestMapping(value="/count",
                method=GET)
@ResponseBody
public long getTenantCount()
                    throws ProfileException

Throws:

ProfileException

getAllTenants

@RequestMapping(value="/all",
                method=GET)
@ResponseBody
public List<Tenant> getAllTenants()
                           throws ProfileException

Throws:

ProfileException

verifyNewProfiles

@RequestMapping(value="/{name}/verify_new_profiles",
                method=POST)
@ResponseBody
public Tenant verifyNewProfiles(@PathVariable("name")
 String tenantName,
 @RequestParam("verify")
 boolean verify)
                         throws ProfileException

Throws:

ProfileException

addRoles

@RequestMapping(value="/{name}/roles/add",
                method=POST)
@ResponseBody
public Tenant addRoles(@PathVariable("name")
 String tenantName,
 @RequestParam("role")
 Collection<String> roles)
                throws ProfileException

Throws:

ProfileException

removeRoles

@RequestMapping(value="/{name}/roles/remove",
                method=POST)
@ResponseBody
public Tenant removeRoles(@PathVariable("name")
 String tenantName,
 @RequestParam("role")
 Collection<String> roles)
                   throws ProfileException

Throws:

ProfileException

addAttributeDefinitions

@RequestMapping(value="/{name}/attribute_definitions/add",
                method=POST)
@ResponseBody
public Tenant addAttributeDefinitions(@PathVariable("name")
 String tenantName,
 @RequestBody
 Collection<AttributeDefinition> attributeDefinitions)
                               throws ProfileException

Throws:

ProfileException

updateAttributeDefinitions

@RequestMapping(value="/{name}/attribute_definitions/update",
                method=POST)
@ResponseBody
public Tenant updateAttributeDefinitions(@PathVariable("name")
 String tenantName,
 @RequestBody
 Collection<AttributeDefinition> attributeDefinitions)
                                  throws ProfileException

Throws:

ProfileException

removeAttributeDefinitions

@RequestMapping(value="/{name}/attribute_definitions/remove",
                method=POST)
@ResponseBody
public Tenant removeAttributeDefinitions(@PathVariable("name")
 String tenantName,
 @RequestParam("attributeName")
 Collection<String> attributeNames)
                                  throws ProfileException

Throws:

ProfileException