public interface

WebLDAPSettings

com.microstrategy.web.objects.WebLDAPSettings

Class Overview

The WebLDAPSettings interface contains a set of settings related to the LDAP configuration of a WebServerDef object. Any changes made to the properties on this interface will not be saved to metadata until the WebServerDef object it was obtained from is saved back to metadata.

Summary

Public Methods
abstract void clear()
This method will clear all LDAP settings, and set the string sent to the server back to an empty string.
abstract int getAllowLoginIfNotLinked()
Returns an integer indicates whether to let the user logon if LDAP Attribute value is not read from the LDAP server.
abstract int getBatchImportGroup()
Returns the option whether import groups on the Import/Synchronize tab.
abstract int getBatchImportUser()
Returns the option whether to import/synchronize at Login on the Import/Synchronize tab.
abstract String getBatchSearchFilterForGroups()
Returns a String contains the search filter for importing list of groups.
abstract String getBatchSearchFilterForUsers()
Returns a String contains the search filter for importing list of users.
abstract int getBatchSynch()
Returns an integer indicates whether to synchronize MicroStrategy User Login/User Name with LDAP and MicroStraetgy Group Name with LDAP.
abstract int getCallConvention()
Returns the current setting for the call convention used to call into the LDAP DLL.
abstract String getDeviceID()
Returns a String contains the device option on the Import-Options tab.
abstract String getLDAPAttrMSTRImport()
Returns the current LDAP attribute name that is used to indicate whether to import LDAP user/group.
abstract String getLDAPAttrMSTRUserGuid()
Returns the current setting for the LDAP attribute name that is used to store the GUID of the DSSUser corresponding to the imported LDAP user/group.
abstract String getLDAPAttribute()
Returns a String contains a list of LDAP attributes indexes and LDAP attributes separated by ";"s.
abstract String getLDAPAttributeForEmailAddress()
Returns a String contains the email address option on the Import-Options tab.
abstract String getLDAPAttributeForGroupName()
Returns the name of the LDAP attribute that maps the MicroStrategy group name.
abstract String getLDAPAttributeForLogin()
Returns the current setting for the name of the LDAP attribute that is mapping to the MicroStrategy User login.
abstract String getLDAPAttributeForUserName()
Returns the name of the LDAP attribute that maps the MicroStrategy user name.
abstract int getLDAPAuthUserBind()
abstract SimpleList getLDAPDLLs()
This method returns an editable SimpleList which can be used to add or remove LDAP dlls which are required for LDAP support.
abstract int getLDAPGroupSearchDepth()
Returns the number of nested group levels above to import in the Filters tab.
abstract int getLDAPImportGroup()
Returns the LDAPImportGroup property, the indicator of whether to import the LDAP groups of a login LDAP user.
abstract int getLDAPImportUser()
Returns the LDAPImportUser property, which is the indicator of whether to import a login LDAP user.
abstract String getLDAPMSTRAuthUserDN()
Returns the current setting for the distinguished name of the LDAP user that is used for LDAP authentication.
abstract String getLDAPObjectClassForUserGroup()
abstract String getLDAPSearchFilterForDNFromLogin()
Returns the LDAP search filter that is used to find the LDAP user object based on the LDAP login.
abstract String getLDAPSearchFilterForGroup()
Returns the The LDAP search filter that is used to find the LDAP groups of a LDAP user.
abstract String getLDAPSearchRoot()
Returns the distinguished name of the search root of LDAP directory.
abstract String getLDAPServerCertificate()
Returns the setting for the LDAP server certificate.
abstract String getLDAPServerName()
Returns the LDAP server name.
abstract int getLDAPServerPort()
Returns the LDAP server port property.
abstract int getLDAPServerSecureConnection()
Returns the setting for the secure connection mode to the LDAP server.
abstract int getLDAPServerVendor()
Returns the setting for the vendor of the LDAP server.
abstract int getLDAPStringCoding()
Returns the current character encoding for LDAP operations.
abstract int getLDAPSynch()
Returns the current LDAP synch property.
abstract int getLDAPTimeout()
Returns the current setting for LDAP search timeout, in seconds.
abstract int getLDAPVendor()
Returns the current setting for the vendor of LDAP SDK dynamic-link library.
abstract int getLDAPVerification()
abstract int getLDAPVersion()
Returns the current setting of the version of LDAP protocol that is supported by the third-party LDAP support libraries.
abstract boolean getNTAuthenticationWithLDAP()
Returns an integer indicates whether to Synchronize user/group information with LDAP during Windows information with LDAP during Windows authentication and import Windows link during batch import.
abstract int getPlatform()
Returns the current setting for the platform of the LDAP SDK.
abstract int getSimpleSecurityPlugInWithLDAP()
Returns an integer indicates whether to synchronize user/group information with LDAP during trusted authentication.
abstract String getUID()
Returns a String contains the Integrated Authentication/Trusted Authentication unique ID on the Import-Options tab.
abstract void setAllowLoginIfNotLinked(int val)
Sets an integer indicates whether to let the user logon if LDAP Attribute value is not read from the LDAP server.
abstract void setBatchImportGroup(int val)
Returns the option whether import groups on the Import/Synchronize tab.
abstract void setBatchImportUser(int user)
Sets the option whether to import/synchronize at Login on the Import/Synchronize tab.
abstract void setBatchSearchFilterForGroups(String filter)
Sets a String contains the search filter for importing list of groups.
abstract void setBatchSearchFilterForUsers(String filter)
Sets a String contains the search filter for importing list of users.
abstract void setBatchSynch(int synch)
Sets an integer indicates whether to synchronize MicroStrategy User Login/User Name with LDAP and MicroStraetgy Group Name with LDAP.
abstract void setCallConvention(int callConvention)
Sets the setting for the call convention used to call into the LDAP DLL.
abstract void setDeviceID(String id)
Sets a String contains the device option on the Import-Options tab.
abstract void setLDAPAttrMSTRImport(String importVal)
Sets the LDAP attribute name that is used to indicate whether to import LDAP user/group.
abstract void setLDAPAttrMSTRUserGuid(String guid)
Sets the LDAP attribute name that is used to store the GUID of the DSSUser corresponding to the imported LDAP user/group.
abstract void setLDAPAttribute(String attr)
Sets a list of LDAP attributes index and LDAP attributes in a String.
abstract void setLDAPAttributeForEmailAddress(String email)
Sets a String contains the email address option on the Import-Options tab.
abstract void setLDAPAttributeForGroupName(String attr)
Sets the name of the LDAP attribute that maps the MicroStrategy user name.
abstract void setLDAPAttributeForLogin(String ldapAttrForLogin)
Sets the name of the LDAP attribute that is mapping to the MicroStrategy User login.
abstract void setLDAPAttributeForUserName(String attr)
Sets the name of the LDAP attribute that maps the MicroStrategy user name.
abstract void setLDAPAuthUserBind(int ldapAuthUserBind)
abstract void setLDAPDLLs(SimpleList dllsList)
This method sets the LDAPDLLs on the Platform tab of the LDAP settings.
abstract void setLDAPGroupSearchDepth(int depth)
Sets the number of nested group levels above to import in the Filters tab.
abstract void setLDAPImportGroup(int importSetting)
Sets the LDAPImportGroup property, the indicator of whether to import the LDAP groups of a login LDAP user.
abstract void setLDAPImportUser(int importSetting)
Sets the LDAPImportUser property, which is the indicator of whether to import a login LDAP user.
abstract void setLDAPMSTRAuthUserDN(String userDN)
Sets the distinguished name of the LDAP user that is used for LDAP authentication.
abstract void setLDAPMSTRAuthUserPwd(String userPwd)
Sets the password of the LDAP user that is used for LDAP authentication.
abstract void setLDAPObjectClassForUserGroup(String groupClass)
abstract void setLDAPSearchFilterForDNFromLogin(String filter)
Sets the LDAP search filter that is used to find the LDAP user object based on the LDAP login.
abstract void setLDAPSearchFilterForGroup(String filter)
Sets the The LDAP search filter that is used to find the LDAP groups of a LDAP user.
abstract void setLDAPSearchRoot(String searchRoot)
Sets the distinguished name of the search root of LDAP directory.
abstract void setLDAPServerCertificate(String certificate)
Sets the LDAP server certificate property.
abstract void setLDAPServerName(String name)
Sets the LDAP server name.
abstract void setLDAPServerPort(int port)
Sets the LDAP server port property.
abstract void setLDAPServerSecureConnection(int setting)
Sets the setting for the secure connection mode to the LDAP server.
abstract void setLDAPServerVendor(int vendor)
Sets the vendor of the LDAP server.
abstract void setLDAPStringCoding(int ldapStringCoding)
Sets the character encoding for LDAP operations.
abstract void setLDAPSynch(int ldapSynch)
Sets the LDAP synch property.
abstract void setLDAPTimeout(int timeout)
Sets the LDAP search timeout, in seconds.
abstract void setLDAPVendor(int vendor)
Sets the vendor of LDAP SDK dynamic-link library.
abstract void setLDAPVerification(int ldapVerification)
abstract void setLDAPVersion(int version)
Sets the version of LDAP protocol that is supported by the third-party LDAP support libraries.
abstract void setNTAuthenticationWithLDAP(boolean value)
Sets an integer indicates whether to Synchronize user/group information with LDAP during Windows information with LDAP during Windows authentication and import Windows link during batch import.
abstract void setPlatform(int platform)
Sets the platform that the LDAP SDK is running upon.
abstract void setSimpleSecurityPlugInWithLDAP(int val)
Sets an integer indicates whether to synchronize user/group information with LDAP during trusted authentication.
abstract void setUID(String id)
Sets a String contains the Integrated Authentication/Trusted Authentication unique ID on the Import-Options tab.

Public Methods

public abstract void clear ()

This method will clear all LDAP settings, and set the string sent to the server back to an empty string. By calling this method, the user is specifying that they wish to turn off LDAP support for the ServerDef. Note that calling any method on the WebLDAPSettings interface after calling this method will effectively undo the clear.

public abstract int getAllowLoginIfNotLinked ()

Returns an integer indicates whether to let the user logon if LDAP Attribute value is not read from the LDAP server. A return of 0 indicates that the user's logon will fail if LDAP Attribute value is not read from the LDAP server; A return of 1 indicates the user are allowed to logon if LDAP Attribute value is not read from the LDAP server. com.microstrategy.webapiEnumDSSXMLLDAPLogin}

Returns
  • An integer indicates whether to let the user logon if LDAP attribute value is not read from the LDAP server.

public abstract int getBatchImportGroup ()

Returns the option whether import groups on the Import/Synchronize tab. 0 stands for false(check box unchecked) and 1 stands for true(check box checked).

Returns
  • An integer indicates whether to import groups

public abstract int getBatchImportUser ()

Returns the option whether to import/synchronize at Login on the Import/Synchronize tab. 0 stands for false(check box unchecked) and 1 stands for true(check box checked).

Returns
  • An integer indicates whether to import/synchronize at Login

public abstract String getBatchSearchFilterForGroups ()

Returns a String contains the search filter for importing list of groups.

Returns
  • A String contains the search filter for importing list of groups.

public abstract String getBatchSearchFilterForUsers ()

Returns a String contains the search filter for importing list of users.

Returns
  • A String contains the search filter for importing list of users.

public abstract int getBatchSynch ()

Returns an integer indicates whether to synchronize MicroStrategy User Login/User Name with LDAP and MicroStraetgy Group Name with LDAP. com.microstrategy.api.EnumDSSXMLLDAPSynch

Returns
  • An integer indicates whether to synchronize MicroStrategy User Login/User Name with LDAP and MicroStraetgy Group Name with LDAP.

public abstract int getCallConvention ()

Returns the current setting for the call convention used to call into the LDAP DLL. This value should come from EnumDSSXMLLDAPCallConvention.

Returns
  • The call convention that is currently set to sue for the LDAP DLL.

public abstract String getDeviceID ()

Returns a String contains the device option on the Import-Options tab. There are 5 different available options. com.microstrategy.apiEnumDSSXMLLDAPEmailAddress

Returns
  • Device ID.

public abstract String getLDAPAttrMSTRImport ()

Returns the current LDAP attribute name that is used to indicate whether to import LDAP user/group. It is optional. The default value is "MSTRImport".

Returns
  • The current setting for LDAP import attribute name.

public abstract String getLDAPAttrMSTRUserGuid ()

Returns the current setting for the LDAP attribute name that is used to store the GUID of the DSSUser corresponding to the imported LDAP user/group. It is optional. The default value is "MSTRUserGUID".

Returns
  • The current setting for the User GUID LDAP attribute.

public abstract String getLDAPAttribute ()

Returns a String contains a list of LDAP attributes indexes and LDAP attributes separated by ";"s. An example of a list of two would be "0;cn;1;dn;"

Returns
  • String

public abstract String getLDAPAttributeForEmailAddress ()

Returns a String contains the email address option on the Import-Options tab. An empty string would be considered as check box of "Importing email address" unchecked. A String of "mail" would be considered as check box checked and use the default LDAP attribute('mail'). Any other non-empty Strings would be considered as check box checked and "Other(type in the value)" radio button checked.

Returns
  • LDAP attribute email address.

public abstract String getLDAPAttributeForGroupName ()

Returns the name of the LDAP attribute that maps the MicroStrategy group name. It is used to fill/update the name property of the MicroStrategy group when importing and synchronizing.

Returns
  • The current setting for the LDAP attribute which maps the MicroStrategy group name.

public abstract String getLDAPAttributeForLogin ()

Returns the current setting for the name of the LDAP attribute that is mapping to the MicroStrategy User login. It is used to search for the MicroStrategy User if the search based on the distinguished name fails. It is also used to fill/update the login property of the MicroStrategy user when importing and synchronizing.

Returns
  • The current name of the LDAP attribute that is mapping to the MSTR user login.

public abstract String getLDAPAttributeForUserName ()

Returns the name of the LDAP attribute that maps the MicroStrategy user name. It is used to fill/update the name property of the MicroStrategy user when importing and synchronizing.

Returns
  • The current setting for the LDAP attribute which maps the MicroStrategy user name.

public abstract int getLDAPAuthUserBind ()

public abstract SimpleList getLDAPDLLs ()

This method returns an editable SimpleList which can be used to add or remove LDAP dlls which are required for LDAP support. Note that after setting the LDAPVendor property, this list of DLLs will be reset to the default.

Returns
  • The editable list of LDAP DLLs needed for LDAP support.

public abstract int getLDAPGroupSearchDepth ()

Returns the number of nested group levels above to import in the Filters tab. This number is an integer from 1 to 99.

Returns
  • The number of nested group levels above to import in the Filters tab.

public abstract int getLDAPImportGroup ()

Returns the LDAPImportGroup property, the indicator of whether to import the LDAP groups of a login LDAP user.

Returns
  • The current setting of the LDAPImportGroup property. Returning 0 indicates that the group will not be imported; Returning 1 indicates that the group will not be imported.

public abstract int getLDAPImportUser ()

Returns the LDAPImportUser property, which is the indicator of whether to import a login LDAP user.

Returns
  • The current setting of the LDAPImportUser property, returning 0 indicates that a login LDAP user will not be imported; returning 1 indicates that a login LDAP user will be imported.

public abstract String getLDAPMSTRAuthUserDN ()

Returns the current setting for the distinguished name of the LDAP user that is used for LDAP authentication. We require that this LDAP user has read rights on all LDAP users/groups. And, if this LDAP user has write rights on LDAP users/groups, we can write the GUID of our DSSUser back to the MSTRUserGUID attribute in the LDAP directory. If this is not set, we will use an anonymous LDAP user.

Returns
  • The current setting for the LDAPMSTRAuthUserDN property.

public abstract String getLDAPObjectClassForUserGroup ()

public abstract String getLDAPSearchFilterForDNFromLogin ()

Returns the LDAP search filter that is used to find the LDAP user object based on the LDAP login. The predefined symbol for LDAP login, #LDAP_LOGIN#, should be in the search filter at least once. It will be replaced by the real LDAP login when searching for the LDAP user.

Returns
  • The current setting for the LDAP search filter for the user object.

public abstract String getLDAPSearchFilterForGroup ()

Returns the The LDAP search filter that is used to find the LDAP groups of a LDAP user. The predefined symbol of the LDAP user distinguished name, #LDAPDN#, should be in the search filter at least once. It will be replaced by the distinguished name when searching for the groups.

Returns
  • The current setting for the LDAP group search filter.

public abstract String getLDAPSearchRoot ()

Returns the distinguished name of the search root of LDAP directory. This parameter is optional - if set, it will reduce the search domain, which improves the LDAP authentication performance. If it is not set, we will search the whole LDAP directory.

Returns
  • The current setting for the search root.

public abstract String getLDAPServerCertificate ()

Returns the setting for the LDAP server certificate. This property is the certificate file path of the LDAP server. It is only required for SSL connections.

Returns
  • The current LDAP server certificate setting.

public abstract String getLDAPServerName ()

Returns the LDAP server name.

Returns
  • The current setting for the LDAP server name.

public abstract int getLDAPServerPort ()

Returns the LDAP server port property. This is the port number of the primary LDAP server. By default, 389 is used for plain-text connection and 636 is used for Socket-Security-Layer connection. When the property LDAPServerSecureConnection is set, the default value will be assigned.

Returns
  • The current setting for the LDAP server port.

public abstract int getLDAPServerSecureConnection ()

Returns the setting for the secure connection mode to the LDAP server. This will be a value from EnumDSSXMLLDAPServerSecureConnection.

Returns
  • The current setting for the LDAP server port.

public abstract int getLDAPServerVendor ()

Returns the setting for the vendor of the LDAP server. This is different from the setLDAPVendor method in that the get/setLDAPVendor method refers to the LDAP SDK; this method refers to the LDAP server.

Returns

public abstract int getLDAPStringCoding ()

Returns the current character encoding for LDAP operations. This will be a value from the EnumDSSXMLLDAPStringCoding enumeration.

Returns

public abstract int getLDAPSynch ()

Returns the current LDAP synch property. This property is a bit-wise value that indicates whether to synch user and/or group during authentication process. The values that comprise this bitwise property are in EnumDSSXMLLDAPSynch.

Returns
  • The current LDAP synch property.

public abstract int getLDAPTimeout ()

Returns the current setting for LDAP search timeout, in seconds.

Returns
  • The current LDAP searhc timeout, in seconds.

public abstract int getLDAPVendor ()

Returns the current setting for the vendor of LDAP SDK dynamic-link library. It is an enumeration type property, and is defined in EnumDSSXMLLDAPVendor.

Returns

public abstract int getLDAPVerification ()

public abstract int getLDAPVersion ()

Returns the current setting of the version of LDAP protocol that is supported by the third-party LDAP support libraries.

Returns

public abstract boolean getNTAuthenticationWithLDAP ()

Returns an integer indicates whether to Synchronize user/group information with LDAP during Windows information with LDAP during Windows authentication and import Windows link during batch import. com.microstrategy.api.EnumDSSXMLLDAPNTAuthentication

Returns
  • An integer indicates the ntAuthenticationWithLDAP option.

public abstract int getPlatform ()

Returns the current setting for the platform of the LDAP SDK.

Returns

public abstract int getSimpleSecurityPlugInWithLDAP ()

Returns an integer indicates whether to synchronize user/group information with LDAP during trusted authentication. EnumDSSXMLLDAPSimpleSecurityPlugin

Returns
  • An integer indicates whether to synchronize user/group information with LDAP during trusted authentication.

public abstract String getUID ()

Returns a String contains the Integrated Authentication/Trusted Authentication unique ID on the Import-Options tab. An empty string would be considered as check box of "Batch import Integrated Authentication/Trusted Authentication unique ID" unchecked. A String of "userPrincipalName" would be considered as check box checked and radio button "Use default LDAP attribute('userPrincipalName')" checked. Any other non-empty Strings would be considered as check box checked and "Other(type in the value)" radio button checked.

Returns
  • Integrated Authentication/Trusted Authentication unique ID

public abstract void setAllowLoginIfNotLinked (int val)

Sets an integer indicates whether to let the user logon if LDAP Attribute value is not read from the LDAP server. com.microstrategy.webapiEnumDSSXMLLDAPLogin}

public abstract void setBatchImportGroup (int val)

Returns the option whether import groups on the Import/Synchronize tab. 0 stands for false(check box unchecked) and 1 stands for true(check box checked). If the input value does not equal to 0, it will be considered as 1, which is true(check box checked).

public abstract void setBatchImportUser (int user)

Sets the option whether to import/synchronize at Login on the Import/Synchronize tab. 0 stands for false(check box unchecked) and 1 stands for true(check box checked). If the input value does not equal to 0, it will be considered as 1, which is true(check box checked).

public abstract void setBatchSearchFilterForGroups (String filter)

Sets a String contains the search filter for importing list of groups.

public abstract void setBatchSearchFilterForUsers (String filter)

Sets a String contains the search filter for importing list of users.

public abstract void setBatchSynch (int synch)

Sets an integer indicates whether to synchronize MicroStrategy User Login/User Name with LDAP and MicroStraetgy Group Name with LDAP. com.microstrategy.api.EnumDSSXMLLDAPSynch

Returns
  • An integer indicates whether to synchronize MicroStrategy User Login/User Name with LDAP and MicroStraetgy Group Name with LDAP.

public abstract void setCallConvention (int callConvention)

Sets the setting for the call convention used to call into the LDAP DLL. This value should come from EnumDSSXMLLDAPCallConvention.

Parameters
callConvention The call convention to use to call into the LDAP DLL.

public abstract void setDeviceID (String id)

Sets a String contains the device option on the Import-Options tab. There are 5 different available options. com.microstrategy.apiEnumDSSXMLLDAPEmailAddress

public abstract void setLDAPAttrMSTRImport (String importVal)

Sets the LDAP attribute name that is used to indicate whether to import LDAP user/group.

Parameters
importVal The new setting for the LDAP import attribute name.

public abstract void setLDAPAttrMSTRUserGuid (String guid)

Sets the LDAP attribute name that is used to store the GUID of the DSSUser corresponding to the imported LDAP user/group.

Parameters
guid The new value for the User GUID LDAP attribute.

public abstract void setLDAPAttribute (String attr)

Sets a list of LDAP attributes index and LDAP attributes in a String. The LDAP attributes indexes and LDAP attributes are separated by ";"s. An example of a list of two would be "0;cn;1;dn;"

public abstract void setLDAPAttributeForEmailAddress (String email)

Sets a String contains the email address option on the Import-Options tab. An empty string would be considered as check box of "Importing email address" unchecked. A String of "mail" would be considered as check box checked and use the default LDAP attribute('mail'). Any other non-empty Strings would be considered as check box checked and "Other(type in the value)" radio button checked.

public abstract void setLDAPAttributeForGroupName (String attr)

Sets the name of the LDAP attribute that maps the MicroStrategy user name. It is used to fill/update the name property of the MicroStrategy user when importing and synchronizing.

Parameters
attr The new value for the LDAP attribute which maps the MicroStrategy user name.

public abstract void setLDAPAttributeForLogin (String ldapAttrForLogin)

Sets the name of the LDAP attribute that is mapping to the MicroStrategy User login. It is used to search for the MicroStrategy User if the search based on the distinguished name fails. It is also used to fill/update the login property of the MicroStrategy user when importing and synchronizing.

Parameters
ldapAttrForLogin The new setting for the LDAP attribute which maps to the MSTR user login.

public abstract void setLDAPAttributeForUserName (String attr)

Sets the name of the LDAP attribute that maps the MicroStrategy user name. It is used to fill/update the name property of the MicroStrategy user when importing and synchronizing.

Parameters
attr The new value for the LDAP attribute which maps the MicroStrategy user name.

public abstract void setLDAPAuthUserBind (int ldapAuthUserBind)

public abstract void setLDAPDLLs (SimpleList dllsList)

This method sets the LDAPDLLs on the Platform tab of the LDAP settings. This simple list actually contains a list of Strings

Parameters
dllsList A list of DLLs

public abstract void setLDAPGroupSearchDepth (int depth)

Sets the number of nested group levels above to import in the Filters tab. This number is an integer from 1 to 99. If input depth is greater than 99, 99 will be passed; If input depth is less than 0, 0 will be passed. This persists the behavior in the developer.

Parameters
depth number of nested group levels above to import

public abstract void setLDAPImportGroup (int importSetting)

Sets the LDAPImportGroup property, the indicator of whether to import the LDAP groups of a login LDAP user.

Parameters
importSetting The new value of the property, an input of 0 will be considered as the check box unchecked; An input of anything else will be considered as the check box checked.

public abstract void setLDAPImportUser (int importSetting)

Sets the LDAPImportUser property, which is the indicator of whether to import a login LDAP user.

Parameters
importSetting The new value of the property, an input of 0 will be considered as the check box unchecked; An input of anything else will be considered as the check box checked.

public abstract void setLDAPMSTRAuthUserDN (String userDN)

Sets the distinguished name of the LDAP user that is used for LDAP authentication. We require that this LDAP user has read rights on all LDAP users/groups. And, if this LDAP user has write rights on LDAP users/groups, we can write the GUID of our DSSUser back to the MSTRUserGUID attribute in the LDAP directory. If this is not set, we will use an anonymous LDAP user.

Parameters
userDN The new value for this property.

public abstract void setLDAPMSTRAuthUserPwd (String userPwd)

Sets the password of the LDAP user that is used for LDAP authentication. If the LDAPMSTRAuthUserDN property is set, this property will correspond to the password for that user.

Parameters
userPwd The password to use for the LDAP user.

public abstract void setLDAPObjectClassForUserGroup (String groupClass)

public abstract void setLDAPSearchFilterForDNFromLogin (String filter)

Sets the LDAP search filter that is used to find the LDAP user object based on the LDAP login. The predefined symbol for LDAP login, #LDAP_LOGIN#, should be in the search filter at least once. It will be replaced by the real LDAP login when searching for the LDAP user.

Parameters
filter The new setting for the LDAP search filter for the user object.

public abstract void setLDAPSearchFilterForGroup (String filter)

Sets the The LDAP search filter that is used to find the LDAP groups of a LDAP user. The predefined symbol of the LDAP user distinguished name, #LDAPDN#, should be in the search filter at least once. It will be replaced by the distinguished name when searching for the groups.

Parameters
filter The filter to use when searching for the group.

public abstract void setLDAPSearchRoot (String searchRoot)

Sets the distinguished name of the search root of LDAP directory. This parameter is optional - if set, it will reduce the search domain, which improves the LDAP authentication performance. If it is not set, we will search the whole LDAP directory.

Parameters
searchRoot The new value to user for the search root.

public abstract void setLDAPServerCertificate (String certificate)

Sets the LDAP server certificate property. This property is the certificate file path of the LDAP server. It is only required for SSL connections.

Parameters
certificate The certificate to use for the LDAP server.

public abstract void setLDAPServerName (String name)

Sets the LDAP server name.

Parameters
name The new setting for the LDAP server name.

public abstract void setLDAPServerPort (int port)

Sets the LDAP server port property. This is the port number of the primary LDAP server. Note that when the property LDAPServerSecureConnection is set, the default value will be reassigned to this property.

Parameters
port The LDAP server port to use.

public abstract void setLDAPServerSecureConnection (int setting)

Sets the setting for the secure connection mode to the LDAP server. This should be a value from EnumDSSXMLLDAPServerSecureConnection. When this property is set, the default value of the LDAPServerPort property will be assigned.

Parameters
setting The new value for the secure connection mode, from EnumDSSXMLLDAPServerSecureConnection.

public abstract void setLDAPServerVendor (int vendor)

Sets the vendor of the LDAP server. This is different from the setLDAPVendor method in that the get/setLDAPVendor method refers to the LDAP SDK; this method refers to the LDAP server.

Parameters
vendor The LDAP Server vendor, from EnumDSSXMLLDAPVendor.

public abstract void setLDAPStringCoding (int ldapStringCoding)

Sets the character encoding for LDAP operations. This should be a value from the EnumDSSXMLLDAPStringCoding enumeration.

Parameters
ldapStringCoding The new LDAP character encoding, from EnumDSSXMLLDAPStringCoding.

public abstract void setLDAPSynch (int ldapSynch)

Sets the LDAP synch property. This property is a bit-wise value that indicates whether to synch user and/or group during authentication process. The values that comprise this bitwise property are in EnumDSSXMLLDAPSynch.

Parameters
ldapSynch The new value for the LDAP synch property. This should be the bitwise-OR of one or more values in EnumDSSXMLLDAPSynch.

public abstract void setLDAPTimeout (int timeout)

Sets the LDAP search timeout, in seconds.

Parameters
timeout The new timeout (in seconds) for LDAP searches.

public abstract void setLDAPVendor (int vendor)

Sets the vendor of LDAP SDK dynamic-link library. It is an enumeration type property, and is defined in EnumDSSXMLLDAPVendor. Note that when this property is changed, the following properties will be set to the default values for the selected vendor: LDAPDLLs, LDAPAttributeForLogin, LDAPAttributeForUserName, LDAPAttributeForGroupName, LDAPSearchFilterForDNFromLogin, LDAPSearchFilterForGroup, and LDAPStringCoding.

Parameters
vendor The vendor to use for LDAP support, from EnumDSSXMLLDAPVendor.

public abstract void setLDAPVerification (int ldapVerification)

public abstract void setLDAPVersion (int version)

Sets the version of LDAP protocol that is supported by the third-party LDAP support libraries.

Parameters
version The version of the LDAP protocol supported, from EnumDSSXMLLDAPVersion.

public abstract void setNTAuthenticationWithLDAP (boolean value)

Sets an integer indicates whether to Synchronize user/group information with LDAP during Windows information with LDAP during Windows authentication and import Windows link during batch import. com.microstrategy.api.EnumDSSXMLLDAPNTAuthentication

public abstract void setPlatform (int platform)

Sets the platform that the LDAP SDK is running upon.

Parameters
platform The platform the LDAP SDK is running upon, from EnumDSSXMLLDAPPlatform.

public abstract void setSimpleSecurityPlugInWithLDAP (int val)

Sets an integer indicates whether to synchronize user/group information with LDAP during trusted authentication. EnumDSSXMLLDAPSimpleSecurityPlugin

public abstract void setUID (String id)

Sets a String contains the Integrated Authentication/Trusted Authentication unique ID on the Import-Options tab. An empty string would be considered as check box of "Batch import Integrated Authentication/Trusted Authentication unique ID" unchecked. A String of "userPrincipalName" would be considered as check box checked and radio button "Use default LDAP attribute('userPrincipalName')" checked. Any other non-empty Strings would be considered as check box checked and "Other(type in the value)" radio button checked.