Apache Directory Studio Apache DS Configuration User's Guide Apache Directory Studio Apache DS Configuration: User's Guide Version 1.5.2.v20091211 Copyright © 2006 - 2009 Apache Software Foundation Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Table of Contents I. Getting started ................................................................................................................ 1 1. Download and installation ........................................................................................ 1 2. Configuration Editor ................................................................................................ 4 2.1. Editor for Apache DS 1.5.0 ............................................................................ 4 2.2. Editor for Apache DS 1.5.1 .......................................................................... 11 2.3. Editor for Apache DS 1.5.2 .......................................................................... 19 2.4. Editor for Apache DS 1.5.3 .......................................................................... 27 2.5. Editor for Apache DS 1.5.4 .......................................................................... 35 2.6. Editor for Apache DS 1.5.5 .......................................................................... 42 II. Tasks .......................................................................................................................... 51 1. Open a Server Configuration ................................................................................... 51 2. Create a new Server Configuration ........................................................................... 51 III. What's new ................................................................................................................. 53 IV. Release notes .............................................................................................................. 55 iv Chapter I. Getting started This part of the guide provides you a sum up of the basic concepts of the Apache DS Configuration. 1. Download and installation Beside the integration in Apache Directory Studio the Apache Directory Studio Apache DS Configuration can also be installed as a plug-in into a regular Eclipse installation. This section describes this alternative. Using the Eclipse Install/Update Manager is the easiest way to install the Apache Directory Studio Apache DS Configuration plug-in. From workbench menu choose Help # Software Updates # Find and Install... . In the opened wizard choose Search for new features to install and click Next . Next please specify the Apache Directory Studio update site. Click the New Remote Site... button. In the dialog input the following and press OK : • Name: Apache Directory Studio Update Site • URL: http://directory.apache.org/studio/update/1.x Make sure the new update site is checked an press Finish . 1 Getting started Now the install manager checks the update site and presents the search results. Select the feature you want to install - of course the Apache Directory Studio Apache DS Configuration - and click Next . Accept the license agreement, the Apache Directory Studio Apache DS Configuration is distributed under the Apache License, Version 2.0. 2 Getting started In the next dialog ensure that the Apache Directory Studio Apache DS feature is selected and click to Finish . Now the install manager loads the necessary files. When download is finished you have to verify the installation, please click to Install . 3 Getting started After installation it is recommended to restart the Eclipse workbench. 2. Configuration Editor The Configuration Editor currently supports 4 versions of Apache DS. Each version having a specific associated editor. • The Editor for Apache DS 1.5.0 allows you to edit the 'server.xml' file of an Apache DS version 1.5.0 installation. • The Editor for Apache DS 1.5.1 allows you to edit the 'server.xml' file of an Apache DS version 1.5.1 installation. • The Editor for Apache DS 1.5.2 allows you to edit the 'server.xml' file of an Apache DS version 1.5.2 installation. • The Editor for Apache DS 1.5.3 allows you to edit the 'server.xml' file of an Apache DS version 1.5.3 installation. • The Editor for Apache DS 1.5.4 allows you to edit the 'server.xml' file of an Apache DS version 1.5.4 installation. • The Editor for Apache DS 1.5.5 allows you to edit the 'server.xml' file of an Apache DS version 1.5.5 installation. 2.1. Editor for Apache DS 1.5.0 The Configuration Editor for Apache DS consists in a 4 pages Editor: • The General page allows you to set "general" settings about the server such as the server port, administrator DN, password, etc... • The Partitions page allows you to manage your server partitions. • The Interceptors page allows you to manage your server interceptors. • The Extended Operations page allows you to manage your server extended operations handlers. 2.1.1. General Page The General Page of the Configuration Editor allows you to edit the server settings. 4 Getting started It contains four sections : Settings , Binary Attribute , Limits and Options . Here's what the General Page looks like: Settings A Port is mandatory and must be an integer between 1 to 65535. An Authentication method is mandatory and is at the moment not editable and set to ' Simple A Principal is mandatory and represents the DN of the Administrator of the server. A Password is mandatory and represents the password of the Administrator of the server. Check the Show Password checkbox to display the password in a unhidden form. Check the Allow Anymous Access checkbox to allow anymous access on the server. Binary Attributes This section allows you to specify to the server the attribute types that you want to be handled as binary content. 5 Getting started Use the Add... , Edit... and Delete buttons to set your Binary Attributes. Limits This section allows you to specify the Limits of the server. Max. Time Limit lets you choose the maximum time that should last a request (in milliseconds). Max. Size Limit lets you choose the maximum number of entries that should be returned. Synchronization Period lets you choose the number of milliseconds between two synchronizations. Max. Threads lets you choose the number of threads that should be used by the server in its execution. Options Check the Enable Access Control to enable Access Control on the server. Check the Enable NTP to enable NTP on the server. Check the Enable Kerberos to enable Kerberos on the server. Check the Enable Change Password to enable Change Password service on the server. Check the Denormalize Operational Attributes to use a more human readable form ('uid=admin,ou=system' instead of '0.9.2342.19200300.100.1.1=admin,2.5.4.11=system') for Operational Attributes on the server. 2.1.2. Partitions Page The Partitions Page of the Configuration Editor allows you to edit the server partitions. 6