Apache Directory Studio Apache DS - The Apache Software ...

Apache Directory Studio Apache DS User's Guide

Apache Directory Studio Apache DS: 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. Download and installation ........................................................................................ 2. Views ................................................................................................................... 2.1. Servers view ................................................................................................ 3. Editors .................................................................................................................. 3.1. Apache DS Configuration editor ..................................................................... II. Tasks ........................................................................................................................... 1. Creating a new server .............................................................................................. 2. Starting a server ..................................................................................................... 3. Stopping a server .................................................................................................... 4. Editing the configuration .......................................................................................... 5. Deleting a server .................................................................................................... III. Reference ..................................................................................................................... 1. Preferences ............................................................................................................ 1.1. Colors and Fonts preferences .......................................................................... 1.2. Server Logs preferences ................................................................................. IV. Release notes ...............................................................................................................

iv

1 1 4 4 5 5 6 6 6 6 6 6 7 7 7 7 9

Chapter I. Getting started This part of the guide provides you a sum up of the basic concepts of the Apache DS plugin.

1. Download and installation Beside the integration in Apache Directory Studio the Apache Directory Studio Apache DS plugin 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 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 - and click Next .

Accept the license agreement, the Apache Directory Studio Apache DS plugin 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. Views 2.1. Servers view The Servers view allows you to manage the servers. This view displays a list of all your servers. You can use this view to start or stop the servers. Here is what the Servers view looks like:

Use the Servers view to perform the following tasks: • Create a server • Edit a server • Delete a server • Start a server • Stop a server The Servers view displays the current status of all the servers. The Status column indicates whether or not a server has been started. The following lists the possible server status: • Starting • Started • Stopping • Stopped Toolbar

4

Getting started

The toolbar of the Servers view contains the following actions: •

- Create a new server : Creates a new server.

•

- Run : Starts the selected server.

•

- Stop : Stops the selected server.

Icons The following icons can appear in the Hierarchy view: Icon

Description Server Starting server

Started server Stopping server

Stopped server

3. Editors 3.1. Apache DS Configuration editor The Apache DS Configuration editor is used to edit the configuration of a server. Here is what the Apache DS Configuration editor looks like:

For additional information about the Apache DS Configuration editor please refer you to the specific help contents of the Apache DS Configuration feature.

5

Chapter II. Tasks 1. Creating a new server To create a new server, in the Servers view toolbar, click on the E shortcut.

New Server button, or use the Strg-

The following wizard appears:

Give a name to the server. Option

Description

Default

Name

The name of the server. In the Servers view the empty server is listed with this name. The name must be unique.

2. Starting a server To start a server, in the Servers view, select the server you want to start and click the the toolbar, or use the Strg-R shortcut.

Run button in

3. Stopping a server To stop a server, in the Servers view, select the server you want to stop and click the the toolbar, or use the Strg-T shortcut.

Stop button in

4. Editing the configuration To edit the configuration of a server, in the Servers view, select the server and double-click on it, click the Open Configuration action in the context menu, or use the F3 shortcut.

5. Deleting a server To delete a server, in the Servers view, select the server you want to delete and click the in the context menu, or use the Delete shortcut.

6

Delete action

Chapter III. Reference 1. Preferences 1.1. Colors and Fonts preferences In the Colors and Fonts preferences page you can configure colors and fonts options in the Apache DS plugin.

In the Console group you can define the style how the logs of the server logs are displayed within the Console view.

1.2. Server Logs preferences In the Server Logs preferences page you can configure general settings for the global Apache DS server logs.

7

Reference

Option

Description

Default

Level

Choose one of Debug , Info , Warning , Error or Warning Fatal to be used as log level for defined Apache DS servers.

Pattern

Specify the conversion pattern you want for the [%d{HH:mm:ss}] server logs displayed in the Console view. [%c] - %m%n

8

%p

Chapter IV. Release notes Apache Directory Studio 1.5.2 - (2009, December 11th) Bug • [DIRSTUDIO-602] - Unable to start an Apache DS version 1.5.5 server

Apache Directory Studio 1.5.1 - (2009, November 30th) Nothing new.

Apache Directory Studio 1.5.0 - (2009, November 2nd) Bug • [DIRSTUDIO-569] - Exceptions showing up in the log when starting a server in the Apache DS plugin • [DIRSTUDIO-537] - Error in the title of the Properties window of a server in the Apache DS plugin Improvement • [DIRSTUDIO-541] - Add support for version 1.5.5 of the Apache DS • [DIRSTUDIO-534] - Re-order the preference pages for better understanding

Apache Directory Studio 1.4.0 - (2009, April 7th) New Feature • [DIRSTUDIO-397] - Request for multi-language GUI

Apache Directory Studio 1.3.0 - (2008, November 24th) Bug • [DIRSTUDIO-382] - Unable to launch Apache Directory Server with Turkish Regional Settings Improvement • [DIRSTUDIO-407] - Stack the Servers view aside the Connections view as a perpective extension of the LDAP Browser Perpective

9

Release notes

• [DIRSTUDIO-406] - The New Server Wizard should be listed in the NewWizards section • [DIRSTUDIO-405] - Update the Apache DS plugin to use Apache DS 1.5.4 dependencies Task • [DIRSTUDIO-375] - Move each plugin IDs in a plugin.properties file

Apache Directory Studio 1.2.0 - (2008, august 18th) Initial release.

10