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

    • exportRealm

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

    • exportComponents

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

    • exportClient

      public static org.keycloak.representations.idm.ClientRepresentation exportClient(org.keycloak.models.KeycloakSession session, org.keycloak.models.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<org.keycloak.models.RoleModel> roles)

    • exportRole

      public static org.keycloak.representations.idm.RoleRepresentation exportRole(org.keycloak.models.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(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.exportimport.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(org.keycloak.models.FederatedIdentityModel socialLink)

    • exportCredential

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

    • exportUsersToStream

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

    • exportUsersToStream

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

    • exportFederatedUsersToStream

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

    • exportFederatedUsersToStream

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

    • exportFederatedUser

      public static org.keycloak.representations.idm.UserRepresentation exportFederatedUser(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String id, org.keycloak.exportimport.ExportOptions options)
      Full export of user data stored in federated storage (including role mappings and credentials)
      Parameters:
      id -
      Returns:
      fully exported user representation