LDAP Service

Sometimes you want components or Groovy Scripts to be able to access LDAP. When you create these components or scripts, you could just put some code in there to do exactly that, but this has a couple of disadvantages:

  • You end up with repeated code
    • So any bugs you get have to be fixed in several places.
  • If you change the password of the user used to access LDAP, you have to update this in multiple places.
    • Which is just an administrative pain

In Aspire, components or scripts can access other components (see here for more details. The LDAP Service installs a component, that can be accessed by any number of other components and provides services via the Aspire LDAP Interface.

This way, you have a single code base giving access to the most common LDAP functionality and a single point of configuration

With the LDAP Service App-bundle installed, you can access common LDAP functions from other components or scripts.


Configuration

This section lists all configuration parameters available to install the LDAP services Application Bundle.


General Application Configuration

PropertyTypeDefaultDescription
GELDAPserverString
The url of the LDAP server to connect too
GEauthenticationNone/Simple/DigestNoneThe type of authentication to use
GELDAPuserString
The username to pass to the ldap server. Could be an Active Directory domain\user or a distinguished name
GELDAPpasswordString
The user's password
GEsearchBaseString
The default distinguished name on the server to perform searches from
GElowerCasebooleanfalseIf true, information returned will be converted to lowercase
debugBooleanfalseControls whether debugging is enabled for the application. Debug messages will be written to the log files.


Configuration Example

To install the application bundle, add the configuration, as follows, to the <autoStart> section of the Aspire settings.xml.

<application config="com.searchtechnologies.aspire:app-ldap-services">
  <properties>
    <property name="GELDAPserver">ldap://ldap.searchtechnologies.com</property>
    <property name="useAuth">true</property>
    <property name="GEauthentication">simple</property>
    <property name="GELDAPuser">search\sdenny</property>
    <property name="GELDAPpassword">encrypted:F8CBFF4564F6781D63B5DAD8F30EC630</property>
    <property name="GEsearchBase">dc=search, dc=local</property>
    <property name="GElowerCase">false</property>
    <property name="debug">false</property>
  </properties>
</application>

Note: Any optional properties can be removed from the configuration to use the default value described on the table above.

LDAP Service App-bundle (Aspire 2)
AppBundle Name Ldap services
Maven Coordinates com.searchtechnologies.aspire:app-ldap-services
Versions 2.2.2
Type Flags None
Inputs N/A
Outputs N/A
  • No labels