org.jasig.schedassist.impl.ldap.LDAPCalendarAccountDaoImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sched-assist-spi Show documentation
Scheduling Assistant Common Service Provider implementations.
There is a newer version: 1.1.4
/**
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you 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.jasig.schedassist.impl.ldap;

import java.util.Collections;
import java.util.List;

import javax.naming.directory.SearchControls;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jasig.schedassist.ICalendarAccountDao;
import org.jasig.schedassist.model.ICalendarAccount;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.support.DataAccessUtils;
import org.springframework.ldap.SizeLimitExceededException;
import org.springframework.ldap.TimeLimitExceededException;
import org.springframework.ldap.core.AttributesMapper;
import org.springframework.ldap.core.LdapTemplate;
import org.springframework.ldap.filter.AndFilter;
import org.springframework.ldap.filter.EqualsFilter;
import org.springframework.ldap.filter.Filter;
import org.springframework.ldap.filter.LikeFilter;
import org.springframework.ldap.filter.OrFilter;

import com.googlecode.ehcache.annotations.Cacheable;
import com.googlecode.ehcache.annotations.KeyGenerator;


/**
 * @author Nicholas BlairNicholas Blair
 * @version $Id: LDAPCalendarAccountDaoImpl.java $
 */
public class LDAPCalendarAccountDaoImpl implements ICalendarAccountDao {

	private static final String WILD = "*";
	private LdapTemplate ldapTemplate;
	private AttributesMapper attributesMapper = new DefaultAttributesMapperImpl();
	private String baseDn = "o=isp";
	private String calendarUsernameAttributeName = "uid";
	private String calendarUniqueIdAttributeName = "uid";
	private String calendarDisplayNameAttributeName = "cn";
	private long searchResultsLimit = 25L;
	private int searchTimeLimit = 5000;
	private final Log log = LogFactory.getLog(this.getClass());
	
	
	/**
	 * @param ldapTemplate the ldapTemplate to set
	 */
	@Autowired
	public void setLdapTemplate(LdapTemplate ldapTemplate) {
		this.ldapTemplate = ldapTemplate;
	}
	/**
	 * @param attributesMapper the attributesMapper to set
	 */
	@Autowired(required=false)
	public void setAttributesMapper(AttributesMapper attributesMapper) {
		this.attributesMapper = attributesMapper;
	}
	/**
	 * @param baseDn the baseDn to set
	 */
	public void setBaseDn(String baseDn) {
		this.baseDn = baseDn;
	}
	/**
	 * @param calendarUsernameAttributeName the calendarUsernameAttributeName to set
	 */
	public void setCalendarUsernameAttributeName(
			String calendarUsernameAttributeName) {
		this.calendarUsernameAttributeName = calendarUsernameAttributeName;
	}
	/**
	 * @param calendarUniqueIdAttributeName the calendarUniqueIdAttributeName to set
	 */
	public void setCalendarUniqueIdAttributeName(
			String calendarUniqueIdAttributeName) {
		this.calendarUniqueIdAttributeName = calendarUniqueIdAttributeName;
	}
	/**
	 * @param calendarDisplayNameAttributeName the calendarDisplayNameAttributeName to set
	 */
	public void setCalendarDisplayNameAttributeName(
			String calendarDisplayNameAttributeName) {
		this.calendarDisplayNameAttributeName = calendarDisplayNameAttributeName;
	}
	/**
	 * @param searchResultsLimit the searchResultsLimit to set
	 */
	public void setSearchResultsLimit(long searchResultsLimit) {
		this.searchResultsLimit = searchResultsLimit;
	}
	/**
	 * @param searchTimeLimit the searchTimeLimit to set
	 */
	public void setSearchTimeLimit(int searchTimeLimit) {
		this.searchTimeLimit = searchTimeLimit;
	}

	/* (non-Javadoc)
	 * @see org.jasig.schedassist.ICalendarAccountDao#getCalendarAccount(java.lang.String)
	 */
	@Override
	@Cacheable(cacheName="userAccountCache", keyGenerator=@KeyGenerator(name="StringCacheKeyGenerator"))
	public ICalendarAccount getCalendarAccount(String username) {
		EqualsFilter filter = new EqualsFilter(this.calendarUsernameAttributeName, username);
		return executeSearch(filter);
	}

	/* (non-Javadoc)
	 * @see org.jasig.schedassist.ICalendarAccountDao#getCalendarAccountFromUniqueId(java.lang.String)
	 */
	@Override
	@Cacheable(cacheName="userAccountCache", keyGenerator=@KeyGenerator(name="StringCacheKeyGenerator"))
	public ICalendarAccount getCalendarAccountFromUniqueId(
			String calendarUniqueId) {
		return getCalendarAccount(this.calendarUniqueIdAttributeName, calendarUniqueId);
	}

	/* (non-Javadoc)
	 * @see org.jasig.schedassist.ICalendarAccountDao#getCalendarAccount(java.lang.String, java.lang.String)
	 */
	@Override
	@Cacheable(cacheName="userAccountCache", keyGenerator=@KeyGenerator(name="StringCacheKeyGenerator"))
	public ICalendarAccount getCalendarAccount(String attributeName,
			String attributeValue) {
		AndFilter filter = new AndFilter();
		filter.and(new EqualsFilter(attributeName, attributeValue));
		// make sure our results have usernames
		filter.and(new LikeFilter(this.calendarUsernameAttributeName, WILD));
		return executeSearch(filter);
	}

	/* (non-Javadoc)
	 * @see org.jasig.schedassist.ICalendarAccountDao#searchForCalendarAccounts(java.lang.String)
	 */
	@Override
	@Cacheable(cacheName="userAccountCache", keyGenerator=@KeyGenerator(name="StringCacheKeyGenerator"))
	public List searchForCalendarAccounts(String searchText) {
		AndFilter filter = new AndFilter();
		
		StringBuilder wildSearchText = new StringBuilder();
		wildSearchText.append(WILD);
		wildSearchText.append(searchText.replace(" ", WILD));
		wildSearchText.append(WILD);
		
		OrFilter orFilter = new OrFilter();
		orFilter.or(new LikeFilter(this.calendarUsernameAttributeName, wildSearchText.toString()));
		orFilter.or(new LikeFilter(this.calendarDisplayNameAttributeName, wildSearchText.toString()));
		
		filter.and(orFilter);
		// guarantee search for users with calendar attributes
		filter.and(new LikeFilter(this.calendarUniqueIdAttributeName, WILD));
		// guarantee search for users with usernames
		filter.and(new LikeFilter(this.calendarUsernameAttributeName, WILD));
		return executeSearchReturnList(filter);
	}

	/**
	 * 
	 * @param searchFilter
	 * @return
	 */
	protected ICalendarAccount executeSearch(final Filter searchFilter) {
		List results = executeSearchReturnList(searchFilter);
		ICalendarAccount result = DataAccessUtils.singleResult(results);
		return result;
	}
	/**
	 * 
	 * @param searchFilter
	 * @return
	 */
	@SuppressWarnings("unchecked")
	protected List executeSearchReturnList(final Filter searchFilter) {
		log.debug("executing search filter: " + searchFilter);
		
		SearchControls sc = new SearchControls();
		sc.setCountLimit(searchResultsLimit);
		sc.setTimeLimit(searchTimeLimit);
		sc.setSearchScope(SearchControls.SUBTREE_SCOPE);
		
		List results = Collections.emptyList();
		try {
			results = ldapTemplate.search(baseDn, searchFilter.toString(), sc, attributesMapper);
		} catch (SizeLimitExceededException e) {
			log.debug("search filter exceeded results size limit(" + searchResultsLimit +"): " + searchFilter);
		} catch (TimeLimitExceededException e) {
			log.warn("search filter exceeded time limit (" + searchTimeLimit + " milliseconds): " + searchFilter);
		}
		return results;
	}
}