Package io.micronaut.security.endpoints

Class LoginControllerConfigurationProperties

java.lang.Object

io.micronaut.security.endpoints.LoginControllerConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, ControllerConfiguration, LoginControllerConfiguration

@Requires(property="micronaut.security.endpoints.login.enabled",
          notEquals="false",
          defaultValue="true")
@ConfigurationProperties("micronaut.security.endpoints.login")
public class LoginControllerConfigurationProperties
extends Object
implements LoginControllerConfiguration

Since:

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	DEFAULT_PATH	The default path.
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
LoginControllerConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
@NonNull String	getPath()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Enables LoginController.
void	setPath(String path)	Path to the LoginController.

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

DEFAULT_PATH

public static final String DEFAULT_PATH

The default path.

See Also:

• Constant Field Values

Constructor Details

LoginControllerConfigurationProperties

public LoginControllerConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

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

Returns:

true if you want to enable the LoginController

getPath

@NonNull
public @NonNull String getPath()

Specified by:

getPath in interface ControllerConfiguration

Returns:

the path where the controller is enabled.

setEnabled

public void setEnabled(boolean enabled)

Enables LoginController. Default value true

Parameters:

enabled - True if it is enabled

setPath

public void setPath(String path)

Path to the LoginController. Default value "/login"

Parameters:

path - The path