Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY CUSTOMIZATION, Manual

Page: 40 / 612

Creating a Plug-In Configuration File
40 Netscape Directory Server Plug-In Programmer’s Guide • December 2003
This example plug-in configuration file defines an example plug-in as follows:
• Line 1 sets the DN of the plug-in, which identifies the plug-in:
dn: cn=Example Plug-in,cn=plugins,cn=config
Here, the common name of the plug-in is set to
Example Plug-in
. The rest of
the DN entry (
cn=plugins,cn=config
) places the entry in the database tree
that contains the configuration settings for plug-ins.
• Lines 2-4 declare the object classes of the plug-in.
• Line 5 sets the common name of the plug-in to
Example Plug-in
.
• Line 6 defines the absolute path to the library that implements the plug-in:
nsslapd-pluginpath: C:/ds60/lib/test-plugin.dll
In this example, the plug-in is a Windows NT DLL, located in the directory
C:/ds60/lib
.
• Line 7 identifies the initialization function that the server calls to register the
plug-in. In this example, the initialization is set to
searchdn_preop_init
. For
information on implementing initialization functions, see “Writing Plug-in
Initialization Functions,” on page 32.
• Line 8 sets the type of plug-in. In this case, it is a pre-operation plug-in. For a
complete list of the types of plug-in you can declare, refer to the “Summary of
Plug-In Directives” on page 42.
• Line 9 specifies whether or not the plug-in is active by default. The
nsslapd-pluginenabled
attribute can have a value of either
on
or
off
. The
following line specifies that the plug-in is active by default:
nsslapd-pluginenabled: on
5. cn: Example Plug-in
6. nsslapd-pluginpath: C:/ds60/lib/test-plugin.dll
7. nsslapd-plugininitfunc: searchdn_preop_init
8. nsslapd-plugintype: preoperation
9. nsslapd-pluginenabled: on
10. nsslapd-pluginid: Example Pre-operation Plug-in
11. nsslapd-pluginversion: 1.0
12. nsslapd-pluginvendor: Example Corporation
13. nsslapd-plugindescription: This plug-in does ...
Code Example 3-1 An Example Plug-In Configuration File (Continued)