Package io.micronaut.security.filters

Class SecurityFilterConfigurationProperties

java.lang.Object

io.micronaut.security.filters.SecurityFilterConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, SecurityFilterConfiguration

@ConfigurationProperties("micronaut.security.filter")
public class SecurityFilterConfigurationProperties
extends Object
implements SecurityFilterConfiguration

ConfigurationProperties implementation of SecurityFilterConfiguration.

Since:

3.1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	The default enable value.
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
SecurityFilterConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
@NonNull String	getPattern()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Enables SecurityFilter.
void	setPath(@NonNull String pattern)	Pattern the SecurityFilter should match.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

• Constant Field Values

Constructor Details

SecurityFilterConfigurationProperties

public SecurityFilterConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

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

Returns:

true if you want to enable the SecurityFilter

getPattern

@NonNull
public @NonNull String getPattern()

Specified by:

getPattern in interface SecurityFilterConfiguration

Returns:

The pattern the SecurityFilter should match.

setEnabled

public void setEnabled(boolean enabled)

Enables SecurityFilter. Default value true

Parameters:

enabled - True if it is enabled

setPath

public void setPath(@NonNull
 @NonNull String pattern)

Pattern the SecurityFilter should match. Default value `/**`. URLS NOT MATCHED BY PREVIOUS PATTERN ARE NOT SECURED

Parameters:

pattern - The pattern