org.keycloak.exportimport.util.MultipleStepsExportProvider クラス

org.keycloak.exportimport.util.MultipleStepsExportProvider の継承関係図

org.keycloak.exportimport.util.MultipleStepsExportProvider 連携図

クラス
class	FederatedUsersHolder
class	RealmsHolder
class	UsersHolder

公開メンバ関数
void	exportModel (KeycloakSessionFactory factory) throws IOException
void	exportRealm (KeycloakSessionFactory factory, String realmName) throws IOException

限定公開メンバ関数
void	exportRealmImpl (KeycloakSessionFactory factory, final String realmName) throws IOException
abstract void	writeRealm (String fileName, RealmRepresentation rep) throws IOException
abstract void	writeUsers (String fileName, KeycloakSession session, RealmModel realm, List< UserModel > users) throws IOException
abstract void	writeFederatedUsers (String fileName, KeycloakSession session, RealmModel realm, List< String > users) throws IOException

限定公開変数類
final Logger	logger = Logger.getLogger(getClass())

詳解

著者

Marek Posolda

関数詳解

exportModel()

void org.keycloak.exportimport.util.MultipleStepsExportProvider.exportModel ( KeycloakSessionFactory  factory ) throws IOException

inline

                                                                               {
        final RealmsHolder holder = new RealmsHolder();

        KeycloakModelUtils.runJobInTransaction(factory, new KeycloakSessionTask() {

            @Override
            public void run(KeycloakSession session) {
                List<RealmModel> realms = session.realms().getRealms();
                holder.realms = realms;
            }

        });

        for (RealmModel realm : holder.realms) {
            exportRealmImpl(factory, realm.getName());
        }
    }

exportRealm()

void org.keycloak.exportimport.util.MultipleStepsExportProvider.exportRealm ( KeycloakSessionFactory  factory, String  realmName  ) throws IOException

inline

                                                                                                 {
        exportRealmImpl(factory, realmName);
    }

exportRealmImpl()

void org.keycloak.exportimport.util.MultipleStepsExportProvider.exportRealmImpl ( KeycloakSessionFactory  factory, final String  realmName  ) throws IOException

inlineprotected

                                                                                                              {
        final UsersExportStrategy usersExportStrategy = ExportImportConfig.getUsersExportStrategy();
        final int usersPerFile = ExportImportConfig.getUsersPerFile();
        final UsersHolder usersHolder = new UsersHolder();
        final boolean exportUsersIntoRealmFile = usersExportStrategy == UsersExportStrategy.REALM_FILE;
        FederatedUsersHolder federatedUsersHolder = new FederatedUsersHolder();

        KeycloakModelUtils.runJobInTransaction(factory, new ExportImportSessionTask() {

            @Override
            protected void runExportImportTask(KeycloakSession session) throws IOException {
                RealmModel realm = session.realms().getRealmByName(realmName);
                RealmRepresentation rep = ExportUtils.exportRealm(session, realm, exportUsersIntoRealmFile, true);
                writeRealm(realmName + "-realm.json", rep);
                logger.info("Realm '" + realmName + "' - data exported");

                // Count total number of users
                if (!exportUsersIntoRealmFile) {
                    usersHolder.totalCount = session.users().getUsersCount(realm, true);
                    federatedUsersHolder.totalCount = session.userFederatedStorage().getStoredUsersCount(realm);
                }
            }

        });

        if (usersExportStrategy != UsersExportStrategy.SKIP && !exportUsersIntoRealmFile) {
            // We need to export users now
            usersHolder.currentPageStart = 0;

            // usersExportStrategy==SAME_FILE  means exporting all users into single file (but separate to realm)
            final int countPerPage = (usersExportStrategy == UsersExportStrategy.SAME_FILE) ? usersHolder.totalCount : usersPerFile;

            while (usersHolder.currentPageStart < usersHolder.totalCount) {
                if (usersHolder.currentPageStart + countPerPage < usersHolder.totalCount) {
                    usersHolder.currentPageEnd = usersHolder.currentPageStart + countPerPage;
                } else {
                    usersHolder.currentPageEnd = usersHolder.totalCount;
                }

                KeycloakModelUtils.runJobInTransaction(factory, new ExportImportSessionTask() {

                    @Override
                    protected void runExportImportTask(KeycloakSession session) throws IOException {
                        RealmModel realm = session.realms().getRealmByName(realmName);
                        usersHolder.users = session.users().getUsers(realm, usersHolder.currentPageStart, usersHolder.currentPageEnd - usersHolder.currentPageStart, true);

                        writeUsers(realmName + "-users-" + (usersHolder.currentPageStart / countPerPage) + ".json", session, realm, usersHolder.users);

                        logger.info("Users " + usersHolder.currentPageStart + "-" + (usersHolder.currentPageEnd -1) + " exported");
                    }

                });

                usersHolder.currentPageStart = usersHolder.currentPageEnd;
            }
        }
        if (usersExportStrategy != UsersExportStrategy.SKIP && !exportUsersIntoRealmFile) {
            // We need to export users now
            federatedUsersHolder.currentPageStart = 0;

            // usersExportStrategy==SAME_FILE  means exporting all users into single file (but separate to realm)
            final int countPerPage = (usersExportStrategy == UsersExportStrategy.SAME_FILE) ? federatedUsersHolder.totalCount : usersPerFile;

            while (federatedUsersHolder.currentPageStart < federatedUsersHolder.totalCount) {
                if (federatedUsersHolder.currentPageStart + countPerPage < federatedUsersHolder.totalCount) {
                    federatedUsersHolder.currentPageEnd = federatedUsersHolder.currentPageStart + countPerPage;
                } else {
                    federatedUsersHolder.currentPageEnd = federatedUsersHolder.totalCount;
                }

                KeycloakModelUtils.runJobInTransaction(factory, new ExportImportSessionTask() {

                    @Override
                    protected void runExportImportTask(KeycloakSession session) throws IOException {
                        RealmModel realm = session.realms().getRealmByName(realmName);
                        federatedUsersHolder.users = session.userFederatedStorage().getStoredUsers(realm, federatedUsersHolder.currentPageStart, federatedUsersHolder.currentPageEnd - federatedUsersHolder.currentPageStart);

                        writeFederatedUsers(realmName + "-federated-users-" + (federatedUsersHolder.currentPageStart / countPerPage) + ".json", session, realm, federatedUsersHolder.users);

                        logger.info("Users " + federatedUsersHolder.currentPageStart + "-" + (federatedUsersHolder.currentPageEnd -1) + " exported");
                    }

                });

                federatedUsersHolder.currentPageStart = federatedUsersHolder.currentPageEnd;
            }
        }
    }

writeFederatedUsers()

abstract void org.keycloak.exportimport.util.MultipleStepsExportProvider.writeFederatedUsers ( String  fileName, KeycloakSession  session, RealmModel  realm, List< String >  users  ) throws IOException

abstractprotected

writeRealm()

abstract void org.keycloak.exportimport.util.MultipleStepsExportProvider.writeRealm ( String  fileName, RealmRepresentation  rep  ) throws IOException

abstractprotected

writeUsers()

abstract void org.keycloak.exportimport.util.MultipleStepsExportProvider.writeUsers ( String  fileName, KeycloakSession  session, RealmModel  realm, List< UserModel >  users  ) throws IOException

abstractprotected

メンバ詳解

logger

final Logger org.keycloak.exportimport.util.MultipleStepsExportProvider.logger = Logger.getLogger(getClass())

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/exportimport/util/MultipleStepsExportProvider.java