com.edorasware.api.config.security

Interface SecurityApiConfigurationConfigurer

All Superinterfaces:

ConfigurationConfigurer<SecurityApiConfigurationBuilder>

@ExtensionPoint
public interface SecurityApiConfigurationConfigurer
extends ConfigurationConfigurer<SecurityApiConfigurationBuilder>

Interface for beans that customize the web security of the public REST API.

This interface is slightly different to a standard ConfigurationConfigurer as the implementation provides default security settings which can be adjusted using the pre- and post- configuration methods. The configure(SecurityApiConfigurationBuilder) method can be used to disable the default settings completely if required. The execution order is as follows:

• preConfigureHttpSecurity(HttpSecurity)

• configure(SecurityApiConfigurationBuilder)

• if HTTP security defaults are enabled, add default settings

• postConfigureHttpSecurity(HttpSecurity)

  The corresponding sequence is also used for the authentication manager settings.

  NOTE: if the defaults are disabled you can set your full configuration in either
  the pre- or post- method.

For information on how to use this interface to customize your application please refer to the ConfigurationConfigurer documentation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONFIGURATION_ORDER

Method Summary

Modifier and Type	Method and Description
default void	configure(SecurityApiConfigurationBuilder configurationBuilder) Allows the security configuration default settings to be disabled.
default void	postConfigureAuthenticationManagerBuilder(org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder authenticationManagerBuilder) Allows the authentication manager configuration to be adjusted after the default settings are applied.
default void	postConfigureHttpSecurity(org.springframework.security.config.annotation.web.builders.HttpSecurity httpSecurity) Allows the HTTP security configuration to be adjusted after the default settings are applied.
default void	preConfigureAuthenticationManagerBuilder(org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder authenticationManagerBuilder) Allows the authentication manager configuration to be adjusted before the default settings are applied.
default void	preConfigureHttpSecurity(org.springframework.security.config.annotation.web.builders.HttpSecurity httpSecurity) Allows the HTTP security configuration to be adjusted before the default settings are applied.

Field Detail

CONFIGURATION_ORDER

static final int CONFIGURATION_ORDER

See Also:

Constant Field Values

Method Detail

configure

default void configure(SecurityApiConfigurationBuilder configurationBuilder)

Allows the security configuration default settings to be disabled.

There is no need to override this method if you don’t nee

Specified by:

configure in interface ConfigurationConfigurer<SecurityApiConfigurationBuilder>

Parameters:

configurationBuilder - a SecurityApiConfigurationBuilder

preConfigureHttpSecurity

default void preConfigureHttpSecurity(org.springframework.security.config.annotation.web.builders.HttpSecurity httpSecurity)
                               throws Exception

Allows the HTTP security configuration to be adjusted before the default settings are applied.

Parameters:

httpSecurity - the HttpSecurity reference to be configured

Throws:

Exception - if the configuration failed

preConfigureAuthenticationManagerBuilder

default void preConfigureAuthenticationManagerBuilder(org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder authenticationManagerBuilder)
                                               throws Exception

Allows the authentication manager configuration to be adjusted before the default settings are applied.

Parameters:

authenticationManagerBuilder - the AuthenticationManagerBuilder reference to be configured

Throws:

Exception - if the configuration failed

postConfigureHttpSecurity

default void postConfigureHttpSecurity(org.springframework.security.config.annotation.web.builders.HttpSecurity httpSecurity)
                                throws Exception

Allows the HTTP security configuration to be adjusted after the default settings are applied.

Parameters:

httpSecurity - the HttpSecurity reference to be configured

Throws:

Exception - if the configuration failed

postConfigureAuthenticationManagerBuilder

default void postConfigureAuthenticationManagerBuilder(org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder authenticationManagerBuilder)
                                                throws Exception

Allows the authentication manager configuration to be adjusted after the default settings are applied.

Parameters:

authenticationManagerBuilder - the AuthenticationManagerBuilder reference to be configured

Throws:

Exception - if the configuration failed