sirius.web.security

Class ScopeInfo

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.web.security.ScopeInfo

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

public class ScopeInfo
extends sirius.kernel.di.transformers.Composable

Represents the scope the current call is being processed in.

The scope is determined using the installed ScopeDetector (Any class implementing the interface and wearing a Register annotation will do.)

The current scope is used to determine which UserManager is used. Therefore a system consisting of a backend and frontend can use distinct scopes and a different user manager for each.

Field Summary

Fields

Modifier and Type	Field and Description
static ScopeInfo	DEFAULT_SCOPE If no distinct scope is recognized by the current ScopeDetector or if no detector is installed, this scope is used.

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
ScopeInfo(String scopeId, String scopeType, String scopeName, String lang, Function<ScopeInfo,com.typesafe.config.Config> configSupplier, Function<ScopeInfo,Object> scopeSupplier) Creates a new ScopeInfo with the given parameters.

Method Summary

Modifier and Type	Method and Description
static String	getDefaulScopeConfigContents(String name) Returns the original contents of the given default config file.
static List<String>	getDefaultScopeConfigFiles() Lists the names of all loaded default config files.
<T> T	getHelper(Class<T> clazz) Retrieves the helper of the given type.
<T> T	getHelper(String name) Retrieves the helper of the given name.
String	getLang() Returns the two letter language code of this scope as understood by NLS.setDefaultLanguage(String).
static com.typesafe.config.Config	getScopeDefaultConfig() Returns the default config for all scopes.
String	getScopeId() Returns the unique ID of the scope
String	getScopeName() Returns the representative name of the scope
<T> T	getScopeObject(Class<T> clazz) Returns the associated scope object.
String	getScopeType() Returns the type of the scope.
UserSettings	getSettings() Returns the scope specific configuration.
UserManager	getUserManager() Returns the UserManager responsible for this scope.
boolean	is(Class<?> type)
<A> Optional<A>	tryAs(Class<A> adapterType)

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCOPE

public static final ScopeInfo DEFAULT_SCOPE

If no distinct scope is recognized by the current ScopeDetector or if no detector is installed, this scope is used.

Constructor Detail

ScopeInfo

public ScopeInfo(@Nonnull
                 String scopeId,
                 @Nonnull
                 String scopeType,
                 @Nonnull
                 String scopeName,
                 @Nullable
                 String lang,
                 @Nullable
                 Function<ScopeInfo,com.typesafe.config.Config> configSupplier,
                 @Nullable
                 Function<ScopeInfo,Object> scopeSupplier)

Creates a new ScopeInfo with the given parameters.

Parameters:

scopeId - the unique id of the scope

scopeType - the type of the scope (like "backend" or "frontend"). This is used to retrieve the associated UserManager from the system config.

scopeName - the representative name of the scope

lang - the language used by the scope or null for the default language

configSupplier - used to fetch the scope specific configuration

scopeSupplier - used to fetch the associated scope object. This can be a database entity or the like associated with the scope

Method Detail

getScopeId

@Nonnull
public String getScopeId()

Returns the unique ID of the scope

Returns:

the unique ID identifying the scope

getScopeType

@Nonnull
public String getScopeType()

Returns the type of the scope.

This is used to determine the associated UserManager from the system config using the key security.scopes.[type].manager.

Returns:

the type of the scope

getScopeName

@Nonnull
public String getScopeName()

Returns the representative name of the scope

Returns:

the representative (non-technical) name of the scope

getLang

@Nullable
public String getLang()

Returns the two letter language code of this scope as understood by NLS.setDefaultLanguage(String).

Returns:

the language code used by this scope or null if there is no specific language used

getScopeObject

public <T> T getScopeObject(Class<T> clazz)

Returns the associated scope object.

Can be used to fetch the data object or database entity which represents this scope.

Type Parameters:

T - determines the type of the expected scope object

Parameters:

clazz - the expected type of the scope object

Returns:

the associated scope object or null if no scope object can be determined or if the expected class did not match

is

public boolean is(@Nonnull
                  Class<?> type)

Specified by:

is in interface sirius.kernel.di.transformers.Transformable

Overrides:

is in class sirius.kernel.di.transformers.Composable

tryAs

public <A> Optional<A> tryAs(@Nonnull
                             Class<A> adapterType)

Specified by:

tryAs in interface sirius.kernel.di.transformers.Transformable

Overrides:

tryAs in class sirius.kernel.di.transformers.Composable

getHelper

public <T> T getHelper(Class<T> clazz)

Retrieves the helper of the given type.

Helpers are utility classes which are kept per ScopeInfo and created by HelperFactory instances.

Type Parameters:

T - the generic type of the helper

Parameters:

clazz - the type of the helper to fetch

Returns:

a cached or newly created instance of the helper for this scope.

getHelper

public <T> T getHelper(String name)

Retrieves the helper of the given name.

Helpers are utility classes which are kept per ScopeInfo and created by HelperFactory instances.

When using helpers in templates, it is better to refer to them via name than via class, as this stays constant when renaming or moving classes.

Type Parameters:

T - the generic type of the helper

Parameters:

name - the name of the helper to fetch

Returns:

a cached or newly created instance of the helper for this scope.

getDefaultScopeConfigFiles

public static List<String> getDefaultScopeConfigFiles()

Lists the names of all loaded default config files.

This and getDefaulScopeConfigContents(String) can be used to output the default configuration for users which customizes the scope configuration.

Returns:

the names of all known default config files.

getDefaulScopeConfigContents

public static String getDefaulScopeConfigContents(String name)

Returns the original contents of the given default config file.

Can be used to display the default config (with explaining comments) to the user which customizes the scope configuration.

Parameters:

name - the name of the config file to show

Returns:

the string contents of the config file

getScopeDefaultConfig

public static com.typesafe.config.Config getScopeDefaultConfig()

Returns the default config for all scopes.

This is built by loading all scope-*.conf files. Additionaly the scope-settings.conf for all active customizations are used as well (if present).

Returns:

the default config object shared by all scopes

getSettings

public UserSettings getSettings()

Returns the scope specific configuration.

Applications should consider using UserInfo.getSettings() or UserContext.getSettings() as this also includes user specific settings.

Returns:

the config the this scope

getUserManager

public UserManager getUserManager()

Returns the UserManager responsible for this scope.

Returns:

the user manager of this scope