How Extended Operations Work

• the OID of the extended operation that should be performed
• data specific to the extended operation

• an OID
• any additional data

Determining the Extended Operations Supported

Performing an Extended Operation

• the synchronous ldap_extended_operation_s() function (see "Performing a Synchronous Extended Operation.")
• the asynchronous ldap_extended_operation() function (see "Performing an Asynchronous Extended Operation.")

Performing a Synchronous Extended Operation

Performing an Asynchronous Extended Operation

1. To send an LDAP extended operation request, call the asynchronous ldap_extended_operation() function.
This function returns an LDAP_SUCCESS result code if the request was successfully sent (or an LDAP result code if an error occurred while sending the request). The function also sets the msgidp argument to point to a message ID identifying the extended operation.
2. To determine whether the server sent a response for this operation to your client, call the ldap_result() function and pass in this message ID.
The ldap_result() function uses the message ID to determine if the server sent an extended operation response. The function passes back the response in an LDAPMessage structure.
3. Call the ldap_parse_extended_result() function to parse the LDAPMessage structure and retrieve information from the server's response.
If the server sent an OID of an extended operation to your client, the OID is passed back as the retoidp argument.
If the server sent a data to your client, the data is specified in the berval structure passed back as the retdatap argument.
4. Call the ldap_get_lderrno() function to get the LDAP result code for the operation. The function returns an LDAP_SUCCESS result code if the extended operation was performed successfully or an LDAP error code if a problem occurred.
See the documentation on the return values of the ldap_extended_operation_s() function for a list of result codes that the server can return for this operation.

Example: Extended Operation

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include <time.h>

#include "ldap.h"

/* Name and port of the LDAP server you want to connect to. */

#define MY_HOST "localhost"

#define MY_PORT   389

/* DN of user (and password of user) who you want to authenticate as */

#define MGR_DN   "cn=Directory Manager"

#define MGR_PW   "23skidoo"

int

main( int argc, char **argv )

{

    /* OID of the extended operation that you are requesting */

    const char *oidrequest = "1.2.3.4";

    char *oidresult;

    struct berval valrequest;

    struct berval *valresult;

    LDAP *ld;

    int rc, version;

    /* Set up the value that you want to pass to the server */

    printf( "Setting up value to pass to server...\n" );

    valrequest.bv_val = "My Value";

    valrequest.bv_len = strlen( "My Value" );

    /* Get a handle to an LDAP connection */

    printf( "Getting the handle to the LDAP connection...\n" );

    if ( (ld = ldap_init( MY_HOST, MY_PORT )) == NULL ) {

   perror( "ldap_init" );

   ldap_unbind( ld );

   return( 1 );

    }

    /* Set the LDAP protocol version supported by the client

       to 3. (By default, this is set to 2. Extended operations

       are part of version 3 of the LDAP protocol.) */

    ldap_get_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version );

    printf( "Resetting version %d to 3.0...\n", version );

    version = LDAP_VERSION3;

    ldap_set_option( ld, LDAP_OPT_PROTOCOL_VERSION, &version );

    /* Authenticate to the directory as the Directory Manager */

    printf( "Binding to the directory...\n" );

    if ( ldap_simple_bind_s( ld, MGR_DN, MGR_PW ) != LDAP_SUCCESS ) {

   ldap_perror( ld, "ldap_simple_bind_s" );

   ldap_unbind( ld );

   return( 1 );

    }

    /* Initiate the extended operation */

    printf( "Initiating the extended operation...\n" );

    if ( ( rc = ldap_extended_operation_s( ld, oidrequest, &valrequest, NULL, NULL, &oidresult, &valresult ) ) != LDAP_SUCCESS ) {

   ldap_perror( ld, "ldap_extended_operation failed: " );

   ldap_unbind( ld );

   return( 1 );

    } 

    /* Get the OID and the value from the result returned by the server. */

    printf( "Operation successful.\n" );

    printf( "\tReturned OID: %s\n", oidresult );

    printf( "\tReturned value: %s\n", valresult->bv_val );

    /* Disconnect from the server. */

    ldap_unbind( ld );

    return 0;

}

Last Updated: 10/01/98 17:05:15