dsapi.h

Go to the documentation of this file.

/* Emacs mode: -*- C -*- */
 
/* 
 * Copyright (c) 2004-2017, Isode Limited, London, England.
 * All rights reserved.
 *
 * Acquisition and use of this software and related materials for any
 * purpose requires a written licence agreement from Isode
 * Limited, or a written licence from an organisation licenced by Isode
 * Limited to grant such a licence.
 *
 */
 
/*
 * dsapi.h
 *
 * Simple directory API directory operations.
 *
 */
 
/* 
 * 
 *
 * @VERSION@
 */
 
#ifndef ISODE_DSAPI_H
#define ISODE_DSAPI_H
 
#include <isode/ds/dsapi/dsapi_cdecl.h>
#include <isode/ds/dsapi/dsapi_attr.h>
#include <isode/ds/dsapi/dsapi_entry.h>
#include <isode/ds/dsapi/dsapi_referral.h>
#include <isode/ds/dsapi/dsapi_name.h>
#include <isode/ds/dsapi/dsapi_const.h>
#include <isode/ds/dsapi/dsapi_common_args.h>
#include <isode/ds/dsapi/dsapi_ldif.h>
 
LIBDSAPI_CDECL
DS_Status DS_Initialize (
    void
);
 
LIBDSAPI_CDECL
DS_Status DS_InitializeWithLog (
    int
);
 
LIBDSAPI_CDECL
DS_Status DS_InitializeSecurity (
    const char *path
);
 
LIBDSAPI_CDECL
void DS_UninitializeSecurity (void);
 
LIBDSAPI_CDECL
int DS_Version (
    void
);
 
LIBDSAPI_CDECL
DS_Status DS_Session_New (
    const char  *address,
    int          force_tls,
    DS_Session **session_p
);
 
LIBDSAPI_CDECL
DS_Status DS_BindAnonymousSync (
    DS_Session     *session,
    DS_CommonArgs  *common_args,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_BindSync_Anonymous (
    const char  *address,
    DS_Session **session_p
) DSAPI_DEPRECATED;
 
LIBDSAPI_CDECL
DS_Status DS_BindSimpleSync (
    DS_Session     *session,
    const DS_DN    *dn,
    const char     *password,
    DS_CommonArgs  *common_args,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_BindSync_Simple (
    const char   *address,
    const DS_DN  *dn,
    const char   *password,
    DS_Session  **session_p
) DSAPI_DEPRECATED;
 
LIBDSAPI_CDECL
DS_Status DS_BindStrongSync (
    DS_Session     *session,
    const DS_DN    *dsa_dn,
    const DS_DN    *dn,
    const char     *password,
    DS_CommonArgs  *common_args,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_BindSync_Strong (
    const char   *address,
    const DS_DN  *dsa_dn,
    const DS_DN  *dn,
    const char   *password,
    DS_Session  **session_p
) DSAPI_DEPRECATED;
 
LIBDSAPI_CDECL
const char ** DS_SaslMechList(void);
 
LIBDSAPI_CDECL
DS_Status DS_BindSASLSync (
    DS_Session     *session,
    const char     *mechanism,
    const char     *userid,
    const char     *secret,
    DS_CommonArgs  *common_args,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_BindSync_SASL (
    const char  *address,
    const char  *mechanism,
    const char  *userid,
    const char  *secret,
    DS_Session **session_p
) DSAPI_DEPRECATED;
 
LIBDSAPI_CDECL
DS_Status DS_BindWithParameters (
    DS_Session          *session,
    const DS_BindParams *bind_params,
    DS_CommonArgs       *common_args,
    DS_Indication      **indication_p);
 
LIBDSAPI_CDECL
void DS_UnbindSync (
    DS_Session **session_p
);
 
LIBDSAPI_CDECL
DS_Status DS_GetSessionState(
    const DS_Session *session_p,
    DSSessionState *state_p
);
 
LIBDSAPI_CDECL
DS_Status DS_GetSessionCertificates (
    const DS_Session *session_p,
    DS_AttrValList  **av_list_p,
    int *identity_check_result
);
 
 
LIBDSAPI_CDECL
DS_Status DS_AllowUnknownAttrs (
    DS_Session *session,
    int allow_unknown
);
 
 
LIBDSAPI_CDECL
DS_Status DS_GetAllowUnknownAttrs (
    DS_Session *session,
    int *allow_unknown_p
);
 
 
LIBDSAPI_CDECL
DS_Status DS_ReadSync (
    DS_Session     *session,
    const DS_DN    *dn,
    const char     *attr_selection[],
    DS_CommonArgs  *common_args,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_SearchSync (
    DS_Session     *session,
    const DS_DN    *base_dn,
    const char     *filter,
    DSSearchScope   search_scope,
    const char     *attr_selection[],
    DS_CommonArgs  *common_args,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_NextPageSync (
    DS_Session    *session,
    DS_Indication *di
);
 
LIBDSAPI_CDECL
DS_Status DS_AddSync (
    DS_Session           *session,
    const DS_Entry       *entry,
    const DS_CommonArgs  *common_args,
    DS_Indication       **indication_p
);
    
LIBDSAPI_CDECL
DS_Status DS_AddSyncByDN (
    DS_Session           *session,
    const DS_DN          *dn,
    const DS_AttrList    *attrs,
    const DS_CommonArgs  *common_args,
    DS_Indication       **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_DeleteSync (
    DS_Session           *session,
    const DS_DN          *dn,
    const DS_CommonArgs  *common_args,
    DS_Indication       **indication_p
);
    
LIBDSAPI_CDECL
DS_Status DS_ModifySync (
    DS_Session           *session,
    const DS_Entry       *entry,
    const DS_CommonArgs  *common_args,
    DS_Indication       **indication_p
);
    
LIBDSAPI_CDECL
DS_Status DS_ModifySyncByDN (
    DS_Session           *session,
    const DS_DN          *dn,
    const DS_AttrList    *changes,
    const DS_CommonArgs  *common_args,
    DS_Indication       **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_RenameSync (
    DS_Session           *session,
    const DS_DN          *old_dn,
    const DS_DN          *new_dn,
    int                   delete_old_rdn,
    const DS_CommonArgs  *common_args,
    DS_Indication       **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_CompareSync (
    DS_Session           *session,
    const DS_DN          *dn,
    const DS_Attr        *attr,
    const DS_CommonArgs  *common_args,
    DS_Indication       **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_ReadAsync (
    DS_Session    *session,
    const DS_DN   *dn,
    const char    *attr_selection[],
    DS_CommonArgs *common_args,
    int           *ret_op_id
);
 
LIBDSAPI_CDECL
DS_Status DS_TxnStartSync (
    DS_Session     *session,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_TxnEndSync (
    DS_Session     *session,
    unsigned char  *txn_id,
    size_t          txn_id_len,
    char            commit,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Poll (
    DS_Session     *session,
    int             op_id,
    DS_Indication **indication_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Cancel (
    DS_Session *session,
    int         op_id
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetStatus (
    DS_Indication *indication,
    DS_ErrorType  *type_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetErrorCodes (
    DS_Indication *indication,
    DS_ErrorType  *type_p,
    DS_ErrorValue *value_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetSignatureError (
    DS_Indication *indication,
    int           *sign_error_p
);
 
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetLimitProblem (
    DS_Indication  *indication,
    DSLimitProblem *limit_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetEntryCount (
    DS_Indication *indication,
    int           *ret_num_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetEntryList (
    DS_Indication       *indication,
    const DS_EntryList **entry_list_p
);
 
LIBDSAPI_CDECL
DS_Entry *DS_Indication_GetFirstEntry (
    DS_Indication       *indication
);
 
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetCompareResult (
    DS_Indication *indication,
    int           *matched
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetTxnStartResult (
    DS_Indication  *indication,
    unsigned char **txn_id,
    size_t         *txn_id_len
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetTxnEndResult (
    DS_Indication *indication,
    int           *fail_msg_id
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetContinuationReferences (
    const DS_Indication      *indication,
    const DS_ReferralList   **referral_list_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetReferrals (
    const DS_Indication      *indication,
    const DS_ReferralList   **referral_list_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetPasswordPolicyExpiryWarning (
    const DS_Indication    *indication,
    int                    *time_before_expiration_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetPasswordPolicyGraceWarning (
    const DS_Indication    *indication,
    int                    *grace_authentications_remaining_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetPasswordPolicyErrorCode (
    const DS_Indication    *indication,
    DS_PasswordPolicyError *error_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_GetExtraErrorText (
    const DS_Indication    *indication,
    const char            **error_text_p
);
 
LIBDSAPI_CDECL
DS_Status DS_Indication_HasMoreResults (
    const DS_Indication *indication,
    int                 *more_pages
);
 
LIBDSAPI_CDECL
void DS_Indication_Delete (
    DS_Indication *indication
);
 
#endif /* ISODE_DSAPI_H */