Package com.foreach.across.modules.user.services

Interface UserDirectoryService

All Known Implementing Classes:

UserDirectoryServiceImpl

public interface UserDirectoryService

Since:

2.0.0

Author:

Arne Vandamme

Method Summary

Modifier and Type	Method	Description
Collection<UserDirectory>	getActiveUserDirectories()	Get the list of user directories that should be used for authentication, in authentication precedence order.
UserDirectory	getDefaultUserDirectory()	Get the default directory that should be used for all principals that do not have a specific directory set.
Collection<UserDirectory>	getUserDirectories()
UserDirectory	save(UserDirectory userDirectory)	Create or update a directory instance.

Method Details

getDefaultUserDirectory

UserDirectory getDefaultUserDirectory()

Get the default directory that should be used for all principals that do not have a specific directory set. Usually the default internal directory is returned. This is the initial user directory created with id UserDirectory.DEFAULT_INTERNAL_DIRECTORY_ID. It should never be removed.

Returns:

instance

getUserDirectories

Collection<UserDirectory> getUserDirectories()

Returns:

all user directories

getActiveUserDirectories

Collection<UserDirectory> getActiveUserDirectories()

Get the list of user directories that should be used for authentication, in authentication precedence order.

Returns:

active user directories sorted according to their order property

save

UserDirectory save(UserDirectory userDirectory)

Create or update a directory instance.

Parameters:

userDirectory - dto

Returns:

persisted entity