com.actionsoft.sdk.local.api.cc

接口 LDAPAPI

public interface LDAPAPI

支持日志和审计的操作：不包括open、getRoot、close

 protected Name getPeopleDn(String userId) {
        AndFilter andFilter = new AndFilter();
        andFilter.and(new EqualsFilter("objectclass", "person"));
        andFilter.and(new EqualsFilter("objectclass", "xUserObjectClass"));
        andFilter.and(new EqualsFilter("uid", userId));
        List result = ldap.search("", andFilter.encode(), SearchControls.SUBTREE_SCOPE, new AbstractContextMapper() {
                @Override
                protected Name doMapFromContext(DirContextOperations adapter) {
                        return adapter.getDn();
                }
        });
        if (null == result || result.size() != 1) {
                throw new UserNotFoundException();
        } else {
                return result.get(0);
        }
 }
 

方法概要

限定符和类型	方法和说明
boolean	authenticate(java.lang.String base, java.lang.String filter, java.lang.String password) 验证用户是否合法。
void	bind(java.lang.String dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) Create an entry in the LDAP tree.
void	close(javax.naming.ldap.LdapContext ctx) 关闭上下文对象
javax.naming.ldap.LdapContext	getRootDSE() 查询ROOT DSE对象
java.util.List<java.lang.String>	list(javax.naming.Name base) 返回绑定的对象名称列表
<T> java.util.List<T>	list(javax.naming.Name base, <any> mapper) 返回通过NameClassPairMapper转换NameClassPair的结果列表
void	list(javax.naming.Name base, NameClassPairCallbackHandler handler) 通过NameClassPairCallbackHandler处理NameClassPair
java.util.List<java.lang.String>	list(java.lang.String base) 返回绑定的对象名称列表
<T> java.util.List<T>	list(java.lang.String base, <any> mapper) 返回通过NameClassPairMapper转换NameClassPair的结果列表
void	list(java.lang.String base, NameClassPairCallbackHandler handler) 通过NameClassPairCallbackHandler处理NameClassPair
java.util.List<java.lang.String>	listBindings(javax.naming.Name base) return the names of all the contexts bound to base
<T> java.util.List<T>	listBindings(javax.naming.Name base, <any> mapper) Perform a non-recursive listing of the children of the given base.
<T> java.util.List<T>	listBindings(javax.naming.Name base, <any> mapper) Perform a non-recursive listing of the children of the given base.
void	listBindings(javax.naming.Name base, NameClassPairCallbackHandler handler) Perform a non-recursive listing of children of the given base
java.util.List<java.lang.String>	listBindings(java.lang.String base) Perform a non-recursive listing of children of the given base
<T> java.util.List<T>	listBindings(java.lang.String base, <any> mapper) Perform a non-recursive listing of the children of the given base.
<T> java.util.List<T>	listBindings(java.lang.String base, <any> mapper) Perform a non-recursive listing of the children of the given base.
void	listBindings(java.lang.String base, NameClassPairCallbackHandler handler) Perform a non-recursive listing of children of the given base
<T> T	lookup(java.lang.String dn, <any> mapper) get the attributes of a specified DN and pass them to an AttributesMapper
<T> T	lookup(java.lang.String dn, <any> mapper) lookup a specified DN and pass the found object to a ContextMapper
<T> T	lookup(java.lang.String dn, java.lang.String[] attributes, <any> mapper) Lookup the supplied DN and return the found object
void	modifyAttributes(java.lang.String dn, javax.naming.directory.ModificationItem[] mods) 修改绑定属性
javax.naming.ldap.LdapContext	open() 打开一个上下文对象
<T> java.util.List<T>	search(javax.naming.Name base, java.lang.String filter, int searchScope, <any> mapper) 查询方法，返回所有属性
<T> java.util.List<T>	search(javax.naming.Name base, java.lang.String filter, int searchScope, java.lang.String[] attrs, <any> mapper) Search for all objects matching the supplied filter.
<T> java.util.List<T>	search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls sc, <any> mapper)
void	search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor) ldap查询方法
<T> java.util.List<T>	search(java.lang.String base, java.lang.String filter, int searchScope, <any> mapper)
<T> java.util.List<T>	search(java.lang.String base, java.lang.String filter, int searchScope, <any> mapper) Search for all objects matching the supplied filter.
<T> java.util.List<T>	search(java.lang.String base, java.lang.String filter, int searchScope, java.lang.String[] attrs, <any> mapper)
<T> java.util.List<T>	search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls sc, <any> mapper) 按SearchControls查询，返回所有属性
<T> java.util.List<T>	search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, <any> mapper)
void	search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor) ldap查询方法
<T> T	searchForObject(java.lang.String base, java.lang.String filter, int searchScope, <any> mapper) 查询一个对象
<T> T	searchForObject(java.lang.String base, java.lang.String filter, int searchScope, java.lang.String[] attrs, <any> mapper) 查询一个对象
<T> T	searchForObject(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls searchControls, <any> mapper) Perform a search for a unique entry matching the specified search criteria and return the found object
void	unbind(java.lang.String dn) 删除绑定
void	unbind(java.lang.String dn, boolean recursive) 删除绑定，包含子目录

方法详细资料

open

javax.naming.ldap.LdapContext open()

打开一个上下文对象

getRootDSE

javax.naming.ldap.LdapContext getRootDSE()
                                  throws javax.naming.NamingException

查询ROOT DSE对象

抛出:

javax.naming.NamingException

search

void search(javax.naming.Name base,
            java.lang.String filter,
            javax.naming.directory.SearchControls controls,
            NameClassPairCallbackHandler handler,
            DirContextProcessor processor)

ldap查询方法

search

void search(java.lang.String base,
            java.lang.String filter,
            javax.naming.directory.SearchControls controls,
            NameClassPairCallbackHandler handler,
            DirContextProcessor processor)

ldap查询方法

search

<T> java.util.List<T> search(javax.naming.Name base,
                             java.lang.String filter,
                             int searchScope,
                             java.lang.String[] attrs,
                             <any> mapper)

Search for all objects matching the supplied filter. The Attributes in each SearchResult is supplied to the specified AttributesMapper

参数:

base - The base DN where the search should begin

filter - The filter to use in the search

searchScope - The search scope to set in SearchControls

attrs - The attributes to return, null means all attributes

mapper - The AttributesMapper to use for translating each entry

返回:

a List containing all entries received from the AttributesMapper

search

<T> java.util.List<T> search(java.lang.String base,
                             java.lang.String filter,
                             int searchScope,
                             java.lang.String[] attrs,
                             <any> mapper)

另请参阅:

#search(Name, String, int, String[], AttributesMapper)

search

<T> java.util.List<T> search(javax.naming.Name base,
                             java.lang.String filter,
                             int searchScope,
                             <any> mapper)

查询方法，返回所有属性

另请参阅:

#search(Name, String, int, String[], AttributesMapper)

search

<T> java.util.List<T> search(java.lang.String base,
                             java.lang.String filter,
                             int searchScope,
                             <any> mapper)

另请参阅:

#search(Name, String, int, String[], AttributesMapper)

search

<T> java.util.List<T> search(java.lang.String base,
                             java.lang.String filter,
                             javax.naming.directory.SearchControls sc,
                             <any> mapper)

按SearchControls查询，返回所有属性

另请参阅:

#search(Name, String, int, String[], AttributesMapper)

search

<T> java.util.List<T> search(javax.naming.Name base,
                             java.lang.String filter,
                             javax.naming.directory.SearchControls sc,
                             <any> mapper)

另请参阅:

#search(Name, String, int, String[], AttributesMapper)

search

<T> java.util.List<T> search(java.lang.String base,
                             java.lang.String filter,
                             int searchScope,
                             <any> mapper)

Search for all objects matching the supplied filter. The Object returned in each SearchResult is supplied to the specified ContextMapper

search

<T> java.util.List<T> search(java.lang.String base,
                             java.lang.String filter,
                             javax.naming.directory.SearchControls controls,
                             <any> mapper)

另请参阅:

#search(String, String, int, ContextMapper)

list

void list(java.lang.String base,
          NameClassPairCallbackHandler handler)

通过NameClassPairCallbackHandler处理NameClassPair

list

void list(javax.naming.Name base,
          NameClassPairCallbackHandler handler)

通过NameClassPairCallbackHandler处理NameClassPair

list

<T> java.util.List<T> list(java.lang.String base,
                           <any> mapper)

返回通过NameClassPairMapper转换NameClassPair的结果列表

list

<T> java.util.List<T> list(javax.naming.Name base,
                           <any> mapper)

返回通过NameClassPairMapper转换NameClassPair的结果列表

list

java.util.List<java.lang.String> list(java.lang.String base)

返回绑定的对象名称列表

list

java.util.List<java.lang.String> list(javax.naming.Name base)

返回绑定的对象名称列表

listBindings

void listBindings(java.lang.String base,
                  NameClassPairCallbackHandler handler)

Perform a non-recursive listing of children of the given base

参数:

base - The base DN where the list should be performed

handler - The NameClassPairCallbackHandler to supply each Binding to

listBindings

void listBindings(javax.naming.Name base,
                  NameClassPairCallbackHandler handler)

Perform a non-recursive listing of children of the given base

listBindings

<T> java.util.List<T> listBindings(java.lang.String base,
                                   <any> mapper)

Perform a non-recursive listing of the children of the given base. Each resulting Binding is supplied to the specified NameClassPairCallbackHandler

listBindings

<T> java.util.List<T> listBindings(javax.naming.Name base,
                                   <any> mapper)

Perform a non-recursive listing of the children of the given base. Each resulting Binding is supplied to the specified NameClassPairCallbackHandler

listBindings

<T> java.util.List<T> listBindings(java.lang.String base,
                                   <any> mapper)

Perform a non-recursive listing of the children of the given base. The Object returned in each Binding is supplied to the specified ContextMapper

listBindings

<T> java.util.List<T> listBindings(javax.naming.Name base,
                                   <any> mapper)

Perform a non-recursive listing of the children of the given base. The Object returned in each Binding is supplied to the specified ContextMapper

listBindings

java.util.List<java.lang.String> listBindings(java.lang.String base)

Perform a non-recursive listing of children of the given base

参数:

base - The base DN where the list should be performed

返回:

a List containing the names of all the contexts bound to base

listBindings

java.util.List<java.lang.String> listBindings(javax.naming.Name base)

return the names of all the contexts bound to base

searchForObject

<T> T searchForObject(java.lang.String base,
                      java.lang.String filter,
                      javax.naming.directory.SearchControls searchControls,
                      <any> mapper)

Perform a search for a unique entry matching the specified search criteria and return the found object

参数:

base - the DN to use as the base of the search

filter - the search filter

searchControls - the searchControls to use for the search

mapper - the mapper to use for the search

返回:

the single object returned by the mapper that matches the search criteria

searchForObject

<T> T searchForObject(java.lang.String base,
                      java.lang.String filter,
                      int searchScope,
                      <any> mapper)

查询一个对象

searchForObject

<T> T searchForObject(java.lang.String base,
                      java.lang.String filter,
                      int searchScope,
                      java.lang.String[] attrs,
                      <any> mapper)

查询一个对象

lookup

<T> T lookup(java.lang.String dn,
             <any> mapper)

get the attributes of a specified DN and pass them to an AttributesMapper

lookup

<T> T lookup(java.lang.String dn,
             java.lang.String[] attributes,
             <any> mapper)

Lookup the supplied DN and return the found object

参数:

dn - The distinguished name of the object to find

attributes - The names of the attributes to pass to the mapper

mapper - The AttributesMapper to use for mapping the found object

lookup

<T> T lookup(java.lang.String dn,
             <any> mapper)

lookup a specified DN and pass the found object to a ContextMapper

bind

void bind(java.lang.String dn,
          java.lang.Object obj,
          javax.naming.directory.Attributes attributes)

Create an entry in the LDAP tree. The attributes used to create the entry are either retrieved from the obj parameter or the attributes parameter (or both). One of these parameters may be null but not both

参数:

dn - The distinguished name to bind the object and attributes to

obj - The object to bind, may be null. Typically a DirContext implementation

attributes - The attributes to bind, may be null

unbind

void unbind(java.lang.String dn)

删除绑定

参数:

dn - the name to unbind; may not be empty

unbind

void unbind(java.lang.String dn,
            boolean recursive)

删除绑定，包含子目录

modifyAttributes

void modifyAttributes(java.lang.String dn,
                      javax.naming.directory.ModificationItem[] mods)

修改绑定属性

authenticate

boolean authenticate(java.lang.String base,
                     java.lang.String filter,
                     java.lang.String password)
              throws AWSAPIException,
                     AWSIllegalArgumentException

验证用户是否合法。例如ad验证：authenticate("","(sAMAccountName=userx)","secret");

抛出:

AWSAPIException

AWSIllegalArgumentException

close

void close(javax.naming.ldap.LdapContext ctx)

关闭上下文对象