|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.stratelia.webactiv.beans.admin.AbstractDomainDriver
com.stratelia.silverpeas.domains.ldapdriver.LDAPDriver
public class LDAPDriver
Domain driver for LDAP access. Could be used to access any type of LDAP DB (even exchange) IMPORTANT : For the moment, it is not possible to add, remove or update a group neither add or remove an user. However, it is possible to update an user...
Field Summary | |
---|---|
protected LDAPSettings |
driverSettings
|
protected AbstractLDAPGroup |
groupTranslator
|
protected LDAPUser |
userTranslator
|
Fields inherited from class com.stratelia.webactiv.beans.admin.AbstractDomainDriver |
---|
domainId, domainProperties, keys, m_mapParameters, m_PropertiesDescriptions, m_PropertiesLabels, m_PropertiesMultilang, x509Enabled |
Fields inherited from interface com.stratelia.webactiv.beans.admin.DomainDriver |
---|
ACTION_CREATE_GROUP, ACTION_CREATE_USER, ACTION_DELETE_GROUP, ACTION_DELETE_USER, ACTION_EDIT_USER_IN_GROUP, ACTION_IMPORT_GROUP, ACTION_IMPORT_USER, ACTION_MASK_ALL, ACTION_MASK_MIXED_GROUPS, ACTION_MASK_RO, ACTION_MASK_RW, ACTION_NONE, ACTION_READ_GROUP, ACTION_READ_USER, ACTION_REMOVE_GROUP, ACTION_REMOVE_USER, ACTION_SYNCHRO_GROUP, ACTION_SYNCHRO_USER, ACTION_UPDATE_GROUP, ACTION_UPDATE_USER, ACTION_X509_USER |
Constructor Summary | |
---|---|
LDAPDriver()
|
Method Summary | |
---|---|
void |
addPropertiesToImport(List<DomainProperty> props)
|
void |
addPropertiesToImport(List<DomainProperty> props,
Map<String,String> descriptions)
|
void |
beginSynchronization()
Called when Admin starts the synchronization |
void |
commit()
Commit transaction |
String |
createGroup(Group m_Group)
|
String |
createUser(UserDetail user)
|
void |
deleteGroup(String groupId)
|
void |
deleteUser(String userId)
|
String |
endSynchronization()
Called when Admin ends the synchronization |
Group[] |
getAllChangedGroups(String fromTimeStamp,
String toTimeStamp)
|
UserDetail[] |
getAllChangedUsers(String fromTimeStamp,
String toTimeStamp)
|
Group[] |
getAllGroups()
Retrieve all groups from the database |
Group[] |
getAllRootGroups()
Retrieve all root groups from the database |
UserDetail[] |
getAllUsers()
Retrieve all users from the database |
long |
getDriverActions()
Called when Admin starts the synchronization |
Group |
getGroup(String groupId)
Retrieve group information from database |
Group |
getGroupByName(String groupName)
|
String[] |
getGroupMemberGroupIds(String groupId)
|
Group[] |
getGroups(String groupId)
Retrieve all groups contained in the given group |
String |
getTimeStamp(String minTimeStamp)
|
String |
getTimeStampField()
|
UserDetail |
getUser(String userId)
Retrieve user information from database |
List<String> |
getUserAttributes()
|
UserFull |
getUserFull(String userId)
Retrieve user information from database |
String[] |
getUserMemberGroupIds(String userId)
Retrieve user's groups |
UserDetail[] |
getUsersByQuery(Map<String,String> query)
|
UserDetail[] |
getUsersBySpecificProperty(String propertyName,
String propertyValue)
|
Group |
importGroup(String groupName)
Import a given group in Database from the reference |
UserDetail |
importUser(String userLogin)
Import a given user in Database from the reference |
void |
initFromProperties(ResourceLocator rs)
Virtual method that performs extra initialization from a properties file. |
boolean |
isGroupsInheritProfiles()
|
boolean |
isSynchroOnLoginEnabled()
|
boolean |
isSynchroOnLoginRecursToGroups()
|
boolean |
isSynchroThreaded()
|
boolean |
mustImportUsers()
|
void |
removeGroup(String groupId)
Remove a given group from database |
void |
removeUser(String userId)
Remove a given user from database |
void |
resetEncryptedPassword(UserDetail user,
String encryptedPassword)
|
void |
resetPassword(UserDetail user,
String password)
|
void |
rollback()
Rollback transaction |
void |
startTransaction(boolean bAutoCommit)
Start a new transaction |
Group |
synchroGroup(String groupId)
Update group information in database |
UserDetail |
synchroUser(String userId)
Update user information in database |
void |
updateGroup(Group m_Group)
|
void |
updateUserDetail(UserDetail user)
|
void |
updateUserFull(UserFull user)
|
Methods inherited from class com.stratelia.webactiv.beans.admin.AbstractDomainDriver |
---|
endSynchronization, getMapParameters, getPropertiesDescriptions, getPropertiesLabels, getPropertiesNames, getPropertiesToImport, getProperty, idAsInt, idAsString, init, isSynchroInProcess, isX509CertificateEnabled |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected LDAPSettings driverSettings
protected LDAPUser userTranslator
protected AbstractLDAPGroup groupTranslator
Constructor Detail |
---|
public LDAPDriver()
Method Detail |
---|
public void initFromProperties(ResourceLocator rs) throws AdminException
initFromProperties
in interface DomainDriver
initFromProperties
in class AbstractDomainDriver
rs
- name of resource file
AdminException
public void addPropertiesToImport(List<DomainProperty> props)
addPropertiesToImport
in interface DomainDriver
addPropertiesToImport
in class AbstractDomainDriver
public void addPropertiesToImport(List<DomainProperty> props, Map<String,String> descriptions)
addPropertiesToImport
in interface DomainDriver
addPropertiesToImport
in class AbstractDomainDriver
public long getDriverActions()
getDriverActions
in interface DomainDriver
getDriverActions
in class AbstractDomainDriver
public boolean isSynchroOnLoginEnabled()
isSynchroOnLoginEnabled
in interface DomainDriver
isSynchroOnLoginEnabled
in class AbstractDomainDriver
public boolean isSynchroOnLoginRecursToGroups()
isSynchroOnLoginRecursToGroups
in interface DomainDriver
isSynchroOnLoginRecursToGroups
in class AbstractDomainDriver
public boolean isGroupsInheritProfiles()
isGroupsInheritProfiles
in interface DomainDriver
isGroupsInheritProfiles
in class AbstractDomainDriver
public boolean mustImportUsers()
mustImportUsers
in interface DomainDriver
mustImportUsers
in class AbstractDomainDriver
public boolean isSynchroThreaded()
isSynchroThreaded
in interface DomainDriver
isSynchroThreaded
in class AbstractDomainDriver
public String getTimeStamp(String minTimeStamp) throws AdminException
getTimeStamp
in interface DomainDriver
getTimeStamp
in class AbstractDomainDriver
AdminException
public String getTimeStampField()
getTimeStampField
in interface DomainDriver
getTimeStampField
in class AbstractDomainDriver
public UserDetail[] getAllChangedUsers(String fromTimeStamp, String toTimeStamp) throws AdminException
AdminException
public Group[] getAllChangedGroups(String fromTimeStamp, String toTimeStamp) throws AdminException
AdminException
public void beginSynchronization() throws Exception
beginSynchronization
in interface DomainDriver
beginSynchronization
in class AbstractDomainDriver
Exception
public String endSynchronization() throws Exception
Exception
public UserDetail importUser(String userLogin) throws AdminException
userLogin
- The User Login to import
AdminException
public void removeUser(String userId) throws AdminException
userId
- The user id To remove synchro
AdminException
public UserDetail synchroUser(String userId) throws Exception
userId
- The User Id to synchronize
Exception
public String createUser(UserDetail user) throws Exception
Exception
public void deleteUser(String userId) throws Exception
Exception
public void updateUserFull(UserFull user) throws AdminException
AdminException
public void updateUserDetail(UserDetail user) throws Exception
Exception
public UserFull getUserFull(String userId) throws AdminException
userId
- The user id as stored in the database
AdminException
public UserDetail getUser(String userId) throws AdminException
userId
- The user id as stored in the database
AdminException
public UserDetail[] getAllUsers() throws AdminException
AdminException
public UserDetail[] getUsersBySpecificProperty(String propertyName, String propertyValue) throws AdminException
AdminException
public UserDetail[] getUsersByQuery(Map<String,String> query) throws AdminException
AdminException
public String[] getUserMemberGroupIds(String userId) throws AdminException
userId
- The user id as stored in the database
AdminException
public Group importGroup(String groupName) throws AdminException
groupName
- The group name to import
AdminException
public void removeGroup(String groupId) throws AdminException
groupId
- The group id To remove synchro
AdminException
public Group synchroGroup(String groupId) throws AdminException
groupId
- The group Id to synchronize
AdminException
public String createGroup(Group m_Group) throws AdminException
AdminException
public void deleteGroup(String groupId) throws AdminException
AdminException
public void updateGroup(Group m_Group) throws AdminException
AdminException
public Group getGroup(String groupId) throws AdminException
groupId
- The group id as stored in the database
AdminException
public Group getGroupByName(String groupName) throws AdminException
AdminException
public Group[] getGroups(String groupId) throws AdminException
groupId
- The group id as stored in the database
AdminException
public Group[] getAllGroups() throws AdminException
AdminException
public Group[] getAllRootGroups() throws AdminException
AdminException
public String[] getGroupMemberGroupIds(String groupId) throws AdminException
AdminException
public void startTransaction(boolean bAutoCommit)
bAutoCommit
- Specifies is transaction is automatically committed (without explicit
'commit' statement)public void commit() throws AdminException
AdminException
public void rollback() throws AdminException
AdminException
public List<String> getUserAttributes() throws AdminException
AdminException
public void resetPassword(UserDetail user, String password) throws Exception
Exception
public void resetEncryptedPassword(UserDetail user, String encryptedPassword) throws Exception
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |