Class ModelToRepresentation

java.lang.Object
org.keycloak.models.utils.ModelToRepresentation

public class ModelToRepresentation extends Object
Version:
$Revision: 1 $
Author:
Bill Burke
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static Set<String>
     
    static Set<String>
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    buildGroupPath(org.keycloak.models.GroupModel group)
     
    static void
    exportAuthenticationFlows(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.representations.idm.RealmRepresentation rep)
     
    static void
    exportGroups(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.representations.idm.RealmRepresentation rep)
     
    static void
    exportRequiredActions(org.keycloak.models.RealmModel realm, org.keycloak.representations.idm.RealmRepresentation rep)
     
    static <M, R> Stream<R>
    filterValidRepresentations(Stream<M> models, Function<M,R> transformer)
    Handles exceptions that occur when transforming the model to a representation and will remove all null objects from the stream.
    static org.keycloak.representations.idm.GroupRepresentation
    groupToBriefRepresentation(org.keycloak.models.GroupModel g)
     
    static Map<String,String>
     
    static Map<String,String>
     
    static org.keycloak.representations.idm.RealmRepresentation
    toBriefRepresentation(org.keycloak.models.RealmModel realm)
     
    static org.keycloak.representations.idm.IdentityProviderRepresentation
    toBriefRepresentation(org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel identityProviderModel)
     
    static org.keycloak.representations.idm.RoleRepresentation
    toBriefRepresentation(org.keycloak.models.RoleModel role)
     
    static org.keycloak.representations.idm.UserRepresentation
    toBriefRepresentation(org.keycloak.models.UserModel user)
     
    static org.keycloak.representations.idm.UserRepresentation
    toBriefRepresentation(org.keycloak.models.UserModel user, org.keycloak.representations.idm.UserRepresentation rep, boolean setUserAttributes)
     
    static org.keycloak.representations.idm.RealmEventsConfigRepresentation
    toEventsConfigReprensetation(org.keycloak.models.RealmModel realm)
     
    static org.keycloak.representations.idm.GroupRepresentation
    toGroupHierarchy(org.keycloak.models.GroupModel group, boolean full)
    Deprecated.
    static org.keycloak.representations.idm.GroupRepresentation
    toGroupHierarchy(org.keycloak.models.GroupModel group, boolean full, String search)
    Deprecated.
    static org.keycloak.representations.idm.GroupRepresentation
    toGroupHierarchy(org.keycloak.models.GroupModel group, boolean full, String search, Boolean exact)
    Deprecated.
    static Stream<org.keycloak.representations.idm.GroupRepresentation>
    toGroupHierarchy(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, boolean full)
    Deprecated.
    static List<org.keycloak.representations.idm.ConfigPropertyRepresentation>
    toRepresentation(List<org.keycloak.provider.ProviderConfigProperty> configProperties)
     
    static org.keycloak.representations.idm.authorization.PermissionTicketRepresentation
     
    static org.keycloak.representations.idm.authorization.PermissionTicketRepresentation
    toRepresentation(PermissionTicket ticket, AuthorizationProvider authorization, boolean returnNames)
     
    static <R extends org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation>
    R
     
    static <R extends org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation>
    R
    toRepresentation(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export)
     
    static <R extends org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation>
    R
    toRepresentation(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export, boolean allFields)
     
    static org.keycloak.representations.idm.authorization.ResourceRepresentation
    toRepresentation(Resource model, ResourceServer resourceServer, AuthorizationProvider authorization)
     
    static org.keycloak.representations.idm.authorization.ResourceRepresentation
    toRepresentation(Resource model, ResourceServer resourceServer, AuthorizationProvider authorization, Boolean deep)
     
    static org.keycloak.representations.idm.authorization.ResourceServerRepresentation
    toRepresentation(ResourceServer model, org.keycloak.models.ClientModel client)
     
    static org.keycloak.representations.idm.authorization.ScopeRepresentation
     
    static org.keycloak.representations.account.CredentialMetadataRepresentation
    toRepresentation(org.keycloak.credential.CredentialMetadata credentialMetadata)
     
    static org.keycloak.representations.idm.CredentialRepresentation
    toRepresentation(org.keycloak.credential.CredentialModel cred)
     
    static org.keycloak.representations.idm.AdminEventRepresentation
     
    static org.keycloak.representations.idm.AuthDetailsRepresentation
     
    static org.keycloak.representations.idm.EventRepresentation
     
    static org.keycloak.representations.idm.AuthenticationExecutionRepresentation
    toRepresentation(org.keycloak.models.AuthenticationExecutionModel model)
     
    static org.keycloak.representations.idm.AuthenticatorConfigRepresentation
    toRepresentation(org.keycloak.models.AuthenticatorConfigModel model)
     
    static org.keycloak.representations.idm.ClientRepresentation
    toRepresentation(org.keycloak.models.ClientModel clientModel, org.keycloak.models.KeycloakSession session)
     
    static org.keycloak.representations.idm.ClientScopeRepresentation
    toRepresentation(org.keycloak.models.ClientScopeModel clientScopeModel)
     
    static org.keycloak.representations.idm.FederatedIdentityRepresentation
    toRepresentation(org.keycloak.models.FederatedIdentityModel socialLink)
     
    static org.keycloak.representations.idm.GroupRepresentation
    toRepresentation(org.keycloak.models.GroupModel group, boolean full)
     
    static org.keycloak.representations.idm.IdentityProviderMapperRepresentation
    toRepresentation(org.keycloak.models.IdentityProviderMapperModel model)
     
    static org.keycloak.representations.idm.oid4vc.IssuedVerifiableCredentialRepresentation
    toRepresentation(org.keycloak.models.IssuedVerifiableCredentialModel model, String credentialType)
     
    static org.keycloak.representations.idm.oid4vc.IssuedVerifiableCredentialRepresentation
    toRepresentation(org.keycloak.models.IssuedVerifiableCredentialModel model, org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm)
     
    static org.keycloak.representations.idm.ComponentRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.component.ComponentModel component, boolean internal)
     
    static org.keycloak.representations.idm.RealmRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, boolean internal)
     
    static org.keycloak.representations.idm.RealmRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, boolean internal, boolean export)
     
    static org.keycloak.representations.idm.AuthenticationExecutionExportRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.AuthenticationExecutionModel model)
     
    static org.keycloak.representations.idm.AuthenticationFlowRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.AuthenticationFlowModel model)
     
    static org.keycloak.representations.idm.IdentityProviderRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel identityProviderModel)
     
    static org.keycloak.representations.idm.IdentityProviderRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel identityProviderModel, boolean export)
     
    static org.keycloak.representations.idm.UserRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
     
    static org.keycloak.representations.idm.UserRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.representations.idm.UserRepresentation rep, boolean setUserAttributes)
     
    static org.keycloak.representations.idm.UserRepresentation
    toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.UserModel user, boolean brief)
     
    static org.keycloak.representations.idm.OrganizationDomainRepresentation
    toRepresentation(org.keycloak.models.OrganizationDomainModel model)
     
    static org.keycloak.representations.idm.OrganizationRepresentation
    toRepresentation(org.keycloak.models.OrganizationModel model)
     
    static org.keycloak.representations.idm.OrganizationRepresentation
    toRepresentation(org.keycloak.models.OrganizationModel model, boolean briefRepresentation)
     
    static org.keycloak.representations.idm.ProtocolMapperRepresentation
    toRepresentation(org.keycloak.models.ProtocolMapperModel model)
     
    static org.keycloak.representations.idm.RequiredActionConfigRepresentation
    toRepresentation(org.keycloak.models.RequiredActionConfigModel model)
     
    static org.keycloak.representations.idm.RequiredActionProviderRepresentation
    toRepresentation(org.keycloak.models.RequiredActionProviderModel model)
     
    static org.keycloak.representations.idm.RoleRepresentation
    toRepresentation(org.keycloak.models.RoleModel role)
     
    static org.keycloak.representations.idm.UserConsentRepresentation
    toRepresentation(org.keycloak.models.UserConsentModel model)
     
    static org.keycloak.representations.idm.CredentialRepresentation
    toRepresentation(org.keycloak.models.UserCredentialModel cred)
     
    static org.keycloak.representations.idm.UserSessionRepresentation
    toRepresentation(org.keycloak.models.UserSessionModel session)
     
    static org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation
    toRepresentation(org.keycloak.models.UserVerifiableCredentialModel model, String credentialScopeName)
     
    static org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation
    toRepresentation(org.keycloak.models.UserVerifiableCredentialModel model, org.keycloak.models.RealmModel realm)
     
    static org.keycloak.representations.idm.ConfigPropertyRepresentation
    toRepresentation(org.keycloak.provider.ProviderConfigProperty prop)
     
    static org.keycloak.representations.idm.ComponentRepresentation
    toRepresentationWithoutConfig(org.keycloak.component.ComponentModel component)
     
    static org.keycloak.representations.idm.authorization.ResourceServerRepresentation
    toResourceServerRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientModel client)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • REALM_EXCLUDED_ATTRIBUTES

      public static Set<String> REALM_EXCLUDED_ATTRIBUTES
    • CLIENT_EXCLUDED_ATTRIBUTES

      public static Set<String> CLIENT_EXCLUDED_ATTRIBUTES
  • Constructor Details

    • ModelToRepresentation

      public ModelToRepresentation()
  • Method Details

    • buildGroupPath

      public static String buildGroupPath(org.keycloak.models.GroupModel group)
    • groupToBriefRepresentation

      public static org.keycloak.representations.idm.GroupRepresentation groupToBriefRepresentation(org.keycloak.models.GroupModel g)
    • toRepresentation

      public static org.keycloak.representations.idm.GroupRepresentation toRepresentation(org.keycloak.models.GroupModel group, boolean full)
    • toGroupHierarchy

      @Deprecated public static Stream<org.keycloak.representations.idm.GroupRepresentation> toGroupHierarchy(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, boolean full)
      Deprecated.
    • toGroupHierarchy

      @Deprecated public static org.keycloak.representations.idm.GroupRepresentation toGroupHierarchy(org.keycloak.models.GroupModel group, boolean full)
      Deprecated.
    • toGroupHierarchy

      @Deprecated public static org.keycloak.representations.idm.GroupRepresentation toGroupHierarchy(org.keycloak.models.GroupModel group, boolean full, String search)
      Deprecated.
    • toGroupHierarchy

      @Deprecated public static org.keycloak.representations.idm.GroupRepresentation toGroupHierarchy(org.keycloak.models.GroupModel group, boolean full, String search, Boolean exact)
      Deprecated.
    • toRepresentation

      public static org.keycloak.representations.idm.UserRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
    • toRepresentation

      public static org.keycloak.representations.idm.UserRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user, org.keycloak.representations.idm.UserRepresentation rep, boolean setUserAttributes)
    • toRepresentation

      public static org.keycloak.representations.idm.UserRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.UserModel user, boolean brief)
    • toBriefRepresentation

      public static org.keycloak.representations.idm.UserRepresentation toBriefRepresentation(org.keycloak.models.UserModel user)
    • toBriefRepresentation

      public static org.keycloak.representations.idm.UserRepresentation toBriefRepresentation(org.keycloak.models.UserModel user, org.keycloak.representations.idm.UserRepresentation rep, boolean setUserAttributes)
    • toRepresentation

      public static org.keycloak.representations.idm.EventRepresentation toRepresentation(Event event)
    • toRepresentation

      public static org.keycloak.representations.idm.AdminEventRepresentation toRepresentation(AdminEvent adminEvent)
    • toRepresentation

      public static org.keycloak.representations.idm.AuthDetailsRepresentation toRepresentation(AuthDetails authDetails)
    • toRepresentation

      public static org.keycloak.representations.idm.RoleRepresentation toRepresentation(org.keycloak.models.RoleModel role)
    • toBriefRepresentation

      public static org.keycloak.representations.idm.RoleRepresentation toBriefRepresentation(org.keycloak.models.RoleModel role)
    • toBriefRepresentation

      public static org.keycloak.representations.idm.RealmRepresentation toBriefRepresentation(org.keycloak.models.RealmModel realm)
    • toRepresentation

      public static org.keycloak.representations.idm.RealmRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, boolean internal)
    • toRepresentation

      public static org.keycloak.representations.idm.RealmRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, boolean internal, boolean export)
    • stripRealmAttributesIncludedAsFields

      public static Map<String,String> stripRealmAttributesIncludedAsFields(Map<String,String> attributes)
    • stripClientAttributesIncludedAsFields

      public static Map<String,String> stripClientAttributesIncludedAsFields(Map<String,String> attributes)
    • exportGroups

      public static void exportGroups(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.representations.idm.RealmRepresentation rep)
    • exportAuthenticationFlows

      public static void exportAuthenticationFlows(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.representations.idm.RealmRepresentation rep)
    • exportRequiredActions

      public static void exportRequiredActions(org.keycloak.models.RealmModel realm, org.keycloak.representations.idm.RealmRepresentation rep)
    • toEventsConfigReprensetation

      public static org.keycloak.representations.idm.RealmEventsConfigRepresentation toEventsConfigReprensetation(org.keycloak.models.RealmModel realm)
    • filterValidRepresentations

      public static <M, R> Stream<R> filterValidRepresentations(Stream<M> models, Function<M,R> transformer)
      Handles exceptions that occur when transforming the model to a representation and will remove all null objects from the stream. Entities that have been removed from the store or where a lazy loading exception occurs will not show up in the output stream.
    • toRepresentation

      public static org.keycloak.representations.idm.CredentialRepresentation toRepresentation(org.keycloak.models.UserCredentialModel cred)
    • toRepresentation

      public static org.keycloak.representations.idm.CredentialRepresentation toRepresentation(org.keycloak.credential.CredentialModel cred)
    • toRepresentation

      public static org.keycloak.representations.account.CredentialMetadataRepresentation toRepresentation(org.keycloak.credential.CredentialMetadata credentialMetadata)
    • toRepresentation

      public static org.keycloak.representations.idm.FederatedIdentityRepresentation toRepresentation(org.keycloak.models.FederatedIdentityModel socialLink)
    • toRepresentation

      public static org.keycloak.representations.idm.UserSessionRepresentation toRepresentation(org.keycloak.models.UserSessionModel session)
    • toRepresentation

      public static org.keycloak.representations.idm.ClientScopeRepresentation toRepresentation(org.keycloak.models.ClientScopeModel clientScopeModel)
    • toRepresentation

      public static org.keycloak.representations.idm.ClientRepresentation toRepresentation(org.keycloak.models.ClientModel clientModel, org.keycloak.models.KeycloakSession session)
    • toBriefRepresentation

      public static org.keycloak.representations.idm.IdentityProviderRepresentation toBriefRepresentation(org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel identityProviderModel)
    • toRepresentation

      public static org.keycloak.representations.idm.IdentityProviderRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel identityProviderModel)
    • toRepresentation

      public static org.keycloak.representations.idm.IdentityProviderRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.IdentityProviderModel identityProviderModel, boolean export)
    • toRepresentation

      public static org.keycloak.representations.idm.ProtocolMapperRepresentation toRepresentation(org.keycloak.models.ProtocolMapperModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.IdentityProviderMapperRepresentation toRepresentation(org.keycloak.models.IdentityProviderMapperModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.UserConsentRepresentation toRepresentation(org.keycloak.models.UserConsentModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation toRepresentation(org.keycloak.models.UserVerifiableCredentialModel model, String credentialScopeName)
    • toRepresentation

      public static org.keycloak.representations.idm.oid4vc.UserVerifiableCredentialRepresentation toRepresentation(org.keycloak.models.UserVerifiableCredentialModel model, org.keycloak.models.RealmModel realm)
    • toRepresentation

      public static org.keycloak.representations.idm.AuthenticationFlowRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.AuthenticationFlowModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.AuthenticationExecutionExportRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.AuthenticationExecutionModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.AuthenticationExecutionRepresentation toRepresentation(org.keycloak.models.AuthenticationExecutionModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.AuthenticatorConfigRepresentation toRepresentation(org.keycloak.models.AuthenticatorConfigModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.RequiredActionProviderRepresentation toRepresentation(org.keycloak.models.RequiredActionProviderModel model)
    • toRepresentation

      public static List<org.keycloak.representations.idm.ConfigPropertyRepresentation> toRepresentation(List<org.keycloak.provider.ProviderConfigProperty> configProperties)
    • toRepresentation

      public static org.keycloak.representations.idm.ConfigPropertyRepresentation toRepresentation(org.keycloak.provider.ProviderConfigProperty prop)
    • toRepresentation

      public static org.keycloak.representations.idm.ComponentRepresentation toRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.component.ComponentModel component, boolean internal)
    • toRepresentationWithoutConfig

      public static org.keycloak.representations.idm.ComponentRepresentation toRepresentationWithoutConfig(org.keycloak.component.ComponentModel component)
    • toRepresentation

      public static org.keycloak.representations.idm.authorization.ScopeRepresentation toRepresentation(Scope model)
    • toRepresentation

      public static org.keycloak.representations.idm.authorization.ResourceServerRepresentation toRepresentation(ResourceServer model, org.keycloak.models.ClientModel client)
    • toRepresentation

      public static <R extends org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation> R toRepresentation(Policy policy, AuthorizationProvider authorization)
    • toRepresentation

      public static <R extends org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation> R toRepresentation(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export)
    • toRepresentation

      public static <R extends org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation> R toRepresentation(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export, boolean allFields)
    • toRepresentation

      public static org.keycloak.representations.idm.authorization.ResourceRepresentation toRepresentation(Resource model, ResourceServer resourceServer, AuthorizationProvider authorization)
    • toRepresentation

      public static org.keycloak.representations.idm.authorization.ResourceRepresentation toRepresentation(Resource model, ResourceServer resourceServer, AuthorizationProvider authorization, Boolean deep)
    • toRepresentation

      public static org.keycloak.representations.idm.authorization.PermissionTicketRepresentation toRepresentation(PermissionTicket ticket, AuthorizationProvider authorization)
    • toRepresentation

      public static org.keycloak.representations.idm.authorization.PermissionTicketRepresentation toRepresentation(PermissionTicket ticket, AuthorizationProvider authorization, boolean returnNames)
    • toResourceServerRepresentation

      public static org.keycloak.representations.idm.authorization.ResourceServerRepresentation toResourceServerRepresentation(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientModel client)
    • toRepresentation

      public static org.keycloak.representations.idm.RequiredActionConfigRepresentation toRepresentation(org.keycloak.models.RequiredActionConfigModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.OrganizationRepresentation toRepresentation(org.keycloak.models.OrganizationModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.OrganizationRepresentation toRepresentation(org.keycloak.models.OrganizationModel model, boolean briefRepresentation)
    • toRepresentation

      public static org.keycloak.representations.idm.OrganizationDomainRepresentation toRepresentation(org.keycloak.models.OrganizationDomainModel model)
    • toRepresentation

      public static org.keycloak.representations.idm.oid4vc.IssuedVerifiableCredentialRepresentation toRepresentation(org.keycloak.models.IssuedVerifiableCredentialModel model, String credentialType)
    • toRepresentation

      public static org.keycloak.representations.idm.oid4vc.IssuedVerifiableCredentialRepresentation toRepresentation(org.keycloak.models.IssuedVerifiableCredentialModel model, org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm)