ValueProviderGlobalContext (CONGA Generator 1.17.1-SNAPSHOT API)

java.lang.Object
- io.wcm.devops.conga.generator.spi.context.AbstractPluginContext<ValueProviderGlobalContext>
- - io.wcm.devops.conga.generator.spi.context.ValueProviderGlobalContext

public final class ValueProviderGlobalContext
extends AbstractPluginContext<ValueProviderGlobalContext>

Global context for all ValueProviderPlugin implementations.

Field Summary

Fields
Modifier and Type Field Description

static String PARAM_PLUGIN_NAME
Parameter name in value provider configuration to specify the value provider plugin name.

Constructor Summary

Constructors
Constructor Description

ValueProviderGlobalContext()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`getGlobalValueProviderCache()`	Get global cache map used by all value provider plugin implementations.
`Map<String,Map<String,Object>>`	`getValueProviderConfig()`
`Map<String,Object>`	`getValueProviderConfig(String valueProviderName)`

Methods inherited from class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
getContainerContext, getGenericPluginConfig, getLogger, getPluginContextOptions, getPluginManager, getUrlFileManager, pluginContextOptions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_PLUGIN_NAME
```
public static final String PARAM_PLUGIN_NAME
```
    Parameter name in value provider configuration to specify the value provider plugin name. If not defined, the value provider name itself is used as plugin name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ValueProviderGlobalContext
```
public ValueProviderGlobalContext()
```
- Method Detail
  - getValueProviderConfig
```
public Map<String,Map<String,Object>> getValueProviderConfig()
```
    Returns:
    
    Configuration for value providers. The outer map uses the value provider plugin name as key, the inner map contain the config properties. Never null.
  - getValueProviderConfig
```
public Map<String,Object> getValueProviderConfig(String valueProviderName)
```
    Parameters:
    
    valueProviderName - Value provider name
    
    Returns:
    
    Configuration for the given value provider. Never null.
  - getGlobalValueProviderCache
```
public Map<String,Object> getGlobalValueProviderCache()
```
    Get global cache map used by all value provider plugin implementations.
    
    Returns:
    
    Global cache map