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 Summary

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

Method Detail

getExternalId

@Nonnull
ExternalIdentityRef getExternalId()

Returns the id of this identity as used in the external system.

Returns:

the external id.

getId

@Nonnull
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

@Nonnull
String getPrincipalName()

Returns the principal name of this identity. This usually corresponds to Authorizable.getPrincipal().Principal.getName()

Returns:

the principal name

getIntermediatePath

@CheckForNull
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

@Nonnull
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

@Nonnull
Map<String,?> getProperties()

Returns a map of properties of this external identity.

Returns:

the properties