UserMapFactoryBean.java

/*
 * This program is free software; you can redistribute it and/or modify it under the 
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software 
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this 
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html 
 * or from the Free Software Foundation, Inc., 
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright 2007 - 2009 Pentaho Corporation.  All rights reserved.
 *
*/
package org.pentaho.platform.plugin.services.security.userrole.memory;

import org.springframework.beans.factory.FactoryBean;
import org.springframework.security.userdetails.memory.UserMap;
import org.springframework.security.userdetails.memory.UserMapEditor;

/**
 * Takes as input the string that defines a <code>UserMap</code>. When
 * Spring instantiates this bean, it outputs a
 * <code>UserMap</code>.
 *
 * <p>This class allows a string that defines a <code>UserMap</code> to be defined once in
 * Spring beans XML, then used by multiple client beans that need access to user to role mappings.</p>
 *
 * <p>This class is necessary
 * since <code>UserMap</code> does not define a constructor or setter
 * necessary to populate a <code>UserMap</code> bean, nor does it provide any
 * way to extract its mappings once created.</p>
 *
 * <p>Example usage:</p>
 *
 * <pre>
 *     <bean id="userMap" class="java.lang.String">
 *       <constructor-arg type="java.lang.String">
 *         <value>
 *           <![CDATA[
 *           joe=password,Admin,ceo,Authenticated
 *           ...
 *           ]]>
 *         </value>
 *       </constructor-arg>
 *     </bean>
 *
 *     <bean id="userMapFactoryBean"
 *       class="org.pentaho.security.UserMapFactoryBean">
 *       <property name="userMap" ref="userMap" />
 *     </bean>
 *
 *     <bean id="memoryAuthenticationDao"
 *       class="org.springframework.security.userdetails.memory.InMemoryDaoImpl">
 *       <property name="userMap" ref="userMapFactoryBean" />
 *     </bean>
 * </pre>
 *
 * @author mlowery
 * @see UserRoleListEnhancedUserMapFactoryBean
 */
public class UserMapFactoryBean implements FactoryBean {
  /*
   * The user map text which will be processed by property editor.
   */
  private String userMap;

  public Object getObject() throws Exception {
    UserMapEditor userMapEditor = new UserMapEditor();
    userMapEditor.setAsText(userMap);
    return userMapEditor.getValue();
  }

  public Class getObjectType() {
    return UserMap.class;
  }

  public boolean isSingleton() {
    return true;
  }

  public void setUserMap(final String userMap) {
    this.userMap = userMap;
  }

}