Package org.craftercms.security.utils.tenant

Class TenantUtils

java.lang.Object

org.craftercms.security.utils.tenant.TenantUtils

public class TenantUtils
extends Object

Tenant related utility methods.

Author:

avasquez

Method Summary

Modifier and Type	Method	Description
static String	getCurrentTenantName()	Returns the current tenant name, which is the tenant of the currently authenticated profile.
static List<String>	getTenantNames(TenantService tenantService)	Returns a list with the names of all tenants.

Methods inherited from class java.lang.Object

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

Method Details

getTenantNames

public static List<String> getTenantNames(TenantService tenantService)
                                   throws ProfileException

Returns a list with the names of all tenants.

Parameters:

tenantService - the service that retrieves the Tenants.

Returns:

the list of tenant names

Throws:

ProfileException

getCurrentTenantName

public static String getCurrentTenantName()

Returns the current tenant name, which is the tenant of the currently authenticated profile.

Returns:

the current tenant name.