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
,OIDCClientSecretConfigWrapper.ReadOnlyRotatedSecretClientModel
,TypeAwareClientModelDelegate
,UnsupportedOperationsClientStorageAdapter
public interface ClientScopeModel
extends ProtocolMapperContainerModel, ScopeContainerModel, OrderedModel
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
static interface
Nested classes/interfaces inherited from interface org.keycloak.models.OrderedModel
OrderedModel.OrderedModelComparator<OM extends OrderedModel>
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String name) default String
default String
default String
getId()
getName()
getRealm()
default boolean
default boolean
default boolean
void
removeAttribute
(String name) void
setAttribute
(String name, String value) default void
setConsentScreenText
(String consentScreenText) void
setDescription
(String description) default void
setDisplayOnConsentScreen
(boolean displayOnConsentScreen) default void
setGuiOrder
(String guiOrder) default void
setIncludeInTokenScope
(boolean includeInTokenScope) default void
setIsDynamicScope
(boolean isDynamicScope) void
void
setProtocol
(String protocol) Methods inherited from interface org.keycloak.models.ProtocolMapperContainerModel
addProtocolMapper, getProtocolMapperById, getProtocolMapperByName, getProtocolMappersStream, removeProtocolMapper, updateProtocolMapper
Methods inherited from interface org.keycloak.models.ScopeContainerModel
addScopeMapping, deleteScopeMapping, getRealmScopeMappingsStream, getScopeMappingsStream, hasDirectScope, hasScope
-
Field Details
-
DISPLAY_ON_CONSENT_SCREEN
- See Also:
-
CONSENT_SCREEN_TEXT
- See Also:
-
GUI_ORDER
- See Also:
-
INCLUDE_IN_TOKEN_SCOPE
- See Also:
-
IS_DYNAMIC_SCOPE
- See Also:
-
DYNAMIC_SCOPE_REGEXP
- See Also:
-
-
Method Details
-
getId
String getId() -
getName
String getName() -
getRealm
RealmModel getRealm() -
setName
-
getDescription
String getDescription() -
setDescription
-
getProtocol
String getProtocol() -
setProtocol
-
setAttribute
-
removeAttribute
-
getAttribute
-
getAttributes
-
isDisplayOnConsentScreen
default boolean isDisplayOnConsentScreen() -
setDisplayOnConsentScreen
default void setDisplayOnConsentScreen(boolean displayOnConsentScreen) -
getConsentScreenText
-
setConsentScreenText
-
getGuiOrder
- Specified by:
getGuiOrder
in interfaceOrderedModel
-
setGuiOrder
-
isIncludeInTokenScope
default boolean isIncludeInTokenScope() -
setIncludeInTokenScope
default void setIncludeInTokenScope(boolean includeInTokenScope) -
isDynamicScope
default boolean isDynamicScope() -
setIsDynamicScope
default void setIsDynamicScope(boolean isDynamicScope) -
getDynamicScopeRegexp
-