StringUserTypeMapper.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/providers/trunk/jldap/src/java/edu/amc/sakai/user/StringUserTypeMapper.java $
 * $Id: StringUserTypeMapper.java 105079 2012-02-24 23:08:11Z ottenhoff@longsight.com $
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008 The Sakai Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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 edu.amc.sakai.user;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.novell.ldap.LDAPEntry;

/**
 * Very simple {@link UserTypeMapper} which generates the same
 * <code>String</code> value for any users. Technically, this
 * object could be reconfigured at any time.
 * 
 * @author dmccallum
 */
public class StringUserTypeMapper implements UserTypeMapper {
	
	/** Class-specific logger */
	private static Log M_log = LogFactory.getLog(StringUserTypeMapper.class);
	
	private String userType;
	
	/**
	 * Leaves the cached user type <code>String</code> initialized to <code>null</code>
	 */
	public StringUserTypeMapper() {}
	
	/**
	 * Sets the cached user type to the given <code>String</code>.
	 * Effectively the same as using the no-arg constructor,
	 * then invoking {@link #setUserType(String)}. No guarantees
	 * exist that this constructor will actually invoke that
	 * method, though.
	 * 
	 * @param userType a user type String. <code>null</code> and
	 *   empty Strings OK
	 */
	public StringUserTypeMapper(String userType) {
		this.userType = userType;
	}

	/**
	 * Always returns the value set by {@link #setUserType(String)}.
	 * Default is <code>null</code>
	 * 
	 * @return the value cached by {@link #setUserType(String)}.
	 */
	public String mapLdapEntryToSakaiUserType(LDAPEntry ldapEntry,
			LdapAttributeMapper mapper) {
		
		if ( M_log.isDebugEnabled() ) {
			M_log.debug("mapLdapEntryToSakaiUserType(): returning user type [" + userType + 
					"] for [entry DN = " + ldapEntry.getDN() + "]");
		}
		
		return userType;
	}

	/**
	 * Access the user type <code>String</code> to be returned from
	 * any invocation of {@link #mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper)}.
	 *
	 * @return the cached user type <code>String</code>. Might be
	 *   <code>null</code> or empty.
	 */
	public String getUserType() {
		return userType;
	}

	/**
	 * Set the user type <code>String</code> to be returned from
	 * any invocation of {@link #mapLdapEntryToSakaiUserType(LDAPEntry, LdapAttributeMapper)}.
	 * 
	 * @param userType a user type String. <code>null</code> and
	 *   empty Strings OK
	 */
	public void setUserType(String userType) {
		this.userType = userType;
	}

}