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

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

公開メンバ関数
	UserStorageProviderResource (RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
Map< String, String >	getSimpleName (@PathParam("id") String id)
SynchronizationResult	syncUsers (@PathParam("id") String id, @QueryParam("action") String action)
void	removeImportedUsers (@PathParam("id") String id)
void	unlinkUsers (@PathParam("id") String id)
SynchronizationResult	syncMapperData (@PathParam("parentId") String parentId, @PathParam("id") String mapperId, @QueryParam("direction") String direction)

限定公開変数類
RealmModel	realm
AdminPermissionEvaluator	auth
AdminEventBuilder	adminEvent
ClientConnection	clientConnection
KeycloakSession	session
HttpHeaders	headers

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

詳解

User Storage Provider

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

UserStorageProviderResource()

org.keycloak.services.resources.admin.UserStorageProviderResource.UserStorageProviderResource ( RealmModel  realm, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

                                                                                                                      {
        this.auth = auth;
        this.realm = realm;
        this.adminEvent = adminEvent;
    }

関数詳解

getSimpleName()

Map<String, String> org.keycloak.services.resources.admin.UserStorageProviderResource.getSimpleName ( @PathParam("id") String  id )

inline

Need this for admin console to display simple name of provider when displaying user detail

KEYCLOAK-4328

引数

id

戻り値

                                                                         {
        auth.users().requireQuery();

        ComponentModel model = realm.getComponent(id);
        if (model == null) {
            throw new NotFoundException("Could not find component");
        }
        if (!model.getProviderType().equals(UserStorageProvider.class.getName())) {
            throw new NotFoundException("found, but not a UserStorageProvider");
        }

        Map<String, String> data = new HashMap<>();
        data.put("id", model.getId());
        data.put("name", model.getName());
        return data;
    }

removeImportedUsers()

void org.keycloak.services.resources.admin.UserStorageProviderResource.removeImportedUsers ( @PathParam("id") String  id )

inline

Remove imported users

引数

id

戻り値

                                                                {
        auth.users().requireManage();

        ComponentModel model = realm.getComponent(id);
        if (model == null) {
            throw new NotFoundException("Could not find component");
        }
        if (!model.getProviderType().equals(UserStorageProvider.class.getName())) {
            throw new NotFoundException("found, but not a UserStorageProvider");
        }

        session.users().removeImportedUsers(realm, id);
    }

syncMapperData()

SynchronizationResult org.keycloak.services.resources.admin.UserStorageProviderResource.syncMapperData ( @PathParam("parentId") String  parentId, @PathParam("id") String  mapperId, @QueryParam("direction") String  direction  )

inline

Trigger sync of mapper data related to ldap mapper (roles, groups, ...)

direction is "fedToKeycloak" or "keycloakToFed"

戻り値

                                                                                                                                                                     {
        auth.users().requireManage();

        ComponentModel parentModel = realm.getComponent(parentId);
        if (parentModel == null) throw new NotFoundException("Parent model not found");
        ComponentModel mapperModel = realm.getComponent(mapperId);
        if (mapperModel == null) throw new NotFoundException("Mapper model not found");

        LDAPStorageProvider ldapProvider = (LDAPStorageProvider) session.getProvider(UserStorageProvider.class, parentModel);
        LDAPStorageMapper mapper = session.getProvider(LDAPStorageMapper.class, mapperModel);

        ServicesLogger.LOGGER.syncingDataForMapper(mapperModel.getName(), mapperModel.getProviderId(), direction);

        SynchronizationResult syncResult;
        if ("fedToKeycloak".equals(direction)) {
            syncResult = mapper.syncDataFromFederationProviderToKeycloak(realm);
        } else if ("keycloakToFed".equals(direction)) {
            syncResult = mapper.syncDataFromKeycloakToFederationProvider(realm);
        } else {
            throw new BadRequestException("Unknown direction: " + direction);
        }

        Map<String, Object> eventRep = new HashMap<>();
        eventRep.put("action", direction);
        eventRep.put("result", syncResult);
        adminEvent.operation(OperationType.ACTION).resourcePath(session.getContext().getUri()).representation(eventRep).success();
        return syncResult;
    }

syncUsers()

SynchronizationResult org.keycloak.services.resources.admin.UserStorageProviderResource.syncUsers ( @PathParam("id") String  id, @QueryParam("action") String  action  )

inline

Trigger sync of users

Action can be "triggerFullSync" or "triggerChangedUsersSync"

引数

id
action

戻り値

                                                                                {
        auth.users().requireManage();

        ComponentModel model = realm.getComponent(id);
        if (model == null) {
            throw new NotFoundException("Could not find component");
        }
        if (!model.getProviderType().equals(UserStorageProvider.class.getName())) {
            throw new NotFoundException("found, but not a UserStorageProvider");
        }

        UserStorageProviderModel providerModel = new UserStorageProviderModel(model);



        logger.debug("Syncing users");

        UserStorageSyncManager syncManager = new UserStorageSyncManager();
        SynchronizationResult syncResult;
        if ("triggerFullSync".equals(action)) {
            syncResult = syncManager.syncAllUsers(session.getKeycloakSessionFactory(), realm.getId(), providerModel);
        } else if ("triggerChangedUsersSync".equals(action)) {
            syncResult = syncManager.syncChangedUsers(session.getKeycloakSessionFactory(), realm.getId(), providerModel);
        } else {
            throw new NotFoundException("Unknown action: " + action);
        }

        Map<String, Object> eventRep = new HashMap<>();
        eventRep.put("action", action);
        eventRep.put("result", syncResult);
        adminEvent.operation(OperationType.ACTION).resourcePath(session.getContext().getUri()).representation(eventRep).success();

        return syncResult;
    }

unlinkUsers()

void org.keycloak.services.resources.admin.UserStorageProviderResource.unlinkUsers ( @PathParam("id") String  id )

inline

Unlink imported users from a storage provider

引数

id

戻り値

                                                        {
        auth.users().requireManage();

        ComponentModel model = realm.getComponent(id);
        if (model == null) {
            throw new NotFoundException("Could not find component");
        }
        if (!model.getProviderType().equals(UserStorageProvider.class.getName())) {
            throw new NotFoundException("found, but not a UserStorageProvider");
        }

        session.users().unlinkUsers(realm, id);
    }

メンバ詳解

adminEvent

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

protected

auth

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

protected

clientConnection

ClientConnection org.keycloak.services.resources.admin.UserStorageProviderResource.clientConnection

protected

headers

HttpHeaders org.keycloak.services.resources.admin.UserStorageProviderResource.headers

protected

logger

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

staticprivate

realm

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

protected

session

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

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/resources/admin/UserStorageProviderResource.java