ru.vyarus.guicey.gsp.app

Class GlobalConfig

java.lang.Object

ru.vyarus.guicey.gsp.app.GlobalConfig

public class GlobalConfig
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 Summary

Constructors

Constructor and Description
GlobalConfig()

Method Summary

Modifier and Type	Method and Description
void	addConfigModifier(java.lang.String name, ViewRendererConfigurationModifier modifier)
void	addRenderers(io.dropwizard.views.ViewRenderer... renderers) Specifies additional template engines support (main engines are resolved with lookup).
void	extendAssets(java.lang.String app, AssetSources sources) Register application resources extension.
void	extendViews(java.lang.String app, ViewRestSources sources)
java.util.List<ServerPagesApp>	getApps()
AssetSources	getAssetExtensions(java.lang.String app)
com.google.common.collect.Multimap<java.lang.String,ViewRendererConfigurationModifier>	getConfigModifiers()
io.dropwizard.views.ViewConfigurable<io.dropwizard.Configuration>	getConfigurable()
java.util.List<io.dropwizard.views.ViewRenderer>	getRenderers()
ViewRestSources	getViewExtensions(java.lang.String app)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getViewsConfig()
boolean	isLocked()
boolean	isPrintConfiguration()
void	lock() Called after dropwizard views initialization to prevent configuration after initialization.
void	printConfiguration() Enable global views configuration logging to console.
void	register(ServerPagesApp app) Register application globally.
<T extends io.dropwizard.Configuration> void	setConfigurable(io.dropwizard.views.ViewConfigurable<T> configurable) Specifies global views configuration binding (usually from application configuration object).
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalConfig

public GlobalConfig()

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.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.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.ViewConfigurable<io.dropwizard.Configuration> getConfigurable()

Returns:

dropwizard views configuration binding to use (for global views configuration)

setConfigurable

public <T extends io.dropwizard.Configuration> void setConfigurable(io.dropwizard.views.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

extendAssets

public void extendAssets(java.lang.String app,
                         AssetSources sources)

Register application resources extension.

Parameters:

app - application name to apply new resources to

sources - additional asset sources

extendViews

public void extendViews(java.lang.String app,
                        ViewRestSources sources)

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