Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY CUSTOMIZATION, Manual

Page: 240 / 612

Functions for Setting Internal Operation Flags
240 Netscape Directory Server Plug-In Programmer’s Guide • December 2003
Description
This function sets up the parameter block, for subsequent use by
slapi_search_internal_pb()
, to contain the following data for an internal
search operation.
For unique ID-based search:
•
SLAPI_TARGET_DN
set to the DN that allows to select the right backend.
•
SLAPI_TARGET_UNIQUEID
set to the unique ID of the entry.
For DN-based search:
•
SLAPI_TARGET_DN
set to the search base.
•
SLAPI_SEARCH_SCOPE
set to the search scope.
scope
Search scope (
LDAP_SCOPE_SUBTREE
, etc.).
filter
Search filter.
attrs
Attributes to be returned.
attrsonly
Flag specifying whether to return just attribute names or names
and values.
controls
List of controls associated with the operation.
uniqueid
Unique identifier of the entry. Non-NULL value indicates
unique ID-based search. In this case, scope and filter are ignored;
however, base is still required and is used to select the correct
backend.
All directory entries contain a unique identifier. Unlike the
distinguished name (DN), the unique identifier of an entry never
changes, providing a good way to unambiguously refer to an
entry in a distributed/replicated environment.
plugin_identity
Plug-in identity, a cookie that identifies the plug-in to the
Directory Server during an internal operation.
This cookie is used by the server to retrieve the plug-in
configuration in order to determine whether to allow the
operation and which actions to take during the operation
processing. Plug-in identity is passed to the plug-in initialization
function in the
SLAPI_PLUGIN_IDENTITY pblock
parameter.
A plug-in must save this information and pass it to every
internal operation issued by the plug-in.
operation_flags
Actions taken during operation processing.