org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy クラス

org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy の継承関係図

org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy 連携図

公開メンバ関数
	ProtocolMappersClientRegistrationPolicy (KeycloakSession session, ComponentModel componentModel)
void	beforeRegister (ClientRegistrationContext context) throws ClientRegistrationPolicyException
void	afterRegister (ClientRegistrationContext context, ClientModel clientModel)
void	beforeUpdate (ClientRegistrationContext context, ClientModel clientModel) throws ClientRegistrationPolicyException
void	afterUpdate (ClientRegistrationContext context, ClientModel clientModel)
void	beforeView (ClientRegistrationProvider provider, ClientModel clientModel) throws ClientRegistrationPolicyException
void	beforeDelete (ClientRegistrationProvider provider, ClientModel clientModel) throws ClientRegistrationPolicyException
default void	close ()

限定公開メンバ関数
void	testMappers (ClientRegistrationContext context) throws ClientRegistrationPolicyException

非公開メンバ関数
List< String >	getAllowedMapperProviders ()

非公開変数類
final KeycloakSession	session
final ComponentModel	componentModel

静的非公開変数類
static final Logger	logger = Logger.getLogger(ProtocolMappersClientRegistrationPolicy.class)

詳解

著者

Marek Posolda

構築子と解体子

ProtocolMappersClientRegistrationPolicy()

org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.ProtocolMappersClientRegistrationPolicy ( KeycloakSession  session, ComponentModel  componentModel  )

inline

                                                                                                           {
        this.session = session;
        this.componentModel = componentModel;
    }

関数詳解

afterRegister()

void org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.afterRegister ( ClientRegistrationContext  context, ClientModel  clientModel  )

inline

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyを実装しています。

                                                                                          {
        // Remove mappers of unsupported type, which were added "automatically"
        List<String> allowedMapperProviders = getAllowedMapperProviders();
        Set<ProtocolMapperModel> createdMappers = clientModel.getProtocolMappers();

        createdMappers.stream().filter((ProtocolMapperModel mapper) -> {

            return !allowedMapperProviders.contains(mapper.getProtocolMapper());

        }).forEach((ProtocolMapperModel mapperToRemove) -> {

            logger.debugf("Removing builtin mapper '%s' of type '%s' as type is not permitted", mapperToRemove.getName(), mapperToRemove.getProtocolMapper());
            clientModel.removeProtocolMapper(mapperToRemove);

        });

    }

afterUpdate()

void org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.afterUpdate ( ClientRegistrationContext  context, ClientModel  clientModel  )

inline

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyを実装しています。

                                                                                        {
    }

beforeDelete()

void org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.beforeDelete ( ClientRegistrationProvider  provider, ClientModel  clientModel  ) throws ClientRegistrationPolicyException

inline

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyを実装しています。

                                                                                                                                    {

    }

beforeRegister()

void org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.beforeRegister ( ClientRegistrationContext  context ) throws ClientRegistrationPolicyException

inline

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyを実装しています。

                                                                                                           {
        testMappers(context);
    }

beforeUpdate()

void org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.beforeUpdate ( ClientRegistrationContext  context, ClientModel  clientModel  ) throws ClientRegistrationPolicyException

inline

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyを実装しています。

                                                                                                                                  {
        testMappers(context);
    }

beforeView()

void org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.beforeView ( ClientRegistrationProvider  provider, ClientModel  clientModel  ) throws ClientRegistrationPolicyException

inline

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyを実装しています。

                                                                                                                                  {

    }

close()

default void org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy.close ( )

inlineinherited

org.keycloak.provider.Providerを実装しています。

                         {
    }

getAllowedMapperProviders()

List<String> org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.getAllowedMapperProviders ( )

inlineprivate

                                                     {
        return componentModel.getConfig().getList(ProtocolMappersClientRegistrationPolicyFactory.ALLOWED_PROTOCOL_MAPPER_TYPES);
    }

testMappers()

void org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.testMappers ( ClientRegistrationContext  context ) throws ClientRegistrationPolicyException

inlineprotected

                                                                                                           {
        List<ProtocolMapperRepresentation> protocolMappers = context.getClient().getProtocolMappers();
        if (protocolMappers == null) {
            return;
        }

        List<String> allowedMapperProviders = getAllowedMapperProviders();

        for (ProtocolMapperRepresentation mapper : protocolMappers) {
            String mapperType = mapper.getProtocolMapper();

            if (!allowedMapperProviders.contains(mapperType)) {
                ServicesLogger.LOGGER.clientRegistrationMapperNotAllowed(mapper.getName(), mapperType);
                throw new ClientRegistrationPolicyException("ProtocolMapper type not allowed");
            }
        }
    }

メンバ詳解

componentModel

final ComponentModel org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.componentModel

private

logger

final Logger org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.logger = Logger.getLogger(ProtocolMappersClientRegistrationPolicy.class)

staticprivate

session

final KeycloakSession org.keycloak.services.clientregistration.policy.impl.ProtocolMappersClientRegistrationPolicy.session

private

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/services/clientregistration/policy/impl/ProtocolMappersClientRegistrationPolicy.java