Package org.silverpeas.core.admin.domain

Interface DomainDriver

All Known Subinterfaces:

SilverpeasDomainDriver

All Known Implementing Classes:

AbstractDomainDriver, DomainDriverManager, GoogleDriver, LDAPDriver, SCIMDriver, SilverpeasDriver, SQLDriver

public interface DomainDriver

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DomainDriver.ActionConstants
static interface	DomainDriver.UserFilterManager	Definition of a user filter manager.

Method Summary

Modifier and Type	Method	Description
void	addPropertiesToImport(List<DomainProperty> props)
void	addPropertiesToImport(List<DomainProperty> props, Map<String,String> theDescriptions)
void	beginSynchronization()
String	createGroup(GroupDetail group)
String	createUser(UserDetail user)
void	deleteGroup(String groupId)
void	deleteUser(String userId)
String	endSynchronization(boolean cancelSynchro)
GroupDetail[]	getAllGroups()
GroupDetail[]	getAllRootGroups()
UserDetail[]	getAllUsers()
long	getDriverActions()
GroupDetail	getGroup(String specificId)
GroupDetail	getGroupByName(String groupName)
String[]	getGroupMemberGroupIds(String groupId)
GroupDetail[]	getGroups(String groupId)
String[]	getMapParameters()
Map<String,String>	getPropertiesDescriptions(String language)
Map<String,String>	getPropertiesLabels(String language)
String[]	getPropertiesNames()
List<DomainProperty>	getPropertiesToImport(String language)
DomainProperty	getProperty(String propName)
UserDetail	getUser(String specificId)	Retrieves common user information from database.
List<String>	getUserAttributes()
default Optional<DomainDriver.UserFilterManager>	getUserFilterManager()	Gets an optional DomainDriver.UserFilterManager which permits to manage a filter to apply on the user request results obtained from external user account repository.
UserFull	getUserFull(String specificId)	Retrieves common user information from database with the additional data.
String[]	getUserMemberGroupIds(String specificId)
UserDetail[]	getUsersByQuery(Map<String,String> query)
UserDetail[]	getUsersBySpecificProperty(String propertyName, String value)
GroupDetail	importGroup(String groupName)
UserDetail	importUser(String userLogin)
void	init(int domainId, String initParam, String authenticationServer)
void	initFromProperties(SettingBundle rs)
boolean	isGroupsInheritProfiles()
boolean	isSynchroInProcess()
boolean	isSynchroOnLoginEnabled()
boolean	isSynchroOnLoginRecursToGroups()
boolean	isSynchroThreaded()
boolean	isX509CertificateEnabled()
List<UserFull>	listUserFulls(Collection<String> specificIds)	Retrieves common user information with the additional data from database against the given identifiers.
List<UserDetail>	listUsers(Collection<String> specificIds)	Retrieves the common user information from database against the given identifiers.
boolean	mustImportUsers()
void	removeGroup(String groupId)
void	removeUser(String userId)
void	resetEncryptedPassword(UserDetail user, String encryptedPassword)
void	resetPassword(UserDetail user, String password)
GroupDetail	synchroGroup(String groupId)
UserDetail	synchroUser(String userId)
void	updateGroup(GroupDetail group)
void	updateUserDetail(UserDetail user)
void	updateUserFull(UserFull user)

Method Detail

init

void init(int domainId,
          String initParam,
          String authenticationServer)
   throws AdminException

Throws:

AdminException

getPropertiesNames

String[] getPropertiesNames()

getProperty

DomainProperty getProperty(String propName)

getMapParameters

String[] getMapParameters()

getPropertiesToImport

List<DomainProperty> getPropertiesToImport(String language)

addPropertiesToImport

void addPropertiesToImport(List<DomainProperty> props)

addPropertiesToImport

void addPropertiesToImport(List<DomainProperty> props,
                           Map<String,String> theDescriptions)

getPropertiesLabels

Map<String,String> getPropertiesLabels(String language)

getPropertiesDescriptions

Map<String,String> getPropertiesDescriptions(String language)

initFromProperties

void initFromProperties(SettingBundle rs)
                 throws AdminException

Throws:

AdminException

getDriverActions

long getDriverActions()

isSynchroOnLoginEnabled

boolean isSynchroOnLoginEnabled()

isSynchroThreaded

boolean isSynchroThreaded()

isSynchroOnLoginRecursToGroups

boolean isSynchroOnLoginRecursToGroups()

isGroupsInheritProfiles

boolean isGroupsInheritProfiles()

mustImportUsers

boolean mustImportUsers()

isX509CertificateEnabled

boolean isX509CertificateEnabled()

beginSynchronization

void beginSynchronization()
                   throws AdminException

Throws:

AdminException

isSynchroInProcess

boolean isSynchroInProcess()
                    throws AdminException

Throws:

AdminException

endSynchronization

String endSynchronization(boolean cancelSynchro)
                   throws AdminException

Throws:

AdminException

importUser

UserDetail importUser(String userLogin)
               throws AdminException

Throws:

AdminException

removeUser

void removeUser(String userId)
         throws AdminException

Throws:

AdminException

synchroUser

UserDetail synchroUser(String userId)
                throws AdminException

Throws:

AdminException

createUser

String createUser(UserDetail user)
           throws AdminException

Throws:

AdminException

deleteUser

void deleteUser(String userId)
         throws AdminException

Throws:

AdminException

updateUserFull

void updateUserFull(UserFull user)
             throws AdminException

Throws:

AdminException

updateUserDetail

void updateUserDetail(UserDetail user)
               throws AdminException

Throws:

AdminException

getUser

UserDetail getUser(String specificId)
            throws AdminException

Retrieves common user information from database.

Parameters:

specificId - The user id as stored in the database.

Returns:

The full User object that contain ALL user information.

Throws:

AdminException

listUsers

List<UserDetail> listUsers(Collection<String> specificIds)
                    throws AdminException

Retrieves the common user information from database against the given identifiers.

Parameters:

specificIds - The user ids as stored in the database.

Returns:

a list of common User object.

Throws:

AdminException

getUserFull

UserFull getUserFull(String specificId)
              throws AdminException

Retrieves common user information from database with the additional data.

Parameters:

specificId - The user id as stored in the database.

Returns:

The full User object that contain ALL user information.

Throws:

AdminException

listUserFulls

List<UserFull> listUserFulls(Collection<String> specificIds)
                      throws AdminException

Retrieves common user information with the additional data from database against the given identifiers.

Parameters:

specificIds - The user ids as stored in the database.

Returns:

a list of full User object.

Throws:

AdminException

getUserMemberGroupIds

String[] getUserMemberGroupIds(String specificId)
                        throws AdminException

Throws:

AdminException

getAllUsers

UserDetail[] getAllUsers()
                  throws AdminException

Throws:

AdminException

getUsersBySpecificProperty

UserDetail[] getUsersBySpecificProperty(String propertyName,
                                        String value)
                                 throws AdminException

Throws:

AdminException

getUsersByQuery

UserDetail[] getUsersByQuery(Map<String,String> query)
                      throws AdminException

Throws:

AdminException

importGroup

GroupDetail importGroup(String groupName)
                 throws AdminException

Throws:

AdminException

removeGroup

void removeGroup(String groupId)
          throws AdminException

Throws:

AdminException

synchroGroup

GroupDetail synchroGroup(String groupId)
                  throws AdminException

Throws:

AdminException

createGroup

String createGroup(GroupDetail group)
            throws AdminException

Throws:

AdminException

deleteGroup

void deleteGroup(String groupId)
          throws AdminException

Throws:

AdminException

updateGroup

void updateGroup(GroupDetail group)
          throws AdminException

Throws:

AdminException

getGroup

GroupDetail getGroup(String specificId)
              throws AdminException

Throws:

AdminException

getGroupByName

GroupDetail getGroupByName(String groupName)
                    throws AdminException

Throws:

AdminException

getGroups

GroupDetail[] getGroups(String groupId)
                 throws AdminException

Throws:

AdminException

getAllGroups

GroupDetail[] getAllGroups()
                    throws AdminException

Throws:

AdminException

getAllRootGroups

GroupDetail[] getAllRootGroups()
                        throws AdminException

Throws:

AdminException

getGroupMemberGroupIds

String[] getGroupMemberGroupIds(String groupId)
                         throws AdminException

Throws:

AdminException

getUserAttributes

List<String> getUserAttributes()
                        throws AdminException

Throws:

AdminException

resetPassword

void resetPassword(UserDetail user,
                   String password)
            throws AdminException

Throws:

AdminException

resetEncryptedPassword

void resetEncryptedPassword(UserDetail user,
                            String encryptedPassword)
                     throws AdminException

Throws:

AdminException

getUserFilterManager

default Optional<DomainDriver.UserFilterManager> getUserFilterManager()

Gets an optional DomainDriver.UserFilterManager which permits to manage a filter to apply on the user request results obtained from external user account repository.

Returns:

an optional DomainDriver.UserFilterManager implementation.