org.apache.directory.ldap.client.template

Interface ModelFactory

All Known Implementing Classes:

LdapConnectionTemplate, ModelFactoryImpl

public interface ModelFactory

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

Author:

Apache Directory Project

Method Summary

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

Method Detail

newAddRequest

org.apache.directory.api.ldap.model.message.AddRequest newAddRequest(org.apache.directory.api.ldap.model.entry.Entry entry)

Returns a new AddRequest for the entry.

Parameters:

entry - The Entry to add

Returns:

The resulting AddRequest

newAttribute

org.apache.directory.api.ldap.model.entry.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

org.apache.directory.api.ldap.model.entry.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

org.apache.directory.api.ldap.model.entry.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

org.apache.directory.api.ldap.model.entry.Attribute newAttribute(String name,
                                                                 org.apache.directory.api.ldap.model.entry.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

org.apache.directory.api.ldap.model.message.DeleteRequest newDeleteRequest(org.apache.directory.api.ldap.model.name.Dn dn)

Returns a new DeleteRequest for the dn.

Parameters:

dn - The Dn for the Entry to delete

Returns:

The resulting DeleteRequest

newDn

org.apache.directory.api.ldap.model.name.Dn newDn(String dn)

Returns a Dn that represents dn.

Parameters:

dn - The Entry's Dn

Returns:

The resulting Dn

newEntry

org.apache.directory.api.ldap.model.entry.Entry newEntry(String dn)

Returns a Entry with the specified dn.

Parameters:

dn - The Entry's Dn

Returns:

The resulting Entry

newEntry

org.apache.directory.api.ldap.model.entry.Entry newEntry(org.apache.directory.api.ldap.model.name.Dn dn)

Returns a Entry with the specified dn.

Parameters:

dn - The Entry's Dn

Returns:

The resulting Entry

newModifyRequest

org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.ModifyRequest newModifyRequest(org.apache.directory.api.ldap.model.name.Dn dn)

Returns a new ModifyRequest for the dn.

Parameters:

dn - The DN of the entry to modify

Returns:

The resulting ModifyRequest

newSearchRequest

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(String baseDn,
                                                                           FilterBuilder filter,
                                                                           org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(String baseDn,
                                                                           String filter,
                                                                           org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                                                           String filter,
                                                                           org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                                                           FilterBuilder filter,
                                                                           org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(String baseDn,
                                                                           String filter,
                                                                           org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(String baseDn,
                                                                           FilterBuilder filter,
                                                                           org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                                                           String filter,
                                                                           org.apache.directory.api.ldap.model.message.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

org.apache.directory.api.ldap.model.message.SearchRequest newSearchRequest(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                                                           FilterBuilder filter,
                                                                           org.apache.directory.api.ldap.model.message.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