org.springframework.ldap.samples.article.dao.PersonDaoImpl.java Source code

Introduction

Here is the source code for org.springframework.ldap.samples.article.dao.PersonDaoImpl.java

Source

/*
 * Copyright 2005-2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.ldap.samples.article.dao;

import java.util.List;

import javax.naming.Name;
import javax.naming.NamingException;
import javax.naming.directory.Attributes;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.ldap.core.AttributesMapper;
import org.springframework.ldap.core.ContextMapper;
import org.springframework.ldap.core.DirContextAdapter;
import org.springframework.ldap.core.DistinguishedName;
import org.springframework.ldap.core.LdapTemplate;
import org.springframework.ldap.core.NameClassPairCallbackHandler;
import org.springframework.ldap.filter.EqualsFilter;
import org.springframework.ldap.samples.article.domain.Person;

/**
 * Default implementation of PersonDao. This implementation uses
 * DirContextAdapter for managing attribute values. It has been specified in the
 * Spring Context that the DirObjectFactory should be used when creating objects
 * from contexts, which defaults to creating DirContextAdapter objects. This
 * means that we can use a ContextMapper to map from the found contexts to our
 * domain objects. This is especially useful since we in this case have
 * properties in our domain objects that depend on parts of the DN.
 * 
 * We could have worked with Attributes and an AttributesMapper implementation
 * instead, but working with Attributes is a bore and also, working with
 * AttributesMapper objects (or, indeed Attributes) does not give us access to
 * the distinguished name. However, we do use it in one method that only needs a
 * single attribute: {@link #getAllPersonNames()}.
 * 
 * @author Mattias Hellborg Arthursson
 * @author Ulrik Sandberg
 */
public class PersonDaoImpl implements PersonDao {
    protected static final Log log = LogFactory.getLog(PersonDaoImpl.class);

    private LdapTemplate ldapTemplate;

    /*
     * @see PersonDao#create(Person)
     */
    public void create(Person person) {
        Name dn = buildDn(person);
        System.out.println(dn.toString());
        log.info(dn.toString());
        DirContextAdapter context = new DirContextAdapter(dn);
        mapToContext(person, context);
        ldapTemplate.bind(dn, context, null);
    }

    /**
     * @see PersonDao#update(Person)
     */
    @Override
    public void update(Person person) {
        Name dn = buildDn(person);
        DirContextAdapter context = (DirContextAdapter) ldapTemplate.lookup(dn);
        mapToContext(person, context);
        ldapTemplate.modifyAttributes(dn, context.getModificationItems());
    }

    /**
     * @author k
     * @see PersonDao#delete(Person)
     */
    @Override
    public void delete(Person person) {
        this.ldapTemplate.unbind(buildDn(person));
    }

    /**
     * @see PersonDao#getAllPersonNames()
     */
    @Override
    public List getAllPersonNames() {
        EqualsFilter filter = new EqualsFilter("objectclass", "person");
        return this.ldapTemplate.search(DistinguishedName.EMPTY_PATH, filter.encode(), new AttributesMapper() {
            @Override
            public Object mapFromAttributes(Attributes attrs) throws NamingException {
                return attrs.get("cn").get();
            }
        });
    }

    /**
     * @see PersonDao#findAll()
     */
    @Override
    public List findAll() {
        EqualsFilter filter = new EqualsFilter("objectclass", "person");
        return this.ldapTemplate.search(DistinguishedName.EMPTY_PATH, filter.encode(), getContextMapper());
    }

    /**
     * @see PersonDao#findByPrimaryKey(String)
     */
    @Override
    public Person findByPrimaryKey(String fullName) {
        DistinguishedName dn = buildDn(null, null, fullName);
        return (Person) this.ldapTemplate.lookup(dn, getContextMapper());
    }

    private ContextMapper getContextMapper() {
        return new PersonContextMapper();
    }

    /**
     * :
     *    maps from DirContextAdapter to a Person Object 
     *     @author k
     *
     */
    private static class PersonContextMapper implements ContextMapper {
        @Override
        public Object mapFromContext(Object ctx) {
            DirContextAdapter context = (DirContextAdapter) ctx;
            DistinguishedName dn = new DistinguishedName(context.getDn());
            Person person = new Person();
            person.setFullName(dn.getLdapRdn(1).getComponent().getValue());
            person.setLastName(context.getStringAttribute("sn"));
            person.setDescription(context.getStringAttribute("description"));
            return person;
        }
    }

    private DistinguishedName buildDn(Person person) {
        return buildDn(person.getCountry(), person.getCompany(), person.getFullName());
    }

    private DistinguishedName buildDn(String country, String company, String fullname) {
        DistinguishedName dn = new DistinguishedName();
        dn.add("ou", "people");
        dn.add("uid", fullname);
        return dn;
    }

    private void mapToContext(Person person, DirContextAdapter context) {
        context.setAttributeValues("objectclass",
                new String[] { "person", "organizationalPerson", "inetOrgPerson" });
        context.setAttributeValue("cn", person.getFullName());
        context.setAttributeValue("sn", person.getLastName());
        context.setAttributeValue("description", person.getDescription());
        context.setAttributeValue("uid", person.getFullName());
        context.setAttributeValue("ou", "people");
    }

    public void setLdapTemplate(LdapTemplate ldapTemplate) {
        this.ldapTemplate = ldapTemplate;
    }

}