/*!
* 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 (c) 2002-2013 Pentaho Corporation.. All rights reserved.
*/
/* Parts Copyright 2004, 2005 Acegi Technology Pty Limited
*
* 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.pentaho.platform.plugin.services.security.userrole.memory;
import org.springframework.beans.propertyeditors.PropertiesEditor;
import org.springframework.security.userdetails.User;
import org.springframework.security.userdetails.UserDetails;
import org.springframework.security.userdetails.memory.UserAttribute;
import org.springframework.security.userdetails.memory.UserAttributeEditor;
import java.beans.PropertyEditorSupport;
import java.util.Properties;
/**
* Property editor to assist with the setup of a {@link UserRoleListEnhancedUserMap}.
*
* <p>
* The format of entries should be:
* </p>
*
* <p>
* <code>
* username=password,grantedAuthority[,grantedAuthority][,enabled|disabled]
* </code>
* </p>
*
* <p>
* The <code>password</code> must always be the first entry after the equals. The <code>enabled</code> or
* <code>disabled</code> keyword can appear anywhere (apart from the first entry reserved for the password). If neither
* <code>enabled</code> or <code>disabled</code> appear, the default is <code>enabled</code>. At least one granted
* authority must be listed.
* </p>
*
* <p>
* The <code>username</code> represents the key and duplicates are handled the same was as duplicates would be in Java
* <code>Properties</code> files.
* </p>
*
* <p>
* If the above requirements are not met, the invalid entry will be silently ignored.
* </p>
*
* <p>
* This editor always assumes each entry has a non-expired account and non-expired credentials. However, it does honour
* the user enabled/disabled flag as described above.
* </p>
*
* @author Ben Alex
* @version $Id: UserRoleListEnhancedUserMapEditor.java,v 1.1 2006/04/19 04:57:50 mbatchelor Exp $
*/
public class UserRoleListEnhancedUserMapEditor extends PropertyEditorSupport {
// ~ Methods
// ================================================================
@Override
public void setAsText( final String s ) throws IllegalArgumentException {
UserRoleListEnhancedUserMap userRoleListEnhanceduserMap = new UserRoleListEnhancedUserMap();
// Use properties editor to tokenize the string
PropertiesEditor propertiesEditor = new PropertiesEditor();
propertiesEditor.setAsText( s );
Properties props = (Properties) propertiesEditor.getValue();
UserRoleListEnhancedUserMapEditor.addUsersFromProperties( userRoleListEnhanceduserMap, props );
setValue( userRoleListEnhanceduserMap );
}
public static UserRoleListEnhancedUserMap addUsersFromProperties( final UserRoleListEnhancedUserMap userMap,
final Properties props ) {
// Now we have properties, process each one individually
UserAttributeEditor configAttribEd = new UserAttributeEditor();
for ( Object element : props.keySet() ) {
String username = (String) element;
String value = props.getProperty( username );
// Convert value to a password, enabled setting, and list of granted
// authorities
configAttribEd.setAsText( value );
UserAttribute attr = (UserAttribute) configAttribEd.getValue();
// Make a user object, assuming the properties were properly
// provided
if ( attr != null ) {
UserDetails user =
new User( username, attr.getPassword(), attr.isEnabled(), true, true, true, attr.getAuthorities() );
userMap.addUser( user );
}
}
return userMap;
}
}