de.smartics.properties.spi.config.domain.key
Interface ConfigurationKeyContext

All Known Implementing Classes:

EnvAppConfigurationKeyContext, TenantUserConfigurationKeyContext

public interface ConfigurationKeyContext

Provides access to utilities to deal with configuration keys.

Method Summary

ConfigurationKeyFactory<?>	configurationKeyFactory() Provides access to the configuration key factory.
ConfigurationKeyHelper	configurationKeyHelper(boolean preferEarManifest) Provides a helper to create a configuration key at runtime.
DefinitionConfigParser<?>	definitionConfigParser() Provides a parser to parse definition files.
DefinitionKeyHelper	definitionKeyHelper() Provides a contextless definition helper.
DefinitionKeyHelper	definitionKeyHelper(PropertiesDefinitionContext definitionContext) Provides a contextaware definition helper.
KeyListBuilder	keyListBuilder() Provides access to the key list builder that creates a list of configuration keys to fetch property values.

Method Detail

configurationKeyFactory

ConfigurationKeyFactory<?> configurationKeyFactory()

Provides access to the configuration key factory.

Returns:

a factory to create special configuration keys.

keyListBuilder

KeyListBuilder keyListBuilder()

Provides access to the key list builder that creates a list of configuration keys to fetch property values.

Returns:

the key list builder that creates a list of configuration keys to fetch property values.

definitionConfigParser

DefinitionConfigParser<?> definitionConfigParser()

Provides a parser to parse definition files.

Returns:

a parser to parse definition files.

definitionKeyHelper

DefinitionKeyHelper definitionKeyHelper()

Provides a contextless definition helper.

Returns:

a definition helper.

configurationKeyHelper

ConfigurationKeyHelper configurationKeyHelper(boolean preferEarManifest)

Provides a helper to create a configuration key at runtime.

Parameters:

preferEarManifest - the flag to signal that the manifest of a EAR file (with the extension ear) is preferred if present.

Returns:

a configuration key helper.

definitionKeyHelper

DefinitionKeyHelper definitionKeyHelper(PropertiesDefinitionContext definitionContext)

Provides a contextaware definition helper.

Parameters:

definitionContext - the context to base the definition helper.

Returns:

a definition helper.