Skip to content

Commit

Permalink
Spring Social carries its own auto-configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
habuma committed Nov 10, 2017
1 parent 4916485 commit 7934198
Show file tree
Hide file tree
Showing 9 changed files with 326 additions and 0 deletions.
10 changes: 10 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,16 @@ project("spring-social-security") {
}
}

project("spring-social-autoconfigure") {
description = "Spring Social Boot Auto-Configuration"
dependencies {
compile project(":spring-social-config")
compile project(":spring-social-core")
compile project(":spring-social-web")
compile("org.springframework.boot:spring-boot-autoconfigure:$springBootVersion")
}
}

configure(rootProject) {
description = "Spring Social"

Expand Down
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ mockitoVersion=2.11.0
javaxInjectVersion=1
thymeleaf3Version=3.0.8.RELEASE
thymeleafSpring5Version=3.0.8.RELEASE
springBootVersion=2.0.0.M6
1 change: 1 addition & 0 deletions settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ include 'spring-social-core'
include 'spring-social-web'
include 'spring-social-config'
include 'spring-social-security'
include 'spring-social-autoconfigure'
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* Copyright 2012-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.social.autoconfigure;

import org.springframework.core.env.Environment;
import org.springframework.social.config.annotation.ConnectionFactoryConfigurer;
import org.springframework.social.config.annotation.SocialConfigurerAdapter;
import org.springframework.social.connect.ConnectionFactory;

/**
* Base class for auto-configured {@link SocialConfigurerAdapter}s.
*
* @author Craig Walls
* @author Phillip Webb
* @since 1.4.0
*/
public abstract class SocialAutoConfigurerAdapter extends SocialConfigurerAdapter {

@Override
public void addConnectionFactories(ConnectionFactoryConfigurer configurer,
Environment environment) {
configurer.addConnectionFactory(createConnectionFactory());
}

protected abstract ConnectionFactory<?> createConnectionFactory();

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
* Copyright 2012-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.social.autoconfigure;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
* Base {@link ConfigurationProperties properties} for spring social.
*
* @author Stephane Nicoll
* @since 1.4.0
*/
public abstract class SocialProperties {

/**
* Application id.
*/
private String appId;

/**
* Application secret.
*/
private String appSecret;

public String getAppId() {
return this.appId;
}

public void setAppId(String appId) {
this.appId = appId;
}

public String getAppSecret() {
return this.appSecret;
}

public void setAppSecret(String appSecret) {
this.appSecret = appSecret;
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
/*
* Copyright 2012-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.social.autoconfigure;

import java.util.List;

import org.thymeleaf.spring5.SpringTemplateEngine;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
import org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContext;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.social.UserIdSource;
import org.springframework.social.config.annotation.EnableSocial;
import org.springframework.social.config.annotation.SocialConfigurerAdapter;
import org.springframework.social.connect.ConnectionFactoryLocator;
import org.springframework.social.connect.ConnectionRepository;
import org.springframework.social.connect.UsersConnectionRepository;
import org.springframework.social.connect.web.ConnectController;
import org.springframework.social.connect.web.ConnectInterceptor;
import org.springframework.social.connect.web.DisconnectInterceptor;
import org.springframework.social.connect.web.ProviderSignInController;
import org.springframework.social.connect.web.ProviderSignInInterceptor;
import org.springframework.social.connect.web.SignInAdapter;
import org.springframework.social.connect.web.thymeleaf.SpringSocialDialect;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.web.servlet.view.BeanNameViewResolver;

/**
* {@link EnableAutoConfiguration Auto-configuration} for Spring Social's web connection
* support.
*
* @author Craig Walls
* @since 1.1.0
*/
@Configuration
@ConditionalOnClass({ ConnectController.class, SocialConfigurerAdapter.class })
@ConditionalOnBean({ ConnectionFactoryLocator.class, UsersConnectionRepository.class })
@AutoConfigureBefore(ThymeleafAutoConfiguration.class)
@AutoConfigureAfter(WebMvcAutoConfiguration.class)
public class SocialWebAutoConfiguration {

@Configuration
@EnableSocial
@ConditionalOnWebApplication(type = Type.SERVLET)
protected static class SocialAutoConfigurationAdapter
extends SocialConfigurerAdapter {

private final List<ConnectInterceptor<?>> connectInterceptors;

private final List<DisconnectInterceptor<?>> disconnectInterceptors;

private final List<ProviderSignInInterceptor<?>> signInInterceptors;

public SocialAutoConfigurationAdapter(
ObjectProvider<List<ConnectInterceptor<?>>> connectInterceptorsProvider,
ObjectProvider<List<DisconnectInterceptor<?>>> disconnectInterceptorsProvider,
ObjectProvider<List<ProviderSignInInterceptor<?>>> signInInterceptorsProvider) {
this.connectInterceptors = connectInterceptorsProvider.getIfAvailable();
this.disconnectInterceptors = disconnectInterceptorsProvider.getIfAvailable();
this.signInInterceptors = signInInterceptorsProvider.getIfAvailable();
}

@Bean
@ConditionalOnMissingBean(ConnectController.class)
public ConnectController connectController(
ConnectionFactoryLocator factoryLocator,
ConnectionRepository repository) {
ConnectController controller = new ConnectController(factoryLocator,
repository);
if (!CollectionUtils.isEmpty(this.connectInterceptors)) {
controller.setConnectInterceptors(this.connectInterceptors);
}
if (!CollectionUtils.isEmpty(this.disconnectInterceptors)) {
controller.setDisconnectInterceptors(this.disconnectInterceptors);
}
return controller;
}

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(prefix = "spring.social", name = "auto-connection-views")
public BeanNameViewResolver beanNameViewResolver() {
BeanNameViewResolver viewResolver = new BeanNameViewResolver();
viewResolver.setOrder(Ordered.HIGHEST_PRECEDENCE);
return viewResolver;
}

@Bean
@ConditionalOnBean(SignInAdapter.class)
@ConditionalOnMissingBean
public ProviderSignInController signInController(
ConnectionFactoryLocator factoryLocator,
UsersConnectionRepository usersRepository, SignInAdapter signInAdapter) {
ProviderSignInController controller = new ProviderSignInController(
factoryLocator, usersRepository, signInAdapter);
if (!CollectionUtils.isEmpty(this.signInInterceptors)) {
controller.setSignInInterceptors(this.signInInterceptors);
}
return controller;
}

}

@Configuration
@EnableSocial
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnMissingClass("org.springframework.security.core.context.SecurityContextHolder")
protected static class AnonymousUserIdSourceConfig extends SocialConfigurerAdapter {

@Override
public UserIdSource getUserIdSource() {
return () -> "anonymous";
}

}

@Configuration
@EnableSocial
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass(SecurityContextHolder.class)
protected static class AuthenticationUserIdSourceConfig
extends SocialConfigurerAdapter {

@Override
public UserIdSource getUserIdSource() {
return new SecurityContextUserIdSource();
}

}

@Configuration
@ConditionalOnClass(SpringTemplateEngine.class)
protected static class SpringSocialThymeleafConfig {

@Bean
@ConditionalOnMissingBean
public SpringSocialDialect springSocialDialect() {
return new SpringSocialDialect();
}

}

private static class SecurityContextUserIdSource implements UserIdSource {

@Override
public String getUserId() {
SecurityContext context = SecurityContextHolder.getContext();
Authentication authentication = context.getAuthentication();
Assert.state(authentication != null,
"Unable to get a ConnectionRepository: no user signed in");
return authentication.getName();
}

}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* Copyright 2012-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.
*/

/**
* Auto-configuration for Spring Social.
*/
package org.springframework.social.autoconfigure;
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{"properties": [
{
"name": "spring.social.auto-connection-views",
"type": "java.lang.Boolean",
"description": "Enable the connection status view for supported providers.",
"defaultValue": false
}
]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.social.autoconfigure.SocialWebAutoConfiguration

0 comments on commit 7934198

Please sign in to comment.