org.keycloak.exportimport.dir.DirExportProvider クラス

org.keycloak.exportimport.dir.DirExportProvider の継承関係図

org.keycloak.exportimport.dir.DirExportProvider 連携図

公開メンバ関数
	DirExportProvider ()
	DirExportProvider (File rootDirectory)
void	writeRealm (String fileName, RealmRepresentation rep) throws IOException
void	close ()
void	exportModel (KeycloakSessionFactory factory) throws IOException
void	exportRealm (KeycloakSessionFactory factory, String realmName) throws IOException

静的公開メンバ関数
static boolean	recursiveDeleteDir (File dirPath)

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

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

非公開変数類
final File	rootDirectory

詳解

著者

Marek Posolda

構築子と解体子

DirExportProvider() [1/2]

org.keycloak.exportimport.dir.DirExportProvider.DirExportProvider ( )

inline

                               {
        // Determine system tmp directory
        String tempDir = System.getProperty("java.io.tmpdir");

        this.rootDirectory = new File(tempDir + "/keycloak-export");
        this.rootDirectory.mkdirs();

        logger.infof("Exporting into directory %s", this.rootDirectory.getAbsolutePath());
    }

DirExportProvider() [2/2]

org.keycloak.exportimport.dir.DirExportProvider.DirExportProvider ( File  rootDirectory )

inline

                                                 {
        this.rootDirectory = rootDirectory;
        this.rootDirectory.mkdirs();

        logger.infof("Exporting into directory %s", this.rootDirectory.getAbsolutePath());
    }

関数詳解

close()

void org.keycloak.exportimport.dir.DirExportProvider.close ( )

inline

                        {
    }

exportModel()

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

inlineinherited

                                                                               {
        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

inlineinherited

                                                                                                 {
        exportRealmImpl(factory, realmName);
    }

exportRealmImpl()

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

inlineprotectedinherited

                                                                                                              {
        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;
            }
        }
    }

recursiveDeleteDir()

static boolean org.keycloak.exportimport.dir.DirExportProvider.recursiveDeleteDir ( File  dirPath )

inlinestatic

                                                           {
        if (dirPath.exists()) {
            File[] files = dirPath.listFiles();
            for (int i = 0; i < files.length; i++) {
                if (files[i].isDirectory()) {
                    recursiveDeleteDir(files[i]);
                } else {
                    files[i].delete();
                }
            }
        }
        if (dirPath.exists())
            return dirPath.delete();
        else
            return true;
    }

writeFederatedUsers()

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

inlineprotected

                                                                                                                                          {
        File file = new File(this.rootDirectory, fileName);
        FileOutputStream os = new FileOutputStream(file);
        ExportUtils.exportFederatedUsersToStream(session, realm, users, JsonSerialization.prettyMapper, os);
    }

writeRealm()

void org.keycloak.exportimport.dir.DirExportProvider.writeRealm ( String  fileName, RealmRepresentation  rep  ) throws IOException

inline

                                                                                        {
        File file = new File(this.rootDirectory, fileName);
        FileOutputStream stream = new FileOutputStream(file);
        JsonSerialization.prettyMapper.writeValue(stream, rep);
    }

writeUsers()

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

inlineprotected

                                                                                                                                    {
        File file = new File(this.rootDirectory, fileName);
        FileOutputStream os = new FileOutputStream(file);
        ExportUtils.exportUsersToStream(session, realm, users, JsonSerialization.prettyMapper, os);
    }

メンバ詳解

logger

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

protectedinherited

rootDirectory

final File org.keycloak.exportimport.dir.DirExportProvider.rootDirectory

private

---

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

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