Package org.keycloak.models

Interface ClientScopeModel

All Superinterfaces:
OrderedModel, ProtocolMapperContainerModel, ScopeContainerModel
All Known Subinterfaces:
ClientModel
All Known Implementing Classes:
AbstractClientStorageAdapter, AbstractReadOnlyClientScopeAdapter, AbstractReadOnlyClientStorageAdapter, ClientAdapter, ClientAdapter, ClientModelLazyDelegate, ClientModelLazyDelegate.WithId, ClientScopeAdapter, ClientScopeAdapter, ClientScopeDecorator, CredentialScopeModel, OIDCClientSecretConfigWrapper.ReadOnlyRotatedSecretClientModel, TypeAwareClientModelDelegate, UnsupportedOperationsClientStorageAdapter
public interface ClientScopeModel extends ProtocolMapperContainerModel, ScopeContainerModel, OrderedModel
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Details

  • Method Details

    • isParameterizedScope

      static boolean isParameterizedScope(ClientScopeModel scope)
      Returns true when parameterized scopes are enabled and the scope is defined as parameterized.
      Parameters:
      scope - The scope to check
      Returns:
      true when the parameterized scopes feature is enabled and the scope is parameterized, false otherwise

    • isDynamicScope

      @Deprecated static boolean isDynamicScope(ClientScopeModel scope)
      Deprecated.
      Use isParameterizedScope(ClientScopeModel) instead.

    • getId

      String getId()

    • getName

      String getName()

    • getRealm

      RealmModel getRealm()

    • setName

      void setName(String name)

    • getDescription

      String getDescription()

    • setDescription

      void setDescription(String description)

    • getProtocol

      String getProtocol()

    • setProtocol

      void setProtocol(String protocol)

    • setAttribute

      void setAttribute(String name, String value)

    • removeAttribute

      void removeAttribute(String name)

    • getAttribute

      String getAttribute(String name)

    • getAttributes

      Map<String,String> getAttributes()

    • isDisplayOnConsentScreen

      default boolean isDisplayOnConsentScreen()

    • setDisplayOnConsentScreen

      default void setDisplayOnConsentScreen(boolean displayOnConsentScreen)

    • getConsentScreenText

      default String getConsentScreenText()

    • setConsentScreenText

      default void setConsentScreenText(String consentScreenText)

    • getGuiOrder

      default String getGuiOrder()
      Specified by:
      getGuiOrder in interface OrderedModel

    • setGuiOrder

      default void setGuiOrder(String guiOrder)

    • isIncludeInTokenScope

      default boolean isIncludeInTokenScope()

    • setIncludeInTokenScope

      default void setIncludeInTokenScope(boolean includeInTokenScope)

    • isParameterizedScope

      default boolean isParameterizedScope()

    • isAlwaysConsent

      default boolean isAlwaysConsent()

    • setIsParameterizedScope

      default void setIsParameterizedScope(boolean isParameterizedScope)

    • getParameterizedScopeRegexp

      default String getParameterizedScopeRegexp()

    • getParameterFromScope

      default Optional<String> getParameterFromScope(String requestScope)
      Extracts the parameter value from a requested scope string in the format scopeName:parameterValue.
      Parameters:
      requestScope - the requested scope string, e.g. "my_scope:some_value"
      Returns:
      the extracted parameter value, or empty if this is not a parameterized scope or no valid parameter is present

    • isDynamicScope

      @Deprecated default boolean isDynamicScope()
      Deprecated.
      Use isParameterizedScope() instead.

    • setIsDynamicScope

      @Deprecated default void setIsDynamicScope(boolean isDynamicScope)
      Deprecated.
      Use setIsParameterizedScope(boolean) instead.

    • getDynamicScopeRegexp

      @Deprecated default String getDynamicScopeRegexp()
      Deprecated.
      Use getParameterizedScopeRegexp() instead.

    • isIncludeInOpenIDProviderMetadata

      default boolean isIncludeInOpenIDProviderMetadata()

    • setIncludeInOpenIDProviderMetadata

      default void setIncludeInOpenIDProviderMetadata(boolean includeInOpenIDProviderMetadata)