org.dsmltools
Class DSMLLDAPReader

java.lang.Object
  extended by org.dsmltools.DSMLLDAPConnection
      extended by org.dsmltools.DSMLLDAPReader

public final class DSMLLDAPReader
extends DSMLLDAPConnection

This class implements functionality to search an LDAP directory and return the results of the search as a DSML document.


Field Summary
static int ALL
           
static int DATA
           
static int SCHEMA
          Constants for use in setting the value of m_contents
 
Fields inherited from class org.dsmltools.DSMLLDAPConnection
m_conn
 
Constructor Summary
DSMLLDAPReader()
           
 
Method Summary
 DSMLDocumentImpl search(java.lang.String xiBaseDN, int xiScope, java.lang.String xiFilter, java.lang.String[] xiAttributes, boolean xiAttrsOnly, LDAPSearchConstraints xiCons)
          This method has an interface like that of LDAPConnection.search, except that it returns a Document object, representing the directory information as DSML, rather than an LDAPSearchResults object.
 void setContents(int xiContents)
          Sets what sort of output is required.
 void setOutputFullSchema(boolean xiOutputFullSchema)
          Sets whether we output the full directory schema or a mini schema.
 
Methods inherited from class org.dsmltools.DSMLLDAPConnection
connect, disconnect
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCHEMA

public static final int SCHEMA
Constants for use in setting the value of m_contents

See Also:
Constant Field Values

DATA

public static final int DATA
See Also:
Constant Field Values

ALL

public static final int ALL
See Also:
Constant Field Values
Constructor Detail

DSMLLDAPReader

public DSMLLDAPReader()
Method Detail

search

public DSMLDocumentImpl search(java.lang.String xiBaseDN,
                               int xiScope,
                               java.lang.String xiFilter,
                               java.lang.String[] xiAttributes,
                               boolean xiAttrsOnly,
                               LDAPSearchConstraints xiCons)
This method has an interface like that of LDAPConnection.search, except that it returns a Document object, representing the directory information as DSML, rather than an LDAPSearchResults object.

Parameters:
xiBaseDN - The base DN for the search
xiScope - The scope of the search
xiFilter - The filter to use
xiAttributes - The attributes to return (default all)
xiAttrsOnly - Whether or not to return only attributes and not ocs.
xiCons - A structure defining any constraints on the search
Returns:
A DSMLDocumentImpl containing the data returned by the search, and

setOutputFullSchema

public void setOutputFullSchema(boolean xiOutputFullSchema)
Sets whether we output the full directory schema or a mini schema.

Parameters:
xiOutputFullSchema - The value to set it to

setContents

public void setContents(int xiContents)
Sets what sort of output is required.

Parameters:
xiContents - The type of output - one of ALL, DATA or SCHEMA.