Sun Java System Directory Server Enterprise Edition 6.2 Developer's Guide

Plug-In Registration

The following parameters are for use when registering plug-ins and their functions with the server and when accessing information about plug-in type and identity.

The following table lists information accessible to all types of plug-ins.

Table 18–14 Plug-In Information Parameters

Parameter ID  

Data Type  

Description  

SLAPI_PLUGIN

void *

Internal server representation of the plug-in. 

SLAPI_PLUGIN_ARGC

int

Number of arguments in the configuration entry. 

SLAPI_PLUGIN_ARGV

char *

Array of arguments in the configuration entry. 

SLAPI_PLUGIN_IDENTITY

void *

Plug-in identifier set and then required by the server when handling internal operations. 

You may cast this to Slapi_ComponentId.

SLAPI_PLUGIN_PRIVATE

void *

Private data you pass to your plug-in functions. 

You define this data structure. 

SLAPI_PLUGIN_TYPE

int

Type of plug-in function, corresponding to the value of nsslapd-pluginType in the configuration entry for the plug-in. (Use the plug-in type values given here between parentheses in configuration entries.)

  • SLAPI_PLUGIN_EXTENDEDOP (extendedop)

  • SLAPI_PLUGIN_INTERNAL_POSTOPERATION (internalpostoperation)

  • SLAPI_PLUGIN_INTERNAL_PREOPERATION (internalpreoperation)

  • SLAPI_PLUGIN_LDBM_ENTRY_FETCH_STORE (ldbmentryfetchstore)

  • SLAPI_PLUGIN_MATCHINGRULE (matchingrule)

  • SLAPI_PLUGIN_TYPE_OBJECT (object)

  • SLAPI_PLUGIN_PASSWDCHECK (passwordcheck)

  • SLAPI_PLUGIN_POSTOPERATION (postoperation)

  • SLAPI_PLUGIN_PREOPERATION (preoperation)

  • SLAPI_PLUGIN_PWD_STORAGE_SCHEME (pwdstoragescheme)

  • SLAPI_PLUGIN_REVER_PWD_STORAGE_SCHEME (reverpwdstoragescheme)

SLAPI_PLUGIN_VERSION

char *

Plug-in API version supported by the plug-in. 

  • SLAPI_PLUGIN_CURRENT_VERSION (presently SLAPI_PLUGIN_VERSION_03)

  • SLAPI_PLUGIN_VERSION_01 (3.x and later servers)

  • SLAPI_PLUGIN_VERSION_02 (4.x and later servers)

  • SLAPI_PLUGIN_VERSION_03 (5.x servers)