org.keycloak.partialimport.UsersPartialImport クラス

org.keycloak.partialimport.UsersPartialImport の継承関係図

org.keycloak.partialimport.UsersPartialImport 連携図

公開メンバ関数
List< UserRepresentation >	getRepList (PartialImportRepresentation partialImportRep)
String	getName (UserRepresentation user)
String	getModelId (RealmModel realm, KeycloakSession session, UserRepresentation user)
boolean	exists (RealmModel realm, KeycloakSession session, UserRepresentation user)
String	existsMessage (RealmModel realm, UserRepresentation user)
ResourceType	getResourceType ()
void	remove (RealmModel realm, KeycloakSession session, UserRepresentation user)
void	create (RealmModel realm, KeycloakSession session, UserRepresentation user)
abstract String	getName (T resourceRep)
abstract String	getModelId (RealmModel realm, KeycloakSession session, T resourceRep)
abstract boolean	exists (RealmModel realm, KeycloakSession session, T resourceRep)
abstract String	existsMessage (RealmModel realm, T resourceRep)
abstract void	remove (RealmModel realm, KeycloakSession session, T resourceRep)
abstract void	create (RealmModel realm, KeycloakSession session, T resourceRep)
void	prepare (PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) throws ErrorResponseException
void	removeOverwrites (RealmModel realm, KeycloakSession session)
PartialImportResults	doImport (PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) throws ErrorResponseException

限定公開メンバ関数
ErrorResponseException	existsError (String message)
PartialImportResult	overwritten (String modelId, T resourceRep)
PartialImportResult	skipped (String modelId, T resourceRep)
PartialImportResult	added (String modelId, T resourceRep)

限定公開変数類
final Set< T >	toOverwrite
final Set< T >	toSkip

非公開メンバ関数
boolean	userNameExists (RealmModel realm, KeycloakSession session, UserRepresentation user)
boolean	userEmailExists (RealmModel realm, KeycloakSession session, UserRepresentation user)

非公開変数類
final Map< String, String >	createdIds = new HashMap<>()

詳解

PartialImport handler for users.

著者

Stan Silvert ssilv.nosp@m.ert@.nosp@m.redha.nosp@m.t.co.nosp@m.m (C) 2016 Red Hat Inc.

関数詳解

added()

PartialImportResult org.keycloak.partialimport.AbstractPartialImport< T >.added ( String  modelId, T  resourceRep  )

inlineprotectedinherited

                                                                       {
        return PartialImportResult.added(getResourceType(), getName(resourceRep), modelId, resourceRep);
    }

create() [1/2]

abstract void org.keycloak.partialimport.AbstractPartialImport< T >.create ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

create() [2/2]

void org.keycloak.partialimport.UsersPartialImport.create ( RealmModel  realm, KeycloakSession  session, UserRepresentation  user  )

inline

                                                                                           {
        user.setId(KeycloakModelUtils.generateId());
        UserModel userModel = RepresentationToModel.createUser(session, realm, user);
        if (userModel == null) throw new RuntimeException("Unable to create user " + getName(user));
        createdIds.put(getName(user), userModel.getId());
    }

doImport()

PartialImportResults org.keycloak.partialimport.AbstractPartialImport< T >.doImport ( PartialImportRepresentation  partialImportRep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inlineinherited

                                                                                                                                                                {
        PartialImportResults results = new PartialImportResults();
        List<T> repList = getRepList(partialImportRep);
        if ((repList == null) || repList.isEmpty()) return results;

        for (T resourceRep : toOverwrite) {
            try {
                create(realm, session, resourceRep);
            } catch (Exception e) {
                ServicesLogger.LOGGER.overwriteError(e, getName(resourceRep));
                throw new ErrorResponseException(ErrorResponse.error(e.getMessage(), Response.Status.INTERNAL_SERVER_ERROR));
            }

            String modelId = getModelId(realm, session, resourceRep);
            results.addResult(overwritten(modelId, resourceRep));
        }

        for (T resourceRep : toSkip) {
            String modelId = getModelId(realm, session, resourceRep);
            results.addResult(skipped(modelId, resourceRep));
        }

        for (T resourceRep : repList) {
            if (toOverwrite.contains(resourceRep)) continue;
            if (toSkip.contains(resourceRep)) continue;

            try {
                create(realm, session, resourceRep);
                String modelId = getModelId(realm, session, resourceRep);
                results.addResult(added(modelId, resourceRep));
            } catch (Exception e) {
                ServicesLogger.LOGGER.creationError(e, getName(resourceRep));
                throw new ErrorResponseException(ErrorResponse.error(e.getMessage(), Response.Status.INTERNAL_SERVER_ERROR));
            }
        }

        return results;
    }

exists() [1/2]

abstract boolean org.keycloak.partialimport.AbstractPartialImport< T >.exists ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

exists() [2/2]

boolean org.keycloak.partialimport.UsersPartialImport.exists ( RealmModel  realm, KeycloakSession  session, UserRepresentation  user  )

inline

                                                                                              {
        return userNameExists(realm, session, user) || userEmailExists(realm, session, user);
    }

existsError()

ErrorResponseException org.keycloak.partialimport.AbstractPartialImport< T >.existsError ( String  message )

inlineprotectedinherited

                                                                 {
        Response error = ErrorResponse.exists(message);
        return new ErrorResponseException(error);
    }

existsMessage() [1/2]

abstract String org.keycloak.partialimport.AbstractPartialImport< T >.existsMessage ( RealmModel  realm, T  resourceRep  )

abstractinherited

existsMessage() [2/2]

String org.keycloak.partialimport.UsersPartialImport.existsMessage ( RealmModel  realm, UserRepresentation  user  )

inline

                                                                           {
        if (user.getEmail() == null || !realm.isDuplicateEmailsAllowed()) {
            return "User with user name " + getName(user) + " already exists.";
        }

        return "User with user name " + getName(user) + " or with email " + user.getEmail() + " already exists.";
    }

getModelId() [1/2]

abstract String org.keycloak.partialimport.AbstractPartialImport< T >.getModelId ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

getModelId() [2/2]

String org.keycloak.partialimport.UsersPartialImport.getModelId ( RealmModel  realm, KeycloakSession  session, UserRepresentation  user  )

inline

                                                                                                 {
        if (createdIds.containsKey(getName(user))) return createdIds.get(getName(user));

        String userName = user.getUsername();
        if (userName != null) {
            return session.users().getUserByUsername(userName, realm).getId();
        } else if (!realm.isDuplicateEmailsAllowed()) {
            String email = user.getEmail();
            return session.users().getUserByEmail(email, realm).getId();
        }
        
        return null;
    }

getName() [1/2]

abstract String org.keycloak.partialimport.AbstractPartialImport< T >.getName ( T  resourceRep )

abstractinherited

getName() [2/2]

String org.keycloak.partialimport.UsersPartialImport.getName ( UserRepresentation  user )

inline

                                                   {
        if (user.getUsername() != null) return user.getUsername();

        return user.getEmail();
    }

getRepList()

List<UserRepresentation> org.keycloak.partialimport.UsersPartialImport.getRepList ( PartialImportRepresentation  partialImportRep )

inline

                                                                                             {
        return partialImportRep.getUsers();
    }

getResourceType()

ResourceType org.keycloak.partialimport.UsersPartialImport.getResourceType ( )

inline

                                          {
        return ResourceType.USER;
    }

overwritten()

PartialImportResult org.keycloak.partialimport.AbstractPartialImport< T >.overwritten ( String  modelId, T  resourceRep  )

inlineprotectedinherited

                                                                            {
        return PartialImportResult.overwritten(getResourceType(), getName(resourceRep), modelId, resourceRep);
    }

prepare()

void org.keycloak.partialimport.AbstractPartialImport< T >.prepare ( PartialImportRepresentation  partialImportRep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inlineinherited

                                                                                {
        List<T> repList = getRepList(partialImportRep);
        if ((repList == null) || repList.isEmpty()) return;

        for (T resourceRep : getRepList(partialImportRep)) {
            if (exists(realm, session, resourceRep)) {
                switch (partialImportRep.getPolicy()) {
                    case SKIP: toSkip.add(resourceRep); break;
                    case OVERWRITE: toOverwrite.add(resourceRep); break;
                    default: throw existsError(existsMessage(realm, resourceRep));
                }
            }
        }
    }

remove() [1/2]

abstract void org.keycloak.partialimport.AbstractPartialImport< T >.remove ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

remove() [2/2]

void org.keycloak.partialimport.UsersPartialImport.remove ( RealmModel  realm, KeycloakSession  session, UserRepresentation  user  )

inline

                                                                                           {
        UserModel userModel = session.users().getUserByUsername(user.getUsername(), realm);
        if (userModel == null && !realm.isDuplicateEmailsAllowed()) {
            userModel = session.users().getUserByEmail(user.getEmail(), realm);
        }
        if (userModel != null) {
            boolean success = new UserManager(session).removeUser(realm, userModel);
            if (!success) throw new RuntimeException("Unable to overwrite user " + getName(user));
        }
    }

removeOverwrites()

void org.keycloak.partialimport.AbstractPartialImport< T >.removeOverwrites ( RealmModel  realm, KeycloakSession  session  )

inlineinherited

                                                                            {
        for (T resourceRep : toOverwrite) {
            remove(realm, session, resourceRep);
        }
    }

skipped()

PartialImportResult org.keycloak.partialimport.AbstractPartialImport< T >.skipped ( String  modelId, T  resourceRep  )

inlineprotectedinherited

                                                                         {
        return PartialImportResult.skipped(getResourceType(), getName(resourceRep), modelId, resourceRep);
    }

userEmailExists()

boolean org.keycloak.partialimport.UsersPartialImport.userEmailExists ( RealmModel  realm, KeycloakSession  session, UserRepresentation  user  )

inlineprivate

                                                                                                        {
        return (user.getEmail() != null) && !realm.isDuplicateEmailsAllowed() &&
               (session.users().getUserByEmail(user.getEmail(), realm) != null);
    }

userNameExists()

boolean org.keycloak.partialimport.UsersPartialImport.userNameExists ( RealmModel  realm, KeycloakSession  session, UserRepresentation  user  )

inlineprivate

                                                                                                       {
        return session.users().getUserByUsername(user.getUsername(), realm) != null;
    }

メンバ詳解

createdIds

final Map<String, String> org.keycloak.partialimport.UsersPartialImport.createdIds = new HashMap<>()

private

toOverwrite

final Set<T> org.keycloak.partialimport.AbstractPartialImport< T >.toOverwrite

protectedinherited

toSkip

final Set<T> org.keycloak.partialimport.AbstractPartialImport< T >.toSkip

protectedinherited

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/partialimport/UsersPartialImport.java