Interface ScopeLocator


@ProviderType public interface ScopeLocator
Lists scope aliases and matching LiferayOAuth2Scopes based on a portal instance configuration of the OAuth2 framework. Scope aliases can match multiple LiferayOAuth2Scopes from OAuth2 frameworks in different portal instances.
  • Method Details

    • getLiferayOAuth2Scope

      LiferayOAuth2Scope getLiferayOAuth2Scope(long companyId, String applicationName, String scope)
    • getLiferayOAuth2Scopes

      Collection<LiferayOAuth2Scope> getLiferayOAuth2Scopes(long companyId)
      Returns all the application exported scopes.
      Parameters:
      companyId - the ID of the portal instance containing the scopes
      Returns:
      the matching scopes
    • getLiferayOAuth2Scopes

      Collection<LiferayOAuth2Scope> getLiferayOAuth2Scopes(long companyId, String scopesAlias)
      Returns the application exported scopes matching the given portal instance's scopes alias.
      Parameters:
      companyId - the ID of the portal instance containing the scopes
      scopesAlias - the alias mapped to scopes
      Returns:
      the matching scopes
    • getLiferayOAuth2Scopes

      Collection<LiferayOAuth2Scope> getLiferayOAuth2Scopes(long companyId, String scopesAlias, String applicationName)
      Returns the application exported scopes matching the given portal instance's scopes alias, filtered by application name.
      Parameters:
      companyId - the ID of the portal instance containing the scopes
      scopesAlias - the alias mapped to scopes
      applicationName - the application containing the scopes
      Returns:
      the matching scopes, filtered by application name
    • getScopeAliases

      Collection<String> getScopeAliases(long companyId)
      Returns the scope aliases available for the given portal instance.
      Parameters:
      companyId - the ID of the portal instance containing the scope aliases
      Returns:
      the non-null scope aliases
    • getScopeAliases

      Collection<String> getScopeAliases(long companyId, String applicationName)
      Returns the scope aliases available for the given portal instance, filtered by application name.
      Parameters:
      companyId - the ID of the portal instance containing the scope aliases
      applicationName - the application exporting the scopes
      Returns:
      the non-null scope aliases, filtered by application name