ConfigurationLDAP (Logi Report 25.3 Service Pack 5 API Index)

```
public interface ConfigurationLDAP
```
This interface defines the methods to manage the LDAP server configuration.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`autoImportLDAPUser(String userName, String password)` Auto-imports a LDAP user.
`boolean`	`checkSynchronization()` Deprecated. This method is not effective since V7.0.
`boolean`	`confirmFilter(String userName, String filter)` Checks whether the user confirms the LDAP search filter or not.
`boolean`	`deleteSynSchedule()` Deletes the LDAP synchronization schedule task.
`boolean`	`disableSynSchedule()` Disables the LDAP synchronization schedule.
`boolean`	`enableSynSchedule()` Enables the LDAP synchronization schedule.
`boolean`	`exportSynResultToXMLFile(String outputDir, SynchronizationResult result)` Exports the LDAP synchronization result object to an XML file.
`Vector`	`getEncryptedUsers()` Deprecated. This method is not effective since V7.0.
`SynchronizationResult`	`getLastLDAPSynchronizeScheduleResult()` Gets the last LDAP synchronization schedule task's result object.
`Vector`	`getLDAPGroups()` Gets the LDAP groups setting according to LDAP configuration.
`Enumeration`	`getLdapSynchronization()` Deprecated. This method is not effective since V7.0.
`Vector`	`getLDAPUsers()` Gets the LDAP users setting according to LDAP configuration.
`Properties`	`getSynchronizeSchedule()` Gets the LDAP synchronization schedule's properties.
`Enumeration`	`getUserNames()` Gets LDAP user names.
`boolean`	`importAllLDAPUsersAndGroups(boolean isOverWrite)` Imports all the LDAP groups and users from LDAP server.
`boolean`	`importLDAPGroups(boolean isOverWrite)` Imports the LDAP groups to local from LDAP Server(import to role or group).
`boolean`	`importLDAPGroupsAndUsers()` Deprecated. This method is not effective since V7.0.
`boolean`	`importLDAPRoles(boolean isOverWrite)` Deprecated. This method is not effective since V7.1. It has been replaced by importLDAPGroups(boolean isOverWrite).
`boolean`	`importLDAPUsers(boolean isOverWrite)` Imports the LDAP user to local from LDAP server.
`boolean`	`importSpecifyLDAPGroups(Vector specifyRolesName, boolean isOverWrite)` Imports some LDAP groups that specified by customers to local from LDAP Server(import to role or group).
`boolean`	`importSpecifyLDAPRoles(Vector specifyRolesName, boolean isOverWrite)` Deprecated. This method is not effective since V7.1. It has been replaced by importSpecifyLDAPGroups(Vector specifyRolesName, boolean isOverWrite).
`boolean`	`importSpecifyLDAPUsers(Vector specifyUsersName, boolean isOverWrite)` Imports some LDAP users that are specified by customers to local from LDAP Server.
`boolean`	`isConfromFilter(String userName, String filter)` Deprecated. This method is not effective since V8.0.
`boolean`	`isLDAPScheduleEnable()` Checks whether the LDAP Synchronization schedule is enabled or not.
`boolean`	`isValidLDAPUser(String userName, String password)` Checks whether a user is a valid LDAP user or not.
`boolean`	`isValidLDAPUserByDN(String userName, String userDN, String password)` Checks whether a user is a valid LDAP user or not.
`String`	`listExistedGroupDescriptions(String groupName)` Deprecated. This method is not effective since V6.
`Vector`	`listExistedGroups()` Returns all the groups in LDAP.
`Vector`	`listExistedGroupsName()` Deprecated. This method is not effective since V6.
`String`	`listExistedUserFullName(String name)` Deprecated. This method is not effective since V6.
`Vector`	`listExistedUserNames()` Deprecated. This method is not effective since V6.
`Vector`	`listExistedUsers()` Returns all the user names in LDAP.
`void`	`setEncryptedUserAuthInfo(String name, String pw)` Deprecated. This method is not effective since V6.
`boolean`	`submitSynchronizeSchedule(Properties pro, String submitter)` Submits a new LDAP synchronization schedule to server.
`SynchronizationResult`	`synchronize()` Synchronizes the server's security information with LDAP server.
`String`	`testRoleMap(String filter, String roleName)` Checks whether the role map is valid or not.

- Method Detail
  - getLdapSynchronization
```
Enumeration getLdapSynchronization()
```
    Deprecated. This method is not effective since V7.0.
    
    Checks the synchronization and returns the entries and the acls.
    
    Returns:
    
    hashtable key:acl name value:entry name
  - getUserNames
```
Enumeration getUserNames()
```
    Gets LDAP user names.
    
    Returns:
    
    the enumeration of user names.
  - importLDAPGroupsAndUsers
```
boolean importLDAPGroupsAndUsers()
```
    Deprecated. This method is not effective since V7.0.
    
    Puts LDAP user and group into server.
    
    Returns:
    
    boolean if the import is successful.
  - checkSynchronization
```
boolean checkSynchronization()
```
    Deprecated. This method is not effective since V7.0.
    
    Puts the LDAP user and group synchronization with server.
    
    Returns:
    
    boolean if the check is successful.
  - setEncryptedUserAuthInfo
```
void setEncryptedUserAuthInfo(String name,
                              String pw)
```
    Deprecated. This method is not effective since V6.
    
    Saves the user password when the user is encrypted.
    
    Parameters:
    
    name - the user name.
    
    pw - the password.
  - listExistedUsers
```
Vector listExistedUsers()
```
    Returns all the user names in LDAP.
    
    Returns:
    
    all the user names in LDAP.
  - listExistedGroups
```
Vector listExistedGroups()
```
    Returns all the groups in LDAP.
    
    Returns:
    
    all the groups in LDAP.
  - listExistedUserNames
```
Vector listExistedUserNames()
```
    Deprecated. This method is not effective since V6.
    
    Returns all the user names in LDAP.
    
    Returns:
    
    all the user names in LDAP.
  - listExistedUserFullName
```
String listExistedUserFullName(String name)
```
    Deprecated. This method is not effective since V6.
    
    Returns all the user full names in LDAP.
    
    Returns:
    
    all the user full names in LDAP.
  - listExistedGroupsName
```
Vector listExistedGroupsName()
```
    Deprecated. This method is not effective since V6.
    
    Returns all the groups in LDAP.
    
    Returns:
    
    all the groups in LDAP.
  - listExistedGroupDescriptions
```
String listExistedGroupDescriptions(String groupName)
```
    Deprecated. This method is not effective since V6.
    
    Returns all groups Description in LDAP.
    
    Returns:
    
    all groups Description in LDAP.
  - importLDAPUsers
```
boolean importLDAPUsers(boolean isOverWrite)
```
    Imports the LDAP user to local from LDAP server.
    
    Parameters:
    
    isOverWrite - true when the LDAP user overwrites the local user, otherwise false.
    
    Returns:
    
    whether to import successfully or not.
    
    Since:
    
    V6
  - importSpecifyLDAPUsers
```
boolean importSpecifyLDAPUsers(Vector specifyUsersName,
                               boolean isOverWrite)
```
    Imports some LDAP users that are specified by customers to local from LDAP Server.
    
    Parameters:
    
    specifyUsersName - the specified LDAP users' name setting.
    
    isOverWrite - true when the LDAP user overwrites the local user, otherwise false.
    
    Returns:
    
    whether to import successfully or not.
    
    Since:
    
    V6
  - importLDAPRoles
```
boolean importLDAPRoles(boolean isOverWrite)
```
    Deprecated. This method is not effective since V7.1. It has been replaced by importLDAPGroups(boolean isOverWrite).
    
    Imports the LDAP groups to local roles from LDAP server.
    
    Parameters:
    
    isOverWrite - true when the LDAP user overwrites the local user, otherwise false.
    
    Returns:
    
    whether to import successfully or not.
    
    Since:
    
    V6
  - importLDAPGroups
```
boolean importLDAPGroups(boolean isOverWrite)
```
    Imports the LDAP groups to local from LDAP Server(import to role or group).
    
    Parameters:
    
    isOverWrite - true when the LDAP user overwrites the local user, otherwise false.
    
    Returns:
    
    whether to import successfully or not.
    
    Since:
    
    V7.1
  - importSpecifyLDAPRoles
```
boolean importSpecifyLDAPRoles(Vector specifyRolesName,
                               boolean isOverWrite)
```
    Deprecated. This method is not effective since V7.1. It has been replaced by importSpecifyLDAPGroups(Vector specifyRolesName, boolean isOverWrite).
    
    Imports some LDAP groups that are specified by customers to local roles from LDAP Server.
    
    Parameters:
    
    specifyRolesName - the specified roles' name setting.
    
    isOverWrite - true when the LDAP user overwrites the local user, otherwise false.
    
    Returns:
    
    whether to import successfully or not.
    
    Since:
    
    V6
  - importSpecifyLDAPGroups
```
boolean importSpecifyLDAPGroups(Vector specifyRolesName,
                                boolean isOverWrite)
```
    Imports some LDAP groups that specified by customers to local from LDAP Server(import to role or group).
    
    Parameters:
    
    specifyRolesName - the specified roles' name setting.
    
    isOverWrite - true when the LDAP user overwrites the local user, otherwise false.
    
    Returns:
    
    whether to import successfully or not.
    
    Since:
    
    V7.1
  - importAllLDAPUsersAndGroups
```
boolean importAllLDAPUsersAndGroups(boolean isOverWrite)
```
    Imports all the LDAP groups and users from LDAP server.
    
    Parameters:
    
    isOverWrite - true when the LDAP user overwrites the local user, otherwise false.
    
    Returns:
    
    true when the import is successful, otherwise return false.
  - getLDAPUsers
```
Vector getLDAPUsers()
```
    Gets the LDAP users setting according to LDAP configuration.
    
    Returns:
    
    the LDAP users setting.
    
    Since:
    
    V6
  - getLDAPGroups
```
Vector getLDAPGroups()
```
    Gets the LDAP groups setting according to LDAP configuration.
    
    Returns:
    
    the LDAP groups setting.
    
    Since:
    
    V6
  - getEncryptedUsers
```
Vector getEncryptedUsers()
```
    Deprecated. This method is not effective since V7.0.
    
    Returns all the users which have been encrypted.
    
    Returns:
    
    all the users which have been encrypted.
  - testRoleMap
```
String testRoleMap(String filter,
                   String roleName)
```
    Checks whether the role map is valid or not.
    
    Parameters:
    
    filter - the role map's filter.
    
    roleName - the role map's binding role name.
    
    Returns:
    
    the test message.
    
    Since:
    
    server V7.0
  - autoImportLDAPUser
```
String autoImportLDAPUser(String userName,
                          String password)
```
    Auto-imports a LDAP user.
    
    Parameters:
    
    userName - the user's name.
    
    password - the user's password.
    
    Returns:
    
    if imported successfully, return null, otherwise return error message.
    
    Since:
    
    server V7.0
  - isConfromFilter
```
boolean isConfromFilter(String userName,
                        String filter)
```
    Deprecated. This method is not effective since V8.0.
    
    Checks whether the user conforms the LDAP search filter or not.
    
    Parameters:
    
    userName - the user's name.
    
    filter - the LDAP search filter.
    
    Returns:
    
    if this filter is confirmed, return true, otherwise return false.
    
    Since:
    
    server V7.0
  - confirmFilter
```
boolean confirmFilter(String userName,
                      String filter)
```
    Checks whether the user confirms the LDAP search filter or not.
    
    Parameters:
    
    userName - the user's name.
    
    filter - the LDAP search filter.
    
    Returns:
    
    if this filter is confirmed, return true, otherwise return false.
    
    Since:
    
    server V8.0
  - isValidLDAPUser
```
boolean isValidLDAPUser(String userName,
                        String password)
```
    Checks whether a user is a valid LDAP user or not.
    
    Parameters:
    
    userName - the user's name.
    
    password - the user's password.
    
    Returns:
    
    if user is a valid LDAP user, return true, otherwise return false.
    
    Since:
    
    server V7.0
  - isValidLDAPUserByDN
```
boolean isValidLDAPUserByDN(String userName,
                            String userDN,
                            String password)
```
    Checks whether a user is a valid LDAP user or not.
    
    Parameters:
    
    userName - the user's name.
    
    userDN - the user's dn(distinguished name) in LDAP server.
    
    password - the user's password.
    
    Returns:
    
    if user is a valid LDAP user, return true, otherwise return false.
    
    Since:
    
    server V8.0
  - synchronize
```
SynchronizationResult synchronize()
```
    Synchronizes the server's security information with LDAP server.
    
    Returns:
    
    a SynchronizationResult Object, the user can get the synchronization information. For instance: the users' name is removed because LDAP server removed it.
    
    Since:
    
    server V7.0
  - isLDAPScheduleEnable
```
boolean isLDAPScheduleEnable()
```
    Checks whether the LDAP Synchronization schedule is enabled or not.
    
    Returns:
    
    if this schedule is enabled, return true, otherwise return false.
    
    Since:
    
    server V7.0
  - submitSynchronizeSchedule
```
boolean submitSynchronizeSchedule(Properties pro,
                                  String submitter)
```
    Submits a new LDAP synchronization schedule to server. If there is a schedule store in server, the system will replace the old schedule with the new one.
    
    Parameters:
    
    pro - the schedule's properties.
    
    submitter - the submitter's name.
    
    Returns:
    
    if submitted successful, return true. otherwise return false.
    
    Since:
    
    server V7.0
  - getSynchronizeSchedule
```
Properties getSynchronizeSchedule()
```
    Gets the LDAP synchronization schedule's properties.
    
    Returns:
    
    Properties the schedule's properties.
  - disableSynSchedule
```
boolean disableSynSchedule()
```
    Disables the LDAP synchronization schedule.
    
    Returns:
    
    if disabled successfully, return true, otherwise return false.
    
    Since:
    
    server V7.0
  - enableSynSchedule
```
boolean enableSynSchedule()
```
    Enables the LDAP synchronization schedule.
    
    Returns:
    
    if enabled successfully, return true, otherwise return false.
    
    Since:
    
    server V7.0
  - deleteSynSchedule
```
boolean deleteSynSchedule()
```
    Deletes the LDAP synchronization schedule task.
    
    Returns:
    
    if deleted successfully, return true, otherwise return false.
    
    Since:
    
    server V7.0
  - exportSynResultToXMLFile
```
boolean exportSynResultToXMLFile(String outputDir,
                                 SynchronizationResult result)
```
    Exports the LDAP synchronization result object to an XML file.
    
    Parameters:
    
    outputDir - the XML file's dir, for example: C:\temp\result.xml.
    
    result - the LDAP synchronization result.
    
    Returns:
    
    if the object is successfully exported, return true, otherwise return false.
    
    Since:
    
    server V7.0
  - getLastLDAPSynchronizeScheduleResult
```
SynchronizationResult getLastLDAPSynchronizeScheduleResult()
```
    Gets the last LDAP synchronization schedule task's result object.
    
    Returns:
    
    the LDAP synchronization result object.
    
    Since:
    
    server V7.0

Interface ConfigurationLDAP

Method Summary

Method Detail

getLdapSynchronization

getUserNames

importLDAPGroupsAndUsers

checkSynchronization

setEncryptedUserAuthInfo

listExistedUsers

listExistedGroups

listExistedUserNames

listExistedUserFullName

listExistedGroupsName

listExistedGroupDescriptions

importLDAPUsers

importSpecifyLDAPUsers

importLDAPRoles

importLDAPGroups

importSpecifyLDAPRoles

importSpecifyLDAPGroups

importAllLDAPUsersAndGroups

getLDAPUsers

getLDAPGroups

getEncryptedUsers

testRoleMap

autoImportLDAPUser

isConfromFilter

confirmFilter

isValidLDAPUser

isValidLDAPUserByDN

synchronize

isLDAPScheduleEnable

submitSynchronizeSchedule

getSynchronizeSchedule

disableSynSchedule

enableSynSchedule

deleteSynSchedule

exportSynResultToXMLFile

getLastLDAPSynchronizeScheduleResult