org.keycloak.models.jpa.ClientScopeAdapter クラス

org.keycloak.models.jpa.ClientScopeAdapter の継承関係図

org.keycloak.models.jpa.ClientScopeAdapter 連携図

公開メンバ関数
	ClientScopeAdapter (RealmModel realm, EntityManager em, KeycloakSession session, ClientScopeEntity entity)
ClientScopeEntity	getEntity ()
String	getId ()
RealmModel	getRealm ()
String	getName ()
void	setName (String name)
String	getDescription ()
void	setDescription (String description)
String	getProtocol ()
void	setProtocol (String protocol)
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 >	getRealmScopeMappings ()
Set< RoleModel >	getScopeMappings ()
void	addScopeMapping (RoleModel role)
void	deleteScopeMapping (RoleModel role)
boolean	hasScope (RoleModel role)
void	setAttribute (String name, String value)
void	removeAttribute (String name)
String	getAttribute (String name)
Map< String, String >	getAttributes ()
boolean	equals (Object o)
int	hashCode ()
default boolean	isDisplayOnConsentScreen ()
default void	setDisplayOnConsentScreen (boolean displayOnConsentScreen)
default String	getConsentScreenText ()
default void	setConsentScreenText (String consentScreenText)
default String	getGuiOrder ()
default void	setGuiOrder (String guiOrder)

静的公開メンバ関数
static ClientScopeEntity	toClientScopeEntity (ClientScopeModel model, EntityManager em)

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

限定公開メンバ関数
ProtocolMapperEntity	getProtocolMapperEntity (String id)
ProtocolMapperEntity	getProtocolMapperEntityByName (String protocol, String name)
ProtocolMapperModel	entityToModel (ProtocolMapperEntity entity)
TypedQuery< ClientScopeRoleMappingEntity >	getRealmScopeMappingQuery (RoleModel role)

限定公開変数類
KeycloakSession	session
RealmModel	realm
EntityManager	em
ClientScopeEntity	entity

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

ClientScopeAdapter()

org.keycloak.models.jpa.ClientScopeAdapter.ClientScopeAdapter ( RealmModel  realm, EntityManager  em, KeycloakSession  session, ClientScopeEntity  entity  )

inline

                                                                                                                     {
        this.session = session;
        this.realm = realm;
        this.em = em;
        this.entity = entity;
    }

関数詳解

addProtocolMapper()

ProtocolMapperModel org.keycloak.models.jpa.ClientScopeAdapter.addProtocolMapper ( ProtocolMapperModel  model )

inline

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

                                                                            {
        if (getProtocolMapperByName(model.getProtocol(), model.getName()) != null) {
            throw new ModelDuplicateException("Protocol mapper name must be unique per protocol");
        }
        String id = model.getId() != null ? model.getId() : KeycloakModelUtils.generateId();
        ProtocolMapperEntity entity = new ProtocolMapperEntity();
        entity.setId(id);
        entity.setName(model.getName());
        entity.setProtocol(model.getProtocol());
        entity.setProtocolMapper(model.getProtocolMapper());
        entity.setClientScope(this.entity);
        entity.setConfig(model.getConfig());

        em.persist(entity);
        this.entity.getProtocolMappers().add(entity);
        return entityToModel(entity);
    }

addScopeMapping()

void org.keycloak.models.jpa.ClientScopeAdapter.addScopeMapping ( RoleModel  role )

inline

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

                                                {
        if (hasScope(role)) return;
        ClientScopeRoleMappingEntity entity = new ClientScopeRoleMappingEntity();
        entity.setClientScope(getEntity());
        RoleEntity roleEntity = RoleAdapter.toRoleEntity(role, em);
        entity.setRole(roleEntity);
        em.persist(entity);
        em.flush();
        em.detach(entity);
    }

deleteScopeMapping()

void org.keycloak.models.jpa.ClientScopeAdapter.deleteScopeMapping ( RoleModel  role )

inline

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

                                                   {
        TypedQuery<ClientScopeRoleMappingEntity> query = getRealmScopeMappingQuery(role);
        List<ClientScopeRoleMappingEntity> results = query.getResultList();
        if (results.size() == 0) return;
        for (ClientScopeRoleMappingEntity entity : results) {
            em.remove(entity);
        }
    }

entityToModel()

ProtocolMapperModel org.keycloak.models.jpa.ClientScopeAdapter.entityToModel ( ProtocolMapperEntity  entity )

inlineprotected

                                                                             {
        ProtocolMapperModel mapping = new ProtocolMapperModel();
        mapping.setId(entity.getId());
        mapping.setName(entity.getName());
        mapping.setProtocol(entity.getProtocol());
        mapping.setProtocolMapper(entity.getProtocolMapper());
        Map<String, String> config = new HashMap<String, String>();
        if (entity.getConfig() != null) config.putAll(entity.getConfig());
        mapping.setConfig(config);
        return mapping;
    }

equals()

boolean org.keycloak.models.jpa.ClientScopeAdapter.equals ( Object  o )

inline

                                    {
        if (this == o) return true;
        if (o == null || !(o instanceof ClientScopeModel)) return false;

        ClientScopeModel that = (ClientScopeModel) o;
        return that.getId().equals(getId());
    }

getAttribute()

String org.keycloak.models.jpa.ClientScopeAdapter.getAttribute ( String  name )

inline

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

                                            {
        return entity.getAttributes().get(name);
    }

getAttributes()

Map<String, String> org.keycloak.models.jpa.ClientScopeAdapter.getAttributes ( )

inline

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

                                               {
        Map<String, String> copy = new HashMap<>();
        copy.putAll(entity.getAttributes());
        return copy;
    }

getConsentScreenText()

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

inlineinherited

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

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

getDescription()

String org.keycloak.models.jpa.ClientScopeAdapter.getDescription ( )

inline

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

{ return entity.getDescription(); }

getEntity()

ClientScopeEntity org.keycloak.models.jpa.ClientScopeAdapter.getEntity ( )

inline

                                         {
        return entity;
    }

getGuiOrder()

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

inlineinherited

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

                                 {
        return getAttribute(GUI_ORDER);
    }

getId()

String org.keycloak.models.jpa.ClientScopeAdapter.getId ( )

inline

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

                          {
        return entity.getId();
    }

getName()

String org.keycloak.models.jpa.ClientScopeAdapter.getName ( )

inline

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

                            {
        return entity.getName();
    }

getProtocol()

String org.keycloak.models.jpa.ClientScopeAdapter.getProtocol ( )

inline

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

                                {
        return entity.getProtocol();
    }

getProtocolMapperById()

ProtocolMapperModel org.keycloak.models.jpa.ClientScopeAdapter.getProtocolMapperById ( String  id )

inline

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

                                                                {
        ProtocolMapperEntity entity = getProtocolMapperEntity(id);
        if (entity == null) return null;
        return entityToModel(entity);
    }

getProtocolMapperByName()

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

inline

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

                                                                                     {
        ProtocolMapperEntity entity = getProtocolMapperEntityByName(protocol, name);
        if (entity == null) return null;
        return entityToModel(entity);
    }

getProtocolMapperEntity()

ProtocolMapperEntity org.keycloak.models.jpa.ClientScopeAdapter.getProtocolMapperEntity ( String  id )

inlineprotected

                                                                      {
        for (ProtocolMapperEntity entity : this.entity.getProtocolMappers()) {
            if (entity.getId().equals(id)) {
                return entity;
            }
        }
        return null;

    }

getProtocolMapperEntityByName()

ProtocolMapperEntity org.keycloak.models.jpa.ClientScopeAdapter.getProtocolMapperEntityByName ( String  protocol, String  name  )

inlineprotected

                                                                                               {
        for (ProtocolMapperEntity entity : this.entity.getProtocolMappers()) {
            if (entity.getProtocol().equals(protocol) && entity.getName().equals(name)) {
                return entity;
            }
        }
        return null;

    }

getProtocolMappers()

Set<ProtocolMapperModel> org.keycloak.models.jpa.ClientScopeAdapter.getProtocolMappers ( )

inline

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

                                                         {
        Set<ProtocolMapperModel> mappings = new HashSet<ProtocolMapperModel>();
        for (ProtocolMapperEntity entity : this.entity.getProtocolMappers()) {
            ProtocolMapperModel mapping = new ProtocolMapperModel();
            mapping.setId(entity.getId());
            mapping.setName(entity.getName());
            mapping.setProtocol(entity.getProtocol());
            mapping.setProtocolMapper(entity.getProtocolMapper());
            Map<String, String> config = new HashMap<String, String>();
            if (entity.getConfig() != null) {
                config.putAll(entity.getConfig());
            }
            mapping.setConfig(config);
            mappings.add(mapping);
        }
        return mappings;
    }

getRealm()

RealmModel org.keycloak.models.jpa.ClientScopeAdapter.getRealm ( )

inline

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

                                 {
        return realm;
    }

getRealmScopeMappingQuery()

TypedQuery<ClientScopeRoleMappingEntity> org.keycloak.models.jpa.ClientScopeAdapter.getRealmScopeMappingQuery ( RoleModel  role )

inlineprotected

                                                                                                 {
        TypedQuery<ClientScopeRoleMappingEntity> query = em.createNamedQuery("clientScopeHasRole", ClientScopeRoleMappingEntity.class);
        query.setParameter("clientScope", getEntity());
        RoleEntity roleEntity = RoleAdapter.toRoleEntity(role, em);
        query.setParameter("role", roleEntity);
        return query;
    }

getRealmScopeMappings()

Set<RoleModel> org.keycloak.models.jpa.ClientScopeAdapter.getRealmScopeMappings ( )

inline

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

                                                  {
        Set<RoleModel> roleMappings = getScopeMappings();

        Set<RoleModel> appRoles = new HashSet<>();
        for (RoleModel role : roleMappings) {
            RoleContainerModel container = role.getContainer();
            if (container instanceof RealmModel) {
                if (container.getId().equals(realm.getId())) {
                    appRoles.add(role);
                }
            }
        }

        return appRoles;
    }

getScopeMappings()

Set<RoleModel> org.keycloak.models.jpa.ClientScopeAdapter.getScopeMappings ( )

inline

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

                                             {
        TypedQuery<String> query = em.createNamedQuery("clientScopeRoleMappingIds", String.class);
        query.setParameter("clientScope", getEntity());
        List<String> ids = query.getResultList();
        Set<RoleModel> roles = new HashSet<RoleModel>();
        for (String roleId : ids) {
            RoleModel role = realm.getRoleById(roleId);
            if (role == null) continue;
            roles.add(role);
        }
        return roles;
    }

hashCode()

int org.keycloak.models.jpa.ClientScopeAdapter.hashCode ( )

inline

                          {
        return getId().hashCode();
    }

hasScope()

boolean org.keycloak.models.jpa.ClientScopeAdapter.hasScope ( RoleModel  role )

inline

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

                                            {
        Set<RoleModel> roles = getScopeMappings();
        if (roles.contains(role)) return true;

        for (RoleModel mapping : roles) {
            if (mapping.hasRole(role)) return true;
        }
        return false;
    }

isDisplayOnConsentScreen()

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

inlineinherited

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

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

removeAttribute()

void org.keycloak.models.jpa.ClientScopeAdapter.removeAttribute ( String  name )

inline

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

                                             {
        entity.getAttributes().remove(name);
    }

removeProtocolMapper()

void org.keycloak.models.jpa.ClientScopeAdapter.removeProtocolMapper ( ProtocolMapperModel  mapping )

inline

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

                                                                  {
        ProtocolMapperEntity toDelete = getProtocolMapperEntity(mapping.getId());
        if (toDelete != null) {
            session.users().preRemove(mapping);

            this.entity.getProtocolMappers().remove(toDelete);
            em.remove(toDelete);
        }

    }

setAttribute()

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

inline

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

                                                        {
        entity.getAttributes().put(name, value);

    }

setConsentScreenText()

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

inlineinherited

                                                                {
        setAttribute(CONSENT_SCREEN_TEXT, consentScreenText);
    }

setDescription()

void org.keycloak.models.jpa.ClientScopeAdapter.setDescription ( String  description )

inline

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

{ entity.setDescription(description); }

setDisplayOnConsentScreen()

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

inlineinherited

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

setGuiOrder()

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

inlineinherited

                                              {
        setAttribute(GUI_ORDER, guiOrder);
    }

setName()

void org.keycloak.models.jpa.ClientScopeAdapter.setName ( String  name )

inline

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

                                     {
        name = KeycloakModelUtils.convertClientScopeName(name);
        entity.setName(name);
    }

setProtocol()

void org.keycloak.models.jpa.ClientScopeAdapter.setProtocol ( String  protocol )

inline

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

                                             {
        entity.setProtocol(protocol);

    }

toClientScopeEntity()

static ClientScopeEntity org.keycloak.models.jpa.ClientScopeAdapter.toClientScopeEntity ( ClientScopeModel  model, EntityManager  em  )

inlinestatic

                                                                                                  {
        if (model instanceof ClientScopeAdapter) {
            return ((ClientScopeAdapter)model).getEntity();
        }
        return em.getReference(ClientScopeEntity.class, model.getId());
    }

updateProtocolMapper()

void org.keycloak.models.jpa.ClientScopeAdapter.updateProtocolMapper ( ProtocolMapperModel  mapping )

inline

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

                                                                  {
        ProtocolMapperEntity entity = getProtocolMapperEntity(mapping.getId());
        entity.setProtocolMapper(mapping.getProtocolMapper());
        if (entity.getConfig() == null) {
            entity.setConfig(mapping.getConfig());
        } else {
            entity.getConfig().clear();
            entity.getConfig().putAll(mapping.getConfig());
        }
        em.flush();

    }

メンバ詳解

CONSENT_SCREEN_TEXT

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

inherited

DISPLAY_ON_CONSENT_SCREEN

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

inherited

em

EntityManager org.keycloak.models.jpa.ClientScopeAdapter.em

protected

entity

ClientScopeEntity org.keycloak.models.jpa.ClientScopeAdapter.entity

protected

GUI_ORDER

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

inherited

realm

RealmModel org.keycloak.models.jpa.ClientScopeAdapter.realm

protected

session

KeycloakSession org.keycloak.models.jpa.ClientScopeAdapter.session

protected

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/models/jpa/ClientScopeAdapter.java