sirius.web.security

Interface HelperFactory<H>

Type Parameters:

H - the type of helpers created by this factory

All Superinterfaces:

sirius.kernel.di.std.Priorized

public interface HelperFactory<H>
extends sirius.kernel.di.std.Priorized

Helpers are used by the ScopeInfo to perform certain tasks.

Note that a helper is created once per scope and not per user or request. Everything that is specific to the user or request has the be in the request itself or the session.

Variables can be annotated using HelperConfig and will be automatically filled with the value set in the scope config. HOWEVER: Note that user specific overwrites of this config value cannot be applied. These values have to be fetched using UserContext.getSettings().

Field Summary

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
Class<H>	getHelperType() Returns the type of helpers produced by this factory.
String	getName() Returns a short and descriptive name which can be used to fetch the helper in templates.
default int	getPriority()
H	make(ScopeInfo scope) Creates a new helper for the given scope.

Method Detail

getPriority

default int getPriority()

Specified by:

getPriority in interface sirius.kernel.di.std.Priorized

getHelperType

@Nonnull
Class<H> getHelperType()

Returns the type of helpers produced by this factory.

Returns:

the class of helpers produced by this factory

getName

@Nonnull
String getName()

Returns a short and descriptive name which can be used to fetch the helper in templates.

We prefer using names over class names in templates as this make refactorings way easier.

Returns:

the unique name used to fetch the helper in a template

make

@Nonnull
H make(@Nonnull
                ScopeInfo scope)

Creates a new helper for the given scope.

Parameters:

scope - the scope for which this helper is created

Returns:

a new instance of the helper class for the given scope