Package com.devonfw.module.security.common.api.authentication

Class DefaultAuthentication

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.authentication.UsernamePasswordAuthenticationToken

com.devonfw.module.security.common.api.authentication.DefaultAuthentication

All Implemented Interfaces:

AdvancedAuthentication, Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer

public class DefaultAuthentication
extends org.springframework.security.authentication.UsernamePasswordAuthenticationToken
implements AdvancedAuthentication

Implementation of AdvancedAuthentication to be used by default in devon4j apps after successful authentication.

Since:

2020.04.001

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultAuthentication(Object principal, Object credentials, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)	The constructor.
DefaultAuthentication(Object principal, Object credentials, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities, Map<String,Object> attributes)	The constructor.
DefaultAuthentication(Object principal, Object credentials, Set<String> permissions)	The constructor.
DefaultAuthentication(Object principal, Object credentials, Set<String> permissions, Map<String,Object> attributes)	The constructor.

Method Summary

Modifier and Type	Method	Description
<T> T	getAttribute(String key)
Map<String,Object>	getAttributes()
Set<String>	getPermissions()
static DefaultAuthentication	ofAccessControls(Object principal, Object credentials, Collection<? extends AccessControl> accessControls, Map<String,Object> attributes)	Creates a new DefaultAuthentication instance for the provided values.
void	setAttribute(String key, Object value)

Methods inherited from class org.springframework.security.authentication.UsernamePasswordAuthenticationToken

eraseCredentials, getCredentials, getPrincipal, setAuthenticated

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.devonfw.module.security.common.api.authentication.AdvancedAuthentication

hasPermission

Methods inherited from interface org.springframework.security.core.Authentication

getAuthorities, getCredentials, getDetails, getPrincipal, isAuthenticated, setAuthenticated

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Constructor Detail

DefaultAuthentication

public DefaultAuthentication(Object principal,
                             Object credentials,
                             Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

The constructor.

Parameters:

principal - the principal.

credentials - the optional credentials.

authorities - the authorities.

DefaultAuthentication

public DefaultAuthentication(Object principal,
                             Object credentials,
                             Collection<? extends org.springframework.security.core.GrantedAuthority> authorities,
                             Map<String,Object> attributes)

The constructor.

Parameters:

principal - the principal.

credentials - the optional credentials.

authorities - the authorities.

attributes - the Map of attributes. Use Collections.unmodifiableMap(Map) to prevent mutation.

DefaultAuthentication

public DefaultAuthentication(Object principal,
                             Object credentials,
                             Set<String> permissions)

The constructor.

Parameters:

principal - the principal.

credentials - the optional credentials.

permissions - the permissions.

DefaultAuthentication

public DefaultAuthentication(Object principal,
                             Object credentials,
                             Set<String> permissions,
                             Map<String,Object> attributes)

The constructor.

Parameters:

principal - the principal.

credentials - the optional credentials.

permissions - the permissions.

attributes - the Map of attributes. Use Collections.unmodifiableMap(Map) to prevent mutation.

Method Detail

ofAccessControls

public static DefaultAuthentication ofAccessControls(Object principal,
                                                     Object credentials,
                                                     Collection<? extends AccessControl> accessControls,
                                                     Map<String,Object> attributes)

Creates a new DefaultAuthentication instance for the provided values.

Parameters:

principal - the principal.

credentials - the optional credentials.

accessControls - the permissions.

attributes - the Map of attributes. Use Collections.unmodifiableMap(Map) to prevent mutation.

Returns:

New DefaultAuthentication.

getPermissions

public Set<String> getPermissions()

Specified by:

getPermissions in interface AdvancedAuthentication

Returns:

the authorities as a Set of flat Strings. Allows to improve performance of of checks if permissions are present or not.

See Also:

AdvancedAuthentication.hasPermission(String)

getAttributes

public Map<String,Object> getAttributes()

Returns:

the attributes Map.

getAttribute

public <T> T getAttribute(String key)

Specified by:

getAttribute in interface AdvancedAuthentication

Type Parameters:

T - type of the expected return type.

Parameters:

key - the key of the requested attribute.

Returns:

the attribute for the given key or null if not present.

setAttribute

public void setAttribute(String key,
                         Object value)

Specified by:

setAttribute in interface AdvancedAuthentication

Parameters:

key - the key to set. May not be null.

value - the value to set. May not be null.