Package ru.vyarus.guicey.gsp.app

Class ServerPagesGlobalState

  • public class ServerPagesGlobalState
extends java.lang.Object
    Global configuration object shared by all server page bundles. Contains configuration for global views creation. Object used internally by ServerPagesBundle.
    Since:
    06.12.2018

    • Constructor Detail

      • ServerPagesGlobalState

        public ServerPagesGlobalState()

    • Method Detail

      • register

        public void register​(ServerPagesApp app)
        Register application globally.
        Parameters:
        app - server pages application

      • getApps

        public java.util.List<ServerPagesApp> getApps()
        Returns:
        list of created server page applications

      • getRenderers

        public java.util.List<io.dropwizard.views.common.ViewRenderer> getRenderers()
        Returns:
        view renderers to use (for global views configuration)

      • getViewsConfig

        public java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> getViewsConfig()
        Returns:
        final views configuration or null if not yet initialized

      • viewsConfig

        public java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> viewsConfig​(java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> viewsConfig)
        Parameters:
        viewsConfig - final views config
        Returns:
        provided view config

      • addRenderers

        public void addRenderers​(io.dropwizard.views.common.ViewRenderer... renderers)
        Specifies additional template engines support (main engines are resolved with lookup). Duplicates are removed automatically.
        Parameters:
        renderers - additional view renderers

      • getConfigurable

        public io.dropwizard.views.common.ViewConfigurable<io.dropwizard.core.Configuration> getConfigurable()
        Returns:
        dropwizard views configuration binding to use (for global views configuration)

      • setConfigurable

        public <T extends io.dropwizard.core.Configuration> void setConfigurable​(io.dropwizard.views.common.ViewConfigurable<T> configurable)
        Specifies global views configuration binding (usually from application configuration object). Could be configured only by one bundle in order to simplify configuration.
        Type Parameters:
        T - configuration type
        Parameters:
        configurable - dropwizard views configuration binding

      • addConfigModifier

        public void addConfigModifier​(java.lang.String name,
                              ViewRendererConfigurationModifier modifier)
        Parameters:
        name - view renderer name to apply to
        modifier - modifier for exact renderer config

      • getConfigModifiers

        public com.google.common.collect.Multimap<java.lang.String,​ViewRendererConfigurationModifier> getConfigModifiers()
        Returns:
        modifiers for global views configuration

      • isPrintConfiguration

        public boolean isPrintConfiguration()
        Returns:
        true to log global views config (to see how it was modified), false to not log

      • printConfiguration

        public void printConfiguration()
        Enable global views configuration logging to console.

      • lock

        public void lock()
        Called after dropwizard views initialization to prevent configuration after initialization.

      • isLocked

        public boolean isLocked()
        Returns:
        true if global configuration locked, false otherwise

      • extendApp

        public void extendApp​(ExtendedConfiguration ext)
        Register, possibly delayed, application configuration.
        Parameters:
        ext - application extensions configuration

      • applyDelayedExtensions

        public void applyDelayedExtensions​(ru.vyarus.dropwizard.guice.module.installer.bundle.GuiceyEnvironment environment)
        Apply all configured extensions. Must be called just before applications initialization (the latest moment).
        Parameters:
        environment - environment

      • getAssetExtensions

        public AssetSources getAssetExtensions​(java.lang.String app)
        Parameters:
        app - application name
        Returns:
        registered asset extensions

      • getViewExtensions

        public ViewRestSources getViewExtensions​(java.lang.String app)
        Parameters:
        app - application name
        Returns:
        registered asset extensions