com.haulmont.cuba.core.sys

Class AppContext

java.lang.Object

com.haulmont.cuba.core.sys.AppContext

public class AppContext
extends java.lang.Object

System-level class with static methods providing access to some central application structures:

• Spring's ApplicationContext
• Application properties which were set in app.properties files
• Current thread's SecurityContext

It also allows to register listeners which are triggered on the application start/stop, and provides the method isStarted() to check whether the app is fully initialized at the moment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppContext.Internals INTERNAL.
static interface	AppContext.Listener Application startup/shutdown listener.
static interface	AppContext.SecuredOperation<T>

Field Summary

Fields

Modifier and Type	Field and Description
static SecurityContext	NO_USER_CONTEXT

Constructor Summary

Constructors

Constructor and Description
AppContext()

Method Summary

Modifier and Type	Method and Description
static void	addListener(AppContext.Listener listener) Register an application start/stop listener.
static AppComponents	getAppComponents()
static org.springframework.context.ApplicationContext	getApplicationContext() INTERNAL.
static java.lang.String	getProperty(java.lang.String key) Get property value defined in the set of app.properties files.
static java.lang.String[]	getPropertyNames()
static SecurityContext	getSecurityContext()
static SecurityContext	getSecurityContextNN()
static boolean	isReady()
static boolean	isStarted()
static void	setProperty(java.lang.String key, java.lang.String value) Set property value.
static void	setSecurityContext(SecurityContext securityContext) Set current thread's SecurityContext.
static <T> T	withSecurityContext(SecurityContext securityContext, AppContext.SecuredOperation<T> operation) Sets current thread's SecurityContext, calls operation and sets previous security context back.
static void	withSecurityContext(SecurityContext securityContext, java.lang.Runnable runnable) Sets current thread's SecurityContext, invokes runnable and sets previous security context back.

Methods inherited from class java.lang.Object

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

Field Detail

NO_USER_CONTEXT

public static final SecurityContext NO_USER_CONTEXT

Constructor Detail

AppContext

public AppContext()

Method Detail

getApplicationContext

public static org.springframework.context.ApplicationContext getApplicationContext()

INTERNAL. Used by other framework classes to get access Spring's context.

getPropertyNames

public static java.lang.String[] getPropertyNames()

Returns:

all property names defined in the set of app.properties files

getProperty

@Nullable
public static java.lang.String getProperty(java.lang.String key)

Get property value defined in the set of app.properties files.

Parameters:

key - property key

Returns:

property value or null if the key is not found

setProperty

public static void setProperty(java.lang.String key,
                               @Nullable
                               java.lang.String value)

Set property value. The new value will be accessible at the runtime through getProperty(String) and getPropertyNames(), but will not be saved in any app.properties file and will be lost after the application restart.

Parameters:

key - property key

value - property value. If null, the property will be removed.

getSecurityContext

@Nullable
public static SecurityContext getSecurityContext()

Returns:

current thread's SecurityContext or null if there is no context bound

getSecurityContextNN

public static SecurityContext getSecurityContextNN()

Returns:

current thread's SecurityContext

Throws:

java.lang.SecurityException - if there is no context bound to the current thread

setSecurityContext

public static void setSecurityContext(@Nullable
                                      SecurityContext securityContext)

Set current thread's SecurityContext.

Parameters:

securityContext - security context to be set for the current thread

withSecurityContext

public static void withSecurityContext(SecurityContext securityContext,
                                       java.lang.Runnable runnable)

Sets current thread's SecurityContext, invokes runnable and sets previous security context back.

Parameters:

securityContext - security context to be set for the current thread

runnable - runnable

withSecurityContext

public static <T> T withSecurityContext(SecurityContext securityContext,
                                        AppContext.SecuredOperation<T> operation)

Sets current thread's SecurityContext, calls operation and sets previous security context back.

Parameters:

securityContext - security context to be set for the current thread

operation - operation

Returns:

result of operation

getAppComponents

public static AppComponents getAppComponents()

Returns:

app components holder instance

addListener

public static void addListener(AppContext.Listener listener)

Register an application start/stop listener.

Parameters:

listener - listener implementation

isStarted

public static boolean isStarted()

Returns:

true if the application context is initialized

isReady

public static boolean isReady()

Returns:

true if the application context is initialized and all AppContext.Listeners have been notified