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 Summary
Modifier and TypeMethodDescriptiongetLiferayOAuth2Scope(long companyId, String applicationName, String scope) getLiferayOAuth2Scopes(long companyId) Returns all the application exported scopes.getLiferayOAuth2Scopes(long companyId, String scopesAlias) Returns the application exported scopes matching the given portal instance's scopes alias.getLiferayOAuth2Scopes(long companyId, String scopesAlias, String applicationName) Returns the application exported scopes matching the given portal instance's scopes alias, filtered by application name.getScopeAliases(long companyId) Returns the scope aliases available for the given portal instance.getScopeAliases(long companyId, String applicationName) Returns the scope aliases available for the given portal instance, filtered by application name.
-
Method Details
-
getLiferayOAuth2Scope
-
getLiferayOAuth2Scopes
Returns all the application exported scopes.- Parameters:
companyId- the ID of the portal instance containing the scopes- Returns:
- the matching scopes
-
getLiferayOAuth2Scopes
Returns the application exported scopes matching the given portal instance's scopes alias.- Parameters:
companyId- the ID of the portal instance containing the scopesscopesAlias- 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 scopesscopesAlias- the alias mapped to scopesapplicationName- the application containing the scopes- Returns:
- the matching scopes, filtered by application name
-
getScopeAliases
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-
nullscope aliases
-
getScopeAliases
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 aliasesapplicationName- the application exporting the scopes- Returns:
- the non-
nullscope aliases, filtered by application name
-