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

Interface ExternalIdentityProvider

public interface ExternalIdentityProvider

ExternalIdentityProvider defines an interface to an external system that provides users and groups that can be synced with local ones.

Method Summary

Methods

Modifier and Type	Method and Description
ExternalUser	authenticate(javax.jcr.Credentials credentials) Authenticates the user represented by the given credentials and returns it.
ExternalGroup	getGroup(String name) Returns the group for the given (local) group name.
ExternalIdentity	getIdentity(ExternalIdentityRef ref) Returns the identity for the given reference or null if it does not exist.
String	getName() Returns the name of this provider.
ExternalUser	getUser(String userId) Returns the user for the given (local) id.
Iterator<ExternalGroup>	listGroups() List all external groups.
Iterator<ExternalUser>	listUsers() List all external users.

Method Detail

getName

@Nonnull
String getName()

Returns the name of this provider.

Returns:

the provider name.

getIdentity

@CheckForNull
ExternalIdentity getIdentity(@Nonnull
                                        ExternalIdentityRef ref)
                             throws ExternalIdentityException

Returns the identity for the given reference or 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.

Parameters:

ref - the reference

Returns:

an identity or null

Throws:

ExternalIdentityException - if an error occurs.

getUser

@CheckForNull
ExternalUser getUser(@Nonnull
                                String userId)
                     throws ExternalIdentityException

Returns the user for the given (local) id. if the user does not exist null is returned.

Parameters:

userId - the user id.

Returns:

the user or null

Throws:

ExternalIdentityException - if an error occurs.

authenticate

@CheckForNull
ExternalUser authenticate(@Nonnull
                                     javax.jcr.Credentials credentials)
                          throws ExternalIdentityException,
                                 LoginException

Authenticates the user represented by the given credentials and returns it. If the user does not exist in this provider, null is returned. If the authentication fails, a LoginException is thrown.

Parameters:

credentials - the credentials

Returns:

the user or null

Throws:

ExternalIdentityException - if an error occurs

LoginException - if the user could not be authenticated

getGroup

@CheckForNull
ExternalGroup getGroup(@Nonnull
                                  String name)
                       throws ExternalIdentityException

Returns the group for the given (local) group name. if the group does not exist null is returned.

Parameters:

name - the group name

Returns:

the group or null

Throws:

ExternalIdentityException - if an error occurs.

listUsers

@Nonnull
Iterator<ExternalUser> listUsers()
                                 throws ExternalIdentityException

List all external users.

Returns:

an iterator over all external users

Throws:

ExternalIdentityException - if an error occurs.

listGroups

@Nonnull
Iterator<ExternalGroup> listGroups()
                                   throws ExternalIdentityException

List all external groups.

Returns:

an iterator over all external groups

Throws:

ExternalIdentityException - if an error occurs.