public interface ExternalIdentityProvider
ExternalIdentityProvider
defines an interface to an external system that provides users and groups that
can be synced with local ones.Modifier and Type | Method and Description |
---|---|
@Nullable ExternalUser |
authenticate(@NotNull Credentials credentials)
Authenticates the user represented by the given credentials and returns it.
|
@Nullable ExternalGroup |
getGroup(@NotNull String name)
Returns the group for the given (local) group name.
|
@Nullable ExternalIdentity |
getIdentity(@NotNull ExternalIdentityRef ref)
Returns the identity for the given reference or
null if it does not exist. |
@NotNull String |
getName()
Returns the name of this provider.
|
@Nullable ExternalUser |
getUser(@NotNull String userId)
Returns the user for the given (local) id.
|
@NotNull Iterator<ExternalGroup> |
listGroups()
List all external groups.
|
@NotNull Iterator<ExternalUser> |
listUsers()
List all external users.
|
@NotNull @NotNull String getName()
@Nullable @Nullable ExternalIdentity getIdentity(@NotNull @NotNull ExternalIdentityRef ref) throws ExternalIdentityException
null
if it does not exist. The provider should check if
the provider name
matches his own name or is null
and
should not return a foreign identity.ref
- the referencenull
ExternalIdentityException
- if an error occurs.@Nullable @Nullable ExternalUser getUser(@NotNull @NotNull String userId) throws ExternalIdentityException
null
is returned.userId
- the user id.null
ExternalIdentityException
- if an error occurs.@Nullable @Nullable ExternalUser authenticate(@NotNull @NotNull Credentials credentials) throws ExternalIdentityException, LoginException
null
is returned. If the authentication fails, a LoginException is thrown.credentials
- the credentialsnull
ExternalIdentityException
- if an error occursLoginException
- if the user could not be authenticated@Nullable @Nullable ExternalGroup getGroup(@NotNull @NotNull String name) throws ExternalIdentityException
null
is returned.name
- the group namenull
ExternalIdentityException
- if an error occurs.@NotNull @NotNull Iterator<ExternalUser> listUsers() throws ExternalIdentityException
ExternalIdentityException
- if an error occurs.@NotNull @NotNull Iterator<ExternalGroup> listGroups() throws ExternalIdentityException
ExternalIdentityException
- if an error occurs.Copyright © 2010 - 2020 Adobe. All Rights Reserved