Add UserDetailsRepositoryResourceFactoryBean

Add the ability to easily create a UserDetailsRepository from a Properties
in the standard Spring Security user format.

Fixes gh-4382

config/src/main/java/org/springframework/security/config/core/userdetails/UserDetailsRepositoryResourceFactoryBean.java

@@ -0,0 +1,100 @@
+/*
+ *
+ *  * Copyright 2002-2017 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.security.config.core.userdetails;
+
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.context.ResourceLoaderAware;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.security.core.userdetails.MapUserDetailsRepository;
+import org.springframework.security.core.userdetails.UserDetails;
+
+import java.util.Collection;
+
+/**
+ * Constructs an {@link MapUserDetailsRepository} from a resource using {@link UserDetailsResourceFactoryBean}.
+ *
+ * @author Rob Winch
+ * @since 5.0
+ * @see UserDetailsResourceFactoryBean
+ */
+public class UserDetailsRepositoryResourceFactoryBean implements ResourceLoaderAware, FactoryBean<MapUserDetailsRepository> {
+	private UserDetailsResourceFactoryBean userDetails = new UserDetailsResourceFactoryBean();
+
+	@Override
+	public MapUserDetailsRepository getObject() throws Exception {
+		Collection<UserDetails> users = userDetails.getObject();
+		return new MapUserDetailsRepository(users);
+	}
+
+	@Override
+	public Class<?> getObjectType() {
+		return MapUserDetailsRepository.class;
+	}
+
+	@Override
+	public void setResourceLoader(ResourceLoader resourceLoader) {
+		userDetails.setResourceLoader(resourceLoader);
+	}
+
+	/**
+	 * Sets a the location of a Resource that is a Properties file in the format defined in {@link UserDetailsResourceFactoryBean}
+	 *
+	 * @param propertiesResourceLocation the location of the properties file that contains the users (i.e. "classpath:users.properties")
+	 * @return the UserDetailsResourceFactoryBean
+	 */
+	public void setPropertiesResourceLocation(String propertiesResourceLocation) {
+		this.userDetails.setPropertiesResourceLocation(propertiesResourceLocation);
+	}
+
+	/**
+	 * Sets a a Resource that is a Properties file in the format defined in {@link UserDetailsResourceFactoryBean}
+	 *
+	 * @param propertiesResource the Resource to use
+	 */
+	public void setPropertiesResource(Resource propertiesResource) {
+		this.userDetails.setPropertiesResource(propertiesResource);
+	}
+
+	/**
+	 * Create a UserDetailsRepositoryResourceFactoryBean with the location of a Resource that is a Properties file in the
+	 * format defined in {@link UserDetailsResourceFactoryBean}
+	 *
+	 * @param propertiesResourceLocation the location of the properties file that contains the users (i.e. "classpath:users.properties")
+	 * @return the UserDetailsResourceFactoryBean
+	 */
+	public static UserDetailsRepositoryResourceFactoryBean usersFromResourceLocation(String propertiesResourceLocation) {
+		UserDetailsRepositoryResourceFactoryBean result = new UserDetailsRepositoryResourceFactoryBean();
+		result.setPropertiesResourceLocation(propertiesResourceLocation);
+		return result;
+	}
+
+	/**
+	 * Create a UserDetailsRepositoryResourceFactoryBean with a Resource that is a Properties file in the
+	 * format defined in {@link UserDetailsResourceFactoryBean}
+	 *
+	 * @param propertiesResource the Resource that is a properties file that contains the users
+	 * @return the UserDetailsResourceFactoryBean
+	 */
+	public static UserDetailsRepositoryResourceFactoryBean usersFromResource(Resource propertiesResource) {
+		UserDetailsRepositoryResourceFactoryBean result = new UserDetailsRepositoryResourceFactoryBean();
+		result.setPropertiesResource(propertiesResource);
+		return result;
+	}
+}

config/src/test/java/org/springframework/security/config/core/userdetails/UserDetailsRepositoryResourceFactoryBeanPropertiesResourceITests.java

@@ -0,0 +1,54 @@
+/*
+ *
+ *  * Copyright 2002-2017 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.security.config.core.userdetails;
+
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.core.userdetails.UserDetailsRepository;
+import org.springframework.security.util.InMemoryResource;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
+
+/**
+ * @author Rob Winch
+ * @since 5.0
+ */
+@RunWith(SpringRunner.class)
+public class UserDetailsRepositoryResourceFactoryBeanPropertiesResourceITests {
+	@Autowired
+	UserDetailsRepository users;
+
+	@Test
+	public void loadUserByUsernameWhenUserFoundThenNotNull() {
+		assertThat(users.findByUsername("user").block()).isNotNull();
+	}
+
+	@Configuration
+	static class Config {
+		@Bean
+		public UserDetailsRepositoryResourceFactoryBean userDetailsService() {
+			return UserDetailsRepositoryResourceFactoryBean.usersFromResource(new InMemoryResource("user=password,ROLE_USER"));
+		}
+	}
+}

config/src/test/java/org/springframework/security/config/core/userdetails/UserDetailsRepositoryResourceFactoryBeanPropertiesResourceLocationITests.java

@@ -0,0 +1,53 @@
+/*
+ *
+ *  * Copyright 2002-2017 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.security.config.core.userdetails;
+
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.core.userdetails.UserDetailsRepository;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
+
+/**
+ * @author Rob Winch
+ * @since 5.0
+ */
+@RunWith(SpringRunner.class)
+public class UserDetailsRepositoryResourceFactoryBeanPropertiesResourceLocationITests {
+	@Autowired
+	UserDetailsRepository users;
+
+	@Test
+	public void loadUserByUsernameWhenUserFoundThenNotNull() {
+		assertThat(users.findByUsername("user").block()).isNotNull();
+	}
+
+	@Configuration
+	static class Config {
+		@Bean
+		public UserDetailsRepositoryResourceFactoryBean userDetailsService() {
+			return UserDetailsRepositoryResourceFactoryBean.usersFromResourceLocation("classpath:users.properties");
+		}
+	}
+}