DsmlSearch (VT LDAP Libraries 3.3.8 API)

java.lang.Object
- edu.vt.middleware.ldap.LdapSearch
- - edu.vt.middleware.ldap.dsml.DsmlSearch

```
public class DsmlSearch
extends LdapSearch
```
DsmlSearch queries an LDAP and returns the result as DSML. Each instance of DsmlSearch maintains it's own pool of LDAP connections.

Version:

$Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $

Author:

Middleware Services

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DsmlSearch.Version
Valid DSML versions.

Field Summary
- Fields inherited from class edu.vt.middleware.ldap.LdapSearch
  beanFactory, logger, pool

Constructor Summary

Constructors
Constructor Description

DsmlSearch(LdapPool<Ldap> pool)
This creates a new DsmlSearch with the supplied pool.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DsmlSearch.Version`	`getVersion()`	This gets the version of dsml to produce.
`void`	`search(java.lang.String query, java.lang.String[] attrs, java.io.Writer writer)`	This will perform an LDAP search with the supplied query and return attributes.
`void`	`setVersion(DsmlSearch.Version v)`	This sets the version of dsml to produce.

Methods inherited from class edu.vt.middleware.ldap.LdapSearch
close, finalize, getLdapBeanFactory, search, setLdapBeanFactory

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DsmlSearch
```
public DsmlSearch(LdapPool<Ldap> pool)
```
    This creates a new DsmlSearch with the supplied pool.
    
    Parameters:
    
    pool - LdapPool
- Method Detail
  - getVersion
```
public DsmlSearch.Version getVersion()
```
    This gets the version of dsml to produce.
    
    Returns:
    
    Version of DSML to produce
  - setVersion
```
public void setVersion(DsmlSearch.Version v)
```
    This sets the version of dsml to produce.
    
    Parameters:
    
    v - Version of DSML to produce
  - search
```
public void search(java.lang.String query,
                   java.lang.String[] attrs,
                   java.io.Writer writer)
            throws javax.naming.NamingException,
                   java.io.IOException
```
    This will perform an LDAP search with the supplied query and return attributes. The results will be written to the supplied Writer. Use version to control which version of DSML is written.
    
    Overrides:
    
    search in class LdapSearch
    
    Parameters:
    
    query - String to search for
    
    attrs - String[] to return
    
    writer - Writer to write to
    
    Throws:
    
    javax.naming.NamingException - if an error occurs while searching
    
    java.io.IOException - if an error occurs while writing search results