LDAPXML: Map Documentation

A map file lets LDAPXML know what kind of XML to output for your LDAP tree. Here's the DTD.

<lxmap>

The root element in a map file is <lxmap>. All LX map files must have this element as the top element wrapping all the other elements. XML Attributes:

namespace: See Namespaces below.
ns: See Namespaces below.
root: The element name for the root element of your output XML.
version: Must always equal '1.0' for this version.

<entry>

The entry represents an LDAP entry. It specifies the structural objectClass in it's class attribute. When the LDAPXML encounters an LDAP entry, it tries to find a matching <entry> to use as a conversion map. This element can contain any number of <class> elements, which specify details of the mapping process. XML Attributes:

class: An objectClass in the LDAP that uniquely identifies this type of entry. This is ususally the structural object class in LDAP schemas.
hook: The name of a java class which can modify aspects of the mapping/conversion process. See hook documentation for details.
namespace: See Namespaces below.
ns: See Namespaces below.

<class>

Specifies how to convert the a given LDAP objectClass to XML. By default all the elements are mapped. A <class> element can also contain various <element< or <attribute> elements which specify how to map the various LDAP attributes to XML. When in 'exclusive' mode (see below) only those attributes specifically referenced are mapped. XML Attributes:

name: The name of this objectClass.
mode: When set to 'inclusive' all the LDAP attributes of this class are mapped by default. When set to 'exclusive', only the attributes specifically requested are mapped. Defaults to 'inclusive'
place: When set to 'block' creates an XML element for this class. The default is 'inline' which adds this class' LDAP attributes to the parent XML element.
namespace: See Namespaces below.
ns: See Namespaces below.

<attribute>

Creates a XML attribute for a given LDAP attribute. This element should be contained within a <class> element. By putting <rename> or <ignore> elements within this one, you can manipulate it. XML Attributes:

name: The name of this LDAP attribute.

<element>

Creates a XML element for a given LDAP attribute. This element should be contained within a <class> element. By putting <rename> or <ignore> elements within this one, you can manipulate it. XML Attributes:

name: The name of this LDAP attribute.

<rename>

Renames the XML element or XML attribute that this <rename> element is contained within. By default all mapped LDAP attributes keep the same name, this allows you to map <entry> or <attribute> to a different name. XML Attributes:

name: The new name.

<ignore>

Causes the XML element or XML attribute that this <rename> to not be used or output in the final XML.

Namespace Elements

The ns and namespace attributes specify which namespace prefix and namespace uri to use on the given XML elements. They apply to all elements beneath the element to which they are assigned.