Package org.forgerock.am.identity.application

Interface UniversalIdFactory

public interface UniversalIdFactory
Factory for creating UniversalId instances from various inputs such as Dn, SSOToken, or usernames with their associated IdType and Realm.

  • Method Details

    • universalId

      UniversalId universalId(Dn dn) throws IdRepoException
      Creates a UniversalId from a distinguished name (DN).
      Parameters:
      dn - the distinguished name
      Returns:
      the corresponding UniversalId
      Throws:
      IdRepoException - if an error occurs while creating the UniversalId

    • universalId

      UniversalId universalId(SSOToken token) throws IdRepoException, SSOException
      Creates a UniversalId from a single sign-on token.
      Parameters:
      token - the single sign-on token
      Returns:
      the corresponding UniversalId
      Throws:
      IdRepoException - if an error occurs while creating the UniversalId
      SSOException - if an error occurs with the SSO token

    • universalId

      UniversalId universalId(String name, IdType type, Realm realm) throws IdRepoException
      Creates a UniversalId from a username, its type, and the associated realm.
      Parameters:
      name - the username
      type - the type of the identifier (e.g., user, group)
      realm - the realm associated with the identifier
      Returns:
      the corresponding UniversalId
      Throws:
      IdRepoException - if an error occurs while creating the UniversalId

    • universalId

      UniversalId universalId(String name, IdType type, Dn realmDn) throws IdRepoException
      Creates a UniversalId from a username, its type, and the associated realm's distinguished name (DN).
      Parameters:
      name - the username
      type - the type of the identifier (e.g., user, group)
      realmDn - the distinguished name of the realm associated with the identifier
      Returns:
      the corresponding UniversalId
      Throws:
      IdRepoException - if an error occurs while creating the UniversalId