Package com.lexmark.saperion.client.administration

Interface TenantManagementClient

  • All Superinterfaces:
    SearchClient<com.lexmark.saperion.administration.TenantType>, com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.administration.TenantType>
    All Known Implementing Classes:
    TenantManagementClientImpl
    public interface TenantManagementClient
extends SearchClient<com.lexmark.saperion.administration.TenantType>
    This client provides functionality to administrate tenants in a saperion system.
    Author:
    jschwarz

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default com.lexmark.saperion.administration.TenantReferenceType createTenant​(java.lang.String name, java.lang.String adminPassword)
      This method creates a new tenant with the given name and returns a reference to the new tenant.
      com.lexmark.saperion.administration.TenantReferenceType createTenant​(java.lang.String name, java.lang.String description, java.lang.String adminPassword)
      This method creates a new tenant with the given name and description and returns a reference to the new tenant.
      TenantClient resolve​(com.lexmark.saperion.administration.TenantReferenceType reference)
      This method returns a client capable to administrate the tenant with the given reference.
      TenantClient resolveName​(java.lang.String tenantName)
      This method returns a client capable to administrate the tenant with the given name.
      SearchClient<com.lexmark.saperion.administration.TenantType> searchDeleted()
      This method returns a new SearchClient that can be used to search for deleted tenants.

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

        search

    • Method Detail

      • resolve

        TenantClient resolve​(com.lexmark.saperion.administration.TenantReferenceType reference)
              throws com.lexmark.saperion.exceptions.EcmException
        This method returns a client capable to administrate the tenant with the given reference.
        Parameters:
        reference - a reference to the tenant to administrate
        Returns:
        a client capable to administrate the tenant with the given reference
        Throws:
        com.lexmark.saperion.exceptions.EcmException

      • resolveName

        TenantClient resolveName​(java.lang.String tenantName)
                  throws com.lexmark.saperion.exceptions.EcmException
        This method returns a client capable to administrate the tenant with the given name.
        Parameters:
        tenantName - the name of the tenant to administrate
        Returns:
        a client capable to administrate the tenant with the given name
        Throws:
        com.lexmark.saperion.exceptions.EcmException

      • createTenant

        com.lexmark.saperion.administration.TenantReferenceType createTenant​(java.lang.String name,
                                                                     java.lang.String description,
                                                                     java.lang.String adminPassword)
                                                              throws com.lexmark.saperion.exceptions.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:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • createTenant

        default com.lexmark.saperion.administration.TenantReferenceType createTenant​(java.lang.String name,
                                                                             java.lang.String adminPassword)
                                                                      throws com.lexmark.saperion.exceptions.EcmException
        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.
        Parameters:
        name - the name of the tenant
        adminPassword - the password for the tenant-administrator
        Returns:
        a reference to the newly created tenant
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • searchDeleted

        SearchClient<com.lexmark.saperion.administration.TenantType> searchDeleted()
        This method returns a new SearchClient that can be used to search for deleted tenants.
        Returns:
        a search client for deleted tenants