Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AggregateConfigurationRuntimeContext(ConfigurationRuntimeContext...) - Constructor for class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.AggregateConfigurationRuntimeContext
B
- build() - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationSubstitutionBundle.Builder
- build() - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle.Builder
- build() - Method in interface org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle.FinalBuilder
- build() - Method in class org.sdase.commons.server.dropwizard.bundles.DefaultLoggingConfigurationBundle.Builder
- build() - Method in class org.sdase.commons.server.dropwizard.bundles.MetadataContextBundle.Builder
- build(JsonNode, String) - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.generic.GenericLookupYamlConfigurationFactory
- builder() - Static method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationSubstitutionBundle
- builder() - Static method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle
- builder() - Static method in class org.sdase.commons.server.dropwizard.bundles.DefaultLoggingConfigurationBundle
- builder() - Static method in class org.sdase.commons.server.dropwizard.bundles.MetadataContextBundle
- Builder() - Constructor for class org.sdase.commons.server.dropwizard.bundles.ConfigurationSubstitutionBundle.Builder
- Builder() - Constructor for class org.sdase.commons.server.dropwizard.bundles.DefaultLoggingConfigurationBundle.Builder
- Builder() - Constructor for class org.sdase.commons.server.dropwizard.bundles.MetadataContextBundle.Builder
C
- close() - Method in class org.sdase.commons.server.dropwizard.metadata.MetadataContextCloseable
- compareTo(MappableField) - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
- ConfigurationRuntimeContext - Interface in org.sdase.commons.server.dropwizard.bundles.configuration
-
A context of configured properties at runtime.
- ConfigurationRuntimeContext.AggregateConfigurationRuntimeContext - Class in org.sdase.commons.server.dropwizard.bundles.configuration
-
A
ConfigurationRuntimeContext
that checks multipleConfigurationRuntimeContext
's in a defined order. - ConfigurationRuntimeContext.EnvironmentConfigurationRuntimeContext - Class in org.sdase.commons.server.dropwizard.bundles.configuration
-
A
ConfigurationRuntimeContext
that is backed by environment variables. - ConfigurationRuntimeContext.SystemPropertiesConfigurationRuntimeContext - Class in org.sdase.commons.server.dropwizard.bundles.configuration
-
A
ConfigurationRuntimeContext
that is backed by system properties. - ConfigurationSubstitutionBundle - Class in org.sdase.commons.server.dropwizard.bundles
-
The
ConfigurationSubstitutionBundle
allows to use placeholders for environment variables or system properties in configuration yaml files. - ConfigurationSubstitutionBundle() - Constructor for class org.sdase.commons.server.dropwizard.bundles.ConfigurationSubstitutionBundle
- ConfigurationSubstitutionBundle.Builder - Class in org.sdase.commons.server.dropwizard.bundles
- ConfigurationValueSupplierBundle<C extends io.dropwizard.core.Configuration,
R> - Class in org.sdase.commons.server.dropwizard.bundles -
A bundle that creates a
Supplier
for a configuration value. - ConfigurationValueSupplierBundle.Builder<C extends io.dropwizard.core.Configuration,
R> - Class in org.sdase.commons.server.dropwizard.bundles - ConfigurationValueSupplierBundle.FinalBuilder<C extends io.dropwizard.core.Configuration,
R> - Interface in org.sdase.commons.server.dropwizard.bundles - ConfigurationValueSupplierBundle.InitialBuilder - Interface in org.sdase.commons.server.dropwizard.bundles
- configure(FeatureContext) - Method in interface org.sdase.commons.server.dropwizard.ContextAwareEndpoint
- ConsoleAppenderInjectorSourceProvider - Class in org.sdase.commons.server.dropwizard.logging
- ConsoleAppenderInjectorSourceProvider(ConfigurationSourceProvider) - Constructor for class org.sdase.commons.server.dropwizard.logging.ConsoleAppenderInjectorSourceProvider
-
Create a new instance.
- ContextAwareEndpoint - Interface in org.sdase.commons.server.dropwizard
-
Implement this interface in classes that should receive
Context
injections and are registered as instance. - create(Class<T>, Validator, ObjectMapper, String) - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.generic.GenericLookupYamlConfigurationFactory.GenericLookupYamlConfigurationFactoryFactory
- createCloseableContext(DetachedMetadataContext) - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
- createConfigurationHints(Type) - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.JacksonTypeScanner
-
Creates a multi-line text that describes each found property briefly.
- createContext(DetachedMetadataContext) - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
Creates a new
MetadataContext
for the currentThread
. - createDynamicPropertyDocumentation(ObjectMapper, Class<C>) - Static method in class org.sdase.commons.server.dropwizard.bundles.configuration.generic.GenericLookupConfigCommand
-
Discovers all dynamic environment properties and creates a human-readable multiline documentation text with information about types, formats and conventions used in the current implementation followed by a list.
- current() - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
D
- DefaultLoggingConfigurationBundle - Class in org.sdase.commons.server.dropwizard.bundles
-
The
DefaultLoggingConfigurationBundle
allows to configure the console logger with the settings desired by the SDA. - DefaultLoggingConfigurationBundle() - Constructor for class org.sdase.commons.server.dropwizard.bundles.DefaultLoggingConfigurationBundle
- DefaultLoggingConfigurationBundle.Builder - Class in org.sdase.commons.server.dropwizard.bundles
- detachedCurrent() - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
- DetachedMetadataContext - Class in org.sdase.commons.server.dropwizard.metadata
- DetachedMetadataContext() - Constructor for class org.sdase.commons.server.dropwizard.metadata.DetachedMetadataContext
- DROPWIZARD_PLAIN_TYPES - Static variable in class org.sdase.commons.server.dropwizard.bundles.scanner.JacksonTypeScanner
-
Types that can be mapped from
String
in Dropwizard configuration.
E
- EnvironmentConfigurationRuntimeContext() - Constructor for class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.EnvironmentConfigurationRuntimeContext
- equals(Object) - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
- expand(Set<String>) - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
-
Resolves
MappableFields
fromMappableField.getContextKey()
that are available in the current context, considering variable parts like "<key>". - EXTEND - Enum constant in enum class org.sdase.commons.server.dropwizard.metadata.MetadataContextMergeStrategy
-
All values for a specific key will be merged into a distinct list of values.
F
- filter(ClientRequestContext) - Method in class org.sdase.commons.server.dropwizard.metadata.MetadataContextClientRequestFilter
- filter(ContainerRequestContext) - Method in class org.sdase.commons.server.dropwizard.metadata.MetadataContextFilter
- filter(ContainerRequestContext, ContainerResponseContext) - Method in class org.sdase.commons.server.dropwizard.metadata.MetadataContextFilter
- FROM_ENVIRONMENT - Static variable in interface org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext
-
Instance of a
ConfigurationRuntimeContext
that is backed by environment variables. - FROM_SYSTEM_PROPERTIES - Static variable in interface org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext
-
Instance of a
ConfigurationRuntimeContext
that is backed by system properties. - FROM_SYSTEM_PROPERTIES_AND_ENVIRONMENT - Static variable in interface org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext
-
Instance of a
ConfigurationRuntimeContext
that is backed with higher precedence by system properties and with lower precedence by environment variables.
G
- GenericLookupConfigCommand<T extends io.dropwizard.core.Configuration> - Class in org.sdase.commons.server.dropwizard.bundles.configuration.generic
-
A
Command
that documents the configuration keys as standard output that are discovered dynamically by theJacksonTypeScanner
. - GenericLookupConfigCommand() - Constructor for class org.sdase.commons.server.dropwizard.bundles.configuration.generic.GenericLookupConfigCommand
- GenericLookupYamlConfigurationFactory<T> - Class in org.sdase.commons.server.dropwizard.bundles.configuration.generic
-
A
YamlConfigurationFactory
that consumes all environment variables that match known properties in the configuration class. - GenericLookupYamlConfigurationFactory(Class<T>, Validator, ObjectMapper, String, JacksonTypeScanner, ConfigurationRuntimeContext, LookupTracker) - Constructor for class org.sdase.commons.server.dropwizard.bundles.configuration.generic.GenericLookupYamlConfigurationFactory
-
Creates a new configuration factory for the given class.
- GenericLookupYamlConfigurationFactory.GenericLookupYamlConfigurationFactoryFactory<T> - Class in org.sdase.commons.server.dropwizard.bundles.configuration.generic
- GenericLookupYamlConfigurationFactoryFactory(LookupTracker) - Constructor for class org.sdase.commons.server.dropwizard.bundles.configuration.generic.GenericLookupYamlConfigurationFactory.GenericLookupYamlConfigurationFactoryFactory
- getContextKey() - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
- getDefinedKeys() - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.AggregateConfigurationRuntimeContext
- getDefinedKeys() - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.EnvironmentConfigurationRuntimeContext
- getDefinedKeys() - Method in interface org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext
-
Determines all keys that are defined in the current context.
- getDefinedKeys() - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.SystemPropertiesConfigurationRuntimeContext
- getJsonPathToProperty() - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
- getKey() - Method in class org.sdase.commons.server.dropwizard.bundles.LookupKeyAndOperators
- getOperators() - Method in class org.sdase.commons.server.dropwizard.bundles.LookupKeyAndOperators
- getPropertyTypeDescription() - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
- getUnknownConfigurationKey() - Method in exception org.sdase.commons.server.dropwizard.metadata.KeyConfigurationMissingException
- getValue(String) - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.AggregateConfigurationRuntimeContext
- getValue(String) - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.EnvironmentConfigurationRuntimeContext
- getValue(String) - Method in interface org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext
-
Determines the value with the highest precedence for the given
key
in the current context. - getValue(String) - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.SystemPropertiesConfigurationRuntimeContext
H
- hashCode() - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
I
- initialize(Bootstrap<?>) - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationSubstitutionBundle
- initialize(Bootstrap<?>) - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle
- initialize(Bootstrap<?>) - Method in class org.sdase.commons.server.dropwizard.bundles.DefaultLoggingConfigurationBundle
- isEffectivelyEmpty() - Method in class org.sdase.commons.server.dropwizard.metadata.DetachedMetadataContext
- isEffectivelyEmpty() - Method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
J
- JacksonTypeScanner - Class in org.sdase.commons.server.dropwizard.bundles.scanner
-
Scans configuration classes for configurable properties recursively (up to 25 nesting depth).
- JacksonTypeScanner(ObjectMapper, Set<Class<?>>) - Constructor for class org.sdase.commons.server.dropwizard.bundles.scanner.JacksonTypeScanner
K
- KEEP - Enum constant in enum class org.sdase.commons.server.dropwizard.metadata.MetadataContextMergeStrategy
-
Existing values take precedence.
- KeyConfigurationMissingException - Exception in org.sdase.commons.server.dropwizard.metadata
-
Exception to be thrown when a metadata key can't be resolved from the configuration.
- keyFromConfiguration(String) - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
Derives the metadata key from the service specific configured environment.
- keys() - Method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
L
- lookedUpKeys() - Method in interface org.sdase.commons.server.dropwizard.bundles.LookupTracker
- lookedUpKeys() - Method in class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentLookup
- lookup(String) - Method in class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentLookup
- lookupKey(String) - Static method in class org.sdase.commons.server.dropwizard.bundles.LookupKeyAndOperators
-
Extracts the actual lookup key of a key with operators.
- LookupKeyAndOperators - Class in org.sdase.commons.server.dropwizard.bundles
-
Provides the
actual lookup key
and optional operators from a full lookup key string. - LookupTracker - Interface in org.sdase.commons.server.dropwizard.bundles
-
Tracks keys that were looked up in the environment.
M
- ManagedShutdownListener - Interface in org.sdase.commons.server.dropwizard.lifecycle
-
Functional interface to implement a
Managed
as lambda if onlyManaged.stop()
should be handled. - MappableField - Class in org.sdase.commons.server.dropwizard.bundles.scanner
-
Represents a field in a configuration class that can be set from a property in the context.
- mergeContext(DetachedMetadataContext, MetadataContextMergeStrategy) - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
Merges the given new metadata context data into the
MetadataContext.current()
metadata context. - METADATA_FIELDS_ENVIRONMENT_VARIABLE - Static variable in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
The name of the property or environment variable that defines which fields (e.g.
- MetadataContext - Interface in org.sdase.commons.server.dropwizard.metadata
-
The
MetadataContext
stores information about a long-running business processes that is independent of specific APIs or business rules of a single service. - MetadataContextBundle - Class in org.sdase.commons.server.dropwizard.bundles
-
The
MetadataContextBundle
activates handling of theMetadataContext
. - MetadataContextBundle() - Constructor for class org.sdase.commons.server.dropwizard.bundles.MetadataContextBundle
- MetadataContextBundle.Builder - Class in org.sdase.commons.server.dropwizard.bundles
- MetadataContextClientRequestFilter - Class in org.sdase.commons.server.dropwizard.metadata
-
A
ClientRequestFilter
to submit theMetadataContext
to other services that are called synchronously. - MetadataContextClientRequestFilter(Set<String>) - Constructor for class org.sdase.commons.server.dropwizard.metadata.MetadataContextClientRequestFilter
- MetadataContextCloseable - Class in org.sdase.commons.server.dropwizard.metadata
- MetadataContextFilter - Class in org.sdase.commons.server.dropwizard.metadata
-
A filter that creates the
MetadataContext
for processing a request. - MetadataContextFilter(Set<String>) - Constructor for class org.sdase.commons.server.dropwizard.metadata.MetadataContextFilter
- MetadataContextMergeStrategy - Enum Class in org.sdase.commons.server.dropwizard.metadata
-
Strategies for merging data from a
DetachedMetadataContext
into the current metadata context. - metadataFields() - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
O
- of(String) - Static method in class org.sdase.commons.server.dropwizard.bundles.LookupKeyAndOperators
-
Creates a new instance of
LookupKeyAndOperators
- of(MetadataContext) - Static method in class org.sdase.commons.server.dropwizard.metadata.DetachedMetadataContext
- onShutdown() - Method in interface org.sdase.commons.server.dropwizard.lifecycle.ManagedShutdownListener
-
Stops the object.
- onShutdown(ManagedShutdownListener) - Static method in interface org.sdase.commons.server.dropwizard.lifecycle.ManagedShutdownListener
-
To be used with lifecycle manage to avoid casting.
- open(String) - Method in class org.sdase.commons.server.dropwizard.logging.ConsoleAppenderInjectorSourceProvider
- org.sdase.commons.server.dropwizard - package org.sdase.commons.server.dropwizard
- org.sdase.commons.server.dropwizard.bundles - package org.sdase.commons.server.dropwizard.bundles
- org.sdase.commons.server.dropwizard.bundles.configuration - package org.sdase.commons.server.dropwizard.bundles.configuration
- org.sdase.commons.server.dropwizard.bundles.configuration.generic - package org.sdase.commons.server.dropwizard.bundles.configuration.generic
- org.sdase.commons.server.dropwizard.bundles.scanner - package org.sdase.commons.server.dropwizard.bundles.scanner
- org.sdase.commons.server.dropwizard.lifecycle - package org.sdase.commons.server.dropwizard.lifecycle
- org.sdase.commons.server.dropwizard.logging - package org.sdase.commons.server.dropwizard.logging
- org.sdase.commons.server.dropwizard.metadata - package org.sdase.commons.server.dropwizard.metadata
R
- REPLACE - Enum constant in enum class org.sdase.commons.server.dropwizard.metadata.MetadataContextMergeStrategy
-
New values take precedence.
- requireNonNull() - Method in interface org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle.FinalBuilder
-
Validate that the configuration is not null.
- run(C, Environment) - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle
- run(Configuration, Environment) - Method in class org.sdase.commons.server.dropwizard.bundles.DefaultLoggingConfigurationBundle
- run(Configuration, Environment) - Method in class org.sdase.commons.server.dropwizard.bundles.MetadataContextBundle
- run(Bootstrap<T>, Namespace, T) - Method in class org.sdase.commons.server.dropwizard.bundles.configuration.generic.GenericLookupConfigCommand
S
- scan(Type) - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.JacksonTypeScanner
-
Scans the given
rootType
for configurable fields recursively. - start() - Method in interface org.sdase.commons.server.dropwizard.lifecycle.ManagedShutdownListener
- stop() - Method in interface org.sdase.commons.server.dropwizard.lifecycle.ManagedShutdownListener
- substitute(TextStringBuilder, int, int) - Method in class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentSubstitutor
- supplier() - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle
- SystemPropertiesConfigurationRuntimeContext() - Constructor for class org.sdase.commons.server.dropwizard.bundles.configuration.ConfigurationRuntimeContext.SystemPropertiesConfigurationRuntimeContext
- SystemPropertyAndEnvironmentLookup - Class in org.sdase.commons.server.dropwizard.bundles
-
A
StringLookup
for Java's system properties and environment variables. - SystemPropertyAndEnvironmentLookup() - Constructor for class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentLookup
- SystemPropertyAndEnvironmentSubstitutor - Class in org.sdase.commons.server.dropwizard.bundles
-
A
StringSubstitutor
that picks properties fromSystem.getProperty(String)
(preferred) andSystem.getenv(String)
(secondary) that may be modified by operators. - SystemPropertyAndEnvironmentSubstitutor() - Constructor for class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentSubstitutor
- SystemPropertyAndEnvironmentSubstitutor(boolean) - Constructor for class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentSubstitutor
- SystemPropertyAndEnvironmentSubstitutor(boolean, boolean) - Constructor for class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentSubstitutor
- SystemPropertyAndEnvironmentSubstitutor(boolean, boolean, StringLookup) - Constructor for class org.sdase.commons.server.dropwizard.bundles.SystemPropertyAndEnvironmentSubstitutor
T
- toMetadataContext() - Method in class org.sdase.commons.server.dropwizard.metadata.DetachedMetadataContext
- toString() - Method in class org.sdase.commons.server.dropwizard.bundles.scanner.MappableField
- transferMetadataContext(Runnable) - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
Transfers the current metadata context to the runnable when executed in a new thread.
- transferMetadataContext(Callable<V>) - Static method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
Transfers the current metadata context to the callable when executed in a new thread.
V
- validate(Predicate<R>) - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle.Builder
- validate(Predicate<R>) - Method in interface org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle.FinalBuilder
-
Validate the configuration value with a custom predicate.
- valueOf(String) - Static method in enum class org.sdase.commons.server.dropwizard.metadata.MetadataContextMergeStrategy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.sdase.commons.server.dropwizard.metadata.MetadataContextMergeStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- valuesByKey(String) - Method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
MetadataContext.valuesByKeyFromEnvironment(String)
should be preferred to be independent of different environments. - valuesByKeyFromEnvironment(String) - Method in interface org.sdase.commons.server.dropwizard.metadata.MetadataContext
-
reads the values of the metadata context from a key that is configurable by system properties or environment variables.
- valueSupplier() - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle
W
- withAccessor(Function<C, R>) - Method in interface org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle.InitialBuilder
- withAccessor(Function<C1, R1>) - Method in class org.sdase.commons.server.dropwizard.bundles.ConfigurationValueSupplierBundle.Builder
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form