com.lexmark.saperion.client.implementation.administration

Class TenantManagementClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.SearchClientImpl<TenantListItemType>

com.lexmark.saperion.client.implementation.administration.TenantManagementClientImpl

All Implemented Interfaces:

TenantManagementClient, SearchClient<TenantListItemType>, SearchExecutionService<TenantListItemType>

public class TenantManagementClientImpl
extends SearchClientImpl<TenantListItemType>
implements TenantManagementClient

This is the default implementation of TenantManagementClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
TenantManagementClientImpl(TenantManagementService tenantManagementService)

Method Summary

Modifier and Type	Method and Description
TenantReferenceType	createTenant(String name, String adminPassword) This method creates a new tenant with the given name and returns a reference to the new tenant.
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.
TenantClient	resolve(TenantReferenceType reference) This method returns a client capable to administrate the tenant with the given reference.
TenantClient	resolveName(String tenantName) This method returns a client capable to administrate the tenant with the given name.
SearchClient<TenantListItemType>	searchDeleted() This method returns a new SearchClient that can be used to search for deleted tenants.

Methods inherited from class com.lexmark.saperion.client.implementation.SearchClientImpl

exists, list, list, list, list, list, list, list, page, page, search, uniqueResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lexmark.saperion.client.SearchClient

exists, list, list, list, list, list, list, list, page, page, uniqueResult

Methods inherited from interface com.lexmark.saperion.search.SearchExecutionService

search

Constructor Detail

TenantManagementClientImpl

public TenantManagementClientImpl(TenantManagementService tenantManagementService)

Method Detail

resolve

public TenantClient resolve(TenantReferenceType reference)
                     throws EcmException

Description copied from interface: TenantManagementClient

This method returns a client capable to administrate the tenant with the given reference.

Specified by:

resolve in interface TenantManagementClient

Parameters:

reference - a reference to the tenant to administrate

Returns:

a client capable to administrate the tenant with the given reference

Throws:

EcmException

resolveName

public TenantClient resolveName(String tenantName)
                         throws EcmException

Description copied from interface: TenantManagementClient

This method returns a client capable to administrate the tenant with the given name.

Specified by:

resolveName in interface TenantManagementClient

Parameters:

tenantName - the name of the tenant to administrate

Returns:

a client capable to administrate the tenant with the given name

Throws:

EcmException

createTenant

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

Description copied from interface: TenantManagementClient

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.

Specified by:

createTenant in interface TenantManagementClient

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:

EcmException - indicates that a system exception occurred

createTenant

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

Description copied from interface: TenantManagementClient

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

Specified by:

createTenant in interface TenantManagementClient

Parameters:

name - the name of the tenant

adminPassword - the password for the tenant-administrator

Returns:

a reference to the newly created tenant

Throws:

EcmException - indicates that a system exception occurred

searchDeleted

public SearchClient<TenantListItemType> searchDeleted()

Description copied from interface: TenantManagementClient

This method returns a new SearchClient that can be used to search for deleted tenants.

Specified by:

searchDeleted in interface TenantManagementClient

Returns:

a search client for deleted tenants