Registering and Managing Plug-ins

To enable the directory server to call a plug-in at the right moment, you must register the plug-in with the directory server. Do this by creating a configuration entry for the plug-in under cn=plugin,cn=subconfigsubentry. This plug-in must have orclPluginConfig as one of its object classes.

See Also: "Plug-in Schema Elements" for details about the attributes in the orclPluginConfig object class.

This section contains these topics:

• Registering and Managing Plug-ins by Using Oracle Directory Manager

• Registering and Managing Plug-ins by Using Command-Line Tools

Registering and Managing Plug-ins by Using Oracle Directory Manager

This section provides examples of how to create, modify, and delete plug-in configuration entries by using Oracle Directory manager.

Adding a Plug-in Configuration Entry by Using Oracle Directory Manager

To register a plug-in:

1. In the navigator pane, expand in succession Oracle Internet Directory Servers and directory server instance.

2. Select Plug-in Management. The Plug-in Management window appears in the right pane.

3. Choose Create. The New Plug-in dialog box appears.

4. In the New Plug-in dialog box, enter values in the fields. These fields are described in Table C-13.

5. When you have finished entering the values, choose OK. This returns you to the Plug-in Management window. The plug-in you just created is listed in the Plug-in Entry Name column.

6. Choose OK.

Editing a Plug-in by Using Oracle Directory Manager

To edit a plug-in entry:

1. In the navigator pane, expand in succession Oracle Internet Directory Servers and directory server instance.

2. Select Plug-in Management. The Plug-in Management window appears in the right pane.

3. In the right pane, select the name of the plug-in entry you want to edit, then choose Edit. The Plug-in: dialog box appears.

4. In the Plug-in: dialog box, modify the values in the appropriate fields. These fields are described in Table C-13.

5. Choose OK.

Deleting a Plug-in by Using Oracle Directory Manager

To delete a plug-in:

1. In the navigator pane, expand in succession Oracle Internet Directory Servers and directory server instance.

2. Select Plug-in Management. The Plug-in Management window appears in the right pane.

3. In the right pane, select the name of the plug-in you want to delete, then choose Edit. The Plug-in: dialog box appears.

4. In the Plug-in dialog box, choose Delete, and, when prompted, confirm your deletion. This returns you to the Plug-in Management window. The plug-in entry you deleted no longer appears in the list.

Registering and Managing Plug-ins by Using Command-Line Tools

This section provides examples of how to create, modify, and delete plug-in configuration entries by using command-line tools.

See Also: Plug-in Schema Elements for information about the attributes in the orclPluginConfig object class

Examples: Adding a Plug-in Configuration Entry by Using Command-Line Tools

In the following examples, an entry is created for an operation-based plug-in called my_plugin1. The LDIF file is named my_ldif_file.ldif.

Example 1: Creating an Operation-Based Plug-in Entry for Compare Operations

The following is an example LDIF file to create such an object:

cn=when_comp,cn=plugin,cn=subconfigsubentry
objectclass=orclPluginConfig
objectclass=top
orclPluginName=my_plugin1
orclPluginType=operational
orclPluginTiming=when
orclPluginLDAPOperation=ldapcompare
orclPluginEnable=1
orclPluginVersion=1.0.1
orclPluginIsReplace=1
cn=when_comp
orclPluginKind=PLSQL
orclPluginSubscriberDNList=dc=COM,c=us;dc=us,dc=oracle,dc=com;dc=org,dc=us;

o=IMC,c=US

Example 2: Creating an Operation-Based Plug-in Entry for Modify Operations

The following is 
an example LDIF file to create such an object:


cn=post_mod_plugin,cn=plugin,cn=subconfigsubentry
objectclass=orclPluginConfig
objectclass=top
orclPluginName=my_plugin1
orclPluginType=operational
orclPluginTiming=post
orclPluginLDAPOperation=ldapmodify
orclPluginEnable=1
orclPluginVersion=1.0.1
cn=post_mod_plugin
orclPluginKind=PLSQL

Add this file to the directory with the following command:

ldapadd -p 389 -h myhost -D binddn -w password -f my_ldif_file.ldif

When you have added this entry to the directory, the directory server validates the plug-in by quickly executing it and checking for compilation or access privilege errors. It then gathers more information about this plug-in--such as timing and the type of LDAP operation related to the plug-in.

Notes: To avoid creating an inconsistent state, metadata for the plug-in configuration entry, cn=plugin, cn=subconfigsubentry, is not replicated in the replication environment.

Example: Modifying a Plug-in Configuration Entry by Using Command-Line Tools

This is an example of disabling a plug-in:

ldapmodify -h  host_name -p  port_number -D cn=orcladmin -w orcladminpwd <<EOF
dn: cn=post_mod_plugin,cn=plugin,cn=subconfigsubentry
changetype: modify
replace: orclPluginEnable
orclPluginEnable: 0
EOF

Example: Deleting a Plug-in Configuration Entry by Using Command-Line Tools

This is an example of deleting a plug-in:

ldapdelete -h  host_name -p port_number -D cn=orcladmin -w orcladminpwd 
"cn=post_mod_plugin,cn=plugin,cn=subconfigsubentry"