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

Interface ExternalIdentity

  • All Known Subinterfaces:
    ExternalGroup, ExternalUser
    public interface ExternalIdentity
    ExternalIdentity defines an identity provided by an external system.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull java.lang.Iterable<ExternalIdentityRef> getDeclaredGroups()
      Returns an iterable of the declared groups of this external identity.
      @NotNull ExternalIdentityRef getExternalId()
      Returns the id of this identity as used in the external system.
      @NotNull java.lang.String getId()
      Returns the local id of this identity as it would be used in this repository.
      @Nullable java.lang.String getIntermediatePath()
      Returns the desired intermediate relative path of the authorizable to be created.
      @NotNull java.lang.String getPrincipalName()
      Returns the principal name of this identity.
      @NotNull java.util.Map<java.lang.String,​?> getProperties()
      Returns a map of properties of this external identity.

    • Method Detail

      • getExternalId

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

      • getId

        @NotNull
@NotNull java.lang.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 java.lang.String getPrincipalName()
        Returns the principal name of this identity. This usually corresponds to Authorizable.getPrincipal().Principal.getName()
        Returns:
        the principal name

      • getIntermediatePath

        @Nullable
@Nullable java.lang.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.

      • getProperties

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