Package org.apache.directory.ldap.client.template

Interface ModelFactory

All Known Implementing Classes:

LdapConnectionTemplate

public interface ModelFactory

A factory for creating org.apache.directory.api.ldap.model objects.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method	Description
AddRequest	newAddRequest(Entry entry)	Returns a new AddRequest for the entry.
Attribute	newAttribute(String name)	Returns a new Attribute for with the provided name and a null value.
Attribute	newAttribute(String name, byte[]... values)	Returns a new Attribute for with the provided name and value(s).
Attribute	newAttribute(String name, String... values)	Returns a new Attribute for with the provided name and value(s).
Attribute	newAttribute(String name, Value... values)	Returns a new Attribute for with the provided name and value(s).
DeleteRequest	newDeleteRequest(Dn dn)	Returns a new DeleteRequest for the dn.
Dn	newDn(String dn)	Returns a Dn that represents dn.
Entry	newEntry(String dn)	Returns a Entry with the specified dn.
Entry	newEntry(Dn dn)	Returns a Entry with the specified dn.
ModifyRequest	newModifyRequest(String dn)	Returns a new ModifyRequest for the dn.
ModifyRequest	newModifyRequest(Dn dn)	Returns a new ModifyRequest for the dn.
SearchRequest	newSearchRequest(String baseDn, String filter, SearchScope scope)	Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.
SearchRequest	newSearchRequest(String baseDn, String filter, SearchScope scope, String... attributes)	Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.
SearchRequest	newSearchRequest(String baseDn, FilterBuilder filter, SearchScope scope)	Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.
SearchRequest	newSearchRequest(String baseDn, FilterBuilder filter, SearchScope scope, String... attributes)	Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.
SearchRequest	newSearchRequest(Dn baseDn, String filter, SearchScope scope)	Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.
SearchRequest	newSearchRequest(Dn baseDn, String filter, SearchScope scope, String... attributes)	Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.
SearchRequest	newSearchRequest(Dn baseDn, FilterBuilder filter, SearchScope scope)	Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.
SearchRequest	newSearchRequest(Dn baseDn, FilterBuilder filter, SearchScope scope, String... attributes)	Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.

Method Detail

newAddRequest

AddRequest newAddRequest(Entry entry)

Returns a new AddRequest for the entry.

Parameters:

entry - The Entry to add

Returns:

The resulting AddRequest

newAttribute

Attribute newAttribute(String name)

Returns a new Attribute for with the provided name and a null value. This is useful for clearing out an Attribute with a ModifyRequest, replace function.

Parameters:

name - The attribute's name

Returns:

The resulting Attribute

newAttribute

Attribute newAttribute(String name,
                       byte[]... values)

Returns a new Attribute for with the provided name and value(s).

Parameters:

name - The attribute's name

values - The attribute's values

Returns:

The resulting Attribute

newAttribute

Attribute newAttribute(String name,
                       String... values)

Returns a new Attribute for with the provided name and value(s).

Parameters:

name - The attribute's name

values - The attribute's values

Returns:

The resulting Attribute

newAttribute

Attribute newAttribute(String name,
                       Value... values)

Returns a new Attribute for with the provided name and value(s).

Parameters:

name - The attribute's name

values - The attribute's values

Returns:

The resulting Attribute

newDeleteRequest

DeleteRequest newDeleteRequest(Dn dn)

Returns a new DeleteRequest for the dn.

Parameters:

dn - The Dn for the Entry to delete

Returns:

The resulting DeleteRequest

newDn

Dn newDn(String dn)

Returns a Dn that represents dn.

Parameters:

dn - The Entry's Dn

Returns:

The resulting Dn

newEntry

Entry newEntry(String dn)

Returns a Entry with the specified dn.

Parameters:

dn - The Entry's Dn

Returns:

The resulting Entry

newEntry

Entry newEntry(Dn dn)

Returns a Entry with the specified dn.

Parameters:

dn - The Entry's Dn

Returns:

The resulting Entry

newModifyRequest

ModifyRequest newModifyRequest(String dn)

Returns a new ModifyRequest for the dn.

Parameters:

dn - The Dn of the entry to modify

Returns:

The resulting ModifyRequest

newModifyRequest

ModifyRequest newModifyRequest(Dn dn)

Returns a new ModifyRequest for the dn.

Parameters:

dn - The DN of the entry to modify

Returns:

The resulting ModifyRequest

newSearchRequest

SearchRequest newSearchRequest(String baseDn,
                               FilterBuilder filter,
                               SearchScope scope)

Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

Returns:

The resulting SearchRequest

newSearchRequest

SearchRequest newSearchRequest(String baseDn,
                               String filter,
                               SearchScope scope)

Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

Returns:

The resulting SearchRequest

newSearchRequest

SearchRequest newSearchRequest(Dn baseDn,
                               String filter,
                               SearchScope scope)

Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

Returns:

The resulting SearchRequest

newSearchRequest

SearchRequest newSearchRequest(Dn baseDn,
                               FilterBuilder filter,
                               SearchScope scope)

Returns a new SearchRequest over baseDn in scope matching filter returning all normal attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

Returns:

The resulting SearchRequest

newSearchRequest

SearchRequest newSearchRequest(String baseDn,
                               String filter,
                               SearchScope scope,
                               String... attributes)

Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

attributes - The list of AttributeType to return

Returns:

The resulting SearchRequest

newSearchRequest

SearchRequest newSearchRequest(String baseDn,
                               FilterBuilder filter,
                               SearchScope scope,
                               String... attributes)

Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

attributes - The list of AttributeType to return

Returns:

The resulting SearchRequest

newSearchRequest

SearchRequest newSearchRequest(Dn baseDn,
                               String filter,
                               SearchScope scope,
                               String... attributes)

Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

attributes - The list of AttributeType to return

Returns:

The resulting SearchRequest

newSearchRequest

SearchRequest newSearchRequest(Dn baseDn,
                               FilterBuilder filter,
                               SearchScope scope,
                               String... attributes)

Returns a new SearchRequest over baseDn in scope matching filter returning attributes for each matching entry.

Parameters:

baseDn - The base DN from which to start the search

filter - The filter selecting the entries

scope - The scope to look from

attributes - The list of AttributeType to return

Returns:

The resulting SearchRequest