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	Deprecated, for removal: This API element is subject to removal in a future version. Not used.
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()
Set<String>	getPostContentTypes()
int	getUnsupportedPostContentTypeStatus()
boolean	isEnabled()	Whether the controller is enabled.
void	setEnabled(boolean enabled)	Enables the controller.
void	setPath(String path)	Path to the controller.
void	setPostContentTypes(Set<String> postContentTypes)	Supported content types for POST endpoints.
void	setUnsupportedPostContentTypeStatus(int unsupportedPostContentTypeStatus)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.security.endpoints.ControllerConfiguration

getPath, getPostContentTypes, getUnsupportedPostContentTypeStatus

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_ENABLED

@Deprecated(forRemoval=true,
            since="4.11.0")
public static final boolean DEFAULT_ENABLED

Deprecated, for removal: This API element is subject to removal in a future version.

Not used. ControllerConfigurationProperties.DEFAULT_ENABLED is used instead.

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

getPostContentTypes

public Set<String> getPostContentTypes()

Specified by:

getPostContentTypes in interface ControllerConfiguration

Returns:

Supported HTTP methods for POST endpoints.

setPostContentTypes

public void setPostContentTypes(Set<String> postContentTypes)

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

Parameters:

postContentTypes - supported content types for POST endpoints.

getUnsupportedPostContentTypeStatus

public int getUnsupportedPostContentTypeStatus()

Specified by:

getUnsupportedPostContentTypeStatus in interface ControllerConfiguration

Returns:

Status code for unsupported content type. Default to 404

setUnsupportedPostContentTypeStatus

public void setUnsupportedPostContentTypeStatus(int unsupportedPostContentTypeStatus)

Parameters:

unsupportedPostContentTypeStatus - Status code for unsupported content type. Default to 404

isEnabled

public boolean isEnabled()

Whether the controller is enabled.

Specified by:

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

Returns:

Whether the controller is enabled.

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 the controller.

Parameters:

enabled - True if it is enabled

setPath

public void setPath(String path)

Path to the controller.

Parameters:

path - The path