com.stratelia.webactiv.beans.admin
Interface DomainDriver

All Known Subinterfaces:

SilverpeasDomainDriver

All Known Implementing Classes:

AbstractDomainDriver, DomainDriverManager, LDAPDriver, SilverpeasDriver, SQLDriver

public interface DomainDriver

Field Summary

static long	ACTION_CREATE_GROUP Create Group action Mask
static long	ACTION_CREATE_USER Create User action Mask
static long	ACTION_DELETE_GROUP Delete Group action Mask
static long	ACTION_DELETE_USER Delete User action Mask
static long	ACTION_EDIT_USER_IN_GROUP Add/Remove User from group action Mask
static long	ACTION_IMPORT_GROUP Add a group in Silverpeas DB by synchronization with a reference LDAP DB
static long	ACTION_IMPORT_USER Add a user in Silverpeas DB by synchronization with a reference LDAP DB
static long	ACTION_MASK_ALL All available actions Mask
static long	ACTION_MASK_MIXED_GROUPS
static long	ACTION_MASK_RO
static long	ACTION_MASK_RW
static long	ACTION_NONE No possible actions Mask
static long	ACTION_READ_GROUP Read Groups' infos action Mask
static long	ACTION_READ_USER Read Users' infos action Mask
static long	ACTION_REMOVE_GROUP Remove group entry from Silverpeas
static long	ACTION_REMOVE_USER Remove user entry from Silverpeas
static long	ACTION_SYNCHRO_GROUP Updates group Silverpeas infos from LDAP DB
static long	ACTION_SYNCHRO_USER Updates user Silverpeas infos from LDAP DB
static long	ACTION_UPDATE_GROUP Update Groups' infos action Mask
static long	ACTION_UPDATE_USER Update Users' infos action Mask
static long	ACTION_X509_USER Create a x509 certificate and store it in server's truststore

Method Summary

void	addPropertiesToImport(List<DomainProperty> props)
void	addPropertiesToImport(List<DomainProperty> props, Map<String,String> theDescriptions)
void	beginSynchronization()
void	commit()
String	createGroup(Group m_Group)
String	createUser(UserDetail user)
void	deleteGroup(String groupId)
void	deleteUser(String userId)
String	endSynchronization(boolean cancelSynchro)
Group[]	getAllChangedGroups(String fromTimeStamp, String toTimeStamp)
UserDetail[]	getAllChangedUsers(String fromTimeStamp, String toTimeStamp)
Group[]	getAllGroups()
Group[]	getAllRootGroups()
UserDetail[]	getAllUsers()
long	getDriverActions()
Group	getGroup(String groupId)
Group	getGroupByName(String groupName)
String[]	getGroupMemberGroupIds(String groupId)
Group[]	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)
String	getTimeStamp(String minTimeStamp)
String	getTimeStampField()
UserDetail	getUser(String userId)
List<String>	getUserAttributes()
UserFull	getUserFull(String userId) Retrieve user information from database
String[]	getUserMemberGroupIds(String userId)
UserDetail[]	getUsersByQuery(Map<String,String> query)
UserDetail[]	getUsersBySpecificProperty(String propertyName, String value)
Group	importGroup(String groupName)
UserDetail	importUser(String userLogin)
void	init(int domainId, String initParam, String authenticationServer)
void	initFromProperties(ResourceLocator rs)
boolean	isGroupsInheritProfiles()
boolean	isSynchroInProcess()
boolean	isSynchroOnLoginEnabled()
boolean	isSynchroOnLoginRecursToGroups()
boolean	isSynchroThreaded()
boolean	isX509CertificateEnabled()
boolean	mustImportUsers()
void	removeGroup(String groupId)
void	removeUser(String userId)
void	resetEncryptedPassword(UserDetail user, String encryptedPassword)
void	resetPassword(UserDetail user, String password)
void	rollback()
void	startTransaction(boolean bAutoCommit)
Group	synchroGroup(String groupId)
UserDetail	synchroUser(String userId)
void	updateGroup(Group m_Group)
void	updateUserDetail(UserDetail user)
void	updateUserFull(UserFull user)

Field Detail

ACTION_NONE

static final long ACTION_NONE

No possible actions Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_READ_USER

static final long ACTION_READ_USER

Read Users' infos action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_READ_GROUP

static final long ACTION_READ_GROUP

Read Groups' infos action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_UPDATE_USER

static final long ACTION_UPDATE_USER

Update Users' infos action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_UPDATE_GROUP

static final long ACTION_UPDATE_GROUP

Update Groups' infos action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_CREATE_USER

static final long ACTION_CREATE_USER

Create User action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_CREATE_GROUP

static final long ACTION_CREATE_GROUP

Create Group action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_DELETE_USER

static final long ACTION_DELETE_USER

Delete User action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_DELETE_GROUP

static final long ACTION_DELETE_GROUP

Delete Group action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_EDIT_USER_IN_GROUP

static final long ACTION_EDIT_USER_IN_GROUP

Add/Remove User from group action Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_IMPORT_USER

static final long ACTION_IMPORT_USER

Add a user in Silverpeas DB by synchronization with a reference LDAP DB

See Also:

getDriverActions(), Constant Field Values

ACTION_SYNCHRO_USER

static final long ACTION_SYNCHRO_USER

Updates user Silverpeas infos from LDAP DB

See Also:

getDriverActions(), Constant Field Values

ACTION_REMOVE_USER

static final long ACTION_REMOVE_USER

Remove user entry from Silverpeas

See Also:

getDriverActions(), Constant Field Values

ACTION_IMPORT_GROUP

static final long ACTION_IMPORT_GROUP

Add a group in Silverpeas DB by synchronization with a reference LDAP DB

See Also:

getDriverActions(), Constant Field Values

ACTION_SYNCHRO_GROUP

static final long ACTION_SYNCHRO_GROUP

Updates group Silverpeas infos from LDAP DB

See Also:

getDriverActions(), Constant Field Values

ACTION_REMOVE_GROUP

static final long ACTION_REMOVE_GROUP

Remove group entry from Silverpeas

See Also:

getDriverActions(), Constant Field Values

ACTION_X509_USER

static final long ACTION_X509_USER

Create a x509 certificate and store it in server's truststore

See Also:

getDriverActions(), Constant Field Values

ACTION_MASK_ALL

static final long ACTION_MASK_ALL

All available actions Mask

See Also:

getDriverActions(), Constant Field Values

ACTION_MASK_RW

static final long ACTION_MASK_RW

See Also:

Constant Field Values

ACTION_MASK_RO

static final long ACTION_MASK_RO

See Also:

Constant Field Values

ACTION_MASK_MIXED_GROUPS

static final long ACTION_MASK_MIXED_GROUPS

See Also:

Constant Field Values

Method Detail

init

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

Throws:

Exception

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(ResourceLocator rs)
                        throws Exception

Throws:

Exception

getDriverActions

long getDriverActions()

isSynchroOnLoginEnabled

boolean isSynchroOnLoginEnabled()

isSynchroThreaded

boolean isSynchroThreaded()

isSynchroOnLoginRecursToGroups

boolean isSynchroOnLoginRecursToGroups()

isGroupsInheritProfiles

boolean isGroupsInheritProfiles()

mustImportUsers

boolean mustImportUsers()

getTimeStamp

String getTimeStamp(String minTimeStamp)
                    throws Exception

Throws:

Exception

getTimeStampField

String getTimeStampField()
                         throws Exception

Throws:

Exception

isX509CertificateEnabled

boolean isX509CertificateEnabled()

getAllChangedUsers

UserDetail[] getAllChangedUsers(String fromTimeStamp,
                                String toTimeStamp)
                                throws Exception

Throws:

Exception

getAllChangedGroups

Group[] getAllChangedGroups(String fromTimeStamp,
                            String toTimeStamp)
                            throws Exception

Throws:

Exception

beginSynchronization

void beginSynchronization()
                          throws Exception

Throws:

Exception

isSynchroInProcess

boolean isSynchroInProcess()
                           throws Exception

Throws:

Exception

endSynchronization

String endSynchronization(boolean cancelSynchro)
                          throws Exception

Throws:

Exception

importUser

UserDetail importUser(String userLogin)
                      throws Exception

Throws:

Exception

removeUser

void removeUser(String userId)
                throws Exception

Throws:

Exception

synchroUser

UserDetail synchroUser(String userId)
                       throws Exception

Throws:

Exception

createUser

String createUser(UserDetail user)
                  throws Exception

Throws:

Exception

deleteUser

void deleteUser(String userId)
                throws Exception

Throws:

Exception

updateUserFull

void updateUserFull(UserFull user)
                    throws Exception

Throws:

Exception

updateUserDetail

void updateUserDetail(UserDetail user)
                      throws Exception

Throws:

Exception

getUser

UserDetail getUser(String userId)
                   throws Exception

Throws:

Exception

getUserFull

UserFull getUserFull(String userId)
                     throws Exception

Retrieve user information from database

Parameters:

userId - The user id as stored in the database

Returns:

The full User object that contain ALL user informations

Throws:

Exception

getUserMemberGroupIds

String[] getUserMemberGroupIds(String userId)
                               throws Exception

Throws:

Exception

getAllUsers

UserDetail[] getAllUsers()
                         throws Exception

Throws:

Exception

getUsersBySpecificProperty

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

Throws:

Exception

getUsersByQuery

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

Throws:

Exception

importGroup

Group importGroup(String groupName)
                  throws Exception

Throws:

Exception

removeGroup

void removeGroup(String groupId)
                 throws Exception

Throws:

Exception

synchroGroup

Group synchroGroup(String groupId)
                   throws Exception

Throws:

Exception

createGroup

String createGroup(Group m_Group)
                   throws Exception

Throws:

Exception

deleteGroup

void deleteGroup(String groupId)
                 throws Exception

Throws:

Exception

updateGroup

void updateGroup(Group m_Group)
                 throws Exception

Throws:

Exception

getGroup

Group getGroup(String groupId)
               throws Exception

Throws:

Exception

getGroupByName

Group getGroupByName(String groupName)
                     throws Exception

Throws:

Exception

getGroups

Group[] getGroups(String groupId)
                  throws Exception

Throws:

Exception

getAllGroups

Group[] getAllGroups()
                     throws Exception

Throws:

Exception

getAllRootGroups

Group[] getAllRootGroups()
                         throws Exception

Throws:

Exception

getGroupMemberGroupIds

String[] getGroupMemberGroupIds(String groupId)
                                throws Exception

Throws:

Exception

startTransaction

void startTransaction(boolean bAutoCommit)

commit

void commit()
            throws Exception

Throws:

Exception

rollback

void rollback()
              throws Exception

Throws:

Exception

getUserAttributes

List<String> getUserAttributes()
                               throws Exception

Throws:

Exception

resetPassword

void resetPassword(UserDetail user,
                   String password)
                   throws Exception

Throws:

Exception

resetEncryptedPassword

void resetEncryptedPassword(UserDetail user,
                            String encryptedPassword)
                            throws Exception

Throws:

Exception