org.keycloak.services.resources.admin.ProtocolMappersResource クラス

org.keycloak.services.resources.admin.ProtocolMappersResource 連携図

公開メンバ関数
	ProtocolMappersResource (RealmModel realm, ProtocolMapperContainerModel client, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission)
List< ProtocolMapperRepresentation >	getMappersPerProtocol (@PathParam("protocol") String protocol)
Response	createMapper (ProtocolMapperRepresentation rep)
void	createMapper (List< ProtocolMapperRepresentation > reps)
List< ProtocolMapperRepresentation >	getMappers ()
ProtocolMapperRepresentation	getMapperById (@PathParam("id") String id)
void	update (@PathParam("id") String id, ProtocolMapperRepresentation rep)
void	delete (@PathParam("id") String id)

限定公開変数類
RealmModel	realm
ProtocolMapperContainerModel	client
AdminPermissionEvaluator	auth
AdminPermissionEvaluator.RequirePermissionCheck	managePermission
AdminPermissionEvaluator.RequirePermissionCheck	viewPermission
AdminEventBuilder	adminEvent
KeycloakSession	session

静的限定公開変数類
static final Logger	logger = Logger.getLogger(ProtocolMappersResource.class)

非公開メンバ関数
void	validateModel (ProtocolMapperModel model)

詳解

Base resource for managing users

Protocol Mappers

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

ProtocolMappersResource()

org.keycloak.services.resources.admin.ProtocolMappersResource.ProtocolMappersResource ( RealmModel  realm, ProtocolMapperContainerModel  client, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent, AdminPermissionEvaluator.RequirePermissionCheck  managePermission, AdminPermissionEvaluator.RequirePermissionCheck  viewPermission  )

inline

                                                                                                   {
        this.realm = realm;
        this.auth = auth;
        this.client = client;
        this.adminEvent = adminEvent.resource(ResourceType.PROTOCOL_MAPPER);
        this.managePermission = managePermission;
        this.viewPermission = viewPermission;

    }

関数詳解

createMapper() [1/2]

Response org.keycloak.services.resources.admin.ProtocolMappersResource.createMapper ( ProtocolMapperRepresentation  rep )

inline

Create a mapper

引数

rep

                                                                   {
        managePermission.require();

        ProtocolMapperModel model = null;
        try {
            model = RepresentationToModel.toModel(rep);
            validateModel(model);
            model = client.addProtocolMapper(model);
            adminEvent.operation(OperationType.CREATE).resourcePath(session.getContext().getUri(), model.getId()).representation(rep).success();

        } catch (ModelDuplicateException e) {
            return ErrorResponse.exists("Protocol mapper exists with same name");
        }

        return Response.created(session.getContext().getUri().getAbsolutePathBuilder().path(model.getId()).build()).build();
    }

createMapper() [2/2]

void org.keycloak.services.resources.admin.ProtocolMappersResource.createMapper ( List< ProtocolMapperRepresentation >  reps )

inline

Create multiple mappers

                                                                      {
        managePermission.require();

        ProtocolMapperModel model = null;
        for (ProtocolMapperRepresentation rep : reps) {
            model = RepresentationToModel.toModel(rep);
            validateModel(model);
            model = client.addProtocolMapper(model);
        }
        adminEvent.operation(OperationType.CREATE).resourcePath(session.getContext().getUri()).representation(reps).success();
    }

delete()

void org.keycloak.services.resources.admin.ProtocolMappersResource.delete ( @PathParam("id") String  id )

inline

Delete the mapper

引数

id

Mapper id

                                                   {
        managePermission.require();

        ProtocolMapperModel model = client.getProtocolMapperById(id);
        if (model == null) throw new NotFoundException("Model not found");
        client.removeProtocolMapper(model);
        adminEvent.operation(OperationType.DELETE).resourcePath(session.getContext().getUri()).success();

    }

getMapperById()

ProtocolMapperRepresentation org.keycloak.services.resources.admin.ProtocolMappersResource.getMapperById ( @PathParam("id") String  id )

inline

Get mapper by id

引数

id

Mapper id

戻り値

                                                                                  {
        viewPermission.require();

        ProtocolMapperModel model = client.getProtocolMapperById(id);
        if (model == null) throw new NotFoundException("Model not found");
        return ModelToRepresentation.toRepresentation(model);
    }

getMappers()

List<ProtocolMapperRepresentation> org.keycloak.services.resources.admin.ProtocolMappersResource.getMappers ( )

inline

Get mappers

戻り値

                                                           {
        viewPermission.require();

        List<ProtocolMapperRepresentation> mappers = new LinkedList<ProtocolMapperRepresentation>();
        for (ProtocolMapperModel mapper : client.getProtocolMappers()) {
            mappers.add(ModelToRepresentation.toRepresentation(mapper));
        }
        return mappers;
    }

getMappersPerProtocol()

List<ProtocolMapperRepresentation> org.keycloak.services.resources.admin.ProtocolMappersResource.getMappersPerProtocol ( @PathParam("protocol") String  protocol )

inline

Get mappers by name for a specific protocol

引数

protocol

戻り値

                                                                                                            {
        viewPermission.require();

        List<ProtocolMapperRepresentation> mappers = new LinkedList<ProtocolMapperRepresentation>();
        for (ProtocolMapperModel mapper : client.getProtocolMappers()) {
            if (mapper.getProtocol().equals(protocol)) mappers.add(ModelToRepresentation.toRepresentation(mapper));
        }
        return mappers;
    }

update()

void org.keycloak.services.resources.admin.ProtocolMappersResource.update ( @PathParam("id") String  id, ProtocolMapperRepresentation  rep  )

inline

Update the mapper

引数

id	Mapper id
rep

                                                                                     {
        managePermission.require();

        ProtocolMapperModel model = client.getProtocolMapperById(id);
        if (model == null) throw new NotFoundException("Model not found");
        model = RepresentationToModel.toModel(rep);

        validateModel(model);

        client.updateProtocolMapper(model);
        adminEvent.operation(OperationType.UPDATE).resourcePath(session.getContext().getUri()).representation(rep).success();
    }

validateModel()

void org.keycloak.services.resources.admin.ProtocolMappersResource.validateModel ( ProtocolMapperModel  model )

inlineprivate

                                                          {
        try {
            ProtocolMapper mapper = (ProtocolMapper)session.getKeycloakSessionFactory().getProviderFactory(ProtocolMapper.class, model.getProtocolMapper());
            if (mapper != null) {
                mapper.validateConfig(session, realm, client, model);
            } else {
                throw new NotFoundException("ProtocolMapper provider not found");
            }
        } catch (ProtocolMapperConfigException ex) {
            logger.error(ex.getMessage());
            Properties messages = AdminRoot.getMessages(session, realm, auth.adminAuth().getToken().getLocale());
            throw new ErrorResponseException(ex.getMessage(), MessageFormat.format(messages.getProperty(ex.getMessageKey(), ex.getMessage()), ex.getParameters()),
                    Response.Status.BAD_REQUEST);
        }
    }

メンバ詳解

adminEvent

AdminEventBuilder org.keycloak.services.resources.admin.ProtocolMappersResource.adminEvent

protected

auth

AdminPermissionEvaluator org.keycloak.services.resources.admin.ProtocolMappersResource.auth

protected

client

ProtocolMapperContainerModel org.keycloak.services.resources.admin.ProtocolMappersResource.client

protected

logger

final Logger org.keycloak.services.resources.admin.ProtocolMappersResource.logger = Logger.getLogger(ProtocolMappersResource.class)

staticprotected

managePermission

AdminPermissionEvaluator.RequirePermissionCheck org.keycloak.services.resources.admin.ProtocolMappersResource.managePermission

protected

realm

RealmModel org.keycloak.services.resources.admin.ProtocolMappersResource.realm

protected

session

KeycloakSession org.keycloak.services.resources.admin.ProtocolMappersResource.session

protected

viewPermission

AdminPermissionEvaluator.RequirePermissionCheck org.keycloak.services.resources.admin.ProtocolMappersResource.viewPermission

protected

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/services/resources/admin/ProtocolMappersResource.java