com.haulmont.cuba.core.sys

Class SecurityContext

java.lang.Object

com.haulmont.cuba.core.sys.SecurityContext

Direct Known Subclasses:

PortalSecurityContext

public class SecurityContext
extends java.lang.Object

Holds information about the current user session.
Instances of this class are normally set in AppContext by the framework, but also have to be passed to it in case of manually running new threads. Here is the sample code for an asynchronous execution:

     final SecurityContext securityContext = AppContext.getSecurityContext();
     executor.submit(new Runnable() {
         public void run() {
             AppContext.setSecurityContext(securityContext);
             // business logic here
         }
     });
 

The same can be done using SecurityContextAwareRunnable or SecurityContextAwareCallable wrappers, for example:

     executor.submit(new SecurityContextAwareRunnable<>(() -> {
         // business logic here
     }));
 

or

     Future<String> future = executor.submit(new SecurityContextAwareCallable<>(() -> {
         // business logic here
         return some_string;
     }));
 

Constructor Summary

Constructors

Constructor and Description
SecurityContext(UserSession session)
SecurityContext(java.util.UUID sessionId)
SecurityContext(java.util.UUID sessionId, java.lang.String user)

Method Summary

Modifier and Type	Method and Description
UserSession	getSession()
java.util.UUID	getSessionId()
java.lang.String	getUser()
boolean	isAuthorizationRequired()
void	setAuthorizationRequired(boolean authorizationRequired) Whether the security check is required for standard mechanisms (DataManager in particular) on the middleware.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityContext

public SecurityContext(java.util.UUID sessionId)

SecurityContext

public SecurityContext(java.util.UUID sessionId,
                       java.lang.String user)

SecurityContext

public SecurityContext(UserSession session)

Method Detail

getSessionId

public java.util.UUID getSessionId()

Returns:

Current UserSession ID. This is the only required value for the SecurityContext.

getSession

@Nullable
public UserSession getSession()

Returns:

current user session. Can be null, so don't rely on this method in application code - use UserSessionSource

getUser

@Nullable
public java.lang.String getUser()

Returns:

current user login. Can be null, so don't rely on this method in application code - use UserSessionSource

isAuthorizationRequired

public boolean isAuthorizationRequired()

Returns:

Whether the security check is required for standard mechanisms (DataManager in particular) on the middleware

setAuthorizationRequired

public void setAuthorizationRequired(boolean authorizationRequired)

Whether the security check is required for standard mechanisms (DataManager in particular) on the middleware. Example usage:

 boolean saved = AppContext.getSecurityContext().isAuthorizationRequired();
 AppContext.getSecurityContext().setAuthorizationRequired(true);
 try {
     // all calls to DataManager will apply security restrictions
 } finally {
     AppContext.getSecurityContext().setAuthorizationRequired(saved);
 }
 

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object