Module Ldap_schemaparser

module Ldap_schemaparser: sig .. end

A library for parsing rfc2252 schemas as returned by directory servers

module Oid: sig .. end

val format_oid : Oid.t -> unit

module Lcstring: sig .. end

val format_lcstring : Lcstring.t -> unit

type octype =

`\|`	`Abstract`
`\|`	`Structural`
`\|`	`Auxiliary`

type objectclass = {

	`oc_name : string list;`
	`oc_oid : Oid.t;`
	`oc_desc : string;`
	`oc_obsolete : bool;`
	`oc_sup : Lcstring.t list;`
	`oc_must : Lcstring.t list;`
	`oc_may : Lcstring.t list;`
	`oc_type : octype;`
	`oc_xattr : string list;`

}

The type representing an objectclass definition

type attribute = {

	`at_name : string list;`
	`at_desc : string;`
	`at_oid : Oid.t;`
	`at_equality : string;`
	`at_ordering : string;`
	`at_substr : Oid.t;`
	`at_syntax : Oid.t;`
	`at_length : Int64.t;`
	`at_obsolete : bool;`
	`at_single_value : bool;`
	`at_collective : bool;`
	`at_no_user_modification : bool;`
	`at_usage : string;`
	`at_sup : Lcstring.t list;`
	`at_xattr : string list;`

}

The type representing an attribute definition

type schema = {

	`objectclasses : (Lcstring.t, objectclass) Hashtbl.t;`
	`objectclasses_byoid : (Oid.t, objectclass) Hashtbl.t;`
	`attributes : (Lcstring.t, attribute) Hashtbl.t;`
	`attributes_byoid : (Oid.t, attribute) Hashtbl.t;`

}

The type representing the whole schema. Consists of hashtbls indexed by two useful keys. For both attributes and objectclasses there exists a hashtbl indexed by OID, and one indexed by lower case canonical name. There exist functions in Ldap_ooclient to look up attributes and objectclasses by non canonical names if that is necessary for you to do. see attrToOid, and ocToOid. They will find the oid of an attribute or objectclass given any name, not just the canonical one. Not that this is somewhat (like several orders of magnitude) slower than lookups by canonical name.

val schema_print_depth : int Pervasives.ref

This reference controls the dept of printing for the schema in the toplevel. The default is 10 keys from each table will be printed. OID tables are not currently printed.

val format_schema : schema -> unit

A formatter for the schema, prints the structure, and expands the hashtbls to show the keys. The number of keys printed is controled by schema_print_depth.

exception Parse_error_oc of Lexing.lexbuf * objectclass * string

exception Parse_error_at of Lexing.lexbuf * attribute * string

exception Syntax_error_oc of Lexing.lexbuf * objectclass * string

exception Syntax_error_at of Lexing.lexbuf * attribute * string

val readSchema : string list -> string list -> schema

readSchema attribute_list objectclass_list, parse the schema into a schema type given a list of attribute definition lines, and objectclass definition lines.