Package org.silverpeas.core.admin.domain.driver.scimdriver

Class SCIMDriver

java.lang.Object

org.silverpeas.core.admin.domain.AbstractDomainDriver

org.silverpeas.core.admin.domain.driver.scimdriver.SCIMDriver

All Implemented Interfaces:

DomainDriver

public class SCIMDriver
extends AbstractDomainDriver

Nested Class Summary

Nested classes/interfaces inherited from interface org.silverpeas.core.admin.domain.DomainDriver

DomainDriver.ActionConstants, DomainDriver.UserFilterManager

Field Summary

Fields

Modifier and Type	Field	Description
static String	GROUP

Fields inherited from class org.silverpeas.core.admin.domain.AbstractDomainDriver

domainId, domainProperties, keys, mapParameters, propertiesDescriptions, propertiesl10n, propertiesLabels, synchroInProcess, x509Enabled

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SCIMDriver()	Constructor

Method Summary

Modifier and Type	Method	Description
void	addUserInGroup(String userId, String groupId)
String	createGroup(GroupDetail group)
String	createUser(UserDetail ud)
void	deleteGroup(String groupId)
void	deleteUser(String userId)
GroupDetail[]	getAllGroups()
GroupDetail[]	getAllRootGroups()
UserDetail[]	getAllUsers()
long	getDriverActions()	Called when Admin starts the synchronization
GroupDetail	getGroup(String specificId)
GroupDetail	getGroupByName(String groupName)
String[]	getGroupMemberGroupIds(String groupId)
GroupDetail[]	getGroups(String groupId)
UserDetail	getUser(String specificId)	Retrieves common user information from database.
List<String>	getUserAttributes()
UserFull	getUserFull(String id)	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 propertyValue)
GroupDetail	importGroup(String groupName)
UserDetail	importUser(String userLogin)
void	initFromProperties(SettingBundle rs)	Virtual method that performs extra initialization from a properties file.
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.
void	removeGroup(String groupId)
void	removeUser(String userId)
void	removeUserFromGroup(String userId, String groupId)
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 ud)
void	updateUserFull(UserFull uf)	Update the data inside domain <DOMAIN_NAME>_user table

Methods inherited from class org.silverpeas.core.admin.domain.AbstractDomainDriver

addPropertiesToImport, addPropertiesToImport, beginSynchronization, endSynchronization, getMapParameters, getPropertiesDescriptions, getPropertiesLabels, getPropertiesNames, getPropertiesToImport, getProperty, idAsInt, idAsString, init, isGroupsInheritProfiles, isSynchroInProcess, isSynchroOnLoginEnabled, isSynchroOnLoginRecursToGroups, isSynchroThreaded, isX509CertificateEnabled, mustImportUsers

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.silverpeas.core.admin.domain.DomainDriver

getUserFilterManager

Field Detail

GROUP

public static final String GROUP

See Also:

Constant Field Values

Constructor Detail

SCIMDriver

protected SCIMDriver()

Constructor

Method Detail

getGroupMemberGroupIds

public String[] getGroupMemberGroupIds(String groupId)

initFromProperties

public void initFromProperties(SettingBundle rs)

Virtual method that performs extra initialization from a properties file. To overload by the class who need it.

Specified by:

initFromProperties in interface DomainDriver

Overrides:

initFromProperties in class AbstractDomainDriver

Parameters:

rs - name of resource file

getDriverActions

public long getDriverActions()

Called when Admin starts the synchronization

Specified by:

getDriverActions in interface DomainDriver

Overrides:

getDriverActions in class AbstractDomainDriver

Returns:

importUser

public UserDetail importUser(String userLogin)

removeUser

public void removeUser(String userId)

synchroUser

public UserDetail synchroUser(String userId)

createUser

public String createUser(UserDetail ud)
                  throws AdminException

Parameters:

ud -

Returns:

String

Throws:

AdminException

resetPassword

public void resetPassword(UserDetail user,
                          String password)

resetEncryptedPassword

public void resetEncryptedPassword(UserDetail user,
                                   String encryptedPassword)

deleteUser

public void deleteUser(String userId)

updateUserFull

public void updateUserFull(UserFull uf)

Update the data inside domain <DOMAIN_NAME>_user table

Parameters:

uf - a UserFull object

updateUserDetail

public void updateUserDetail(UserDetail ud)

getUser

public UserDetail getUser(String specificId)
                   throws AdminException

Description copied from interface: DomainDriver

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

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

Description copied from interface: DomainDriver

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

public UserFull getUserFull(String id)
                     throws AdminException

Description copied from interface: DomainDriver

Retrieves common user information from database with the additional data.

Parameters:

id - The user id as stored in the database.

Returns:

The full User object that contain ALL user information.

Throws:

AdminException

listUserFulls

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

Description copied from interface: DomainDriver

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

public String[] getUserMemberGroupIds(String specificId)

getAllUsers

public UserDetail[] getAllUsers()
                         throws AdminException

Throws:

AdminException

getUsersBySpecificProperty

public UserDetail[] getUsersBySpecificProperty(String propertyName,
                                               String propertyValue)

getUsersByQuery

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

importGroup

public GroupDetail importGroup(String groupName)

removeGroup

public void removeGroup(String groupId)

synchroGroup

public GroupDetail synchroGroup(String groupId)

createGroup

public String createGroup(GroupDetail group)

deleteGroup

public void deleteGroup(String groupId)

updateGroup

public void updateGroup(GroupDetail group)

getGroup

public GroupDetail getGroup(String specificId)

getGroupByName

public GroupDetail getGroupByName(String groupName)

getGroups

public GroupDetail[] getGroups(String groupId)

getAllGroups

public GroupDetail[] getAllGroups()

getAllRootGroups

public GroupDetail[] getAllRootGroups()

addUserInGroup

public void addUserInGroup(String userId,
                           String groupId)

removeUserFromGroup

public void removeUserFromGroup(String userId,
                                String groupId)

getUserAttributes

public List<String> getUserAttributes()