A B C D E F G H I J L M N O P R S T U V W X Y
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractConfigurable - Class in io.wcm.devops.conga.model.shared
-
Abstract
Configurable
implementation. - AbstractConfigurable() - Constructor for class io.wcm.devops.conga.model.shared.AbstractConfigurable
- AbstractFileHeader - Class in io.wcm.devops.conga.generator.plugins.fileheader
-
Generic file header plugin implementation.
- AbstractFileHeader() - Constructor for class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- AbstractModel - Class in io.wcm.devops.conga.model.shared
-
Abstract model implementation.
- AbstractModel() - Constructor for class io.wcm.devops.conga.model.shared.AbstractModel
- AbstractModelReader<T> - Class in io.wcm.devops.conga.model.reader
-
Shared functionality for model readers.
- AbstractModelReader(Yaml) - Constructor for class io.wcm.devops.conga.model.reader.AbstractModelReader
- AbstractPluginContext<T> - Class in io.wcm.devops.conga.generator.spi.context
-
Generic plugin context.
- AbstractPluginContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- AbstractPostProcessor - Class in io.wcm.devops.conga.generator.plugins.postprocessor
-
Shared functionality for post processor plugins.
- AbstractPostProcessor() - Constructor for class io.wcm.devops.conga.generator.plugins.postprocessor.AbstractPostProcessor
- accepts(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.ConfFileHeader
- accepts(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
- accepts(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.NoneFileHeader
- accepts(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
- accepts(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
- accepts(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.XmlFileHeader
- accepts(FileContext, ValidatorContext) - Method in class io.wcm.devops.conga.generator.plugins.validator.JsonValidator
- accepts(FileContext, ValidatorContext) - Method in class io.wcm.devops.conga.generator.plugins.validator.NoneValidator
- accepts(FileContext, ValidatorContext) - Method in class io.wcm.devops.conga.generator.plugins.validator.XmlValidator
- accepts(FileContext, T) - Method in interface io.wcm.devops.conga.generator.spi.FilePlugin
-
Checks if the plugin can be applied to the given file.
- accepts(Resource) - Method in class io.wcm.devops.conga.model.reader.AbstractModelReader
- accepts(Resource) - Method in interface io.wcm.devops.conga.model.reader.ModelReader
-
Checks if the given file is accepted by this reader.
- accepts(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.ClasspathUrlFilePlugin
- accepts(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
- accepts(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.HttpUrlFilePlugin
- accepts(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Checks if the plugin can be applied to the given URL.
- accepts(String, EscapingStrategyContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.JsonEscapingStrategy
- accepts(String, EscapingStrategyContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.NoneEscapingStrategy
- accepts(String, EscapingStrategyContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.XmlEscapingStrategy
- accepts(String, EscapingStrategyContext) - Method in interface io.wcm.devops.conga.generator.spi.handlebars.EscapingStrategyPlugin
-
Checks if the plugin can be applied to files with the given file extension.
- addRole(String, List<String>, Map<String, Object>) - Method in class io.wcm.devops.conga.generator.export.NodeModelExport
-
Add role information
- ALWAYS - io.wcm.devops.conga.generator.spi.ImplicitApplyOptions
-
Plugin is always applied to all accepted contexts.
- apply(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- apply(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.NoneFileHeader
- apply(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.XmlFileHeader
- apply(FileContext, FileHeaderContext) - Method in interface io.wcm.devops.conga.generator.spi.FileHeaderPlugin
-
Applies the comment file header.
- apply(FileContext, PostProcessorContext) - Method in interface io.wcm.devops.conga.generator.spi.PostProcessorPlugin
-
Applies the post processing.
- apply(FileContext, ValidatorContext) - Method in class io.wcm.devops.conga.generator.plugins.validator.JsonValidator
- apply(FileContext, ValidatorContext) - Method in class io.wcm.devops.conga.generator.plugins.validator.NoneValidator
- apply(FileContext, ValidatorContext) - Method in class io.wcm.devops.conga.generator.plugins.validator.XmlValidator
- apply(FileContext, ValidatorContext) - Method in interface io.wcm.devops.conga.generator.spi.ValidatorPlugin
-
Validates the given file
- apply(FileContext, T) - Method in interface io.wcm.devops.conga.generator.spi.FilePlugin
-
Applies the plugin operation.
- apply(Object, Options, HelperContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.ContainsHelper
- apply(Object, Options, HelperContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.DisallowPropertyHelper
- apply(Object, Options, HelperContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.EnsurePropertiesHelper
- apply(Object, Options, HelperContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfEqualsHelper
- apply(Object, Options, HelperContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfNotEqualsHelper
- apply(Object, Options, HelperContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.RegexQuoteHelper
- apply(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.util.ModelExportConfigProcessor
-
Apply processor.
- apply(T, Options, HelperContext) - Method in interface io.wcm.devops.conga.generator.spi.handlebars.HelperPlugin
-
Apply the helper to the context.
- applyFileHeader(FileContext, FileHeaderContext, PostProcessorContext) - Method in class io.wcm.devops.conga.generator.plugins.postprocessor.AbstractPostProcessor
-
Apply file header to given file.
B
- baseDir(File) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- baseDir(File) - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- baseNodeDir(File) - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- buildCurrentContextVariables(Node, NodeRole) - Static method in class io.wcm.devops.conga.generator.ContextPropertiesBuilder
-
Build context variables specific for a node and role/variant.
- buildEnvironmentContextVariables(String, Environment, String, VariableObjectTreeResolver, VariableStringResolver) - Static method in class io.wcm.devops.conga.generator.ContextPropertiesBuilder
-
Build context variables that are global to the environment.
C
- charset(String) - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- charset(Charset) - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- CharsetAwareTemplateLoader - Class in io.wcm.devops.conga.generator.handlebars
-
Charset-aware template-loader for handlebars.
- CharsetAwareTemplateLoader(List<ResourceCollection>, String) - Constructor for class io.wcm.devops.conga.generator.handlebars.CharsetAwareTemplateLoader
- CLASSPATH_ENVIRONMENTS_DIR - Static variable in class io.wcm.devops.conga.generator.GeneratorOptions
-
Classpath directory in JAR file for roles
- CLASSPATH_PREFIX - Static variable in class io.wcm.devops.conga.generator.GeneratorOptions
-
Prefix for all CONGA resources in classpath.
- CLASSPATH_PREFIX - Static variable in class io.wcm.devops.conga.resource.ResourceLoader
-
Path prefix for explicitly referencing a classpath resource.
- CLASSPATH_ROLES_DIR - Static variable in class io.wcm.devops.conga.generator.GeneratorOptions
-
Classpath directory in JAR file for roles
- CLASSPATH_TEMPLATES_DIR - Static variable in class io.wcm.devops.conga.generator.GeneratorOptions
-
Classpath directory in JAR file for roles
- ClasspathUrlFilePlugin - Class in io.wcm.devops.conga.generator.plugins.urlfile
-
Copy file from classpath.
- ClasspathUrlFilePlugin() - Constructor for class io.wcm.devops.conga.generator.plugins.urlfile.ClasspathUrlFilePlugin
- commentLines(List<String>) - Method in class io.wcm.devops.conga.generator.spi.context.FileHeaderContext
- ConfFileHeader - Class in io.wcm.devops.conga.generator.plugins.fileheader
-
Adds file headers to .conf files (e.g. for Apache config files).
- ConfFileHeader() - Constructor for class io.wcm.devops.conga.generator.plugins.fileheader.ConfFileHeader
- config(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- config(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- config(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleTenantData
- config(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- ConfigInheritanceResolver - Class in io.wcm.devops.conga.generator.util
-
Iterates over all
Configurable
items in the object tree. - Configurable - Interface in io.wcm.devops.conga.model.shared
-
Configurable definition.
- containerClasspathUrls(List<URL>) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- containerContext(Object) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- containerContext(Object) - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- containerVersionInfo(Map<String, String>) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- containerVersionInfo(Map<String, String>) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- ContainsHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that checks the existence of a value in an array or list.
- ContainsHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.ContainsHelper
- ContextProperties - Class in io.wcm.devops.conga.generator
-
Default configuration property names implicitly set by the configuration generator.
- ContextPropertiesBuilder - Class in io.wcm.devops.conga.generator
-
Builds context variables
- convertTo(String, LineEndings) - Static method in class io.wcm.devops.conga.generator.util.LineEndingConverter
-
Converts all unix line endings to the given line ending style.
- createLoaderOptions() - Static method in class io.wcm.devops.conga.model.util.YamlUtil
-
Create a new loader options instances with default configuration.
D
- deepClone(T) - Static method in class io.wcm.devops.conga.generator.util.ObjectCloner
-
Deep clones an object.
- deescape(String) - Method in class io.wcm.devops.conga.generator.util.VariableStringResolver
-
De-escapes all escaped variables in the given string.
- deescape(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.util.VariableMapResolver
-
De-escapes all escaped variables in all string values in the given map.
- defaultEmptyList(List<T>) - Static method in class io.wcm.devops.conga.model.util.DefaultUtil
-
Returns the given list, or an empty (modifiable) list if given null.
- defaultEmptyMap(Map<K, V>) - Static method in class io.wcm.devops.conga.model.util.DefaultUtil
-
Returns the given map, or an empty (modifiable) map if given null.
- DefaultUtil - Class in io.wcm.devops.conga.model.util
-
Helper methods for defaulting for fallback values if a given value is null.
- deleteBeforeGenerate(boolean) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- deleteFile(String) - Method in class io.wcm.devops.conga.generator.UrlFileManager
-
Delete file with given URL.
- deleteFile(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
- deleteFile(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Delete file with given URL.
- dependencyVersionBuilder(Function<Environment, Collection<String>>) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- destDir(File) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- DisallowPropertyHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that ensures a given property is not set/present.
- DisallowPropertyHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.DisallowPropertyHelper
E
- EachIfEqualsHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that extends the each helper by iterating only on list items that have a specified property set to a specific value.
- EachIfEqualsHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.EachIfEqualsHelper
-
Constructor
- EachIfHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that extends the each helper by iterating only on list items that have a specified property set.
- EachIfHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.EachIfHelper
-
Constructor
- encrypt(String, Object, ValueEncryptionContext) - Method in interface io.wcm.devops.conga.generator.spi.ValueEncryptionPlugin
-
Encrypt value.
- ensureDirExistsAutocreate(File) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Ensure that directory exists and create it if not.
- ensureFileExists(File) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Ensure that file exists.
- EnsurePropertiesHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that checks if all given property names have a value set.
- EnsurePropertiesHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.EnsurePropertiesHelper
- environment(Environment) - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- environment(Environment) - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- environment(Environment) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- Environment - Class in io.wcm.devops.conga.model.environment
-
Defines an environment with a set of nodes and configuration.
- Environment() - Constructor for class io.wcm.devops.conga.model.environment.Environment
- ENVIRONMENT - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Environment name
- environmentDir(File) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- EnvironmentExpander - Class in io.wcm.devops.conga.generator.util
-
Expands configuration nodes in environment.
- EnvironmentReader - Class in io.wcm.devops.conga.model.reader
-
Reads environment definitions.
- EnvironmentReader() - Constructor for class io.wcm.devops.conga.model.reader.EnvironmentReader
-
Constructor
- escape(CharSequence, EscapingStrategyContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.JsonEscapingStrategy
- escape(CharSequence, EscapingStrategyContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.NoneEscapingStrategy
- escape(CharSequence, EscapingStrategyContext) - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.XmlEscapingStrategy
- escape(CharSequence, EscapingStrategyContext) - Method in interface io.wcm.devops.conga.generator.spi.handlebars.EscapingStrategyPlugin
-
Escape the
CharSequence
. - EscapingStrategyContext - Class in io.wcm.devops.conga.generator.spi.handlebars.context
-
Context for
ValidatorPlugin
. - EscapingStrategyContext() - Constructor for class io.wcm.devops.conga.generator.spi.handlebars.context.EscapingStrategyContext
- EscapingStrategyPlugin - Interface in io.wcm.devops.conga.generator.spi.handlebars
-
Plugin that provides an
EscapingStrategy
to be used by Handlebars when replacing variables in a template. - exists() - Method in interface io.wcm.devops.conga.resource.ResourceInfo
- expand(Map<String, Object>) - Static method in class io.wcm.devops.conga.model.util.MapExpander
-
Expands shortcut keys
- expandNodes(Environment, String) - Static method in class io.wcm.devops.conga.generator.util.EnvironmentExpander
-
Environment definitions allows definition of nodes with multiple node names.
- export(NodeModelExportContext) - Method in class io.wcm.devops.conga.generator.plugins.export.NoneNodeModelExport
- export(NodeModelExportContext) - Method in class io.wcm.devops.conga.generator.plugins.export.YamlNodeModelExport
- export(NodeModelExportContext) - Method in interface io.wcm.devops.conga.generator.spi.export.NodeModelExportPlugin
-
Export model information.
- ExportNodeRoleData - Class in io.wcm.devops.conga.generator.spi.export.context
-
Export role data for node.
- ExportNodeRoleData() - Constructor for class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- ExportNodeRoleTenantData - Class in io.wcm.devops.conga.generator.spi.export.context
-
Export tenant data for node.
- ExportNodeRoleTenantData() - Constructor for class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleTenantData
- extract(FileContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.ConfFileHeader
- extract(FileContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
- extract(FileContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
- extract(FileContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
- extract(FileContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.XmlFileHeader
- extract(FileContext) - Method in interface io.wcm.devops.conga.generator.spi.FileHeaderPlugin
-
Extract comment lines from file header.
- extractFileHeader(FileContext, PostProcessorContext) - Method in class io.wcm.devops.conga.generator.plugins.postprocessor.AbstractPostProcessor
-
Extract file header from given file.
- extractFileHeaderBetweenBlockStartEnd(FileContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
-
Extract file header from the beginning of file between comment block start and end symbol.
- extractFileHeaderWithLinePrefixes(FileContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
-
Extract file header from the beginning of file with all lines starting with line prefix.
F
- file(File) - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- FILE_PREFIX - Static variable in class io.wcm.devops.conga.resource.ResourceLoader
-
Path prefix for explicitly referencing a file.
- fileContext(FileContext) - Method in class io.wcm.devops.conga.generator.spi.export.context.GeneratedFileContext
- FileContext - Class in io.wcm.devops.conga.generator.spi.context
-
File context for plugins.
- FileContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.FileContext
- FileHeaderContext - Class in io.wcm.devops.conga.generator.spi.context
-
Context for
FileHeaderPlugin
. - FileHeaderContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.FileHeaderContext
- FileHeaderPlugin - Interface in io.wcm.devops.conga.generator.spi
-
Plugin that generates a file header comment with info that the file was automatically generated and further info like a timestamp.
- FilePlugin<T,R> - Interface in io.wcm.devops.conga.generator.spi
-
Generic plugin interface all other plugins extend from that are called for a generated file.
- files(List<GeneratedFileContext>) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- FilesystemUrlFilePlugin - Class in io.wcm.devops.conga.generator.plugins.urlfile
-
Get file from local filesystem.
- FilesystemUrlFilePlugin() - Constructor for class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
- FileUtil - Class in io.wcm.devops.conga.generator.util
-
Utility methods for file handling.
G
- generate() - Method in class io.wcm.devops.conga.generator.export.NodeModelExport
-
Generate model YAML file.
- generate(String[]) - Method in class io.wcm.devops.conga.generator.Generator
-
Generate files for environment(s).
- generate(String[], String[]) - Method in class io.wcm.devops.conga.generator.Generator
-
Generate files for environment(s).
- GeneratedFileContext - Class in io.wcm.devops.conga.generator.spi.export.context
-
Contains information about a generated file.
- GeneratedFileContext() - Constructor for class io.wcm.devops.conga.generator.spi.export.context.GeneratedFileContext
- Generator - Class in io.wcm.devops.conga.generator
-
Main entry point for CONGA generator.
- Generator(GeneratorOptions) - Constructor for class io.wcm.devops.conga.generator.Generator
- GeneratorException - Exception in io.wcm.devops.conga.generator
-
Exception in generation process.
- GeneratorException(String) - Constructor for exception io.wcm.devops.conga.generator.GeneratorException
- GeneratorException(String, Throwable) - Constructor for exception io.wcm.devops.conga.generator.GeneratorException
- GeneratorOptions - Class in io.wcm.devops.conga.generator
-
Options for generator.
- GeneratorOptions() - Constructor for class io.wcm.devops.conga.generator.GeneratorOptions
- genericPluginConfig(Map<String, Map<String, Object>>) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- genericPluginConfig(Map<String, Map<String, Object>>) - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- get(String, Class<T>) - Method in interface io.wcm.devops.conga.generator.util.PluginManager
-
Get plugin instance.
- get(String, Class<T>) - Method in class io.wcm.devops.conga.generator.util.PluginManagerImpl
-
Get plugin instance.
- get(String, String) - Method in class io.wcm.devops.conga.generator.handlebars.HandlebarsManager
-
Get handlebars instance with escaping for file extension and charset.
- getAggregatedVariants() - Method in class io.wcm.devops.conga.model.environment.NodeRole
-
Get list of defined variants, regardless if the 'variant' or 'variants' parameter was used.
- getAll(Class<T>) - Method in interface io.wcm.devops.conga.generator.util.PluginManager
-
Get all plugin instance.
- getAll(Class<T>) - Method in class io.wcm.devops.conga.generator.util.PluginManagerImpl
-
Get all plugin instance.
- getBaseDir() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getBaseDir() - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- getBlockSuffix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- getBlockSuffix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.ConfFileHeader
- getBlockSuffix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
- getBlockSuffix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
- getCanonicalPath() - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- getCanonicalPath() - Method in interface io.wcm.devops.conga.resource.ResourceInfo
- getCanonicalPath(FileContext) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Deprecated, for removal: This API element is subject to removal in a future version.use
FileContext.getCanonicalPath()
instead. - getCanonicalPath(File) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Get canoncial path of file
- getCharset() - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- getCharset() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines a charset to be used for the generated file.
- getCommentBlockEnd() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- getCommentBlockEnd() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
- getCommentBlockStart() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- getCommentBlockStart() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
- getCommentLinePrefix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- getCommentLinePrefix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.ConfFileHeader
- getCommentLinePrefix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
- getCommentLinePrefix() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
- getCommentLines() - Method in class io.wcm.devops.conga.generator.spi.context.FileHeaderContext
- getCondition() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines a condition whether the file should be generated or not.
- getConfig() - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- getConfig() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- getConfig() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleTenantData
- getConfig() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getConfig() - Method in class io.wcm.devops.conga.model.shared.AbstractConfigurable
-
Defines a map of configuration parameters.
- getConfig() - Method in interface io.wcm.devops.conga.model.shared.Configurable
-
Defines a map of configuration parameters.
- getContainerClasspathUrls() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getContainerContext() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Container-specific context object
- getContainerContext() - Method in class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- getContainerContext() - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- getContainerVersionInfo() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getContainerVersionInfo() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getDeep(Map<String, Object>, String) - Static method in class io.wcm.devops.conga.model.util.MapExpander
-
Get object from map with "deep" access resolving dots in the key as nested map keys.
- getDependencies() - Method in class io.wcm.devops.conga.model.environment.Environment
-
Defines a list of file URLs pointing to JAR files with CONGA definitions that contain dependencies (e.g. roles) to be used in this environment.
- getDependencyVersionBuilder() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getDestDir() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Destination directory for generated file.
- getDir() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Sets the directory to generate or download the file in.
- getEmptyContextVariables() - Static method in class io.wcm.devops.conga.generator.ContextPropertiesBuilder
-
Get map with all context variables set to empty values.
- getEnvironment() - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- getEnvironment() - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- getEnvironment() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getEnvironmentDir() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Directory with environment definitions.
- getEscapingStrategy() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines an handlebars escaping strategy plugin to be used.
- getFile() - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- getFile() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines the file name of the generated or downloaded file.
- getFile(String) - Method in class io.wcm.devops.conga.generator.UrlFileManager
-
Get file binary data from URL.
- getFile(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.ClasspathUrlFilePlugin
- getFile(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
- getFile(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.HttpUrlFilePlugin
- getFile(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Get binary data of external file.
- getFileContext() - Method in class io.wcm.devops.conga.generator.spi.export.context.GeneratedFileContext
- getFileExtension() - Method in interface io.wcm.devops.conga.resource.Resource
- getFileHeader() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines the name of a file header plugin that should be applied to the generated file.
- getFileInfo(NodeRole, RoleFile) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Generates information to identify a file in a role definition by its file name or URL.
- getFileInfo(String, RoleFile) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Generates information to identify a file in a role definition by its file name or URL.
- getFileName(String) - Method in class io.wcm.devops.conga.generator.UrlFileManager
-
Get file name from URL.
- getFileName(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.ClasspathUrlFilePlugin
- getFileName(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
- getFileName(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.HttpUrlFilePlugin
- getFileName(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Get filename for external file.
- getFiles() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- getFiles() - Method in class io.wcm.devops.conga.model.role.Role
-
Defines the files that should be generated for this role.
- getFileUrl(String) - Method in class io.wcm.devops.conga.generator.UrlFileManager
-
Get URL to to binary file.
- getFileUrl(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.ClasspathUrlFilePlugin
- getFileUrl(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
- getFileUrl(String, UrlFilePluginContext) - Method in class io.wcm.devops.conga.generator.plugins.urlfile.HttpUrlFilePlugin
- getFileUrl(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Get URL to external file.
- getFileUrlsWithDependencies(String) - Method in class io.wcm.devops.conga.generator.UrlFileManager
-
Get URLs of transitive dependencies of external file.
- getFileUrlsWithDependencies(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Get URLs of transitive dependencies of external file.
- getGenericPluginConfig() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getGenericPluginConfig() - Method in class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- getGenericPluginConfig() - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- getGlobalValueProviderCache() - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderGlobalContext
-
Get global cache map used by all value provider plugin implementations.
- getInherits() - Method in class io.wcm.devops.conga.model.role.Role
-
Defines inheritance relations for this role.
- getInputStream() - Method in interface io.wcm.devops.conga.resource.Resource
- getInsertPosition(String) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- getInsertPosition(String) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
- getLastModified() - Method in interface io.wcm.devops.conga.resource.Resource
- getLineBreak() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- getLineBreak() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
- getLineEnding() - Method in enum io.wcm.devops.conga.model.shared.LineEndings
- getLineEndings() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines the line endings style for the generated files.
- getLocalFile(String) - Method in class io.wcm.devops.conga.generator.UrlFileManager
-
Get local file reference to given URL.
- getLocalFile(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Get local file reference to given URL.
- getLogger() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getLogger() - Method in class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- getLogger() - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- getMatching() - Method in class io.wcm.devops.conga.model.util.MapSplitter.SplitResult
- getModelExport() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Settings for exporting models to files.
- getModelExportConfigProcessor() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getModelOptions() - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- getModelOptions() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines additional options that are written to the exported model metadata for this file.
- getMultiply() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines a multiply plugin name to be used.
- getMultiplyOptions() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines configuration parameters that are passed as options to the multiply plugin.
- getName() - Method in class io.wcm.devops.conga.generator.plugins.export.NoneNodeModelExport
- getName() - Method in class io.wcm.devops.conga.generator.plugins.export.YamlNodeModelExport
- getName() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.ConfFileHeader
- getName() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
- getName() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.NoneFileHeader
- getName() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
- getName() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
- getName() - Method in class io.wcm.devops.conga.generator.plugins.fileheader.XmlFileHeader
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.JsonEscapingStrategy
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.NoneEscapingStrategy
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.XmlEscapingStrategy
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.ContainsHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.DisallowPropertyHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.EachIfEqualsHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.EachIfHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.EnsurePropertiesHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfEqualsHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfNotEqualsHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.handlebars.helper.RegexQuoteHelper
- getName() - Method in class io.wcm.devops.conga.generator.plugins.multiply.NoneMultiply
- getName() - Method in class io.wcm.devops.conga.generator.plugins.multiply.TenantMultiply
- getName() - Method in class io.wcm.devops.conga.generator.plugins.urlfile.ClasspathUrlFilePlugin
- getName() - Method in class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
- getName() - Method in class io.wcm.devops.conga.generator.plugins.urlfile.HttpUrlFilePlugin
- getName() - Method in class io.wcm.devops.conga.generator.plugins.validator.JsonValidator
- getName() - Method in class io.wcm.devops.conga.generator.plugins.validator.NoneValidator
- getName() - Method in class io.wcm.devops.conga.generator.plugins.validator.XmlValidator
- getName() - Method in class io.wcm.devops.conga.generator.plugins.valueprovider.SystemPropertyValueProviderPlugin
- getName() - Method in interface io.wcm.devops.conga.generator.spi.Plugin
- getName() - Method in interface io.wcm.devops.conga.resource.ResourceInfo
- getNode() - Method in class io.wcm.devops.conga.generator.export.ModelExport
-
Defines node export plugin names.
- getNode() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getNode() - Method in class io.wcm.devops.conga.model.environment.Node
-
Defines the node name.
- getNodeBaseDir() - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- getNodeDir() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getNodes() - Method in class io.wcm.devops.conga.model.environment.Environment
-
Defines nodes for the environment.
- getNodes() - Method in class io.wcm.devops.conga.model.environment.Node
-
Defines multiple node names.
- getOptions() - Method in class io.wcm.devops.conga.generator.spi.context.PostProcessorContext
- getOptions() - Method in class io.wcm.devops.conga.generator.spi.context.ValidatorContext
- getPath() - Method in interface io.wcm.devops.conga.resource.ResourceInfo
- getPluginConfig() - Method in class io.wcm.devops.conga.model.environment.Environment
-
Defines a map of configuration parameters for CONGA plugins.
- getPluginContextOptions() - Method in class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- getPluginManager() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getPluginManager() - Method in class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- getPluginManager() - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- getPostProcessorOptions() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines configuration parameters that are passed as options to the post processor plugins.
- getPostProcessors() - Method in class io.wcm.devops.conga.generator.spi.export.context.GeneratedFileContext
- getPostProcessors() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines a list of post processor plugin names that should be applied to the generated file.
- getResource(ResourceCollection, String) - Method in class io.wcm.devops.conga.resource.ResourceLoader
-
Get resource from filesystem (preferred) or classpath.
- getResource(String) - Method in interface io.wcm.devops.conga.resource.ResourceCollection
-
Get child resource.
- getResource(String) - Method in class io.wcm.devops.conga.resource.ResourceLoader
-
Get resource from filesystem (preferred) or classpath.
- getResourceClassLoader() - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- getResourceCollection(ResourceCollection, String) - Method in class io.wcm.devops.conga.resource.ResourceLoader
-
Get resource collection from filesystem (preferred) or classpath.
- getResourceCollection(String) - Method in interface io.wcm.devops.conga.resource.ResourceCollection
-
Get child resource collection.
- getResourceCollection(String) - Method in class io.wcm.devops.conga.resource.ResourceLoader
-
Get resource collection from filesystem (preferred) or classpath.
- getResourceCollections() - Method in interface io.wcm.devops.conga.resource.ResourceCollection
- getResources() - Method in interface io.wcm.devops.conga.resource.ResourceCollection
- getRole() - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- getRole() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- getRole() - Method in class io.wcm.devops.conga.model.environment.NodeRole
-
Defines the role name.
- getRole() - Method in class io.wcm.devops.conga.model.environment.RoleConfig
-
Defines role name.
- getRole() - Method in class io.wcm.devops.conga.model.role.RoleInherit
-
Defines the role name.
- getRoleConfig() - Method in class io.wcm.devops.conga.model.environment.Environment
-
Defines role-specific configuration.
- getRoleData() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getRoleDir() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Directory with role definitions.
- getRoleFile() - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- getRoles() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleTenantData
- getRoles() - Method in class io.wcm.devops.conga.model.environment.Node
-
Defines roles to be used by this node.
- getRoles() - Method in class io.wcm.devops.conga.model.environment.Tenant
-
Defines tenant roles.
- getRoleVariants() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- getSensitiveConfigParameters() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getSensitiveConfigParameters() - Method in class io.wcm.devops.conga.model.role.Role
-
List of configuration parameter names that contain sensitive data (like passwords) that should be encrypted on serialization e.g. in model export files.
- getSymlinkTarget() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Target path for symlink.
- getTargetDir() - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- getTemplate() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines the template name to be used to generate the file.
- getTemplateDir() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Template base directory
- getTemplateDir() - Method in class io.wcm.devops.conga.model.role.Role
-
Defines the directory where the role template files are located.
- getTemplatePath(Role, RoleFile) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Get template path for a role file.
- getTenant() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleTenantData
- getTenant() - Method in class io.wcm.devops.conga.model.environment.Tenant
-
Defines tenant name.
- getTenantData() - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- getTenants() - Method in class io.wcm.devops.conga.model.environment.Environment
-
Defines a list of tenants for configuration files that have tenant-specific system configurations.
- getUnmatching() - Method in class io.wcm.devops.conga.model.util.MapSplitter.SplitResult
- getUrl() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
URL to download file from.
- getUrlFileManager() - Method in class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- getUrlFileManager() - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- getValidatorOptions() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines configuration parameters that are passed as options to the validator plugins.
- getValidators() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines a list of validator plugin names that should be applied to the generated file.
- getValueProviderCache() - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderContext
-
Get cache object for the current value provider.
- getValueProviderConfig() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- getValueProviderConfig() - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- getValueProviderConfig() - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderGlobalContext
- getValueProviderConfig(String) - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderContext
- getValueProviderConfig(String) - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderGlobalContext
- getValueProviderName() - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderContext
- getVariableMapResolver() - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- getVariableMapResolver() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getVariableStringResolver() - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- getVariableStringResolver() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getVariant() - Method in class io.wcm.devops.conga.model.environment.NodeRole
-
Defines the role variant name.
- getVariant() - Method in class io.wcm.devops.conga.model.role.RoleFile.RoleFileVariantMetadata
- getVariant() - Method in class io.wcm.devops.conga.model.role.RoleVariant
-
Defines the variant name.
- getVariants() - Method in class io.wcm.devops.conga.model.environment.NodeRole
-
Defines multiple role variant names.
- getVariants() - Method in class io.wcm.devops.conga.model.role.Role
-
Defines the role variants available for this role.
- getVariants() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Defines the role variant names for which this file should be generated.
- getVariantsMetadata() - Method in class io.wcm.devops.conga.model.role.RoleFile
- getVersion() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
The main version of the environment definition.
- getYamlConstructor() - Method in class io.wcm.devops.conga.generator.spi.yaml.context.YamlConstructorContext
- getYamlRepresenter() - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- getYamlRepresenter() - Method in class io.wcm.devops.conga.generator.spi.yaml.context.YamlRepresentContext
H
- HandlebarsManager - Class in io.wcm.devops.conga.generator.handlebars
-
Manages charset-aware handlebars instances.
- HandlebarsManager(List<ResourceCollection>, PluginContextOptions) - Constructor for class io.wcm.devops.conga.generator.handlebars.HandlebarsManager
- hasValueProviderReference(String) - Static method in class io.wcm.devops.conga.generator.util.VariableStringResolver
-
Checks if the given string contains any reference to a variable from a value provider.
- HelperContext - Class in io.wcm.devops.conga.generator.spi.handlebars.context
-
Context for
ValidatorPlugin
. - HelperContext() - Constructor for class io.wcm.devops.conga.generator.spi.handlebars.context.HelperContext
- HelperPlugin<T> - Interface in io.wcm.devops.conga.generator.spi.handlebars
-
Plugin that allows to register custom Handlebars
Helper
extensions that can be used in all templates. - HttpUrlFilePlugin - Class in io.wcm.devops.conga.generator.plugins.urlfile
-
Download files from HTTP or HTTPS URL.
- HttpUrlFilePlugin() - Constructor for class io.wcm.devops.conga.generator.plugins.urlfile.HttpUrlFilePlugin
I
- IfEqualsHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that evaluates two objects for equality and shows/hides the contained block accordingly.
- IfEqualsHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfEqualsHelper
- IfNotEqualsHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that evaluates two objects for inequality and shows/hides the contained block accordingly.
- IfNotEqualsHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfNotEqualsHelper
- implicitApply(FileContext, FileHeaderContext) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.NoneFileHeader
- implicitApply(FileContext, FileHeaderContext) - Method in interface io.wcm.devops.conga.generator.spi.FileHeaderPlugin
-
Whether to apply this plugin implicitly.
- implicitApply(FileContext, PostProcessorContext) - Method in interface io.wcm.devops.conga.generator.spi.PostProcessorPlugin
-
Whether to apply this plugin implicitly.
- implicitApply(FileContext, ValidatorContext) - Method in class io.wcm.devops.conga.generator.plugins.validator.NoneValidator
- implicitApply(FileContext, ValidatorContext) - Method in interface io.wcm.devops.conga.generator.spi.ValidatorPlugin
-
Whether to apply this plugin implicitly.
- implicitApply(FileContext, T) - Method in interface io.wcm.devops.conga.generator.spi.FilePlugin
-
Whether to apply this plugin implicitly.
- ImplicitApplyOptions - Enum in io.wcm.devops.conga.generator.spi
-
Whether to apply a plugin implicitly.
- io.wcm.devops.conga.generator - package io.wcm.devops.conga.generator
-
CONGA environment and file generator.
- io.wcm.devops.conga.generator.export - package io.wcm.devops.conga.generator.export
-
CONGA model export for passing CONGA information to 3rdparty tools.
- io.wcm.devops.conga.generator.handlebars - package io.wcm.devops.conga.generator.handlebars
-
Manages and configures handlebar scripting engine.
- io.wcm.devops.conga.generator.plugins.export - package io.wcm.devops.conga.generator.plugins.export
-
CONGA model export plugins.
- io.wcm.devops.conga.generator.plugins.fileheader - package io.wcm.devops.conga.generator.plugins.fileheader
-
Built-in file header plugins.
- io.wcm.devops.conga.generator.plugins.handlebars.escaping - package io.wcm.devops.conga.generator.plugins.handlebars.escaping
-
Built-in handlebars escaping strategy plugins.
- io.wcm.devops.conga.generator.plugins.handlebars.helper - package io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Built-in handlebars helper plugins.
- io.wcm.devops.conga.generator.plugins.multiply - package io.wcm.devops.conga.generator.plugins.multiply
-
Built-in multiply plugins.
- io.wcm.devops.conga.generator.plugins.postprocessor - package io.wcm.devops.conga.generator.plugins.postprocessor
-
CONGA post processor plugins.
- io.wcm.devops.conga.generator.plugins.urlfile - package io.wcm.devops.conga.generator.plugins.urlfile
-
CONGA plugins for getting files from external sources.
- io.wcm.devops.conga.generator.plugins.validator - package io.wcm.devops.conga.generator.plugins.validator
-
Built-in validator plugins.
- io.wcm.devops.conga.generator.plugins.valueprovider - package io.wcm.devops.conga.generator.plugins.valueprovider
-
CONGA value provider plugins.
- io.wcm.devops.conga.generator.spi - package io.wcm.devops.conga.generator.spi
-
CONGA SPI with interfaces for the supported plugin types.
- io.wcm.devops.conga.generator.spi.context - package io.wcm.devops.conga.generator.spi.context
-
Context objects for CONGA SPI plugins.
- io.wcm.devops.conga.generator.spi.export - package io.wcm.devops.conga.generator.spi.export
-
CONGA Export SPI with interfaces for the supported plugin types.
- io.wcm.devops.conga.generator.spi.export.context - package io.wcm.devops.conga.generator.spi.export.context
-
Context objects for CONGA Export SPI plugins.
- io.wcm.devops.conga.generator.spi.handlebars - package io.wcm.devops.conga.generator.spi.handlebars
-
CONGA SPI with interfaces for the supported handlebars plugin types.
- io.wcm.devops.conga.generator.spi.handlebars.context - package io.wcm.devops.conga.generator.spi.handlebars.context
-
Context objects for CONGA SPI Handlebars plugins.
- io.wcm.devops.conga.generator.spi.yaml - package io.wcm.devops.conga.generator.spi.yaml
-
CONGA SPI for customizing Snake YAML file handling.
- io.wcm.devops.conga.generator.spi.yaml.context - package io.wcm.devops.conga.generator.spi.yaml.context
-
Context objects for CONGA YAML SPI plugins.
- io.wcm.devops.conga.generator.util - package io.wcm.devops.conga.generator.util
-
CONGA utilities.
- io.wcm.devops.conga.model.environment - package io.wcm.devops.conga.model.environment
-
Environment and node definition models.
- io.wcm.devops.conga.model.reader - package io.wcm.devops.conga.model.reader
-
Reader for model YAML files.
- io.wcm.devops.conga.model.role - package io.wcm.devops.conga.model.role
-
Role and file definition models.
- io.wcm.devops.conga.model.shared - package io.wcm.devops.conga.model.shared
-
Shared functionality for all model classes.
- io.wcm.devops.conga.model.util - package io.wcm.devops.conga.model.util
-
CONGA model utilities.
- io.wcm.devops.conga.resource - package io.wcm.devops.conga.resource
-
CONGA resource abstraction to read directories and files from either filesystem or classpath.
- isAllowSymlinks() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Is it allowed to create symlinks instead of copying files if they are local files.
- isDeleteBeforeGenerate() - Method in class io.wcm.devops.conga.generator.GeneratorOptions
-
Set to true when the generate should delete the environment folders before generating new (default: false).
- isDeleteSource() - Method in class io.wcm.devops.conga.model.role.RoleFile
-
Whether to delete the the source file that was copied with this file definition.
- isEnabled() - Method in interface io.wcm.devops.conga.generator.spi.ValueEncryptionPlugin
-
When a value needs to be encrypted, the first enabled encryption plugin is used.
- isLocalFile(String) - Method in class io.wcm.devops.conga.generator.UrlFileManager
-
Checks if the given file is a file from the local file system and can be safely referenced via symlink.
- isLocalFile(String, UrlFilePluginContext) - Method in interface io.wcm.devops.conga.generator.spi.UrlFilePlugin
-
Checks if the given file is a file from the local file system and can be safely referenced via symlink.
- isMandatory() - Method in class io.wcm.devops.conga.model.role.RoleFile.RoleFileVariantMetadata
J
- JsonEscapingStrategy - Class in io.wcm.devops.conga.generator.plugins.handlebars.escaping
-
Escapes for JSON files.
- JsonEscapingStrategy() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.escaping.JsonEscapingStrategy
- JsonFileHeader - Class in io.wcm.devops.conga.generator.plugins.fileheader
-
Adds file headers to JSON files.
- JsonFileHeader() - Constructor for class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
- JsonValidator - Class in io.wcm.devops.conga.generator.plugins.validator
-
Validates JSON syntax.
- JsonValidator() - Constructor for class io.wcm.devops.conga.generator.plugins.validator.JsonValidator
L
- LineEndingConverter - Class in io.wcm.devops.conga.generator.util
-
Utility methods for handling line endings in files.
- LineEndings - Enum in io.wcm.devops.conga.model.shared
-
Line endings for generated files.
- logger(Logger) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- logger(Logger) - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
M
- macos - io.wcm.devops.conga.model.shared.LineEndings
-
MacOS line ending (up to version 9)
- MapExpander - Class in io.wcm.devops.conga.model.util
-
Expands map with shortcut keys like {jvm.heapspace.max: 4096m} to {jvm: {heapspace: {max: 4096m}}}
- MapMerger - Class in io.wcm.devops.conga.model.util
-
Deep merges two maps.
- MapSplitter - Class in io.wcm.devops.conga.model.util
-
Splits up maps.
- MapSplitter.SplitResult - Class in io.wcm.devops.conga.model.util
-
Result of
MapSplitter.splitMap(Map, Predicate)
method. - matchesExtension(FileContext, String) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Checks file extension
- matchesExtension(File, String) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Checks file extension
- matchesExtension(String, String) - Static method in class io.wcm.devops.conga.generator.util.FileUtil
-
Checks file extension
- matchesRoleFile(RoleFile, List<String>) - Static method in class io.wcm.devops.conga.generator.util.RoleUtil
-
Checks if the given role file should be generated for the given set of variants.
- merge(Map<K, Object>, Map<K, Object>) - Static method in class io.wcm.devops.conga.model.util.MapMerger
-
Deep merges two maps.
- modelExport(ModelExport) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- ModelExport - Class in io.wcm.devops.conga.generator.export
-
Defines an export configuration for model information.
- ModelExport() - Constructor for class io.wcm.devops.conga.generator.export.ModelExport
- ModelExportConfigProcessor - Class in io.wcm.devops.conga.generator.util
-
Processes map of CONGA configuration parameters before serializing them in a model export file.
- ModelExportConfigProcessor(PluginContextOptions, Set<String>) - Constructor for class io.wcm.devops.conga.generator.util.ModelExportConfigProcessor
- modelOptions(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- ModelReader<T> - Interface in io.wcm.devops.conga.model.reader
-
Reads a model.
- multiply(MultiplyContext) - Method in class io.wcm.devops.conga.generator.plugins.multiply.NoneMultiply
- multiply(MultiplyContext) - Method in class io.wcm.devops.conga.generator.plugins.multiply.TenantMultiply
- multiply(MultiplyContext) - Method in interface io.wcm.devops.conga.generator.spi.MultiplyPlugin
-
Execute multiply operation.
- MULTIPLY_INDEX - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
File index (starting with 0) if a multiply plugin is used.
- MultiplyContext - Class in io.wcm.devops.conga.generator.spi.context
-
Context for
MultiplyPlugin
. - MultiplyContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- MultiplyPlugin - Interface in io.wcm.devops.conga.generator.spi
-
Plugin that allows to generate multiple files from one template.
N
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.export.NoneNodeModelExport
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.export.YamlNodeModelExport
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.fileheader.ConfFileHeader
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.fileheader.NoneFileHeader
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.fileheader.XmlFileHeader
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.JsonEscapingStrategy
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.NoneEscapingStrategy
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.escaping.XmlEscapingStrategy
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.ContainsHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.DisallowPropertyHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.EachIfEqualsHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.EachIfHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.EnsurePropertiesHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfEqualsHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.IfNotEqualsHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.handlebars.helper.RegexQuoteHelper
-
Plugin/Helper name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.multiply.NoneMultiply
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.multiply.TenantMultiply
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.urlfile.ClasspathUrlFilePlugin
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.urlfile.FilesystemUrlFilePlugin
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.urlfile.HttpUrlFilePlugin
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.validator.JsonValidator
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.validator.NoneValidator
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.validator.XmlValidator
-
Plugin name
- NAME - Static variable in class io.wcm.devops.conga.generator.plugins.valueprovider.SystemPropertyValueProviderPlugin
-
Plugin name
- NEVER - io.wcm.devops.conga.generator.spi.ImplicitApplyOptions
-
Plugin is never applied implicitly.
- node(Node) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- Node - Class in io.wcm.devops.conga.model.environment
-
Environment node.
- Node() - Constructor for class io.wcm.devops.conga.model.environment.Node
- NODE - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Current node name
- nodeDir(File) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- NodeModelExport - Class in io.wcm.devops.conga.generator.export
-
Managers model exports via the model export plugins.
- NodeModelExport(File, Node, Environment, ModelExport, VariableStringResolver, VariableMapResolver, Map<String, String>, PluginContextOptions, Set<String>, YamlRepresenter) - Constructor for class io.wcm.devops.conga.generator.export.NodeModelExport
- NodeModelExportContext - Class in io.wcm.devops.conga.generator.spi.export.context
-
Context for
NodeModelExportPlugin
. - NodeModelExportContext() - Constructor for class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- NodeModelExportPlugin - Interface in io.wcm.devops.conga.generator.spi.export
-
Plugin that exports CONGA model information per node for external tools.
- NodeRole - Class in io.wcm.devops.conga.model.environment
-
Role assignment for a node in an environment.
- NodeRole() - Constructor for class io.wcm.devops.conga.model.environment.NodeRole
- NODES - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
List of all nodes.
- NODES_BY_ROLE - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Map with node roles with each entry containing a list of all nodes with this role.
- NODES_BY_ROLE_VARIANT - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Map with node roles with each entry containing a map with node role variants each entry containing a list of all nodes with this role and variant.
- NoneEscapingStrategy - Class in io.wcm.devops.conga.generator.plugins.handlebars.escaping
-
Does no escaping.
- NoneEscapingStrategy() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.escaping.NoneEscapingStrategy
- NoneFileHeader - Class in io.wcm.devops.conga.generator.plugins.fileheader
-
Adds no file header.
- NoneFileHeader() - Constructor for class io.wcm.devops.conga.generator.plugins.fileheader.NoneFileHeader
- NoneMultiply - Class in io.wcm.devops.conga.generator.plugins.multiply
-
Multiplier that does not multiply but generate the file once.
- NoneMultiply() - Constructor for class io.wcm.devops.conga.generator.plugins.multiply.NoneMultiply
- NoneNodeModelExport - Class in io.wcm.devops.conga.generator.plugins.export
-
Export plugin that does nothing (to deactivate export).
- NoneNodeModelExport() - Constructor for class io.wcm.devops.conga.generator.plugins.export.NoneNodeModelExport
- NoneValidator - Class in io.wcm.devops.conga.generator.plugins.validator
-
Does no validation.
- NoneValidator() - Constructor for class io.wcm.devops.conga.generator.plugins.validator.NoneValidator
- normalizeToUnix(String) - Static method in class io.wcm.devops.conga.generator.util.LineEndingConverter
-
Normalizes all line endings that may be Windows or MacOS-style and converts them to Unix-style line endings.
O
- ObjectCloner - Class in io.wcm.devops.conga.generator.util
-
Clone maps.
- options(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.spi.context.PostProcessorContext
- options(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.spi.context.ValidatorContext
P
- PARAM_PLUGIN_NAME - Static variable in class io.wcm.devops.conga.generator.spi.context.ValueProviderGlobalContext
-
Parameter name in value provider configuration to specify the value provider plugin name.
- Plugin - Interface in io.wcm.devops.conga.generator.spi
-
Generic plugin interface all other plugins extend from.
- pluginContextOptions(PluginContextOptions) - Method in class io.wcm.devops.conga.generator.spi.context.AbstractPluginContext
- pluginContextOptions(PluginContextOptions) - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
-
Initialize options with all fields from other options.
- PluginContextOptions - Class in io.wcm.devops.conga.generator.spi.context
-
Parameters passed into all plugin contexts derived from
AbstractPluginContext
. - PluginContextOptions() - Constructor for class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- pluginManager(PluginManager) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- pluginManager(PluginManager) - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- PluginManager - Interface in io.wcm.devops.conga.generator.util
-
Manages registered plugin.
- PluginManagerImpl - Class in io.wcm.devops.conga.generator.util
-
Manages registered plugin.
- PluginManagerImpl() - Constructor for class io.wcm.devops.conga.generator.util.PluginManagerImpl
- postProcessor(String) - Method in class io.wcm.devops.conga.generator.spi.export.context.GeneratedFileContext
- PostProcessorContext - Class in io.wcm.devops.conga.generator.spi.context
-
Context for
PostProcessorPlugin
. - PostProcessorContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.PostProcessorContext
- PostProcessorPlugin - Interface in io.wcm.devops.conga.generator.spi
-
Plugin that allows to post-process a generated file.
R
- read(Resource) - Method in class io.wcm.devops.conga.model.reader.AbstractModelReader
- read(Resource) - Method in interface io.wcm.devops.conga.model.reader.ModelReader
-
Read model
- read(InputStream) - Method in class io.wcm.devops.conga.model.reader.AbstractModelReader
- read(InputStream) - Method in interface io.wcm.devops.conga.model.reader.ModelReader
-
Read model
- read(Reader) - Method in class io.wcm.devops.conga.model.reader.AbstractModelReader
- read(Reader) - Method in interface io.wcm.devops.conga.model.reader.ModelReader
-
Read model
- RegexQuoteHelper - Class in io.wcm.devops.conga.generator.plugins.handlebars.helper
-
Handlebars helper that allows to quotes a string for usage in a regular expression.
- RegexQuoteHelper() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.helper.RegexQuoteHelper
- register(YamlConstructorContext) - Method in interface io.wcm.devops.conga.generator.spi.yaml.YamlConstructorPlugin
-
Register YAML constructor modifications.
- register(YamlRepresentContext) - Method in interface io.wcm.devops.conga.generator.spi.yaml.YamlRepresentPlugin
-
Register YAML represent implementations.
- registerRepresent(Class<?>, Represent) - Method in class io.wcm.devops.conga.generator.spi.yaml.context.YamlRepresenter
-
Register a represent.
- removeContextVariables(Map<String, Object>) - Static method in class io.wcm.devops.conga.generator.ContextPropertiesBuilder
-
Removes all context variables.
- resolve(Object) - Static method in class io.wcm.devops.conga.generator.util.ConfigInheritanceResolver
-
Inherit all configurations.
- resolve(Object) - Method in class io.wcm.devops.conga.generator.util.VariableObjectTreeResolver
-
Resolve all variables.
- resolve(String) - Method in class io.wcm.devops.conga.generator.handlebars.CharsetAwareTemplateLoader
- resolve(String, ValueProviderContext) - Method in class io.wcm.devops.conga.generator.plugins.valueprovider.SystemPropertyValueProviderPlugin
- resolve(String, ValueProviderContext) - Method in interface io.wcm.devops.conga.generator.spi.ValueProviderPlugin
-
Gets parameter value from value provider.
- resolve(String, String, String, Map<String, Object>) - Method in class io.wcm.devops.conga.generator.util.VariableResolver
-
Resolves a variable.
- resolve(String, Map<String, Object>) - Method in class io.wcm.devops.conga.generator.util.VariableStringResolver
-
Replace variable placeholders in a string with syntax ${key} with values from a map.
- resolve(String, Map<String, Object>, boolean) - Method in class io.wcm.devops.conga.generator.util.VariableStringResolver
-
Replace variable placeholders in a string with syntax ${key} with values from a map.
- resolve(Map<String, Object>) - Method in class io.wcm.devops.conga.generator.util.VariableMapResolver
-
Replace variable placeholders in values of a map with syntax ${key} with values from the map itself.
- resolve(Map<String, Object>, boolean) - Method in class io.wcm.devops.conga.generator.util.VariableMapResolver
-
Replace variable placeholders in values of a map with syntax ${key} with values from the map itself.
- resolveRole(String, String, Map<String, Role>) - Static method in class io.wcm.devops.conga.generator.util.RoleUtil
-
Resolve role inheritance.
- resolveString(String, Map<String, Object>) - Method in class io.wcm.devops.conga.generator.util.VariableStringResolver
-
Replace variable placeholders in a string with syntax ${key} with values from a map.
- resolveString(String, Map<String, Object>, boolean) - Method in class io.wcm.devops.conga.generator.util.VariableStringResolver
-
Replace variable placeholders in a string with syntax ${key} with values from a map.
- Resource - Interface in io.wcm.devops.conga.resource
-
Abstraction for one single resource from filesystem or classpath.
- resourceClassLoader(ClassLoader) - Method in class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
- ResourceCollection - Interface in io.wcm.devops.conga.resource
-
Abstraction for a list of resources from filesystem or classpath.
- ResourceException - Exception in io.wcm.devops.conga.resource
-
Error when accessing resources.
- ResourceException(String) - Constructor for exception io.wcm.devops.conga.resource.ResourceException
- ResourceException(String, Throwable) - Constructor for exception io.wcm.devops.conga.resource.ResourceException
- ResourceInfo - Interface in io.wcm.devops.conga.resource
-
Abstraction for resource information.
- ResourceLoader - Class in io.wcm.devops.conga.resource
-
Resource loader to read resource and resource collections from filesystem or classpath.
- ResourceLoader() - Constructor for class io.wcm.devops.conga.resource.ResourceLoader
-
Constructor.
- ResourceLoader(ClassLoader) - Constructor for class io.wcm.devops.conga.resource.ResourceLoader
- role(Role) - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- role(String) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- Role - Class in io.wcm.devops.conga.model.role
-
Defines a role with a set of configuration files to generate.
- Role() - Constructor for class io.wcm.devops.conga.model.role.Role
- ROLE - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Current node role name
- ROLE_VARIANT - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Current node role variant name.
- ROLE_VARIANTS - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
List of current node role variant names.
- RoleConfig - Class in io.wcm.devops.conga.model.environment
-
Global role-specific configuration.
- RoleConfig() - Constructor for class io.wcm.devops.conga.model.environment.RoleConfig
- roleData(List<ExportNodeRoleData>) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- roleDir(File) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- roleFile(RoleFile) - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- RoleFile - Class in io.wcm.devops.conga.model.role
-
Defines a file to be generated or downloaded for a role.
- RoleFile() - Constructor for class io.wcm.devops.conga.model.role.RoleFile
- RoleFile.RoleFileVariantMetadata - Class in io.wcm.devops.conga.model.role
-
Role file variant with metadata.
- RoleInherit - Class in io.wcm.devops.conga.model.role
-
Defines an inheritance relation to another role.
- RoleInherit() - Constructor for class io.wcm.devops.conga.model.role.RoleInherit
- RoleReader - Class in io.wcm.devops.conga.model.reader
-
Reads role definitions.
- RoleReader() - Constructor for class io.wcm.devops.conga.model.reader.RoleReader
-
Constructor
- roles(List<String>) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleTenantData
- RoleUtil - Class in io.wcm.devops.conga.generator.util
-
Helper methods for managing roles.
- roleVariant(List<String>) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- RoleVariant - Class in io.wcm.devops.conga.model.role
-
Defines a named variant of a role.
- RoleVariant() - Constructor for class io.wcm.devops.conga.model.role.RoleVariant
S
- sanitizeComment(String) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.AbstractFileHeader
- sanitizeComment(String) - Method in class io.wcm.devops.conga.generator.plugins.fileheader.JsonFileHeader
- sensitiveConfigParameters(Set<String>) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- setAllowSymlinks(boolean) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- setCharset(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setCondition(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setConfig(Map<String, Object>) - Method in class io.wcm.devops.conga.model.shared.AbstractConfigurable
- setConfig(Map<String, Object>) - Method in interface io.wcm.devops.conga.model.shared.Configurable
- setDeleteSource(boolean) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setDependencies(List<String>) - Method in class io.wcm.devops.conga.model.environment.Environment
- setDir(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setEscapingStrategy(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setFile(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setFileHeader(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setFiles(List<RoleFile>) - Method in class io.wcm.devops.conga.model.role.Role
- setInherits(List<RoleInherit>) - Method in class io.wcm.devops.conga.model.role.Role
- setLineEndings(LineEndings) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setModelOptions(Map<String, Object>) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setMultiply(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setMultiplyOptions(Map<String, Object>) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setNode(String) - Method in class io.wcm.devops.conga.model.environment.Node
- setNode(List<String>) - Method in class io.wcm.devops.conga.generator.export.ModelExport
-
Defines node export plugin names.
- setNodes(List<Node>) - Method in class io.wcm.devops.conga.model.environment.Environment
- setNodes(List<String>) - Method in class io.wcm.devops.conga.model.environment.Node
- setPluginConfig(Map<String, Map<String, Object>>) - Method in class io.wcm.devops.conga.model.environment.Environment
- setPostProcessorOptions(Map<String, Object>) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setPostProcessors(List<String>) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setRole(String) - Method in class io.wcm.devops.conga.model.environment.NodeRole
- setRole(String) - Method in class io.wcm.devops.conga.model.environment.RoleConfig
- setRole(String) - Method in class io.wcm.devops.conga.model.role.RoleInherit
- setRoleConfig(List<RoleConfig>) - Method in class io.wcm.devops.conga.model.environment.Environment
- setRoles(List<NodeRole>) - Method in class io.wcm.devops.conga.model.environment.Node
- setRoles(List<String>) - Method in class io.wcm.devops.conga.model.environment.Tenant
- setSensitiveConfigParameters(List<String>) - Method in class io.wcm.devops.conga.model.role.Role
- setSymlinkTarget(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setTemplate(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setTemplateDir(String) - Method in class io.wcm.devops.conga.model.role.Role
- setTenant(String) - Method in class io.wcm.devops.conga.model.environment.Tenant
- setTenants(List<Tenant>) - Method in class io.wcm.devops.conga.model.environment.Environment
- setUrl(String) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setValidatorOptions(Map<String, Object>) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setValidators(List<String>) - Method in class io.wcm.devops.conga.model.role.RoleFile
- setValueProviderCache(Object) - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderContext
-
Set cache object for the current value provider.
- setVariant(String) - Method in class io.wcm.devops.conga.model.environment.NodeRole
- setVariant(String) - Method in class io.wcm.devops.conga.model.role.RoleVariant
- setVariants(List<RoleVariant>) - Method in class io.wcm.devops.conga.model.role.Role
- setVariants(List<String>) - Method in class io.wcm.devops.conga.model.environment.NodeRole
- setVariants(List<String>) - Method in class io.wcm.devops.conga.model.role.RoleFile
- sourceAt(String) - Method in class io.wcm.devops.conga.generator.handlebars.CharsetAwareTemplateLoader
- splitMap(Map<String, Object>, Predicate<Map.Entry<String, Object>>) - Static method in class io.wcm.devops.conga.model.util.MapSplitter
-
Splits a map in two parts.
- stringToValue(String) - Static method in class io.wcm.devops.conga.generator.util.ValueUtil
-
Parses a string value and converts it to a value object (or list).
- SystemPropertyValueProviderPlugin - Class in io.wcm.devops.conga.generator.plugins.valueprovider
-
Gets values from java system properties.
- SystemPropertyValueProviderPlugin() - Constructor for class io.wcm.devops.conga.generator.plugins.valueprovider.SystemPropertyValueProviderPlugin
T
- targetDir(File) - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- templateDir(File) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- tenant(String) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleTenantData
- Tenant - Class in io.wcm.devops.conga.model.environment
-
Defines a tenant for configuration files that have tenant-specific system configurations.
- Tenant() - Constructor for class io.wcm.devops.conga.model.environment.Tenant
- TENANT - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Current tenant name.
- TENANT_ROLES - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
List of current tenant's role names This is only set if the
TenantMultiply
plugin is used. - tenantData(List<ExportNodeRoleTenantData>) - Method in class io.wcm.devops.conga.generator.spi.export.context.ExportNodeRoleData
- TenantMultiply - Class in io.wcm.devops.conga.generator.plugins.multiply
-
Multiplies a file for each tenant with a matching tenant role.
- TenantMultiply() - Constructor for class io.wcm.devops.conga.generator.plugins.multiply.TenantMultiply
- TENANTS - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
List of all tenants.
- TENANTS_BY_ROLE - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Map with tenant roles with each entry containing a list of all tenants with this role.
- toString() - Method in class io.wcm.devops.conga.generator.spi.context.FileContext
- toString() - Method in class io.wcm.devops.conga.generator.spi.export.context.GeneratedFileContext
- toString() - Method in class io.wcm.devops.conga.model.shared.AbstractModel
U
- unix - io.wcm.devops.conga.model.shared.LineEndings
-
Unix line ending
- UnixShellScriptFileHeader - Class in io.wcm.devops.conga.generator.plugins.fileheader
-
Adds file headers to Unix script files (esp.
- UnixShellScriptFileHeader() - Constructor for class io.wcm.devops.conga.generator.plugins.fileheader.UnixShellScriptFileHeader
- urlFileManager(UrlFileManager) - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- UrlFileManager - Class in io.wcm.devops.conga.generator
-
Manages copy/download of external files referenced in CONGA roles by URL, filesystem, classpath or Maven coordinates.
- UrlFileManager(PluginManager, UrlFilePluginContext) - Constructor for class io.wcm.devops.conga.generator.UrlFileManager
- UrlFilePlugin - Interface in io.wcm.devops.conga.generator.spi
-
Get files from external sources.
- UrlFilePluginContext - Class in io.wcm.devops.conga.generator.spi.context
-
Context for
UrlFilePlugin
. - UrlFilePluginContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.UrlFilePluginContext
V
- ValidationException - Exception in io.wcm.devops.conga.generator.spi
-
Validation failed exception.
- ValidationException(String) - Constructor for exception io.wcm.devops.conga.generator.spi.ValidationException
- ValidationException(String, Throwable) - Constructor for exception io.wcm.devops.conga.generator.spi.ValidationException
- ValidatorContext - Class in io.wcm.devops.conga.generator.spi.context
-
Context for
ValidatorPlugin
. - ValidatorContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.ValidatorContext
- ValidatorPlugin - Interface in io.wcm.devops.conga.generator.spi
-
Plugin that allows to validate a generate file.
- ValueEncryptionContext - Class in io.wcm.devops.conga.generator.spi.context
-
Context for a single
ValueEncryptionPlugin
instance. - ValueEncryptionContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.ValueEncryptionContext
- ValueEncryptionPlugin - Interface in io.wcm.devops.conga.generator.spi
-
Encrypts a sensitive configuration parameter value.
- valueOf(String) - Static method in enum io.wcm.devops.conga.generator.spi.ImplicitApplyOptions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.wcm.devops.conga.model.shared.LineEndings
-
Returns the enum constant of this type with the specified name.
- valueProviderConfig(Map<String, Map<String, Object>>) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- valueProviderConfig(Map<String, Map<String, Object>>) - Method in class io.wcm.devops.conga.generator.spi.context.PluginContextOptions
- ValueProviderContext - Class in io.wcm.devops.conga.generator.spi.context
-
Context for a single
ValueProviderPlugin
instance. - ValueProviderContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.ValueProviderContext
- valueProviderGlobalContext(ValueProviderGlobalContext) - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderContext
- ValueProviderGlobalContext - Class in io.wcm.devops.conga.generator.spi.context
-
Global context for all
ValueProviderPlugin
implementations. - ValueProviderGlobalContext() - Constructor for class io.wcm.devops.conga.generator.spi.context.ValueProviderGlobalContext
- valueProviderName(String) - Method in class io.wcm.devops.conga.generator.spi.context.ValueProviderContext
- ValueProviderPlugin - Interface in io.wcm.devops.conga.generator.spi
-
Provides configuration values from external sources.
- values() - Static method in enum io.wcm.devops.conga.generator.spi.ImplicitApplyOptions
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.wcm.devops.conga.model.shared.LineEndings
-
Returns an array containing the constants of this enum type, in the order they are declared.
- valueToString(Object) - Static method in class io.wcm.devops.conga.generator.util.ValueUtil
-
Convert a value to it's string representation.
- ValueUtil - Class in io.wcm.devops.conga.generator.util
-
Value utilities.
- variableMapResolver(VariableMapResolver) - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- variableMapResolver(VariableMapResolver) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- VariableMapResolver - Class in io.wcm.devops.conga.generator.util
-
Resolve variables in a map referencing other entries from the same map.
- VariableMapResolver(ValueProviderGlobalContext) - Constructor for class io.wcm.devops.conga.generator.util.VariableMapResolver
- VariableObjectTreeResolver - Class in io.wcm.devops.conga.generator.util
-
Iterates over all
Configurable
items in the object tree and resolves all variables usingVariableMapResolver
. - VariableObjectTreeResolver(ValueProviderGlobalContext) - Constructor for class io.wcm.devops.conga.generator.util.VariableObjectTreeResolver
- VariableResolver - Class in io.wcm.devops.conga.generator.util
-
Resolve variables referencing an entry from a map.
- VariableResolver(ValueProviderGlobalContext) - Constructor for class io.wcm.devops.conga.generator.util.VariableResolver
- variableStringResolver(VariableStringResolver) - Method in class io.wcm.devops.conga.generator.spi.context.MultiplyContext
- variableStringResolver(VariableStringResolver) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- VariableStringResolver - Class in io.wcm.devops.conga.generator.util
-
Resolve variables in a string referencing entries from a map.
- VariableStringResolver(ValueProviderGlobalContext, VariableMapResolver) - Constructor for class io.wcm.devops.conga.generator.util.VariableStringResolver
- version(String) - Method in class io.wcm.devops.conga.generator.GeneratorOptions
- VERSION - Static variable in class io.wcm.devops.conga.generator.ContextProperties
-
Environment version
W
- WHEN_UNCONFIGURED - io.wcm.devops.conga.generator.spi.ImplicitApplyOptions
-
Plugin is applied implicitly when no other plugin of the same type is configured explicitely for the given context.
- windows - io.wcm.devops.conga.model.shared.LineEndings
-
Windows line ending
- WindowsShellScriptFileHeader - Class in io.wcm.devops.conga.generator.plugins.fileheader
-
Adds file headers to Windows .bat or .cmd files.
- WindowsShellScriptFileHeader() - Constructor for class io.wcm.devops.conga.generator.plugins.fileheader.WindowsShellScriptFileHeader
X
- XmlEscapingStrategy - Class in io.wcm.devops.conga.generator.plugins.handlebars.escaping
-
Escapes for XML files.
- XmlEscapingStrategy() - Constructor for class io.wcm.devops.conga.generator.plugins.handlebars.escaping.XmlEscapingStrategy
- XmlFileHeader - Class in io.wcm.devops.conga.generator.plugins.fileheader
-
Adds file headers to XML files.
- XmlFileHeader() - Constructor for class io.wcm.devops.conga.generator.plugins.fileheader.XmlFileHeader
-
Constructor.
- XmlValidator - Class in io.wcm.devops.conga.generator.plugins.validator
-
Validates XML syntax.
- XmlValidator() - Constructor for class io.wcm.devops.conga.generator.plugins.validator.XmlValidator
-
Constructor.
Y
- yamlConstructor(Constructor) - Method in class io.wcm.devops.conga.generator.spi.yaml.context.YamlConstructorContext
- YamlConstructorContext - Class in io.wcm.devops.conga.generator.spi.yaml.context
-
Context for
YamlConstructorPlugin
. - YamlConstructorContext() - Constructor for class io.wcm.devops.conga.generator.spi.yaml.context.YamlConstructorContext
- YamlConstructorPlugin - Interface in io.wcm.devops.conga.generator.spi.yaml
-
Plugin that allows to customize SnakeYAML
Constructor
implementation. - YamlNodeModelExport - Class in io.wcm.devops.conga.generator.plugins.export
-
Exports model information for each node in YAML format.
- YamlNodeModelExport() - Constructor for class io.wcm.devops.conga.generator.plugins.export.YamlNodeModelExport
- YamlRepresentContext - Class in io.wcm.devops.conga.generator.spi.yaml.context
-
Context for
YamlRepresentPlugin
. - YamlRepresentContext() - Constructor for class io.wcm.devops.conga.generator.spi.yaml.context.YamlRepresentContext
- yamlRepresenter(YamlRepresenter) - Method in class io.wcm.devops.conga.generator.spi.export.context.NodeModelExportContext
- yamlRepresenter(YamlRepresenter) - Method in class io.wcm.devops.conga.generator.spi.yaml.context.YamlRepresentContext
- YamlRepresenter - Class in io.wcm.devops.conga.generator.spi.yaml.context
-
SnakeYAML
Representer
implementation. - YamlRepresenter() - Constructor for class io.wcm.devops.conga.generator.spi.yaml.context.YamlRepresenter
-
Constructor.
- YamlRepresentPlugin - Interface in io.wcm.devops.conga.generator.spi.yaml
-
Plugin that allows to register custom SnakeYAML
Represent
implementations. - YamlUtil - Class in io.wcm.devops.conga.model.util
-
Helper methods for SnakeYAML.
All Classes All Packages