Interface ModelFactory
-
- All Known Implementing Classes:
LdapConnectionTemplate
public interface ModelFactory
A factory for creatingorg.apache.directory.api.ldap.model
objects.- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AddRequest
newAddRequest(Entry entry)
Returns a newAddRequest
for theentry
.Attribute
newAttribute(String name)
Returns a new Attribute for with the providedname
and a null value.Attribute
newAttribute(String name, byte[]... values)
Returns a new Attribute for with the providedname
andvalue(s)
.Attribute
newAttribute(String name, String... values)
Returns a new Attribute for with the providedname
andvalue(s)
.Attribute
newAttribute(String name, Value... values)
Returns a new Attribute for with the providedname
andvalue(s)
.DeleteRequest
newDeleteRequest(Dn dn)
Returns a newDeleteRequest
for thedn
.Dn
newDn(String dn)
Returns aDn
that representsdn
.Entry
newEntry(String dn)
Returns aEntry
with the specifieddn
.Entry
newEntry(Dn dn)
Returns aEntry
with the specifieddn
.ModifyRequest
newModifyRequest(String dn)
Returns a newModifyRequest
for thedn
.ModifyRequest
newModifyRequest(Dn dn)
Returns a newModifyRequest
for thedn
.SearchRequest
newSearchRequest(String baseDn, String filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.SearchRequest
newSearchRequest(String baseDn, String filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.SearchRequest
newSearchRequest(String baseDn, FilterBuilder filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.SearchRequest
newSearchRequest(String baseDn, FilterBuilder filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.SearchRequest
newSearchRequest(Dn baseDn, String filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.SearchRequest
newSearchRequest(Dn baseDn, String filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.SearchRequest
newSearchRequest(Dn baseDn, FilterBuilder filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.SearchRequest
newSearchRequest(Dn baseDn, FilterBuilder filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.
-
-
-
Method Detail
-
newAddRequest
AddRequest newAddRequest(Entry entry)
Returns a newAddRequest
for theentry
.- Parameters:
entry
- The Entry to add- Returns:
- The resulting AddRequest
-
newAttribute
Attribute newAttribute(String name)
Returns a new Attribute for with the providedname
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 providedname
andvalue(s)
.- Parameters:
name
- The attribute's namevalues
- The attribute's values- Returns:
- The resulting Attribute
-
newAttribute
Attribute newAttribute(String name, String... values)
Returns a new Attribute for with the providedname
andvalue(s)
.- Parameters:
name
- The attribute's namevalues
- The attribute's values- Returns:
- The resulting Attribute
-
newAttribute
Attribute newAttribute(String name, Value... values)
Returns a new Attribute for with the providedname
andvalue(s)
.- Parameters:
name
- The attribute's namevalues
- The attribute's values- Returns:
- The resulting Attribute
-
newDeleteRequest
DeleteRequest newDeleteRequest(Dn dn)
Returns a newDeleteRequest
for thedn
.- Parameters:
dn
- The Dn for the Entry to delete- Returns:
- The resulting DeleteRequest
-
newDn
Dn newDn(String dn)
Returns aDn
that representsdn
.- Parameters:
dn
- The Entry's Dn- Returns:
- The resulting Dn
-
newEntry
Entry newEntry(String dn)
Returns aEntry
with the specifieddn
.- Parameters:
dn
- The Entry's Dn- Returns:
- The resulting Entry
-
newEntry
Entry newEntry(Dn dn)
Returns aEntry
with the specifieddn
.- Parameters:
dn
- The Entry's Dn- Returns:
- The resulting Entry
-
newModifyRequest
ModifyRequest newModifyRequest(String dn)
Returns a newModifyRequest
for thedn
.- Parameters:
dn
- The Dn of the entry to modify- Returns:
- The resulting ModifyRequest
-
newModifyRequest
ModifyRequest newModifyRequest(Dn dn)
Returns a newModifyRequest
for thedn
.- Parameters:
dn
- The DN of the entry to modify- Returns:
- The resulting ModifyRequest
-
newSearchRequest
SearchRequest newSearchRequest(String baseDn, FilterBuilder filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look from- Returns:
- The resulting SearchRequest
-
newSearchRequest
SearchRequest newSearchRequest(String baseDn, String filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look from- Returns:
- The resulting SearchRequest
-
newSearchRequest
SearchRequest newSearchRequest(Dn baseDn, String filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look from- Returns:
- The resulting SearchRequest
-
newSearchRequest
SearchRequest newSearchRequest(Dn baseDn, FilterBuilder filter, SearchScope scope)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returning all normal attributes for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look from- Returns:
- The resulting SearchRequest
-
newSearchRequest
SearchRequest newSearchRequest(String baseDn, String filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look fromattributes
- The list of AttributeType to return- Returns:
- The resulting SearchRequest
-
newSearchRequest
SearchRequest newSearchRequest(String baseDn, FilterBuilder filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look fromattributes
- The list of AttributeType to return- Returns:
- The resulting SearchRequest
-
newSearchRequest
SearchRequest newSearchRequest(Dn baseDn, String filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look fromattributes
- The list of AttributeType to return- Returns:
- The resulting SearchRequest
-
newSearchRequest
SearchRequest newSearchRequest(Dn baseDn, FilterBuilder filter, SearchScope scope, String... attributes)
Returns a newSearchRequest
overbaseDn
inscope
matchingfilter
returningattributes
for each matching entry.- Parameters:
baseDn
- The base DN from which to start the searchfilter
- The filter selecting the entriesscope
- The scope to look fromattributes
- The list of AttributeType to return- Returns:
- The resulting SearchRequest
-
-