diff options
Diffstat (limited to 'ldap/servers/slapd/vattr_spi.h')
-rw-r--r-- | ldap/servers/slapd/vattr_spi.h | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/ldap/servers/slapd/vattr_spi.h b/ldap/servers/slapd/vattr_spi.h new file mode 100644 index 00000000..c9de3988 --- /dev/null +++ b/ldap/servers/slapd/vattr_spi.h @@ -0,0 +1,54 @@ +/** BEGIN COPYRIGHT BLOCK + * Copyright 2001 Sun Microsystems, Inc. + * Portions copyright 1999, 2001-2003 Netscape Communications Corporation. + * All rights reserved. + * END COPYRIGHT BLOCK **/ + +/* Defines the vattr SPI interface, used by COS and Roles at present */ +/* Also needs to be included by any code which participates in the vattr + loop detection scheme (e.g. filter test code) + */ + +/* Loop context structure */ +typedef struct _vattr_context vattr_context; +typedef struct _vattr_sp_handle vattr_sp_handle; +typedef struct _vattr_type_list_context vattr_type_list_context; + +typedef int (*vattr_get_fn_type)(vattr_sp_handle *handle, vattr_context *c, Slapi_Entry *e, char *type, Slapi_ValueSet** results,int *type_name_disposition, char** actual_type_name, int flags, int *free_flags, void *hint); +typedef int (*vattr_get_ex_fn_type)(vattr_sp_handle *handle, vattr_context *c, Slapi_Entry *e, char **type, Slapi_ValueSet*** results,int **type_name_disposition, char*** actual_type_name, int flags, int *free_flags, void **hint); +typedef int (*vattr_compare_fn_type)(vattr_sp_handle *handle, vattr_context *c, Slapi_Entry *e, char *type, Slapi_Value *test_this, int* result, int flags, void *hint); +typedef int (*vattr_types_fn_type)(vattr_sp_handle *handle,Slapi_Entry *e,vattr_type_list_context *type_context,int flags); + +vattr_context *vattr_context_new( Slapi_PBlock *pb ); + +int slapi_vattrspi_register(vattr_sp_handle **h, vattr_get_fn_type get_fn, vattr_compare_fn_type compare_fn, vattr_types_fn_type types_fn); + +/* options must be set to null */ +int slapi_vattrspi_register_ex(vattr_sp_handle **h, vattr_get_ex_fn_type get_fn, vattr_compare_fn_type compare_fn, vattr_types_fn_type types_fn, void *options); +int slapi_vattrspi_regattr(vattr_sp_handle *h,char *type_name_to_register, char* DN /* Is there a DN type ?? */, void *hint); + +/* Type thang structure used by slapi_vattrspi_add_type() */ +struct _vattr_type_thang { + char *type_name; + unsigned long type_flags; /* Same values as Slapi_Attr->a_flags */ + Slapi_ValueSet *type_values; /* for slapi_vattr_list_attrs() use only */ +}; + +int slapi_vattrspi_add_type(vattr_type_list_context *c, vattr_type_thang *thang, int flags); + +/* get thang structure used by slapi_vattr_values_get_sp() */ +struct _vattr_get_thang { + int get_present; + char *get_type_name; + int get_name_disposition; + Slapi_ValueSet *get_present_values; + Slapi_Attr *get_attr; +}; + +/* Loop-detection-aware versions of the functions, to be called by service providers and their ilk */ +SLAPI_DEPRECATED int slapi_vattr_values_get_sp(vattr_context *c, /* Entry we're interested in */ Slapi_Entry *e, /* attr type name */ char *type, /* pointer to result set */ Slapi_ValueSet** results,int *type_name_disposition, char **actual_type_name, int flags, int *free_flags); +int slapi_vattr_values_get_sp_ex(vattr_context *c, /* Entry we're interested in */ Slapi_Entry *e, /* attr type name */ char *type, /* pointer to result set */ Slapi_ValueSet*** results,int **type_name_disposition, char ***actual_type_name, int flags, int *free_flags, int *subtype_count); +int slapi_vattr_namespace_values_get_sp(vattr_context *c, /* Entry we're interested in */ Slapi_Entry *e, /* backend namespace dn */ Slapi_DN *namespace_dn, /* attr type name */ char *type, /* pointer to result set */ Slapi_ValueSet*** results,int **type_name_disposition, char ***actual_type_name, int flags, int *free_flags, int *subtype_count); +int slapi_vattr_value_compare_sp(vattr_context *c, Slapi_Entry *e,char *type, Slapi_Value *test_this, int *result, int flags); +int slapi_vattr_namespace_value_compare_sp(vattr_context *c,/* Entry we're interested in */ Slapi_Entry *e, /* backend namespace dn*/Slapi_DN *namespace_dn, /* attr type name */ const char *type, Slapi_Value *test_this,/* pointer to result */ int *result, int flags); + |