org.springframework.social.security

Class SpringSocialConfigurer

java.lang.Object

org.springframework.security.config.annotation.SecurityConfigurerAdapter<org.springframework.security.web.DefaultSecurityFilterChain,org.springframework.security.config.annotation.web.builders.HttpSecurity>

org.springframework.social.security.SpringSocialConfigurer

All Implemented Interfaces:

org.springframework.security.config.annotation.SecurityConfigurer<org.springframework.security.web.DefaultSecurityFilterChain,org.springframework.security.config.annotation.web.builders.HttpSecurity>

public class SpringSocialConfigurer
extends org.springframework.security.config.annotation.SecurityConfigurerAdapter<org.springframework.security.web.DefaultSecurityFilterChain,org.springframework.security.config.annotation.web.builders.HttpSecurity>

Configurer that adds SocialAuthenticationFilter to Spring Security's filter chain. Used with Spring Security 3.2's Java-based configuration support, when overriding WebSecurityConfigurerAdapter#configure(HttpSecurity):

 protected void configure(HttpSecurity http) throws Exception {
   http.
     // HTTP security configuration details snipped
     .and()
        .apply(new SpringSocialHttpConfigurer());
 }
 

Constructor Summary

Constructors

Constructor and Description
SpringSocialConfigurer() Constructs a SpringSocialHttpConfigurer.

Method Summary

Methods

Modifier and Type	Method and Description
SpringSocialConfigurer	alwaysUsePostLoginUrl(boolean alwaysUsePostLoginUrl) If true, always redirect to postLoginUrl, even if a pre-signin target is in the request cache.
void	configure(org.springframework.security.config.annotation.web.builders.HttpSecurity http)
SpringSocialConfigurer	connectionAddedRedirectUrl(String connectionAddedRedirectUrl) Sets the URL to land on after an a connection was added.
SpringSocialConfigurer	defaultFailureUrl(String defaultFailureUrl) Sets the URL to redirect to if authentication fails or if authorization is denied by the user.
SpringSocialConfigurer	postFailureUrl(String postFailureUrl) Sets the URL to land on after a failed login.
SpringSocialConfigurer	postLoginUrl(String postLoginUrl) Sets the URL to land on after a successful login.
SpringSocialConfigurer	signupUrl(String signupUrl) Sets the URL to land on after an authentication failure so that the user can register with the application.
SpringSocialConfigurer	userIdSource(UserIdSource userIdSource) Sets the UserIdSource to use for authentication.

Methods inherited from class org.springframework.security.config.annotation.SecurityConfigurerAdapter

addObjectPostProcessor, and, getBuilder, init, postProcess, setBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringSocialConfigurer

public SpringSocialConfigurer()

Constructs a SpringSocialHttpConfigurer. Requires that UsersConnectionRepository, SocialAuthenticationServiceLocator, and SocialUserDetailsService beans be available in the application context.

Method Detail

configure

public void configure(org.springframework.security.config.annotation.web.builders.HttpSecurity http)
               throws Exception

Specified by:

configure in interface org.springframework.security.config.annotation.SecurityConfigurer<org.springframework.security.web.DefaultSecurityFilterChain,org.springframework.security.config.annotation.web.builders.HttpSecurity>

Overrides:

configure in class org.springframework.security.config.annotation.SecurityConfigurerAdapter<org.springframework.security.web.DefaultSecurityFilterChain,org.springframework.security.config.annotation.web.builders.HttpSecurity>

Throws:

Exception

userIdSource

public SpringSocialConfigurer userIdSource(UserIdSource userIdSource)

Sets the UserIdSource to use for authentication. Defaults to AuthenticationNameUserIdSource.

Parameters:

userIdSource - the UserIdSource to use when authenticating

Returns:

this SpringSocialConfigurer for chained configuration

postLoginUrl

public SpringSocialConfigurer postLoginUrl(String postLoginUrl)

Sets the URL to land on after a successful login.

Parameters:

postLoginUrl - the URL to redirect to after a successful login

Returns:

this SpringSocialConfigurer for chained configuration

alwaysUsePostLoginUrl

public SpringSocialConfigurer alwaysUsePostLoginUrl(boolean alwaysUsePostLoginUrl)

If true, always redirect to postLoginUrl, even if a pre-signin target is in the request cache.

Parameters:

alwaysUsePostLoginUrl - if true, always redirect to the postLoginUrl

Returns:

this SpringSocialConfigurer for chained configuration

postFailureUrl

public SpringSocialConfigurer postFailureUrl(String postFailureUrl)

Sets the URL to land on after a failed login.

Parameters:

postFailureUrl - the URL to redirect to after a failed login

Returns:

this SpringSocialConfigurer for chained configuration

signupUrl

public SpringSocialConfigurer signupUrl(String signupUrl)

Sets the URL to land on after an authentication failure so that the user can register with the application.

Parameters:

signupUrl - the URL to redirect to after an authentication failure

Returns:

this SpringSocialConfigurer for chained configuration

connectionAddedRedirectUrl

public SpringSocialConfigurer connectionAddedRedirectUrl(String connectionAddedRedirectUrl)

Sets the URL to land on after an a connection was added.

Parameters:

connectionAddedRedirectUrl - the URL to redirect after a connection was added

Returns:

this SpringSocialConfigurer for chained configuration

defaultFailureUrl

public SpringSocialConfigurer defaultFailureUrl(String defaultFailureUrl)

Sets the URL to redirect to if authentication fails or if authorization is denied by the user.

Parameters:

defaultFailureUrl - the URL to redirect to after an authentication fail or authorization deny

Returns:

this SpringSocialConfigurer for chained configuration