com.lexmark.saperion.administration

Interface TenantManagementService

All Superinterfaces:

SearchExecutionService<TenantListItemType>

public interface TenantManagementService
extends SearchExecutionService<TenantListItemType>

The tenant management service provides the required operations to create, read, update and delete tenant entities in the user management system.

Author:

owaeldrich

Method Summary

Modifier and Type	Method and Description
TenantReferenceType	createTenant(String name, String description, String adminPassword) This method creates a new tenant with the given name and description and returns a reference to the new tenant.
void	deleteSchemaExtension(TenantReferenceType tenant) This method deletes the schema-extension of the given tenant.
void	deleteTenant(TenantReferenceType reference) Deletes the tenant with the given reference.
Map<String,PropertyType>	getSchemaExtension(TenantReferenceType tenant) This method returns the schema-extension for the given tenant.
SearchExecutionService<TenantListItemType>	getSearchServiceForDeletedItems()
TenantType	loadTenant(String name) Loads a tenant identified by its name.
TenantType	loadTenant(TenantReferenceType reference) This method returns a tenant given its id.
SearchResultPage<TenantListItemType>	search(Statement statement, PageDefinition pageDefinition) This method lists all tenants in the system.
void	setSchemaExtension(TenantReferenceType tenant, Map<String,PropertyType> schemaExtension) This method stores the given schema-extension for the given tenant.
void	undeleteTenant(TenantReferenceType reference) Un-deletes the tenant with the given reference.
void	updateTenant(TenantReferenceType reference, String description) Updates the referenced tenant with the given properties.

Method Detail

loadTenant

TenantType loadTenant(TenantReferenceType reference)
               throws ResourceNotFoundException,
                      EcmException

This method returns a tenant given its id.

Parameters:

reference - the reference of the tenant to get

Returns:

a tenant given its id

Throws:

ResourceNotFoundException - the referenced tenant does not exist in the backend system

EcmException - indicates that a system exception occurred

loadTenant

TenantType loadTenant(String name)
               throws ResourceNotFoundException,
                      EcmException

Loads a tenant identified by its name.

Parameters:

name - the name of the tenant to load

Returns:

the referenced tenant

Throws:

ResourceNotFoundException - the referenced tenant does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

deleteTenant

void deleteTenant(TenantReferenceType reference)
           throws EcmException

Deletes the tenant with the given reference.

Parameters:

reference - the tenant reference

Throws:

ResourceNotFoundException - the referenced tenant does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

undeleteTenant

void undeleteTenant(TenantReferenceType reference)
             throws EcmException

Un-deletes the tenant with the given reference.

Parameters:

reference - the tenant reference

Throws:

SystemException - indicates that a system exception occurred

EcmException

search

SearchResultPage<TenantListItemType> search(Statement statement,
                                            PageDefinition pageDefinition)
                                     throws EcmException

This method lists all tenants in the system.

Specified by:

search in interface SearchExecutionService<TenantListItemType>

Parameters:

statement - additional statement to filter the tenants

pageDefinition - the page of the result to return

Returns:

a list with all tenants in the system

Throws:

EcmException - indicates that a system exception occurred

getSearchServiceForDeletedItems

SearchExecutionService<TenantListItemType> getSearchServiceForDeletedItems()

createTenant

TenantReferenceType createTenant(String name,
                                 String description,
                                 String adminPassword)
                          throws EcmException

This method creates a new tenant with the given name and description and returns a reference to the new tenant. A tenant-administrator user with the given password will be created automatically.

Parameters:

name - the name of the tenant

description - a description of the tenant

adminPassword - the password for the tenant-administrator

Returns:

a reference to the newly created tenant

Throws:

SystemException - indicates that a system exception occurred

EcmException

updateTenant

void updateTenant(TenantReferenceType reference,
                  String description)
           throws EcmException

Updates the referenced tenant with the given properties.

Parameters:

reference - the tenant reference

description - a tenant description

Throws:

ResourceNotFoundException - the referenced tenant does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

getSchemaExtension

Map<String,PropertyType> getSchemaExtension(TenantReferenceType tenant)
                                     throws EcmException

This method returns the schema-extension for the given tenant.

Parameters:

tenant - the tenant

Returns:

the schema-extension of the tenant

Throws:

EcmException

setSchemaExtension

void setSchemaExtension(TenantReferenceType tenant,
                        Map<String,PropertyType> schemaExtension)
                 throws EcmException

This method stores the given schema-extension for the given tenant. Note that only non-null values will be updated when a schema-extension already exists.

Parameters:

tenant - the tenant

schemaExtension - the schema-extension to store

Throws:

EcmException

deleteSchemaExtension

void deleteSchemaExtension(TenantReferenceType tenant)
                    throws EcmException

This method deletes the schema-extension of the given tenant.

Parameters:

tenant - the tenant

Throws:

EcmException - when deleting the schema-extension failed