Package org.elasticsearch.cluster.metadata

Class AliasValidator

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.cluster.metadata.AliasValidator

public class AliasValidator
extends AbstractComponent

Validator for an alias, to be used before adding an alias to the index metadata and make sure the alias is valid

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor	Description
AliasValidator(Settings settings)

Method Summary

Modifier and Type	Method	Description
void	validateAlias(java.lang.String alias, java.lang.String index, java.lang.String indexRouting, java.util.function.Function<java.lang.String,IndexMetaData> indexLookup)	Validate a proposed alias.
void	validateAlias(Alias alias, java.lang.String index, MetaData metaData)	Allows to validate an Alias and make sure it's valid before it gets added to the index metadata.
void	validateAliasFilter(java.lang.String alias, byte[] filter, QueryShardContext queryShardContext, NamedXContentRegistry xContentRegistry)	Validates an alias filter by parsing it using the provided QueryShardContext
void	validateAliasFilter(java.lang.String alias, java.lang.String filter, QueryShardContext queryShardContext, NamedXContentRegistry xContentRegistry)	Validates an alias filter by parsing it using the provided QueryShardContext
void	validateAliasMetaData(AliasMetaData aliasMetaData, java.lang.String index, MetaData metaData)	Allows to validate an AliasMetaData and make sure it's valid before it gets added to the index metadata.
void	validateAliasStandalone(Alias alias)	Allows to partially validate an alias, without knowing which index it'll get applied to.

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AliasValidator

@Inject
public AliasValidator(Settings settings)

Method Detail

validateAlias

public void validateAlias(Alias alias,
                          java.lang.String index,
                          MetaData metaData)

Allows to validate an Alias and make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.

Throws:

java.lang.IllegalArgumentException - if the alias is not valid

validateAliasMetaData

public void validateAliasMetaData(AliasMetaData aliasMetaData,
                                  java.lang.String index,
                                  MetaData metaData)

Allows to validate an AliasMetaData and make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.

Throws:

java.lang.IllegalArgumentException - if the alias is not valid

validateAliasStandalone

public void validateAliasStandalone(Alias alias)

Allows to partially validate an alias, without knowing which index it'll get applied to. Useful with index templates containing aliases. Checks also that it is possible to parse the alias filter via XContentParser, without validating it as a filter though.

Throws:

java.lang.IllegalArgumentException - if the alias is not valid

validateAlias

public void validateAlias(java.lang.String alias,
                          java.lang.String index,
                          @Nullable
                          java.lang.String indexRouting,
                          java.util.function.Function<java.lang.String,IndexMetaData> indexLookup)

Validate a proposed alias.

validateAliasFilter

public void validateAliasFilter(java.lang.String alias,
                                java.lang.String filter,
                                QueryShardContext queryShardContext,
                                NamedXContentRegistry xContentRegistry)

Validates an alias filter by parsing it using the provided QueryShardContext

Throws:

java.lang.IllegalArgumentException - if the filter is not valid

validateAliasFilter

public void validateAliasFilter(java.lang.String alias,
                                byte[] filter,
                                QueryShardContext queryShardContext,
                                NamedXContentRegistry xContentRegistry)

Validates an alias filter by parsing it using the provided QueryShardContext

Throws:

java.lang.IllegalArgumentException - if the filter is not valid