Package com.activeviam.springboot.atoti.server.starter.api

Class AtotiSecurityProperties

java.lang.Object

com.activeviam.springboot.atoti.server.starter.api.AtotiSecurityProperties

@ConfigurationProperties(prefix="atoti.server.security")
public final class AtotiSecurityProperties
extends Object

Configuration properties for the Atoti security.

These properties are used to configure the security of the Atoti application.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AtotiSecurityProperties.AtotiSecurityPropertiesBuilder
static final class	AtotiSecurityProperties.PageProperties	The page properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE_ADMIN	Role value assigned to administrators of an Atoti application.
static final String	ROLE_USER	Role value assigned to basic users of an Atoti application.

Constructor Summary

Constructors

Constructor	Description
AtotiSecurityProperties()

Method Summary

Modifier and Type	Method	Description
static AtotiSecurityProperties.AtotiSecurityPropertiesBuilder	builder()
boolean	equals(Object o)
String	getCookieName()	Name of the application cookie.
AtotiSecurityProperties.PageProperties	getLoginPage()	Configuration for the resources used for the login page.
AtotiSecurityProperties.PageProperties	getLogoutPage()	Configuration for the resources used for the logout page.
List<String>	getRolesAdmin()
List<String>	getRolesUser()	List of roles assigned to standard users.
int	hashCode()
boolean	isForceHttps()	Configures the security to enforce the use of HTTPS.
void	setCookieName(String cookieName)	Name of the application cookie.
void	setForceHttps(boolean forceHttps)	Configures the security to enforce the use of HTTPS.
void	setLoginPage(AtotiSecurityProperties.PageProperties loginPage)	Configuration for the resources used for the login page.
void	setLogoutPage(AtotiSecurityProperties.PageProperties logoutPage)	Configuration for the resources used for the logout page.
void	setRolesAdmin(List<String> rolesAdmin)	List of roles to consider as Admin.
void	setRolesUser(List<String> rolesUser)	List of roles assigned to standard users.
AtotiSecurityProperties.AtotiSecurityPropertiesBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

ROLE_ADMIN

public static final String ROLE_ADMIN

Role value assigned to administrators of an Atoti application.

See Also:

• Constant Field Values

ROLE_USER

public static final String ROLE_USER

Role value assigned to basic users of an Atoti application.

See Also:

• Constant Field Values

Constructor Details

AtotiSecurityProperties

public AtotiSecurityProperties()

Method Details

getRolesAdmin

public List<String> getRolesAdmin()

builder

public static AtotiSecurityProperties.AtotiSecurityPropertiesBuilder builder()

toBuilder

public AtotiSecurityProperties.AtotiSecurityPropertiesBuilder toBuilder()

getRolesUser

public List<String> getRolesUser()

List of roles assigned to standard users.

getCookieName

public String getCookieName()

Name of the application cookie.

getLoginPage

public AtotiSecurityProperties.PageProperties getLoginPage()

Configuration for the resources used for the login page.

getLogoutPage

public AtotiSecurityProperties.PageProperties getLogoutPage()

Configuration for the resources used for the logout page.

isForceHttps

public boolean isForceHttps()

Configures the security to enforce the use of HTTPS.

This particularly applies to login configuration.

setRolesAdmin

public void setRolesAdmin(List<String> rolesAdmin)

List of roles to consider as Admin.

setRolesUser

public void setRolesUser(List<String> rolesUser)

List of roles assigned to standard users.

setCookieName

public void setCookieName(String cookieName)

Name of the application cookie.

setLoginPage

public void setLoginPage(AtotiSecurityProperties.PageProperties loginPage)

Configuration for the resources used for the login page.

setLogoutPage

public void setLogoutPage(AtotiSecurityProperties.PageProperties logoutPage)

Configuration for the resources used for the logout page.

setForceHttps

public void setForceHttps(boolean forceHttps)

Configures the security to enforce the use of HTTPS.

This particularly applies to login configuration.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object