Package org.apache.jackrabbit.oak.spi.security.authentication.external

Interface ExternalIdentity

All Known Subinterfaces:
ExternalGroup, ExternalUser
All Known Implementing Classes:
LdapGroup, LdapIdentity, LdapUser
public interface ExternalIdentity
ExternalIdentity defines an identity provided by an external system.

  • Method Details

    • getExternalId

      @NotNull @NotNull ExternalIdentityRef getExternalId()
      Returns the id of this identity as used in the external system.
      Returns:
      the external id.

    • getId

      @NotNull @NotNull String getId()
      Returns the local id of this identity as it would be used in this repository. This usually corresponds to Authorizable.getID()
      Returns:
      the internal id.

    • getPrincipalName

      @NotNull @NotNull String getPrincipalName()
      Returns the principal name of this identity. This usually corresponds to Authorizable.getPrincipal().Principal.getName()
      Returns:
      the principal name

    • getIntermediatePath

      @Nullable @Nullable String getIntermediatePath()
      Returns the desired intermediate relative path of the authorizable to be created. For example, one could map an external hierarchy into the local users and groups hierarchy. The provider must escape all characters so that the path is a valid JCR path. The path is always considered relative, even if it starts with a '/'.
      Returns:
      the intermediate path or null or empty.

    • getDeclaredGroups

      @NotNull @NotNull Iterable<ExternalIdentityRef> getDeclaredGroups() throws ExternalIdentityException
      Returns an iterable of the declared groups of this external identity.
      Returns:
      the declared groups
      Throws:
      ExternalIdentityException - if an error occurs

    • getProperties

      @NotNull @NotNull Map<String,?> getProperties()
      Returns a map of properties of this external identity.
      Returns:
      the properties