Package org.keycloak.exportimport.util

Class ExportUtils

java.lang.Object

org.keycloak.exportimport.util.ExportUtils

public class ExportUtils
extends Object

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor	Description
ExportUtils()

Method Summary

Modifier and Type	Method	Description
static org.keycloak.representations.idm.ClientRepresentation	exportClient(KeycloakSession session, ClientModel client)	Full export of application including claims and secret
static org.keycloak.common.util.MultivaluedHashMap<String,org.keycloak.representations.idm.ComponentExportRepresentation>	exportComponents(RealmModel realm, String parentId)
static org.keycloak.representations.idm.CredentialRepresentation	exportCredential(CredentialModel userCred)
static org.keycloak.representations.idm.UserRepresentation	exportFederatedUser(KeycloakSession session, RealmModel realm, String id, ExportOptions options)	Full export of user data stored in federated storage (including role mappings and credentials)
static void	exportFederatedUsersToStream(KeycloakSession session, RealmModel realm, List<String> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os)
static void	exportFederatedUsersToStream(KeycloakSession session, RealmModel realm, List<String> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options)
static org.keycloak.representations.idm.RealmRepresentation	exportRealm(KeycloakSession session, RealmModel realm, boolean includeUsers, boolean internal)
static org.keycloak.representations.idm.RealmRepresentation	exportRealm(KeycloakSession session, RealmModel realm, ExportOptions options, boolean internal)
static org.keycloak.representations.idm.RoleRepresentation	exportRole(RoleModel role)	Full export of role including composite roles
static List<org.keycloak.representations.idm.RoleRepresentation>	exportRoles(Stream<RoleModel> roles)
static org.keycloak.representations.idm.FederatedIdentityRepresentation	exportSocialLink(FederatedIdentityModel socialLink)
static org.keycloak.representations.idm.UserRepresentation	exportUser(KeycloakSession session, RealmModel realm, UserModel user, ExportOptions options, boolean internal)	Full export of user (including role mappings and credentials)
static void	exportUsersToStream(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os)
static void	exportUsersToStream(KeycloakSession session, RealmModel realm, List<UserModel> usersToExport, com.fasterxml.jackson.databind.ObjectMapper mapper, OutputStream os, ExportOptions options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExportUtils

public ExportUtils()

Method Details

exportRealm

public static org.keycloak.representations.idm.RealmRepresentation exportRealm(KeycloakSession session,
 RealmModel realm,
 boolean includeUsers,
 boolean internal)

exportRealm

public static org.keycloak.representations.idm.RealmRepresentation exportRealm(KeycloakSession session,
 RealmModel realm,
 ExportOptions options,
 boolean internal)

exportComponents

public static org.keycloak.common.util.MultivaluedHashMap<String,org.keycloak.representations.idm.ComponentExportRepresentation> exportComponents(RealmModel realm,
 String parentId)

exportClient

public static org.keycloak.representations.idm.ClientRepresentation exportClient(KeycloakSession session,
 ClientModel client)

Full export of application including claims and secret

Parameters:

client -

Returns:

full ApplicationRepresentation

exportRoles

public static List<org.keycloak.representations.idm.RoleRepresentation> exportRoles(Stream<RoleModel> roles)

exportRole

public static org.keycloak.representations.idm.RoleRepresentation exportRole(RoleModel role)

Full export of role including composite roles

Parameters:

role -

Returns:

RoleRepresentation with all stuff filled (including composite roles)

exportUser

public static org.keycloak.representations.idm.UserRepresentation exportUser(KeycloakSession session,
 RealmModel realm,
 UserModel user,
 ExportOptions options,
 boolean internal)

Full export of user (including role mappings and credentials)

Parameters:

user -

Returns:

fully exported user representation

exportSocialLink

public static org.keycloak.representations.idm.FederatedIdentityRepresentation exportSocialLink(FederatedIdentityModel socialLink)

exportCredential

public static org.keycloak.representations.idm.CredentialRepresentation exportCredential(CredentialModel userCred)

exportUsersToStream

public static void exportUsersToStream(KeycloakSession session,
 RealmModel realm,
 List<UserModel> usersToExport,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 OutputStream os)
                                throws IOException

Throws:

IOException

exportUsersToStream

public static void exportUsersToStream(KeycloakSession session,
 RealmModel realm,
 List<UserModel> usersToExport,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 OutputStream os,
 ExportOptions options)
                                throws IOException

Throws:

IOException

exportFederatedUsersToStream

public static void exportFederatedUsersToStream(KeycloakSession session,
 RealmModel realm,
 List<String> usersToExport,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 OutputStream os)
                                         throws IOException

Throws:

IOException

exportFederatedUsersToStream

public static void exportFederatedUsersToStream(KeycloakSession session,
 RealmModel realm,
 List<String> usersToExport,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 OutputStream os,
 ExportOptions options)
                                         throws IOException

Throws:

IOException

exportFederatedUser

public static org.keycloak.representations.idm.UserRepresentation exportFederatedUser(KeycloakSession session,
 RealmModel realm,
 String id,
 ExportOptions options)

Full export of user data stored in federated storage (including role mappings and credentials)

Parameters:

id -

Returns:

fully exported user representation