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 |
---|---|
ExternalUser |
authenticate(Credentials credentials)
Authenticates the user represented by the given credentials and returns it.
|
ExternalGroup |
getGroup(java.lang.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. |
java.lang.String |
getName()
Returns the name of this provider.
|
ExternalUser |
getUser(java.lang.String userId)
Returns the user for the given (local) id.
|
java.util.Iterator<ExternalGroup> |
listGroups()
List all external groups.
|
java.util.Iterator<ExternalUser> |
listUsers()
List all external users.
|
java.lang.String getName()
ExternalIdentity getIdentity(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.ExternalUser getUser(java.lang.String userId) throws ExternalIdentityException
null
is returned.userId
- the user id.null
ExternalIdentityException
- if an error occurs.ExternalUser authenticate(Credentials credentials) throws ExternalIdentityException, javax.security.auth.login.LoginException
null
is returned. If the authentication fails, a LoginException is thrown.credentials
- the credentialsnull
ExternalIdentityException
- if an error occursjavax.security.auth.login.LoginException
- if the user could not be authenticatedExternalGroup getGroup(java.lang.String name) throws ExternalIdentityException
null
is returned.name
- the group namenull
ExternalIdentityException
- if an error occurs.java.util.Iterator<ExternalUser> listUsers() throws ExternalIdentityException
ExternalIdentityException
- if an error occurs.java.util.Iterator<ExternalGroup> listGroups() throws ExternalIdentityException
ExternalIdentityException
- if an error occurs."Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"