Index (ignite-configuration-api 9.1.17 API)

A C D E F G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractConfiguration - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation marks a class as an abstract configuration schema.
addIssue(ValidationIssue) - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Signifies that there's something wrong.
any() - Method in interface org.apache.ignite.configuration.NamedConfigurationTree: Returns a placeholder that allows you to add listeners for changing configuration value of any element of the named list and any of its nested configurations.

C

CamelCaseKeys - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that a NamedConfigValue only has elements with keys in lower camel case, for example 'v', 'value', 'valueOne' and 'valueOneAndTwo'.
canValidate(Class<? extends Annotation>, Class<?>, boolean) - Method in interface org.apache.ignite.configuration.validation.Validator: Checks whether this validator can validate a schema field with given annotation and given class.
caseSensitive() - Element in annotation interface org.apache.ignite.configuration.validation.OneOf: Returns true if list is case-sensitive.
change(Consumer<CHANGET>) - Method in interface org.apache.ignite.configuration.ConfigurationTree: Changes this configuration node value.
changeRoot(RootKey<?, ? super C, C>) - Method in interface org.apache.ignite.configuration.SuperRootChange: Returns a root change for the root key.
Config - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation, if applied to a class, marks it as a configuration schema part.
ConfigurationChangeException - Exception in org.apache.ignite.configuration: Configuration change exception.
ConfigurationChangeException(String) - Constructor for exception org.apache.ignite.configuration.ConfigurationChangeException: Constructor.
ConfigurationChangeException(String, Throwable) - Constructor for exception org.apache.ignite.configuration.ConfigurationChangeException: Constructor.
ConfigurationDynamicDefaultsPatcher - Interface in org.apache.ignite.configuration: Patcher for the configuration.
ConfigurationExtension - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation can only be applied to a class that is either marked with ConfigurationRoot or the superclass is marked with ConfigurationRoot, Config.
ConfigurationListener<VIEWT> - Interface in org.apache.ignite.configuration.notifications: Configuration property change listener.
ConfigurationListenOnlyException - Exception in org.apache.ignite.configuration: This exception is used if an attempt was made to get/update a configuration value in listen-only mode.
ConfigurationListenOnlyException(String) - Constructor for exception org.apache.ignite.configuration.ConfigurationListenOnlyException: Constructor.
ConfigurationModule - Interface in org.apache.ignite.configuration: A module of configuration provided by a JAR file (or, in its source form, by a Maven/Gradle/...
ConfigurationNamedListListener<VIEWT> - Interface in org.apache.ignite.configuration.notifications: Configuration property change listener for named list configurations.
ConfigurationNodeAlreadyExistException - Exception in org.apache.ignite.configuration: This exception is thrown when an operation attempts to create a node with a key that already exists.
ConfigurationNodeAlreadyExistException(String) - Constructor for exception org.apache.ignite.configuration.ConfigurationNodeAlreadyExistException: The constructor.
ConfigurationNodeDoesNotExistException - Exception in org.apache.ignite.configuration: This exception is thrown when an operation attempts to access a node with a key that no longer exists.
ConfigurationNodeDoesNotExistException(String) - Constructor for exception org.apache.ignite.configuration.ConfigurationNodeDoesNotExistException: The constructor.
ConfigurationNodeModificationException - Exception in org.apache.ignite.configuration: The base class for exceptions that can be thrown during modification of NamedListChange.
ConfigurationNodeRemovedException - Exception in org.apache.ignite.configuration: This exception is thrown when an operation attempts to modify a node with a key that was removed.
ConfigurationNodeRemovedException(String) - Constructor for exception org.apache.ignite.configuration.ConfigurationNodeRemovedException: The constructor.
ConfigurationNotificationEvent<VIEWT> - Interface in org.apache.ignite.configuration.notifications: Event object propagated on configuration change.
ConfigurationProperty<VIEWT> - Interface in org.apache.ignite.configuration: Base interface for configuration.
ConfigurationReadOnlyException - Exception in org.apache.ignite.configuration: This exception is used if an attempt was made to update a configuration value in read-only mode.
ConfigurationReadOnlyException(String) - Constructor for exception org.apache.ignite.configuration.ConfigurationReadOnlyException: Constructor.
ConfigurationRoot - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation, if applied to a class, marks it as a configuration schema root.
ConfigurationTree<VIEWT,CHANGET> - Interface in org.apache.ignite.configuration: Configuration tree with configuration values and other configuration trees as child nodes.
ConfigurationType - Enum Class in org.apache.ignite.configuration.annotation: Type of configuration storage.
ConfigurationValidationException - Exception in org.apache.ignite.configuration.validation: Configuration validation exception.
ConfigurationValidationException(String) - Constructor for exception org.apache.ignite.configuration.validation.ConfigurationValidationException: Constructor.
ConfigurationValidationException(Collection<ValidationIssue>) - Constructor for exception org.apache.ignite.configuration.validation.ConfigurationValidationException: Constructor.
ConfigurationValue<VIEWT> - Interface in org.apache.ignite.configuration: Configuration value.
ConfigurationWrongPolymorphicTypeIdException - Exception in org.apache.ignite.configuration: Thrown when the wrong (unknown) type of polymorphic configuration is used.
ConfigurationWrongPolymorphicTypeIdException(String) - Constructor for exception org.apache.ignite.configuration.ConfigurationWrongPolymorphicTypeIdException: Constructor.
ConfigValue - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation marks configuration schema field as a configuration tree node.
create(int, String, Consumer<CHANGET>) - Method in interface org.apache.ignite.configuration.NamedListChange: Creates a new value at the given position in the named list configuration.
create(String, Consumer<CHANGET>) - Method in interface org.apache.ignite.configuration.NamedListChange: Creates a new value in the named list configuration.
createAfter(String, String, Consumer<CHANGET>) - Method in interface org.apache.ignite.configuration.NamedListChange: Create a new value after a given precedingKey key in the named list configuration.
createOrUpdate(String, Consumer<CHANGET>) - Method in interface org.apache.ignite.configuration.NamedListChange: Updates a value in the named list configuration.
currentKey() - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Returns the key of validated node.

D

delete(String) - Method in interface org.apache.ignite.configuration.NamedListChange: Removes the value from the named list configuration.
deletedPrefixes() - Method in interface org.apache.ignite.configuration.ConfigurationModule: Returns a collection of prefixes, removed from configuration.
directProxy() - Method in interface org.apache.ignite.configuration.ConfigurationProperty: Returns a configuration tree for the purpose of reading configuration directly from the underlying storage.
directProxy() - Method in interface org.apache.ignite.configuration.NamedConfigurationTree
DISTRIBUTED - Enum constant in enum class org.apache.ignite.configuration.annotation.ConfigurationType: Distributed configuration.

E

Endpoint - Annotation Interface in org.apache.ignite.configuration.validation: Annotation to validate endpoint.
equals(Object) - Method in class org.apache.ignite.configuration.validation.ValidationIssue
ExceptKeys - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that a NamedConfigValue can't have elements with provided names.

F

fromConsumer(Consumer<ConfigurationNotificationEvent<T>>) - Static method in interface org.apache.ignite.configuration.notifications.ConfigurationListener: Creates an adapter for a given callback.
fromDeletedPrefixes(Collection<String>) - Static method in interface org.apache.ignite.configuration.KeyIgnorer: Creates a key ignorer that uses specified deletedPrefixes.
fromNewValueConsumer(Consumer<T>) - Static method in interface org.apache.ignite.configuration.notifications.ConfigurationListener: Creates an adapter for a given callback.

G

get(int) - Method in interface org.apache.ignite.configuration.NamedListView: Returns value located at the specified index.
get(String) - Method in interface org.apache.ignite.configuration.NamedConfigurationTree: Get named configuration by name.
get(String) - Method in interface org.apache.ignite.configuration.NamedListView: Returns value associated with the passed key.
get(UUID) - Method in interface org.apache.ignite.configuration.NamedConfigurationTree: Retrieves a named list element by its internal id.
get(UUID) - Method in interface org.apache.ignite.configuration.NamedListView: Returns value associated with the passed internal id.
getIssues() - Method in exception org.apache.ignite.configuration.validation.ConfigurationValidationException: Returns list of issues occurred during validation.
getNewOwner() - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Returns the updated view of the owner of the current value.
getNewRoot(RootKey<?, ROOT, ?>) - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Returns updated value of the configuration root.
getNewValue() - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Returns updated value of the configuration.
getOldOwner() - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Returns a previous view of the owner of the current value.
getOldRoot(RootKey<?, ROOT, ?>) - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Returns previous value of the configuration root.
getOldValue() - Method in interface org.apache.ignite.configuration.validation.ValidationContext: Returns previous value of the configuration.

H

hasDefault() - Element in annotation interface org.apache.ignite.configuration.annotation.InjectedValue: Indicates that the current configuration value has a default value.
hasDefault() - Element in annotation interface org.apache.ignite.configuration.annotation.PolymorphicId: Indicates that the field contains a default value that should be equal to one of the PolymorphicConfigInstance.value().
hasDefault() - Element in annotation interface org.apache.ignite.configuration.annotation.Value: Indicates that the current configuration value has a default value.
hashCode() - Method in class org.apache.ignite.configuration.validation.ValidationIssue

I

Immutable - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that this value can only be initialized and can't be changed afterwards.
InjectedName - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation marks a configuration schema field as special (read-only) for getting the key associated with the configuration in the named list.
InjectedValue - Annotation Interface in org.apache.ignite.configuration.annotation: This annotations is intended to be placed on NamedConfigValue elements to emulate key-value pairs in configuration schemas.
internal() - Element in annotation interface org.apache.ignite.configuration.annotation.ConfigurationExtension: Controls whether this configuration is part of the public configuration or is hidden from the end user.
internal() - Method in class org.apache.ignite.configuration.RootKey: Check if the root configuration is marked with ConfigurationExtension and ConfigurationExtension.internal() is true.
InternalId - Annotation Interface in org.apache.ignite.configuration.annotation: Internal id.
internalIds() - Method in interface org.apache.ignite.configuration.NamedConfigurationTree: Returns all internal ids of the elements from the list.
isEmpty() - Method in interface org.apache.ignite.configuration.NamedListView: Returns the true if this list is empty.
iterator() - Method in interface org.apache.ignite.configuration.NamedListView

K

key() - Method in interface org.apache.ignite.configuration.ConfigurationProperty: Get key of this node.
key() - Method in class org.apache.ignite.configuration.RootKey: Returns the name of the configuration root.
key() - Method in class org.apache.ignite.configuration.validation.ValidationIssue: Returns configuration key that did not pass the validation.
KeyIgnorer - Interface in org.apache.ignite.configuration: Determines if key should be ignored while processing configuration.

L

legacyNames() - Element in annotation interface org.apache.ignite.configuration.annotation.PublicName: An array of old deprecated names for the configuration.
listen(ConfigurationListener<VIEWT>) - Method in interface org.apache.ignite.configuration.ConfigurationProperty: Adds configuration values listener.
listenElements(ConfigurationNamedListListener<VIEWT>) - Method in interface org.apache.ignite.configuration.NamedConfigurationTree: Add named-list-specific configuration values listener.
LOCAL - Enum constant in enum class org.apache.ignite.configuration.annotation.ConfigurationType: Local configuration.

M

max() - Element in annotation interface org.apache.ignite.configuration.validation.Range: Returns the upper bound for the value.
message() - Method in class org.apache.ignite.configuration.validation.ValidationIssue: Returns error message.
migrateDeprecatedConfigurations(SuperRootChange) - Method in interface org.apache.ignite.configuration.ConfigurationModule: Logic to perform configuration migration when Ignite version is upgraded.
min() - Element in annotation interface org.apache.ignite.configuration.validation.Range: Returns the lower bound for the value.
MultipleOf - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that this value must be a multiple of the given multiplier.

N

Name - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation is used in conjunction with ConfigValue in case the nested schema contains a field with InjectedName in order to be able to set different default values for the field with InjectedName.
NamedConfigurationTree<T extends ConfigurationProperty<VIEWT>,VIEWT,CHANGET extends VIEWT> - Interface in org.apache.ignite.configuration: Configuration tree representing arbitrary set of named underlying configuration tree of the same type.
NamedConfigValue - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation denotes configuration schema fields that are dynamically created and mapped by name.
NamedListChange<VIEWT,CHANGET extends VIEWT> - Interface in org.apache.ignite.configuration: Closure parameter for ConfigurationTree.change(Consumer) method.
namedListKeys() - Method in interface org.apache.ignite.configuration.NamedListView: Returns an immutable collection of keys contained within this list.
NamedListView<VIEWT> - Interface in org.apache.ignite.configuration: View type for a NamedConfigurationTree.
newName(Class<?>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNotificationEvent: Returns new value of the key of a named list item for the parent (any from the root) or current configuration.
newValue() - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNotificationEvent: Returns updated value of the configuration.
newValue(Class<T>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNotificationEvent: Returns new value of the parent (any from the root) or current configuration.
NotBlank - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that current String configuration values can not be blank.

O

oldName(Class<?>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNotificationEvent: Returns old value of the key of a named list item for the parent (any from the root) or current configuration.
oldValue() - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNotificationEvent: Returns the previous value of the updated configuration.
oldValue(Class<T>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNotificationEvent: Returns old value of the parent (any from the root) or current configuration.
onCreate(ConfigurationNotificationEvent<VIEWT>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNamedListListener: Called when new named list element is created.
onDelete(ConfigurationNotificationEvent<VIEWT>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNamedListListener: Called when named list element is deleted.
OneOf - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that current String configuration values can only be equal to one of the listed values.
onRename(ConfigurationNotificationEvent<VIEWT>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNamedListListener: Called when a named list element is renamed.
onUpdate(ConfigurationNotificationEvent<VIEWT>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationListener: Called on property value update.
onUpdate(ConfigurationNotificationEvent<VIEWT>) - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNamedListListener: Called on property value update.
org.apache.ignite.configuration - package org.apache.ignite.configuration: Basic classes and interfaces for describing and handling configuration trees.
org.apache.ignite.configuration.annotation - package org.apache.ignite.configuration.annotation: Annotations for configuration schemas.
org.apache.ignite.configuration.notifications - package org.apache.ignite.configuration.notifications: Interfaces and classes for configuration notifications.
org.apache.ignite.configuration.validation - package org.apache.ignite.configuration.validation: Interfaces and classes for configuration validation.

P

patchConfigurationWithDynamicDefaults(SuperRootChange) - Method in interface org.apache.ignite.configuration.ConfigurationModule: Patches the provided configuration with dynamic default values.
patchWithDynamicDefaults(String) - Method in interface org.apache.ignite.configuration.ConfigurationDynamicDefaultsPatcher: Patches the configuration with the dynamic default values that are not known at the compile time.
PolymorphicChange - Interface in org.apache.ignite.configuration: Marker interface for *Node classes whose schemas are marked with annotation PolymorphicConfigInstance, this will allow at the compilation stage to distinguish an instance of a polymorphic configuration from the polymorphic configuration itself.
PolymorphicConfig - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation marks the class as a polymorphic configuration schema.
PolymorphicConfigInstance - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation marks the class as an instance of polymorphic configuration schema.
PolymorphicId - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation marks the polymorphic configuration schema field as a special (read only) leaf that will store the current polymorphic configuration type.
polymorphicSchemaExtensions() - Method in interface org.apache.ignite.configuration.ConfigurationModule: Returns classes of polymorphic schema extensions (annotated with PolymorphicConfig) provided by this module.
PowerOfTwo - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that this value must be a power of two.
PublicName - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation allows defining configuration property name that is otherwise impossible to define in configuration schema.

R

Range - Annotation Interface in org.apache.ignite.configuration.validation: Signifies that this value has lower limit (inclusive) and has upper limit (inclusive).
rename(String, String) - Method in interface org.apache.ignite.configuration.NamedListChange: Renames the existing value in the named list configuration.
RootKey<T extends ConfigurationTree<? super VIEWT,? super CHANGET>,VIEWT,CHANGET extends VIEWT> - Class in org.apache.ignite.configuration: Configuration root selector.
RootKey(String, ConfigurationType, Class<?>, boolean) - Constructor for class org.apache.ignite.configuration.RootKey: Constructor with explicit fields values.
rootKeys() - Method in interface org.apache.ignite.configuration.ConfigurationModule: Returns keys of configuration roots provided by this module.
rootName() - Element in annotation interface org.apache.ignite.configuration.annotation.ConfigurationRoot: Returns the unique root name.

S

schemaClass() - Method in class org.apache.ignite.configuration.RootKey: Returns the schema class for the root.
schemaExtensions() - Method in interface org.apache.ignite.configuration.ConfigurationModule: Returns classes of schema extensions (annotated with ConfigurationExtension) provided by this module, including internal extensions.
Secret - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation is used to mark a configuration field as sensitive information.
shouldIgnore(String) - Method in interface org.apache.ignite.configuration.KeyIgnorer: Returns true if key should be ignored.
size() - Method in interface org.apache.ignite.configuration.NamedListView: Returns the number of elements in this list.
stopListen(ConfigurationListener<VIEWT>) - Method in interface org.apache.ignite.configuration.ConfigurationProperty: Removes configuration values listener.
stopListenElements(ConfigurationNamedListListener<VIEWT>) - Method in interface org.apache.ignite.configuration.NamedConfigurationTree: Removes named-list-specific configuration values listener.
storageRevision() - Method in interface org.apache.ignite.configuration.notifications.ConfigurationNotificationEvent: Returns monotonously increasing counter, linked to the specific storage for current configuration values.
StorageStringSize - Annotation Interface in org.apache.ignite.configuration.validation: Annotation for checking the correctness of storage string size.
stream() - Method in interface org.apache.ignite.configuration.NamedListView: Returns an ordered stream of values from the named list.
SuperRootChange - Interface in org.apache.ignite.configuration: Interface that represent a "change" for the conjunction of all roots in the configuration.
syntheticKeyName() - Element in annotation interface org.apache.ignite.configuration.annotation.NamedConfigValue: Key that can be used in HOCON configuration syntax to declare named list with fixed order.

T

toString() - Method in class org.apache.ignite.configuration.RootKey
toString() - Method in class org.apache.ignite.configuration.validation.ValidationIssue
type() - Element in annotation interface org.apache.ignite.configuration.annotation.ConfigurationRoot: Returns the type of the configuration.
type() - Method in interface org.apache.ignite.configuration.ConfigurationModule: Type of the configuration provided by this module.
type() - Method in class org.apache.ignite.configuration.RootKey: Returns the configuration type of the root.

U

update(String, Consumer<CHANGET>) - Method in interface org.apache.ignite.configuration.NamedListChange: Updates a value in the named list configuration.
update(VIEWT) - Method in interface org.apache.ignite.configuration.ConfigurationValue: Update this configuration node value.

V

validate(A, ValidationContext<VIEWT>) - Method in interface org.apache.ignite.configuration.validation.Validator: Perform validation.
ValidationContext<VIEWT> - Interface in org.apache.ignite.configuration.validation: Validation context for the validators.
ValidationIssue - Class in org.apache.ignite.configuration.validation: Class that stores information about issues found during the configuration validation.
ValidationIssue(String, String) - Constructor for class org.apache.ignite.configuration.validation.ValidationIssue: Constructor.
Validator<A extends Annotation,VIEWT> - Interface in org.apache.ignite.configuration.validation: Interface for all configuration validators.
validators() - Method in interface org.apache.ignite.configuration.ConfigurationModule: Returns configuration validators provided by this module.
value() - Element in annotation interface org.apache.ignite.configuration.annotation.Name: Returns the default value for InjectedName.
value() - Element in annotation interface org.apache.ignite.configuration.annotation.PolymorphicConfigInstance: Unique identifier for an extension within a single polymorphic configuration.
value() - Element in annotation interface org.apache.ignite.configuration.annotation.PublicName: Public configuration property name.
value() - Method in interface org.apache.ignite.configuration.ConfigurationProperty: Get value of this property.
value() - Element in annotation interface org.apache.ignite.configuration.validation.ExceptKeys: Returns list of reserved names.
value() - Element in annotation interface org.apache.ignite.configuration.validation.MultipleOf: Returns multiplier value.
value() - Element in annotation interface org.apache.ignite.configuration.validation.OneOf: Returns list of possible values.
Value - Annotation Interface in org.apache.ignite.configuration.annotation: This annotation marks configuration schema field as a configuration tree leaf.
valueOf(String) - Static method in enum class org.apache.ignite.configuration.annotation.ConfigurationType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.ignite.configuration.annotation.ConfigurationType: Returns an array containing the constants of this enum class, in the order they are declared.
viewRoot(RootKey<?, V, ?>) - Method in interface org.apache.ignite.configuration.SuperRootChange: Returns a root view for the root key.

A C D E F G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form