io.jmix.core.security.impl

Class SystemAuthenticatorImpl

java.lang.Object

io.jmix.core.security.impl.SystemAuthenticatorSupport

io.jmix.core.security.impl.SystemAuthenticatorImpl

All Implemented Interfaces:

SystemAuthenticator

@Component(value="core_SystemAuthenticator")
public class SystemAuthenticatorImpl
extends SystemAuthenticatorSupport
implements SystemAuthenticator

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.core.security.impl.SystemAuthenticatorSupport

SystemAuthenticatorSupport.NullAuthentication

Nested classes/interfaces inherited from interface io.jmix.core.security.SystemAuthenticator

SystemAuthenticator.AuthenticatedOperation<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.security.authentication.AuthenticationManager	authenticationManager

Fields inherited from class io.jmix.core.security.impl.SystemAuthenticatorSupport

NULL_AUTHENTICATION, threadLocalStack

Constructor Summary

Constructors

Constructor and Description
SystemAuthenticatorImpl()

Method Summary

Modifier and Type	Method and Description
org.springframework.security.core.Authentication	begin() Authenticate as the 'system' user.
org.springframework.security.core.Authentication	begin(java.lang.String login) Begins an authenticated code block.
protected void	beginServerSessionOnStartup(org.springframework.context.event.ContextRefreshedEvent event)
void	end() End of an authenticated code block.
protected void	endServerSessionOnStartup(org.springframework.context.event.ContextRefreshedEvent event)
void	runWithSystem(java.lang.Runnable operation) Execute code as the 'system' user.
void	runWithUser(java.lang.String login, java.lang.Runnable operation) Execute code on behalf of the specified user.
<T> T	withSystem(SystemAuthenticator.AuthenticatedOperation<T> operation) Execute code as the 'system' user and return a result.
<T> T	withUser(java.lang.String login, SystemAuthenticator.AuthenticatedOperation<T> operation) Execute code on behalf of the specified user and return a result.

Methods inherited from class io.jmix.core.security.impl.SystemAuthenticatorSupport

pollAuthentication, pushAuthentication

Methods inherited from class java.lang.Object

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

Field Detail

authenticationManager

@Autowired(required=false)
protected org.springframework.security.authentication.AuthenticationManager authenticationManager

Constructor Detail

SystemAuthenticatorImpl

public SystemAuthenticatorImpl()

Method Detail

beginServerSessionOnStartup

@EventListener
 @Order(value=105)
protected void beginServerSessionOnStartup(org.springframework.context.event.ContextRefreshedEvent event)

endServerSessionOnStartup

@EventListener
 @Order(value=995)
protected void endServerSessionOnStartup(org.springframework.context.event.ContextRefreshedEvent event)

begin

public org.springframework.security.core.Authentication begin(@Nullable
                                                              java.lang.String login)

Description copied from interface: SystemAuthenticator

Begins an authenticated code block.
Saves the current thread session on a stack to get it back on SystemAuthenticator.end(). Subsequent SystemAuthenticator.end() method must be called in "finally" section.

Specified by:

begin in interface SystemAuthenticator

Parameters:

login - user login. If null, authenticates as the 'system' user.

Returns:

populated Authentication object

begin

public org.springframework.security.core.Authentication begin()

Description copied from interface: SystemAuthenticator

Authenticate as the 'system' user.
Same as SystemAuthenticator.begin(String) with null parameter.

Specified by:

begin in interface SystemAuthenticator

end

public void end()

Description copied from interface: SystemAuthenticator

End of an authenticated code block.
The previous session (or null) is set to security context. Must be called in "finally" section of a try/finally block.

Specified by:

end in interface SystemAuthenticator

withUser

public <T> T withUser(@Nullable
                      java.lang.String login,
                      SystemAuthenticator.AuthenticatedOperation<T> operation)

Description copied from interface: SystemAuthenticator

Execute code on behalf of the specified user and return a result.

Specified by:

withUser in interface SystemAuthenticator

Parameters:

login - user login. If null, the system session is used.

operation - code to execute

Returns:

result of the execution

runWithUser

public void runWithUser(@Nullable
                        java.lang.String login,
                        java.lang.Runnable operation)

Description copied from interface: SystemAuthenticator

Execute code on behalf of the specified user.

Specified by:

runWithUser in interface SystemAuthenticator

Parameters:

login - user login. If null, the system session is used.

operation - code to execute

withSystem

public <T> T withSystem(SystemAuthenticator.AuthenticatedOperation<T> operation)

Description copied from interface: SystemAuthenticator

Execute code as the 'system' user and return a result.

Specified by:

withSystem in interface SystemAuthenticator

Parameters:

operation - code to execute

Returns:

result of the execution

runWithSystem

public void runWithSystem(java.lang.Runnable operation)

Description copied from interface: SystemAuthenticator

Execute code as the 'system' user.

Specified by:

runWithSystem in interface SystemAuthenticator

Parameters:

operation - code to execute