Package io.micronaut.security.config

Class SecurityConfigurationProperties

java.lang.Object

io.micronaut.security.config.SecurityConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, AuthenticationModeConfiguration, SecurityConfiguration

@ConfigurationProperties("micronaut.security")
public class SecurityConfigurationProperties
extends java.lang.Object
implements SecurityConfiguration

Stores configuration for JWT.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ANYWHERE
static AuthenticationStrategy	DEFAULT_AUTHENTICATION_STRATEGY	The default enable value.
static boolean	DEFAULT_ENABLED	The default enable value.
static boolean	DEFAULT_INTERCEPT_URL_MAP_PREPEND_PATTERN_WITH_CONTEXT_PATH	The default value whether intercept url patterns should be prepended with the context path.
static boolean	DEFAULT_REJECT_NOT_FOUND	The default reject-not-found value.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor	Description
SecurityConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
AuthenticationMode	getAuthentication()
AuthenticationStrategy	getAuthenticationProviderStrategy()
java.util.List<InterceptUrlMapPattern>	getInterceptUrlMap()
java.util.List<java.lang.String>	getIpPatterns()
boolean	isEnabled()
boolean	isInterceptUrlMapPrependPatternWithContextPath()
boolean	isRejectNotFound()	For cases where no security rule handles a request and it is determined that the request does not match any routes on the server, whether the response should be to reject the request or allow the not found response to be returned.
void	setAuthentication(AuthenticationMode authentication)	Defines which authentication to use.
void	setAuthenticationProviderStrategy(AuthenticationStrategy authenticationProviderStrategy)	Determines how authentication providers should be processed.
void	setEnabled(boolean enabled)	If Security is enabled.
void	setInterceptUrlMap(java.util.List<InterceptUrlMapPattern> interceptUrlMap)	Map that defines the interception patterns.
void	setInterceptUrlMapPrependPatternWithContextPath(boolean interceptUrlMapPrependPatternWithContextPath)	Whether the intercept URL patterns should be prepended with context path if defined.
void	setIpPatterns(java.util.List<java.lang.String> ipPatterns)	Allowed IP patterns.
void	setRejectNotFound(boolean rejectNotFound)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

ANYWHERE

public static final java.lang.String ANYWHERE

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_INTERCEPT_URL_MAP_PREPEND_PATTERN_WITH_CONTEXT_PATH

public static final boolean DEFAULT_INTERCEPT_URL_MAP_PREPEND_PATTERN_WITH_CONTEXT_PATH

The default value whether intercept url patterns should be prepended with the context path.

See Also:

Constant Field Values

DEFAULT_AUTHENTICATION_STRATEGY

public static final AuthenticationStrategy DEFAULT_AUTHENTICATION_STRATEGY

The default enable value.

DEFAULT_REJECT_NOT_FOUND

public static final boolean DEFAULT_REJECT_NOT_FOUND

The default reject-not-found value.

See Also:

Constant Field Values

Constructor Detail

SecurityConfigurationProperties

public SecurityConfigurationProperties()

Method Detail

getAuthentication

@Nullable
public AuthenticationMode getAuthentication()

Specified by:

getAuthentication in interface AuthenticationModeConfiguration

Returns:

Authentication Model to use

setAuthentication

public void setAuthentication(@Nullable
                              AuthenticationMode authentication)

Defines which authentication to use. Defaults to null. Possible values bearer, session, cookie, idtoken. Should only be supplied if the service handles login and logout requests.

Parameters:

authentication - Login Handler Mode

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

getInterceptUrlMap

public java.util.List<InterceptUrlMapPattern> getInterceptUrlMap()

Specified by:

getInterceptUrlMap in interface SecurityConfiguration

Returns:

a list of InterceptUrlMapPattern

getIpPatterns

public java.util.List<java.lang.String> getIpPatterns()

Specified by:

getIpPatterns in interface SecurityConfiguration

Returns:

a list of IP Regex patterns. e.g. [192.168.1.*]

setEnabled

public void setEnabled(boolean enabled)

If Security is enabled. Default value true

Parameters:

enabled - True if security is enabled

isInterceptUrlMapPrependPatternWithContextPath

public boolean isInterceptUrlMapPrependPatternWithContextPath()

Specified by:

isInterceptUrlMapPrependPatternWithContextPath in interface SecurityConfiguration

Returns:

Whether the intercept URL patterns should be prepended with context path if defined.

setInterceptUrlMapPrependPatternWithContextPath

public void setInterceptUrlMapPrependPatternWithContextPath(boolean interceptUrlMapPrependPatternWithContextPath)

Whether the intercept URL patterns should be prepended with context path if defined. Defaults to false.

Parameters:

interceptUrlMapPrependPatternWithContextPath - Prepend Intercept URL Map pattern with context path

setInterceptUrlMap

public void setInterceptUrlMap(java.util.List<InterceptUrlMapPattern> interceptUrlMap)

Map that defines the interception patterns.

Parameters:

interceptUrlMap - The intercept urls maps

setIpPatterns

public void setIpPatterns(java.util.List<java.lang.String> ipPatterns)

Allowed IP patterns. Default value (["0.0.0.0"])

Parameters:

ipPatterns - The IP patterns

getAuthenticationProviderStrategy

public AuthenticationStrategy getAuthenticationProviderStrategy()

Specified by:

getAuthenticationProviderStrategy in interface SecurityConfiguration

Returns:

The authentication strategy

setAuthenticationProviderStrategy

public void setAuthenticationProviderStrategy(AuthenticationStrategy authenticationProviderStrategy)

Determines how authentication providers should be processed. Default value ANY. Possible values: ANY or ALL.

Parameters:

authenticationProviderStrategy - authentication strategy.

isRejectNotFound

public boolean isRejectNotFound()

Description copied from interface: SecurityConfiguration

For cases where no security rule handles a request and it is determined that the request does not match any routes on the server, whether the response should be to reject the request or allow the not found response to be returned.

Specified by:

isRejectNotFound in interface SecurityConfiguration

Returns:

True if the response should be rejected.

setRejectNotFound

public void setRejectNotFound(boolean rejectNotFound)

Parameters:

rejectNotFound - Whether the server should respond with 401 for requests that do not match any routes on the server, if you set it to false, it will return 404 for requests that do not match any routes on the server. Default value (true).