Package com.broadleafcommerce.tenant.service

Interface TenantResolver

All Known Implementing Classes:
DefaultTenantResolver
public interface TenantResolver
Responsible for resolving the correct Tenant or Application for a given URL. The URL parameter should include everything necessary to identify an application such as the application's domain name or domain prefix.
Author:
Nathan Moore (nathanmoore), Erin Pennington (epenning), Nick Crum (ncrum)

  • Method Details

    • resolveApplication

      @Deprecated Optional<Application> resolveApplication(@NonNull String url)
      Deprecated.
      use resolveApplicationByURL(String)
      Resolves the application that matches the provided URL, or empty.
      Parameters:
      url - the url to match to an Application
      Returns:
      an optional application

    • resolveApplicationByURL

      Optional<Application> resolveApplicationByURL(@NonNull String url)
      Resolves the application that matches the provided URL, or empty.
      Parameters:
      url - the url to match to an Application
      Returns:
      an optional application

    • resolveApplicationById

      Optional<Application> resolveApplicationById(String id)
      Resolves the application that matches the provided ID.
      Parameters:
      id - the ID of the application
      Returns:
      an optional application

    • resolveApplicationByToken

      Optional<Application> resolveApplicationByToken(String token)
      Resolves the application that matches the provided token.
      Parameters:
      token - the token of the application
      Returns:
      an optional application

    • resolveAdminTenant

      Optional<Tenant> resolveAdminTenant(@NonNull String url)
      Resolves the tenant for the admin that matches the provided URL, or empty.
      Parameters:
      url - the url to match to a Tenant
      Returns:
      an optional tenant