Package com.broadleafcommerce.auth.tenant.service

Interface TenantUrlResolver

All Known Implementing Classes:

ExternalTenantUrlResolver

public interface TenantUrlResolver

Responsible for resolving the base URL at which an application or admin is served given the ID of an application or tenant.

See Also:

• DefaultRegisteredClientRepository
• ExternalTenantUrlResolver

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_ADMIN_URL_BY_TENANT_ID
static final String	CACHE_APPLICATION_BY_APPLICATION_ID
static final String	CACHE_APPLICATION_URL_BY_APPLICATION_ID

Method Summary

Modifier and Type	Method	Description
Optional<String>	getAdminUrl(String tenantId)	Resolves the full url of the admin for the provided tenant.
Optional<String>	getApplicationUrl(String applicationId)	Resolves the full url for the provided application.

Field Details

CACHE_APPLICATION_URL_BY_APPLICATION_ID

static final String CACHE_APPLICATION_URL_BY_APPLICATION_ID

See Also:

• Constant Field Values

CACHE_ADMIN_URL_BY_TENANT_ID

static final String CACHE_ADMIN_URL_BY_TENANT_ID

See Also:

• Constant Field Values

CACHE_APPLICATION_BY_APPLICATION_ID

static final String CACHE_APPLICATION_BY_APPLICATION_ID

See Also:

• Constant Field Values

Method Details

getApplicationUrl

Optional<String> getApplicationUrl(String applicationId)

Resolves the full url for the provided application. This is used for discovery of the location where an application is served.

Parameters:

applicationId - the application ID for which to fetch the full url string

Returns:

the full url string for the application

getAdminUrl

Optional<String> getAdminUrl(String tenantId)

Resolves the full url of the admin for the provided tenant. This is used for discovery of the location where the admin is served.

Parameters:

tenantId - the tenant ID for which to fetch the full url string

Returns:

the full url string for the tenant