com.haulmont.cuba.security.app

Class Authentication

java.lang.Object

com.haulmont.cuba.security.app.Authentication

@Component(value="cuba_Authentication")
public class Authentication
extends java.lang.Object

Bean that provides authentication to an arbitrary code on the Middleware.
Authentication is required if the code doesn't belong to a normal user request handling, which is the case for invocation by schedulers or JMX tools, other than Web Client's JMX-console.
Example usage:

     authentication.begin();
     try {
         // valid current thread's user session presents here
     } finally {
         authentication.end();
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Authentication.AuthenticatedOperation<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationManager	authenticationManager
protected java.lang.ThreadLocal<java.lang.Integer>	cleanupCounter
static java.lang.String	NAME
protected ServerConfig	serverConfig
protected java.util.Map<java.lang.String,java.util.UUID>	sessions
protected UserSessionsAPI	userSessions

Constructor Summary

Constructors

Constructor and Description
Authentication()

Method Summary

Modifier and Type	Method and Description
UserSession	begin() Authenticate with login set in cuba.jmxUserLogin app property.
UserSession	begin(java.lang.String login) Begin an authenticated code block.
void	end() End of an authenticated code block.
protected java.lang.String	getSystemLogin()
<T> T	withSystemUser(Authentication.AuthenticatedOperation<T> operation) Execute code on behalf of the user with login set in cuba.jmxUserLogin app property.
<T> T	withUser(java.lang.String login, Authentication.AuthenticatedOperation<T> operation) Execute code on behalf of the specified user.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

authenticationManager

@Inject
protected AuthenticationManager authenticationManager

userSessions

@Inject
protected UserSessionsAPI userSessions

serverConfig

@Inject
protected ServerConfig serverConfig

cleanupCounter

protected java.lang.ThreadLocal<java.lang.Integer> cleanupCounter

sessions

protected java.util.Map<java.lang.String,java.util.UUID> sessions

Constructor Detail

Authentication

public Authentication()

Method Detail

begin

public UserSession begin(@Nullable
                         java.lang.String login)

Begin an authenticated code block.
If a valid current thread session exists, does nothing. Otherwise sets the current thread session, logging in if necessary.
Subsequent end() method must be called in "finally" section.

Parameters:

login - user login. If null, a value of cuba.jmxUserLogin app property is used.

Returns:

new or cached instance of system user session

begin

public UserSession begin()

Authenticate with login set in cuba.jmxUserLogin app property.
Same as begin(String) with null parameter

end

public void end()

End of an authenticated code block.
Performs cleanup for SecurityContext if there was previous loginOnce in this thread. Must be called in "finally" section of a try/finally block.

withUser

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

Execute code on behalf of the specified user.

Parameters:

login - user login. If null, a value of cuba.jmxUserLogin app property is used.

operation - code to execute

Returns:

result of the execution

withSystemUser

public <T> T withSystemUser(Authentication.AuthenticatedOperation<T> operation)

Execute code on behalf of the user with login set in cuba.jmxUserLogin app property.

Parameters:

operation - code to execute

Returns:

result of the execution

getSystemLogin

protected java.lang.String getSystemLogin()