Enable ConditionalOnProperty in a RequestMapping in Controller

Question

I have a piece of code -

 @PropertySource(value = "classpath:securityConfig.properties", ignoreResourceNotFound = true) @Controller public class IndexController { private static final String LOGIN_PAGE = "login"; private static final String HOME_PAGE = "home"; private static final String LOBBY_PAGE = "lobby"; private static final String FORGOT_USER_PAGE = "forgotUserName"; private static final String FORGOT_PASSWORD_PAGE = "forgotPassWord"; @ConditionalOnProperty(name = "auth.mode", havingValue = "fixed") @PreAuthorize("isAnonymous()") @RequestMapping(method = RequestMethod.GET, value = { "/login" }) public String getIndexPage() { return LOGIN_PAGE; } }

However, the ConditionalOn annotation doesnt work as expected. I do not want the controller to execute if auth.mode is anything other than fixed. Note - auth.mode is in securityConfig.properties file

Am I missing something? Probably an annotation at class level?

stackoverflow.com/questions/29958231/…

Héctor Valls
– Héctor Valls

2018-05-07 09:12:09 +00:00
Commented May 7, 2018 at 9:12 — Héctor Valls
– Héctor Valls, Commented May 7, 2018 at 9:12
@Héctor it didnt work

Prateek Narendra
– Prateek Narendra

2018-05-07 09:44:18 +00:00
Commented May 7, 2018 at 9:44 — Prateek Narendra
– Prateek Narendra, Commented May 7, 2018 at 9:44

ptomli · Accepted Answer · 2018-05-07 10:11:33Z

You should move the @ConditionalOnProperty annotation to the class, not on the method.

@PropertySource(value = "classpath:securityConfig.properties", ignoreResourceNotFound = true) @Controller @ConditionalOnProperty(name = "auth.mode", havingValue = "fixed") public class IndexController { ... }

This will mean the entire controller will not exist in the application context unless the condition is satisfied.

vvauban · Accepted Answer · 2023-02-24 13:20:42Z

@ConditionalOnProperty can be used as a method-level annotation only on @Bean method like (in a configuration class):

 @Bean @ConditionalOnProperty(name = "myapp.feature.enabled", havingValue = "true") public MyFeature myFeature() { // create and return MyFeature instance }

I personally used a @Value annotation that loads a property, and then uses a conditional structure (a if) according to the property value.

Like in:

@RestController @RequestMapping("/my-endpoint") public class MyController { @Value("${myapp.my-config-value}") private String myConfigValue; @GetMapping public String myMethod() { if ("disable".equals(myConfigValue)) { throw new IllegalStateException("This service is disabled."); } // if not disabled, do your stuff return myService.doStuff(); } }

Prateek Narendra · Accepted Answer · 2018-05-07 10:14:51Z

Edit the @PreAuthorize annotation to add the condition

@PropertySource(value = "classpath:securityConfig.properties", ignoreResourceNotFound = true) @Controller public class IndexController { private static final String LOGIN_PAGE = "login"; private static final String HOME_PAGE = "home"; private static final String LOBBY_PAGE = "lobby"; private static final String FORGOT_USER_PAGE = "forgotUserName"; private static final String FORGOT_PASSWORD_PAGE = "forgotPassWord"; @Value("${auth.mode:fixed}") private String authenticationMode; public String getAuthenticationMode(){ return this.authenticationMode; } @PreAuthorize("isAnonymous() AND this.getAuthenticationMode().equals(\"fixed\")") @RequestMapping(method = RequestMethod.GET, value = { "/login" }) public String getIndexPage() { return LOGIN_PAGE; }

Collectives™ on Stack Overflow

Enable ConditionalOnProperty in a RequestMapping in Controller

3 Answers 3

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Linked

Related