faare_mapping.dtd

OPIAM stands for Open Identity and Access Management. This Suite will provide modules for user & rig

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
DTD of faare_mapping.xml mapping file. This file describes mapping between Java objects and LDAP entries.
 -->

<!-- top level element : LDAP server configuration and mapping configuration -->
<!ELEMENT mapping (ldapconfig, class+)>

<!--
  LDAP server configuration.
   host: LDAP server address or hostname (ex: "55.2.6.74" or "PC01"').
   port: LDAP server port number (ex: "389").
   baseDN: default base Dname (ex: "ou=test,o=mycompany").
   appliDN: Dname  used for applicative connections (ex: "cn=directory manager").
   appliPwd: password used for applicative connections (ex: "000000000").
   cacheSize: object cache size (ex: "3000").
   sizeLimit: Maximum number of entries got in search results. 0 for no maximum value.
              Default is 1000.
   timeLimit: Maximum time before time out. 0 for no time out.
              Default is 0.
   connectionType: User connection type :
                   - "appli": the connections are always bound with applicative dname and password
                   - "user": the connections are bound with connected user dname and password.
                   Default is "appli"
   serverSort : LDAP server side sort control is supported or not. Default : it is not.

 -->
<!ELEMENT ldapconfig EMPTY>
<!ATTLIST ldapconfig
	host CDATA #REQUIRED
	port CDATA #REQUIRED
	baseDN CDATA #REQUIRED
	appliDN CDATA #REQUIRED
	appliPwd CDATA #REQUIRED
	sizeLimit CDATA #IMPLIED
	timeLimit CDATA #IMPLIED
	cacheSize CDATA #REQUIRED
	connectionType CDATA #IMPLIED
	serverSort (false | true) #IMPLIED
>

<!--
  Mapping between a Java class and an LDAP entry.
  A class is specified with its Java class name (ex: "myapp.Product").
  The "identity" attribute gives the Java class identifier ("dn" for LDAP).
  The mapped class specifies each mapped attribute.
  Any unmapped attribute will not be considered by the persistence level.
-->
<!ELEMENT class (map-to, field+)>
<!ATTLIST class
	name CDATA #REQUIRED
	identity CDATA #REQUIRED
>

<!--
  This element specifies a list of objectclass attribute values wich allow to
  select LDAP entries mapped to this Java class.
  ldap-oc : list of object classes
            Syntax : comma separated list of values, "*" meaning any value.
  Example:
    	<map-to ldap-oc="person,organizationalperson,inetorgperson,top,*" />
	This will map entries with at least
        person,organizationalperson,inetorgperson,top as object classes.

 -->
<!ELEMENT map-to EMPTY>
<!ATTLIST map-to
	ldap-oc CDATA #REQUIRED
>

<!--
  Mapping between a Java attribute and an LDAP attribute.
     name : name of the Java attribute. All attributes may be accessed by a getter and a setter.
            Beware that this field is case sensitive.
     type : type of Java attribute. One of :
            - Standard Java types :
             * "java.lang.String" or "string"
             * "java.lang.Integer"  or "integer"
             * "java.lang.Byte" or "byte"
            - other mapped class (ex: type="myapp.Product")
     collection : in case of multi valued attributes, the type field gives the type of each value,
                  and the kind of collection in the Java object must be specified here.
                  All Java collection are supported.
                  "collection=collection" is used in most cases.
     lazy : in case of a multi valued attribute, the lazy field is set to enable lazy loading for this field.
            Value : lazy loading plugin, extending opiam.admin.faare.persistence.LazyCollection.
            OPIAM Admin standard lazy plugins :
              * opiam.admin.faare.persistence.LazyStringCollection: values of the attribute are strings.
                The string values will be loaded when the collection is iterated.
              * opiam.admin.faare.persistence.LazyDnCollection: same as LazyStringCollection, but values are semantically dnames.
              * opiam.admin.faare.persistence.LazyBytesCollection: same as LazyStringCollection, but values are binary values.
                                                                      (such as photos).
              * opiam.admin.faare.persistence.LazyJBTopCollection: values are other mapped objects.
                When loading the object, the object "identity" fields (dnames) will be loaded. The objects will be loaded
                when the collection is iterated.
  For LDAP persistence, mappings must allways define "dn" and "objectclass".
 -->
<!ELEMENT field (ldap)>
<!ATTLIST field
	name CDATA #REQUIRED
	type CDATA #REQUIRED
	lazy CDATA #IMPLIED
	collection CDATA #IMPLIED
>

<!--
  LDAP attribute name corresponding to a Java attribute.
     name : name of the LDAP attribute, case insensitive.
 -->
<!ELEMENT ldap EMPTY>
<!ATTLIST ldap
	name CDATA #REQUIRED
>