| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd"> |
| |
| <document> |
| <header> |
| <title>LDAP Transformer</title> |
| <version>0.9</version> |
| <type>Technical document</type> |
| <authors> |
| <person name="Carsten Ziegeler" email="cziegeler@apache.org"/> |
| </authors> |
| <abstract>This document describes the LDAP transformer of Cocoon.</abstract> |
| </header> |
| <body> |
| <s1 title="LDAP Transformer"> |
| <p> |
| The <code>LDAPTransformer</code> is a class that can be plugged into a pipeline |
| to transform the SAX events which passes through this transformer into queries |
| to an ldap interface and transforms the response to SAX events which are passed |
| on in the pipeline. |
| </p> |
| <ul> |
| <li>Name : ldap</li> |
| <li>Class: org.apache.cocoon.transformation.LDAPTransformer</li> |
| <li>Cacheable: no.</li> |
| </ul> |
| <p>This transformer is optional and not available in the binary distribution. |
| However if you want to use it, you have to retrieve the jndi package, |
| copy the jar file into the lib directory of Cocoon and rebuild. |
| </p> |
| <p> |
| The file will be specified in a parameter tag in the sitemap pipeline to the |
| transformer as follows: |
| </p> |
| <source> |
| <map:transform type="ldap"/> |
| </source> |
| <p> |
| The following DTD is valid:<br/> |
| <!ELEMENT execute-query (attribute+ | show-attribute? | scope? | initializer? | authentication? | error-element? | sax-error? doc-element? | row-element? | version? | serverurl? | rootdn? | password? | deref-link? | count-limit? | searchbase, filter)><br/> |
| <!ELEMENT execute-increment (attribute | show-attribute? | scope? | initializer? | authentication? | error-element? | sax-error? | doc-element? | row-element? | version? | serverurl? | rootdn? | password? | deref-link? | count-limit? | searchbase, filter)><br/> |
| increments (+1) an integer attribute on a directory-server (ldap)<br/> |
| <br/> |
| <!ELEMENT initializer (#PCDATA)>* (default: "com.sun.jndi.ldap.LdapCtxFactory")<br/> |
| <!ELEMENT authentication (#PCDATA)>* (default: "simple")<br/> |
| <!ELEMENT version (#PCDATA)>* (default: "2")<br/> |
| <!ELEMENT serverurl (#PCDATA)>*<br/> |
| <!ELEMENT port (#PCDATA)>* (default: 389)<br/> |
| <!ELEMENT rootdn (#PCDATA)>*<br/> |
| <!ELEMENT password (#PCDATA)>*<br/> |
| <!ELEMENT scope (ONELEVEL_SCOPE | SUBTREE_SCOPE | OBJECT_SCOPE)>* (default: ONELEVEL_SCOPE)<br/> |
| <!ELEMENT searchbase (#PCDATA)>*<br/> |
| <!ELEMENT doc-element (#PCDATA)>* (default: "doc-element")<br/> |
| <!ELEMENT row-element (#PCDATA)>* (default: "row-element")<br/> |
| <!ELEMENT error-element (#PCDATA)>* (default: "ldap-error") (in case of error returned error tag)<br/> |
| <!ELEMENT sax_error (TRUE | FALSE)>* (default: FALSE) (throws SAX-Exception instead of error tag)<br/> |
| <!ELEMENT attribute (#PCDATA)><br/> |
| <!ELEMENT show-attribute (TRUE | FALSE)> (default: TRUE)<br/> |
| <!ELEMENT filter (#PCDATA | execute-query)><br/> |
| <!ELEMENT deref-link (TRUE | FALSE)> (default: FALSE)<br/> |
| <!ELEMENT count-limit (#PCDATA)> (integer default: 0 -> no limit)<br/> |
| <!ELEMENT time-limit (#PCDATA)> (integer default: 0 -> infinite)<br/> |
| <!ELEMENT debug (TRUE | FALSE)>* (default: FALSE)<br/> |
| can also be defined as parameter in the sitemap. |
| </p> |
| </s1> |
| </body> |
| </document> |
