XQuery Function Documentation

Search and Browse

http://exist-db.org/xquery/jndi

java:org.exist.xquery.modules.jndi.JNDIModule

A module for performing JNDI queries against Directories, returning XML representations of the results.

jndi:close-context

jndi:close-context($directory-context as xs:integer) as item()

Closes a JNDI Context

Parameters:
$directory-context The directory context handle from a jndi:get-dir-context() call
Returns:
item()

jndi:create

jndi:create($directory-context as xs:integer, $dn as xs:string, $attributes as element()) as item()

Create a JNDI Directory entry.

Parameters:
$directory-context The directory context handle from a jndi:get-dir-context() call
$dn The Distinguished Name
$attributes The entry attributes to be set in the form <attributes><attribute name="" value=""/></attributes>. You can also optionally specify ordered="true" for an attribute.
Returns:
item()

jndi:delete

jndi:delete($directory-context as xs:integer, $dn as xs:string) as item()

Delete a JNDI Directory entry.

Parameters:
$directory-context The directory context handle from a jndi:get-dir-context() call
$dn The Distinguished Name
Returns:
item()

jndi:get-dir-context

jndi:get-dir-context($properties as element()?) as xs:long?

Opens a JNDI Directory Context.

Parameters:
$properties? The JNDI Directory Context environment properties to be set in the form <properties><property name="" value=""/></properties>.
Returns:
xs:long? : the directory context handle

jndi:modify

jndi:modify($directory-context as xs:integer, $dn as xs:string, $attributes as element()) as item()

Modify a JNDI Directory entry.

Parameters:
$directory-context The directory context handle from a jndi:get-dir-context() call
$dn The Distinguished Name
$attributes The entry attributes to be set in the form <attributes><attribute name="" value="" operation="add | replace | remove"/></attributes>. You can also optionally specify ordered="true" for an attribute.
Returns:
item()

jndi:rename

jndi:rename($directory-context as xs:integer, $old-dn as xs:string, $new-dn as xs:string) as item()

Rename a JNDI Directory entry.

Parameters:
$directory-context The directory context handle from a jndi:get-dir-context() call
$old-dn The Distinguished Name to rename
$new-dn The new Distinguished Name
Returns:
item()

jndi:search

jndi:search($directory-context as xs:integer, $dn as xs:string, $search-attributes as element()) as node()?

Searches a JNDI Directory by attributes.

Parameters:
$directory-context The directory context handle from a jndi:get-dir-context() call
$dn The Distinguished Name
$search-attributes The search attributes in the form <attributes><attribute name="" value=""/></attributes>.
Returns:
node()? : the search results in DSML format

jndi:search

jndi:search($directory-context as xs:integer, $dn as xs:string, $filter as xs:string, $scope as xs:string) as node()?

Searches a JNDI Directory by filter.

Parameters:
$directory-context The directory context handle from a jndi:get-dir-context() call
$dn The Distinguished Name
$filter The filter. The format and interpretation of filter follows RFC 2254 with the following interpretations for 'attr' and 'value' mentioned in the RFC. 'attr' is the attribute's identifier. 'value' is the string represention the attribute's value. The translation of this string representation into the attribute's value is directory-specific.
$scope The scope, which has a value of 'object', 'onelevel' or 'subtree'
Returns:
node()? : the search results in DSML format