Oracle® Fusion Middleware Developer's Guide for Oracle Directory Server Enterprise Edition 11g Release 1 (11.1.1.7.0) Part Number E28970-01 |
|
|
PDF · Mobi · ePub |
This chapter describes the parameters available in the parameter block, Slapi_PBlock
, structure. This chapter lists data types associated with each parameter.
Note:
To read parameter values, use slapi_pblock_get()
. To write parameter values, use slapi_pblock_set()
. Use of other functions may crash the server.
Refer to the Plug-In API Guide and the example plug-ins under install-path
/examples/
to better grasp how to use these parameters.
This chapter categorizes parameters as follows.
Table 17-1 Slapi_PBlock
Parameter Categories
Category | Accessible to… |
---|---|
All plug-in functions |
|
Pre- and post-operation add functions |
|
All plug-in functions |
|
Pre- and post-operation bind functions |
|
Pre- and post-operation compare functions |
|
All plug-in functions |
|
Pre- and post-operation delete functions |
|
All plug-in functions |
|
Extended operation functions |
|
All plug-in functions |
|
Pre- and post-operation modify functions |
|
All plug-in functions |
|
Plug-in initialization functions and specific types as mentioned in this section |
|
Password check functions and data |
|
Post-operation plug-in functions |
|
Pre- and post-operation modify RDN functions |
|
All plug-in functions |
|
Pre- and post-operation search functions |
The following parameter allows you to configure access log output.
The following parameters allow you to access an entry to add to the directory through the parameter block.
The following parameters allow you to access information about directory backends through the parameter block.
Table 17-4 Backend Information Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Backend serving the current operation. May be |
|
|
Whether the backend tracks modification time and who made the modification:
|
|
|
Value of
|
|
|
Value of |
|
|
Size of the backend database in KB. |
The following parameters allow you to access information about the bind operation through the parameter block.
Table 17-5 Bind Function Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Bind request credentials such as a password or SASL mechanism credentials, depending on the bind method. |
|
|
Authentication method used.
|
|
|
SASL server credentials to send to the client. |
|
|
SASL mechanism used for bind. |
|
|
DN used to bind. |
The following parameters allow you to access an entry or attribute to use in a comparison through the parameter block.
The following parameters allow you to access information about the client connection through the parameter block.
Table 17-7 Connection Information Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Fully qualified domain name of the client. |
|
|
Authentication method used.
|
|
|
IP address of client. |
|
|
DN of the user authenticated for the current connection. |
|
|
The current connection. |
|
|
Identifier for the current connection. |
|
|
Whether the connection is for replication.
|
|
|
Whether the connection is over SSL.
|
|
|
IP address client is connected to. |
The following parameters allow you to access an entry to delete through the parameter block.
The following parameters allow you to access information about configuration of the directory instance through the parameter block.
Table 17-9 Directory Configuration Information Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Number of command-line arguments passed to the server at startup. |
|
|
Array of command-line arguments passed to the server at startup. |
|
|
File system directory containing configuration files for the instance. |
|
|
Configuration file used, such as |
The following parameters allow you to access information about an extended operation through the parameter block.
Table 17-10 Extended Operation Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Object identifier (OID) of the extended operation specified in the request. |
|
|
Value specified in the request. |
|
|
Object identifier (OID) to return to the client. |
|
|
Value to send to the client. |
The following parameters allow you to access information about internal operations through the parameter block.
The following parameters allow you to access an entry to modify through the parameter block.
Table 17-12 Modify Function Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
|
|
|
DN of the entry to modify. |
|
|
Non-normalized DN of the entry to modify. |
The following parameters allow you to access information about the current operation through the parameter block.
Table 17-13 Operation Information Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Array of controls passed before the operation is created. |
|
|
Whether the operation originated internally, or as the result of a client request.
|
|
|
Whether the operation is part of replication with another server.
|
|
|
Operation currently in progress. |
|
|
Identifier for the operation. |
|
|
Message identifier for the operation. |
|
|
Time when the server began processing the operation. |
|
|
Array of controls specified in the request. |
|
|
DN of the user requesting the operation. |
|
|
Whether the bind DN of the user requesting the operation corresponds to the root DN, the value of
|
|
|
DN to which the operation applies. |
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 17-14 Plug-In Information Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Internal server representation of the plug-in. |
|
|
Number of arguments in the configuration entry. |
|
|
Array of arguments in the configuration entry. |
|
|
Plug-in identifier set and then required by the server when handling internal operations. You may cast this to |
|
|
Private data you pass to your plug-in functions. You define this data structure. |
|
|
Type of plug-in function, corresponding to the value of |
|
|
Plug-in API version supported by the plug-in. |
Parameters for use with password check plug-ins follow.
Table 17-15 Password Verification Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Array of password values to check. |
|
|
Function called to check password values against quality criteria. For details, see What a Password Check Plug-In Must Do. |
Parameters for use with post-operation plug-ins follow. These parameters allow plug-ins to compare the state of an entry before an operation with the state of an entry after an operation.
Parameters for registering generic plug-in functions follow. These function types may be registered by any plug-in.
Parameters for registering an extendedop
plug-in function and object identifier list follow.
Parameters for registering an internalpostoperation
plug-in functions follow.
Table 17-19 Internal Postoperation Registration Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Function called after an internal add operation completes. |
|
|
Function called after an internal delete operation completes. |
|
|
Function called after an internal modify operation completes. |
|
|
Function called after an internal rename (modify RDN) operation completes. |
Parameters for registering an internalpreoperation
plug-in functions follow.
Table 17-20 Internal Preoperation Registration Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Function called before an internal add operation is performed. |
|
|
Function called before an internal delete operation is performed. |
|
|
Function called before an internal modify operation is performed. |
|
|
Function called before an internal rename (modify RDN) operation is performed. |
Parameters for registering ldbmentryfetchstore
plug-in functions follow.
Parameters for registering matchingrule
plug-in functions and arguments follow.
Table 17-22 Matching Rule Function and Argument Registration Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Used to signify registration of the matching rule description with |
|
|
Used to signify registration of the matching rule name with |
|
|
Used to signify the matching rule is obsolete when registering with |
|
|
Used to signify registration of the matching rule object identifier with |
|
|
Used to signify registration of the matching rule syntax with |
|
|
Function called to free memory allocated to filter object. |
|
|
Filter factory function. |
|
|
Function called to set the indexer function. |
|
|
Function called to check for a match. |
|
|
Function called to reset the match filter. |
|
|
Whether the filter is reusable.
|
|
|
Index factory function. |
|
|
Function called to index a single entry. |
|
|
Array of index keys corresponding to the attribute values. |
|
|
Object identifier (OID) corresponding to the extensible match rule. |
|
|
Type of operator used to check for matches.
|
|
|
Matching rule filter type. |
|
|
Whether to use the rule to index or to sort.
|
|
|
Attribute value to match. |
|
|
Array of attribute values to match. |
|
|
Filter object for extensible match. You define this data structure to use in a matching rule plug-in. |
Parameters for registering postoperation
plug-in functions follow.
Table 17-23 Postoperation Function Registration Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Function called after an operation is abandoned. |
|
|
Function called after an add operation completes. |
|
|
Function called after a bind operation completes. |
|
|
Function called after a compare operation completes. |
|
|
Function called after a delete operation completes. |
|
|
Function called after an entry is sent to the client. |
|
|
Function called after a modify operation completes. |
|
|
Function called after an rename (modify RDN) operation completes. |
|
|
Function called after a referral is sent to the client. |
|
|
Function called after a result is sent to the client. |
|
|
Function called after a search operation completes. For persistent search operations, this function is called after the client interrupts the search. |
|
|
Function called after an unbind operation completes. |
Parameters for registering preoperation
plug-in functions follow.
Table 17-24 Preoperation Function Registration Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Function called before an operation is abandoned. |
|
|
Function called before an add operation is performed. |
|
|
Function called before a bind operation is performed. |
|
|
Function called before a compare operation is performed. |
|
|
Function called before an delete operation is performed. |
|
|
Function called before an entry is sent to the client. |
|
|
Function called before a modify operation is performed. |
|
|
Function called before an rename (modify RDN) operation is performed. |
|
|
Function called before a referral is sent to the client. |
|
|
Function called before a result is sent to the client. |
|
|
Function called before a search operation is performed. |
|
|
Function called before an unbind operation is performed. |
Parameters for registering pwdstorage
and reverpwdstorage
plug-in functions follow.
Table 17-25 Password Storage Function Registration Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Function called to encode a password for comparison with a stored, encoded password. |
|
|
Stored, encoded user password. |
|
|
( |
|
|
Function called to encode a password for storage. |
|
|
Short password storage scheme name used by the server to identify the encoding scheme. |
|
|
User password in clear text. |
The following parameters allow you to access an entry to rename through the parameter block.
Table 17-26 Rename (Modify RDN) Function Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Whether to delete the old Relative Distinguished Name (RDN).
|
|
|
New RDN to assign to the entry. |
|
|
DN of the new parent of the entry being renamed. |
|
|
DN of the entry to rename. |
|
|
Non-normalized DN of the entry to rename. |
The following parameters allow you to access results through the parameter block.
Table 17-27 Result Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Lets you add a control to the set of controls to send to the client. Use |
|
|
Array of controls to send to client. If you use this with |
|
|
Result code to send to client. |
|
|
Portion of target DN that matched when sending |
|
|
Message to send to client. |
The following parameters allow you to access search parameters through the parameter block.
Table 17-28 Search Function Parameters
Parameter ID | Data Type | Description |
---|---|---|
|
Number of entries returned by the search. |
|
|
Array of attribute types to return in the search results. The asterisk, |
|
|
Whether to return both attribute types and attribute values.
|
|
|
Method for handling aliases. |
|
|
Filter to be used for the search. |
|
|
Array of URLs to other LDAP servers to which the client is referred. |
|
|
Entry returned while iterating through the result set. You may cast this to |
|
|
Scope of the search. |
|
|
Maximum number of entries to return in the search results. |
|
|
String representation of the filter to be used for the search. |
|
|
DN of base entry for the search. |
|
|
Maximum number of seconds to allow for the search. |