A B C F G I J L N P S T

A

addStore(ConfigStoreOptions) - Method in class io.vertx.config.ConfigRetrieverOptions

Adds a store to the list of stores.

B

buildConfiguration(List<File>, Handler<AsyncResult<JsonObject>>) - Method in class io.vertx.config.spi.utils.FileSet

Iterates over the given set of files, and for each matching file, computes the resulting configuration.

C

close() - Method in interface io.vertx.config.ConfigRetriever

Closes the retriever.

close(Handler<Void>) - Method in interface io.vertx.config.spi.ConfigStore

Closes the configuration store.

ConfigChange - Class in io.vertx.config

A structure representing a configuration change.

ConfigChange(JsonObject, JsonObject) - Constructor for class io.vertx.config.ConfigChange

Creates a new ConfigChange instance.

ConfigChange() - Constructor for class io.vertx.config.ConfigChange

Creates a new instance from ConfigChange using empty JSON Object for both the old and new configuration.

ConfigChange(ConfigChange) - Constructor for class io.vertx.config.ConfigChange

Creates a new instance of ConfigChange copying the values stored in the given object.

ConfigChange(JsonObject) - Constructor for class io.vertx.config.ConfigChange

Creates a new ConfigChange instance from the given JSON object.

ConfigProcessor - Interface in io.vertx.config.spi

A processor transforms a chunk of configuration retrieved from a configuration store as a Buffer to a JsonObject.

ConfigRetriever - Interface in io.vertx.config

Defines a configuration retriever that read configuration from ConfigStore and tracks changes periodically.

ConfigRetrieverOptions - Class in io.vertx.config

Options to configure the ConfigRetriever.

ConfigRetrieverOptions() - Constructor for class io.vertx.config.ConfigRetrieverOptions

ConfigRetrieverOptions(ConfigRetrieverOptions) - Constructor for class io.vertx.config.ConfigRetrieverOptions

ConfigRetrieverOptions(JsonObject) - Constructor for class io.vertx.config.ConfigRetrieverOptions

ConfigRetrieverOptionsConverter - Class in io.vertx.config

Converter for ConfigRetrieverOptions.

ConfigRetrieverOptionsConverter() - Constructor for class io.vertx.config.ConfigRetrieverOptionsConverter

ConfigStore - Interface in io.vertx.config.spi

Defines a configuration store.

ConfigStoreFactory - Interface in io.vertx.config.spi

Factory to create instances of ConfigStore.

ConfigStoreOptions - Class in io.vertx.config

Data object representing the configuration of a configuration store.

ConfigStoreOptions() - Constructor for class io.vertx.config.ConfigStoreOptions

ConfigStoreOptions(ConfigStoreOptions) - Constructor for class io.vertx.config.ConfigStoreOptions

ConfigStoreOptions(JsonObject) - Constructor for class io.vertx.config.ConfigStoreOptions

configStream() - Method in interface io.vertx.config.ConfigRetriever

convert(String) - Static method in class io.vertx.config.spi.utils.JsonObjectHelper

create(Vertx, ConfigRetrieverOptions) - Static method in interface io.vertx.config.ConfigRetriever

Creates an instance of the default implementation of the ConfigRetriever.

create(Vertx) - Static method in interface io.vertx.config.ConfigRetriever

Creates an instance of the default implementation of the ConfigRetriever, using the default settings (json file, system properties and environment variables).

create(Vertx, JsonObject) - Method in interface io.vertx.config.spi.ConfigStoreFactory

Creates an instance of the ConfigStore.

F

FileSet - Class in io.vertx.config.spi.utils

Utility class to manage file set selected using a pattern.

FileSet(Vertx, File, JsonObject) - Constructor for class io.vertx.config.spi.utils.FileSet

Creates a new FileSet from a json object.

from(Properties) - Static method in class io.vertx.config.spi.utils.JsonObjectHelper

from(Properties, boolean) - Static method in class io.vertx.config.spi.utils.JsonObjectHelper

fromJson(Iterable<Map.Entry<String, Object>>, ConfigRetrieverOptions) - Static method in class io.vertx.config.ConfigRetrieverOptionsConverter

G

get(Handler<AsyncResult<Buffer>>) - Method in interface io.vertx.config.spi.ConfigStore

Retrieves the configuration store in this store.

get(String) - Static method in class io.vertx.config.spi.utils.Processors

Gets a configuration processor matching with the given format.

getCachedConfig() - Method in interface io.vertx.config.ConfigRetriever

Gets the last computed configuration.

getConfig(Handler<AsyncResult<JsonObject>>) - Method in interface io.vertx.config.ConfigRetriever

Reads the configuration from the different ConfigStore and computes the final configuration.

getConfig() - Method in class io.vertx.config.ConfigStoreOptions

getConfigAsFuture(ConfigRetriever) - Static method in interface io.vertx.config.ConfigRetriever

Deprecated.

removed in Vert.x 4 for ConfigRetriever#getConfig() method that returns a Future<JsonObject> in 3.x you can use instead Future.future(retriever::getConfig)

getFormat() - Method in class io.vertx.config.ConfigStoreOptions

getNewConfiguration() - Method in class io.vertx.config.ConfigChange

getPreviousConfiguration() - Method in class io.vertx.config.ConfigChange

getScanPeriod() - Method in class io.vertx.config.ConfigRetrieverOptions

getStores() - Method in class io.vertx.config.ConfigRetrieverOptions

getSupportedFormats() - Static method in class io.vertx.config.spi.utils.Processors

getType() - Method in class io.vertx.config.ConfigStoreOptions

I

io.vertx.config - package io.vertx.config

io.vertx.config.spi - package io.vertx.config.spi

io.vertx.config.spi.utils - package io.vertx.config.spi.utils

isIncludeDefaultStores() - Method in class io.vertx.config.ConfigRetrieverOptions

isOptional() - Method in class io.vertx.config.ConfigStoreOptions

J

JsonObjectHelper - Class in io.vertx.config.spi.utils

Some utility methods to create json objects from a set of String.

JsonObjectHelper() - Constructor for class io.vertx.config.spi.utils.JsonObjectHelper

L

listen(Handler<ConfigChange>) - Method in interface io.vertx.config.ConfigRetriever

Registers a listener receiving configuration changes.

N

name() - Method in interface io.vertx.config.spi.ConfigProcessor

Name of the processor, generally the name of the format it handles.

name() - Method in interface io.vertx.config.spi.ConfigStoreFactory

P

process(Vertx, JsonObject, Buffer, Handler<AsyncResult<JsonObject>>) - Method in interface io.vertx.config.spi.ConfigProcessor

Transforms the given input into a JsonObject.

Processors - Class in io.vertx.config.spi.utils

A class to deal with configuration prcessors.

Processors() - Constructor for class io.vertx.config.spi.utils.Processors

put(JsonObject, String, String, boolean) - Static method in class io.vertx.config.spi.utils.JsonObjectHelper

S

setBeforeScanHandler(Handler<Void>) - Method in interface io.vertx.config.ConfigRetriever

Registers a handler called before every scan.

setConfig(JsonObject) - Method in class io.vertx.config.ConfigStoreOptions

Sets the configuration of the store

setConfigurationProcessor(Function<JsonObject, JsonObject>) - Method in interface io.vertx.config.ConfigRetriever

Registers a handler that process the configuration before being injected into ConfigRetriever.getConfig(Handler) or ConfigRetriever.listen(Handler).

setFormat(String) - Method in class io.vertx.config.ConfigStoreOptions

Sets the format of the configuration that is retrieved from the store.

setIncludeDefaultStores(boolean) - Method in class io.vertx.config.ConfigRetrieverOptions

Enables or disables the inclusion of the default stored in the configuration.

setNewConfiguration(JsonObject) - Method in class io.vertx.config.ConfigChange

Sets the new configuration.

setOptional(boolean) - Method in class io.vertx.config.ConfigStoreOptions

Sets whether or not the store is optional.

setPreviousConfiguration(JsonObject) - Method in class io.vertx.config.ConfigChange

Sets the previous configuration.

setScanPeriod(long) - Method in class io.vertx.config.ConfigRetrieverOptions

Configures the scan period, in ms.

setStores(List<ConfigStoreOptions>) - Method in class io.vertx.config.ConfigRetrieverOptions

Sets the configuration stores.

setType(String) - Method in class io.vertx.config.ConfigStoreOptions

Sets the configuration type

T

toBuffer(JsonObject) - Static method in class io.vertx.config.spi.utils.JsonObjectHelper

Deprecated.

use JsonObject.toBuffer() instead

toJson() - Method in class io.vertx.config.ConfigChange

toJson() - Method in class io.vertx.config.ConfigRetrieverOptions

toJson(ConfigRetrieverOptions, JsonObject) - Static method in class io.vertx.config.ConfigRetrieverOptionsConverter

toJson(ConfigRetrieverOptions, Map<String, Object>) - Static method in class io.vertx.config.ConfigRetrieverOptionsConverter

toJson() - Method in class io.vertx.config.ConfigStoreOptions

traverse(File) - Static method in class io.vertx.config.spi.utils.FileSet

List all the files from a directory (recursive)

A B C F G I J L N P S T