org.keycloak.models.ClientScopeModel インタフェース

org.keycloak.models.ClientScopeModel の継承関係図

org.keycloak.models.ClientScopeModel 連携図

公開メンバ関数
String	getId ()
String	getName ()
RealmModel	getRealm ()
void	setName (String name)
String	getDescription ()
void	setDescription (String description)
String	getProtocol ()
void	setProtocol (String protocol)
void	setAttribute (String name, String value)
void	removeAttribute (String name)
String	getAttribute (String name)
Map< String, String >	getAttributes ()
default boolean	isDisplayOnConsentScreen ()
default void	setDisplayOnConsentScreen (boolean displayOnConsentScreen)
default String	getConsentScreenText ()
default void	setConsentScreenText (String consentScreenText)
default String	getGuiOrder ()
default void	setGuiOrder (String guiOrder)
Set< ProtocolMapperModel >	getProtocolMappers ()
ProtocolMapperModel	addProtocolMapper (ProtocolMapperModel model)
void	removeProtocolMapper (ProtocolMapperModel mapping)
void	updateProtocolMapper (ProtocolMapperModel mapping)
ProtocolMapperModel	getProtocolMapperById (String id)
ProtocolMapperModel	getProtocolMapperByName (String protocol, String name)
Set< RoleModel >	getScopeMappings ()
void	addScopeMapping (RoleModel role)
void	deleteScopeMapping (RoleModel role)
Set< RoleModel >	getRealmScopeMappings ()
boolean	hasScope (RoleModel role)

公開変数類
String	DISPLAY_ON_CONSENT_SCREEN = "display.on.consent.screen"
String	CONSENT_SCREEN_TEXT = "consent.screen.text"
String	GUI_ORDER = "gui.order"

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

addProtocolMapper()

ProtocolMapperModel org.keycloak.models.ProtocolMapperContainerModel.addProtocolMapper ( ProtocolMapperModel  model )

inherited

addScopeMapping()

void org.keycloak.models.ScopeContainerModel.addScopeMapping ( RoleModel  role )

inherited

deleteScopeMapping()

void org.keycloak.models.ScopeContainerModel.deleteScopeMapping ( RoleModel  role )

inherited

getAttribute()

String org.keycloak.models.ClientScopeModel.getAttribute

(

String

name

)

org.keycloak.models.ClientModelで実装されています。

getAttributes()

Map<String, String> org.keycloak.models.ClientScopeModel.getAttributes

(

)

org.keycloak.models.ClientModelで実装されています。

getConsentScreenText()

default String org.keycloak.models.ClientScopeModel.getConsentScreenText ( )

inline

org.keycloak.models.ClientModelで実装されています。

                                          {
        String consentScreenText = getAttribute(CONSENT_SCREEN_TEXT);
        if (consentScreenText == null) {
            consentScreenText = getName();
        }
        return consentScreenText;
    }

getDescription()

String org.keycloak.models.ClientScopeModel.getDescription

(

)

org.keycloak.models.ClientModelで実装されています。

getGuiOrder()

default String org.keycloak.models.ClientScopeModel.getGuiOrder ( )

inline

org.keycloak.models.OrderedModelを実装しています。

                                 {
        return getAttribute(GUI_ORDER);
    }

getId()

String org.keycloak.models.ClientScopeModel.getId

(

)

org.keycloak.models.ClientModelで実装されています。

getName()

String org.keycloak.models.ClientScopeModel.getName

(

)

org.keycloak.models.ClientModelで実装されています。

getProtocol()

String org.keycloak.models.ClientScopeModel.getProtocol

(

)

org.keycloak.models.ClientModelで実装されています。

getProtocolMapperById()

ProtocolMapperModel org.keycloak.models.ProtocolMapperContainerModel.getProtocolMapperById ( String  id )

inherited

getProtocolMapperByName()

ProtocolMapperModel org.keycloak.models.ProtocolMapperContainerModel.getProtocolMapperByName ( String  protocol, String  name  )

inherited

getProtocolMappers()

Set<ProtocolMapperModel> org.keycloak.models.ProtocolMapperContainerModel.getProtocolMappers ( )

inherited

getRealm()

RealmModel org.keycloak.models.ClientScopeModel.getRealm

(

)

org.keycloak.models.ClientModelで実装されています。

getRealmScopeMappings()

Set<RoleModel> org.keycloak.models.ScopeContainerModel.getRealmScopeMappings ( )

inherited

getScopeMappings()

Set<RoleModel> org.keycloak.models.ScopeContainerModel.getScopeMappings ( )

inherited

hasScope()

boolean org.keycloak.models.ScopeContainerModel.hasScope ( RoleModel  role )

inherited

isDisplayOnConsentScreen()

default boolean org.keycloak.models.ClientScopeModel.isDisplayOnConsentScreen ( )

inline

org.keycloak.models.ClientModelで実装されています。

                                               {
        String displayVal = getAttribute(DISPLAY_ON_CONSENT_SCREEN);
        return displayVal==null ? true : Boolean.parseBoolean(displayVal);
    }

removeAttribute()

void org.keycloak.models.ClientScopeModel.removeAttribute

(

String

name

)

org.keycloak.models.ClientModelで実装されています。

removeProtocolMapper()

void org.keycloak.models.ProtocolMapperContainerModel.removeProtocolMapper ( ProtocolMapperModel  mapping )

inherited

setAttribute()

void org.keycloak.models.ClientScopeModel.setAttribute	(	String	name,
		String	value
	)

org.keycloak.models.ClientModelで実装されています。

setConsentScreenText()

default void org.keycloak.models.ClientScopeModel.setConsentScreenText ( String  consentScreenText )

inline

                                                                {
        setAttribute(CONSENT_SCREEN_TEXT, consentScreenText);
    }

setDescription()

void org.keycloak.models.ClientScopeModel.setDescription

(

String

description

)

org.keycloak.models.ClientModelで実装されています。

setDisplayOnConsentScreen()

default void org.keycloak.models.ClientScopeModel.setDisplayOnConsentScreen ( boolean  displayOnConsentScreen )

inline

                                                                           {
        setAttribute(DISPLAY_ON_CONSENT_SCREEN, String.valueOf(displayOnConsentScreen));
    }

setGuiOrder()

default void org.keycloak.models.ClientScopeModel.setGuiOrder ( String  guiOrder )

inline

                                              {
        setAttribute(GUI_ORDER, guiOrder);
    }

setName()

void org.keycloak.models.ClientScopeModel.setName

(

String

name

)

org.keycloak.models.ClientModelで実装されています。

setProtocol()

void org.keycloak.models.ClientScopeModel.setProtocol

(

String

protocol

)

org.keycloak.models.ClientModelで実装されています。

updateProtocolMapper()

void org.keycloak.models.ProtocolMapperContainerModel.updateProtocolMapper ( ProtocolMapperModel  mapping )

inherited

メンバ詳解

CONSENT_SCREEN_TEXT

String org.keycloak.models.ClientScopeModel.CONSENT_SCREEN_TEXT = "consent.screen.text"

DISPLAY_ON_CONSENT_SCREEN

String org.keycloak.models.ClientScopeModel.DISPLAY_ON_CONSENT_SCREEN = "display.on.consent.screen"

GUI_ORDER

String org.keycloak.models.ClientScopeModel.GUI_ORDER = "gui.order"

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/spi/src/server-spi/src/main/java/org/keycloak/models/ClientScopeModel.java