空间站

1.3 包架构

   这部分包提供了Spring LDAP源代码的逻辑包架构的视图。每个包的依赖性清晰的标注。一个包依赖性是指需要依赖的包来编译这个包，但是运行的时候就不是必须的（依赖您自己要用的这个包）。例如，Spring LDAP 和Acegi Security一起用继承了org.acegisecurity这个包的使用。

 

   1.3.1 org.springframework.ldap

   这个ldap包包含了整个库的中心内容。这些内容包括AttributesMapper,ContextSource,和NameClassPairCallbackHandler.这个也包括中心类LdapTemplate.

  

Example 2.1. AttributesMapper 返回一个简单属性

package com.example.dao;

?/P>

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

?/P>

   public void setLdapTemplate(LdapTemplate ldapTemplate) {

      this.ldapTemplate = ldapTemplate;

   }

?/P>

   public List getAllPersonNames() {

      return ldapTemplate.search(

         "", "(objectclass=person)",

         new AttributesMapper() {

            public Object mapFromAttributes(Attributes attrs)

               throws NamingException {

               return attrs.get("cn").get();

            }

         });

   }

}

  上面粗题字部分是AttributesMapper的实现，它通过属性名称获取到了需要的属性值，然后返回结果。中心代码是LdapTemplate枚举了所有发现的数据入口，通过调用对每个入口特定的AttributesMapper收集得到结果，然后把结果放入list。list通过search方法返回结果值。

 

Example 2.1. AttributesMapper 返回一个简单属性

package com.example.dao;

?/P>

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

?/P>

   public void setLdapTemplate(LdapTemplate ldapTemplate) {

      this.ldapTemplate = ldapTemplate;

   }

?/P>

   public List getAllPersonNames() {

      return ldapTemplate.search(

         "", "(objectclass=person)",

         new AttributesMapper() {

            public Object mapFromAttributes(Attributes attrs)

               throws NamingException {

               return attrs.get("cn").get();

            }

         });

   }

}

  上面粗题字部分是AttributesMapper的实现，它通过属性名称获取到了需要的属性值，然后返回结果。中心代码是LdapTemplate枚举了所有发现的数据入口，通过调用对每个入口特定的AttributesMapper收集得到结果，然后把结果放入list。list通过search方法返回结果值。

Example 2.3. A lookup resulting in a Person object

package com.example.dao;

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

   public Person findPerson(String dn) {

      return (Person) ldapTemplate.lookup(dn, new PersonAttributesMapper());

   }

}

 

这里将遍历特别的dn,把发现的属性集发送到已经提供的AttributesMapper，然后得到person对象的结果集。

 

Example 2.6. Building a distinguished name dynamically

package com.example.dao;

import net.sf.ldaptemplate.support.DistinguishedName;

import javax.naming.Name;

public class PersonDaoImpl implements PersonDao {

   public static final String BASE_DN = "dc=example,dc=com";

   ...

   protected Name buildDn(Person p) {

      DistinguishedName dn = new DistinguishedName(BASE_DN);

      dn.add("c", p.getCountry());

      dn.add("ou", p.getCompany());

      dn.add("cn", p.getFullname());

      return dn;

   }

}

假如一个person有以下属性:

country	Sweden
company	Some Company
fullname	Some Person

上面的代码将产生下面dn的结果：

cn=Some Person, ou=Some Company, c=Sweden, dc=example, dc=com

在java5中，有个Name interface的实现：LdapName。

如果你是在用java5，你可能需要用到LdapName。当然，如果你希望用DistinguishedName，那你可以还用DistinguishedName。

 

Example 2.7. Binding data using Attributes

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

   ...

   public void create(Person p) {

      Name dn = buildDn(p);

      ldapTemplate.bind(dn, null, buildAttributes(p));

   }

 

   private Attributes buildAttributes(Person p) {

      Attributes attrs = new BasicAttributes();

      BasicAttribute ocattr = new BasicAttribute("objectclass");

      ocattr.add("top");

      ocattr.add("person");

      attrs.put(ocattr);

      attrs.put("cn", "Some Person");

      attrs.put("sn", "Person");

      return attrs;

   }

}

Attributes的建立是在减少和冗长时候起了足够的作用。当然他对进一步的地简化绑定操作提供了可能，这个将在第三章描述。

2.4.2 解绑定数据

   在Java LDAP中删除数据就叫着解绑定数据，入口（entry）是需要dn来唯一标志，就像绑定操作一样。下面的例子展示了使用LdapTemplate怎样来解绑定数据：

Example 2.8. Unbinding data

package com.example.dao;

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

   ...

   public void delete(Person p) {

      Name dn = buildDn(p);

      ldapTemplate.unbind(dn);

   }

}

 

2．5 修改

 

       在Java LDAP，数据修改可以有两种方式：使用rebind或者modifyAttributes。

 

2．5．1            使用rebind修改

使用rebind修改数据是一种比较鲁莽的方式。它基本上就是跟在绑定后面的解绑定。它看起来像这样：

Example 2.9. Modifying using rebind

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

   ...

   public void update(Person p) {

      Name dn = buildDn(p);

      ldapTemplate.rebind(dn, null, buildAttributes(p));

   }

}

 

 

2．5．2            使用modifyAttributes修改

 

如果需要修改的属性应该被取代，有一个获取一组修正的方法叫modifyAttributes。

 

Example 2.10. Modifying using modifyAttributes

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

   ...

   public void updateDescription(Person p) {

      Name dn = buildDn(p);

      Attribute attr = new BasicAttribute("description", p.getDescription())

      ModificationItem item = new ModificationItem(DirContext.REPLACE_ATTRIBUTE, attr);

      ldapTemplate.modifyAttributes(dn, new ModificationItem[] {item});

   }

}

 

建立Attributes和ModificationItem 数组是许多工作，但你看到第三章时，修改操作可能变得更简单。

 

 

Example 3.1. Searching using a ContextMapper

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   ...

   private static class PersonContextMapper implements ContextMapper {

      public Object mapFromContext(Object ctx) {

         DirContextAdapter context = (DirContextAdapter)ctx;

         Person p = new Person();

         p.setFullName(context.getStringAttribute("cn"));

         p.setLastName(context.getStringAttribute("sn"));

         p.setDescription(context.getStringAttribute("description"));

         return p;

      }

   }

   public Person findByPrimaryKey(

      String name, String company, String country) {

      Name dn = buildDn(name, company, country);

      return ldapTemplate.lookup(dn, new PersonContextMapper());

   }

}

  上面的代码展示了要获取attributes可以直接通过name，而不用通过Attributes类和BasicAttribute类。

 

Example 3.2. Binding using DirContextAdapter

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   ...

   public void create(Person p) {

      Name dn = buildDn(p);

      DirContextAdapter context = new DirContextAdapter(dn);

      context.setAttributeValues("objectclass", new String[] {"top", "person"});

      context.setAttributeValue("cn", p.getFullname());

      context.setAttributeValue("sn", p.getLastname());

      context.setAttributeValue("description", p.getDescription());

      ldapTemplate.bind(dn, context, null);

   }

}

 

注意我们用获取到的DirContextAdapter作为第二个参数去绑定，本来应该用Context的。第三个参数是null，因为我们没有用到任何的Attributes。

Example 3.4. Binding and modifying using DirContextAdapter

package com.example.dao;

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

   ...

   public void create(Person p) {

      Name dn = buildDn(p);

      DirContextAdapter context = new DirContextAdapter(dn);

      mapToContext(p, context);

      ldapTemplate.bind(dn, context, null);

   }

   public void update(Person p) {

      Name dn = buildDn(p);

      DirContextAdapter context = (DirContextAdapter)ldapTemplate.lookup(dn);

      mapToContext(person, context);

      ldapTemplate.modifyAttributes(dn, context.getModificationItems());

   }

   protected void mapToContext (Person p, DirContextAdapter context) {

      context.setAttributeValues("objectclass", new String[] {"top", "person"});

      context.setAttributeValue("cn", p.getFullName());

      context.setAttributeValue("sn", p.getLastName());

      context.setAttributeValue("description", p.getDescription());

   }

}

 

 

Example 3.5. A complete PersonDao class

package com.example.dao;

 

import java.util.List;

 

import javax.naming.Name;

import javax.naming.NamingException;

import javax.naming.directory.Attributes;

 

import net.sf.ldaptemplate.AttributesMapper;

import net.sf.ldaptemplate.ContextMapper;

import net.sf.ldaptemplate.LdapTemplate;

import net.sf.ldaptemplate.support.DirContextAdapter;

import net.sf.ldaptemplate.support.DistinguishedName;

import net.sf.ldaptemplate.support.filter.EqualsFilter;

 

public class PersonDaoImpl implements PersonDao {

   private LdapTemplate ldapTemplate;

 

   public void setLdapTemplate(LdapTemplate ldapTemplate) {

      this.ldapTemplate = ldapTemplate;

   }

 

   public void create(Person person) {

      DirContextAdapter context = new DirContextAdapter();

      mapToContext(person, context);

      ldapTemplate.bind(buildDn(person), context, null);

   }

 

   public void update(Person person) {

      Name dn = buildDn(person);

      DirContextAdapter context = (DirContextAdapter)ldapTemplate.lookup(dn);

      mapToContext(person, context);

      ldapTemplate.modifyAttributes(dn, context.getModificationItems());

   }

 

   protected void mapToContext(Person person, DirContextAdapter context) {

      context.setAttributeValues("objectclass", new String[] {"top", "person"});

      context.setAttributeValue("cn", person.getFullName());

      context.setAttributeValue("sn", person.getLastName());

      context.setAttributeValue("description", person.getDescription());

   }

 

   private static class PersonContextMapper implements ContextMapper {

      public Object mapFromContext(Object ctx) {

         DirContextAdapter context = (DirContextAdapter)ctx;

         Person person = new Person();

         person.setFullName(context.getStringAttribute("cn"));

         person.setLastName(context.getStringAttribute("sn"));

         person.setDescription(context.getStringAttribute("description"));

         return person;

      }

   }

}

 

?/P>

	注意
	在一些情况下，一个对象的dn是用对象的属性构造的。例如，在上面的例子，国籍，公司，人的全名都可以被用在dn上，这就意味着修改这些属性的其中任意一个都确实需要在LDAP树上除了要修改Attribute的值还需要使用rename（）操作来移动entry。因为这些非常高的实现是需要自己掌握好的一些事情，如果必要的话，也是不允许用户改变这些属性或者在update()方法里使用rename（）操作的

 

NamingEnumeration search(Name name, String filterExpr, Object[] filterArgs, SearchControls ctls)

这个方法是使用一个普通的SearchExecutor实现：

public interface SearchExecutor {

   public NamingEnumeration executeSearch(DirContext ctx) throws NamingException;

}

Example 4.1. A custom search method using SearchExecutor and AttributesMapper

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   ...

   public List search(final Name base, final String filter, final String[] params,

         final SearchControls ctls) {

      SearchExecutor executor = new SearchExecutor() {

         public NamingEnumeration executeSearch(DirContext ctx) {

            return ctx.search(base, filter, params, ctls);

         }

      };

 

      NameClassPairCallbackHandler handler =

         ldapTemplate.new AttributesMapperCallbackHandler(new PersonAttributesMapper());

 

      return ldapTemplate.search(executor, handler);

   }

}

如果你更喜欢用ContextMapper而不是AttributesMapper，那就应该是这样：

Example 4.2. A custom search method using SearchExecutor and ContextMapper

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   ...

   public List search(final Name base, final String filter, final String[] params,

         final SearchControls ctls) {

      SearchExecutor executor = new SearchExecutor() {

         public NamingEnumeration executeSearch(DirContext ctx) {

            return ctx.search(base, filter, params, ctls);

         }

      };

 

      NameClassPairCallbackHandler handler =

         ldapTemplate.new ContextMapperCallbackHandler(new PersonContextMapper());

 

      return ldapTemplate.search(executor, handler);

   }

}

注意：

  当我们使用LdapTemplate.ContextMapperCallbackhandler的时候，你必须确保你已经在SearchControls里面调用了setReturningObjFlag(true)

 

 

public interface ContextExecutor {

   public Object executeWithContext(DirContext ctx) throws NamingException;

}

 

实现ContextExecutor 时，你可以选择使用executeReadOnly（）或者使用executeReadWrite方法。我们需要调用这个方法：

Object lookupLink(Name name)

它对DirContext是十分有用的，但是在LdapTemplate没有对应的方法。它是一个lookup方法，因此它只能是read-only。我们可以像这样实现它：

Example 4.3. A custom DirContext method using ContextExecutor

package com.example.dao;

 

public class PersonDaoImpl implements PersonDao {

   ...

   public Object lookupLink(final Name name) {

      ContextExecutor executor = new ContextExecutor() {

         public Object executeWithContext(DirContext ctx) {

            return ctx.lookupLink(name);

         }

      };

 

      return ldapTemplate.executeReadOnly(executor);

   }

}

同样地，你也可以使用executeReadWrite方法执行一个read－write操作。

 

 

 

 

 

 

 

Example 5.1. The Spring bean definition for an AcegiAuthenticationSource

<beans>

   ...

   <bean id="contextSource" class="org.springframework.ldap.support.LdapContextSource">

      <property name="url" value="ldap://localhost:389" />

      <property name="base" value="dc=example,dc=com" />

      <property name="acegiAuthenticationSource" ref="authenticationSource" />

   </bean>

 

   <bean id="acegiAuthenticationSource"

      class="org.springframework.ldap.support.authentication.AcegiAuthenticationSource" />

   ...

</beans>

注：

在使用AuthenticationSource时候，我们不能指定一个用户名和密码到我们的ContextSource 。这些属性只是在默认的behaviour被用到的时候需要。

当用AcegiAuthenticationSource你需要用到Acegi's LdapAuthenticationProvider做认证的时候，用户是跟LDAP相反的。

Example 5.2. Configuring a DefaultValuesAuthenticationSourceDecorator

<beans>

   ...

   <bean id="contextSource" class="org.springframework.ldap.support.LdapContextSource">

      <property name="url" value="ldap://localhost:389" />

      <property name="base" value="dc=example,dc=com" />

      <property name="authenticationSource" ref="authenticationSource" />

   </bean>

 

   <bean id="authenticationSource"

      class="org.springframework.ldap.support.DefaultValuesAuthenticationSourceDecorator">

      <property name="target" ref="acegiAuthenticationSource" />

      <property name="defaultUser" value="cn=myDefaultUser" />

      <property name="defaultPassword" value="pass" />

   </bean>

 

   <bean id="acegiAuthenticationSource"

      class="org.springframework.ldap.support.authentication.AcegiAuthenticationSource" />

   ...

</beans>