Package org.ametys.plugins.extrausermgt.users.entraid

Class EntraIDUserDirectory

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.user.directory.AbstractCachingUserDirectory

org.ametys.plugins.extrausermgt.users.entraid.EntraIDUserDirectory

All Implemented Interfaces:

UserDirectory, LogEnabled, Disposable, Serviceable

public class EntraIDUserDirectory
extends AbstractCachingUserDirectory

UserDirectory listing users in Entra ID.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.user.directory.UserDirectory

UserDirectory.CredentialsResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ON_PREMISES_SAM_ACCOUNT_NAME	Constant for onPremisesSamAccountName attribute

Constructor Summary

Constructors

Constructor	Description
EntraIDUserDirectory()

Method Summary

Modifier and Type	Method	Description
UserDirectory.CredentialsResult	checkCredentials(String login, String password)	Authenticate a user with its credentials
protected String	getCacheTypeLabel()	Returns a String identifying the type of this directory, used in the cache screen in _admin, such as 'SQL' or 'LDAP'.
StoredUser	getStoredUser(String login)	Get a particular user by his login.
StoredUser	getStoredUserByEmail(String email)	Get a particular user by his email (search should be case insensitive).
Collection<StoredUser>	getStoredUsers()	Get the list of all users of one directory.
List<StoredUser>	getStoredUsers(int count, int offset, Map<String,Object> parameters)	Get a list of users from a directory given the parameters
String	getUserIdentifier(com.microsoft.graph.models.User user)	Get the user identifier based on the configured login attribute.
void	init(String id, String udModelId, Map<String,Object> paramValues, String label)	Initialize the user's directory with given parameters' values.
boolean	isCaseSensitive()	Is the user directory case sensitive for login?

Methods inherited from class org.ametys.plugins.core.impl.user.directory.AbstractCachingUserDirectory

dispose, getCacheByLogin, getCacheByMail, getId, getLabel, getParameterValues, getPopulationId, getUserDirectoryModelId, service, setPopulationId

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.core.user.directory.UserDirectory

getUserIdentity, getUserIdentity

Field Details

ON_PREMISES_SAM_ACCOUNT_NAME

public static final String ON_PREMISES_SAM_ACCOUNT_NAME

Constant for onPremisesSamAccountName attribute

See Also:

• Constant Field Values

Constructor Details

EntraIDUserDirectory

public EntraIDUserDirectory()

Method Details

init

public void init(String id,
 String udModelId,
 Map<String,Object> paramValues,
 String label)
          throws Exception

Description copied from interface: UserDirectory

Initialize the user's directory with given parameters' values.

Specified by:

init in interface UserDirectory

Overrides:

init in class AbstractCachingUserDirectory

Parameters:

id - The non-null and non-empty unique identifier

udModelId - The id of user directory extension point

paramValues - The parameters' values

label - The optional label

Throws:

Exception - If an error occurred

getCacheTypeLabel

protected String getCacheTypeLabel()

Description copied from class: AbstractCachingUserDirectory

Returns a String identifying the type of this directory, used in the cache screen in _admin, such as 'SQL' or 'LDAP'.

Specified by:

getCacheTypeLabel in class AbstractCachingUserDirectory

Returns:

this directory's type

isCaseSensitive

public boolean isCaseSensitive()

Description copied from interface: UserDirectory

Is the user directory case sensitive for login?

Returns:

true is the user directory is case sensitive

getStoredUsers

public Collection<StoredUser> getStoredUsers()

Description copied from interface: UserDirectory

Get the list of all users of one directory.

Returns:

list of users as Collection of StoredUsers, empty if a problem occurs.

getStoredUsers

public List<StoredUser> getStoredUsers(int count,
 int offset,
 Map<String,Object> parameters)

Description copied from interface: UserDirectory

Get a list of users from a directory given the parameters

Parameters:

count - The limit of users to retrieve

offset - The number of result to ignore before starting to collect users.

parameters - A map of additional parameters, see implementation.

Returns:

The list of retrieved StoredUser

getUserIdentifier

public String getUserIdentifier(com.microsoft.graph.models.User user)

Get the user identifier based on the configured login attribute.

Parameters:

user - The Azure AD user

Returns:

The user identifier (either UserPrincipalName or OnPremisesSamAccountName)

getStoredUser

public StoredUser getStoredUser(String login)

Description copied from interface: UserDirectory

Get a particular user by his login.

Parameters:

login - Login of the user to get. Cannot be null.

Returns:

User's information as a StoredUser instance or null if the user login does not exist.

getStoredUserByEmail

public StoredUser getStoredUserByEmail(String email)
                                throws NotUniqueUserException

Description copied from interface: UserDirectory

Get a particular user by his email (search should be case insensitive).

Parameters:

email - Email of the user to get. Cannot be null.

Returns:

User's information as a StoredUser instance or null if the user email does not exist.

Throws:

NotUniqueUserException - If many users match this email

checkCredentials

public UserDirectory.CredentialsResult checkCredentials(String login,
 String password)

Description copied from interface: UserDirectory

Authenticate a user with its credentials

Parameters:

login - The login to check. Cannot be null.

password - The password to check.

Returns:

The credentials result