Package io.envoyproxy.envoy.extensions.http.header_validators.envoy_default.v3

Class HeaderValidatorConfig.UriPathNormalizationOptions.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderValidatorConfig.UriPathNormalizationOptions.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderValidatorConfig.UriPathNormalizationOptions.Builder>

      • getDefaultInstanceForType

        public HeaderValidatorConfig.UriPathNormalizationOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • buildPartial

        public HeaderValidatorConfig.UriPathNormalizationOptions buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • getSkipPathNormalization

        public boolean getSkipPathNormalization()
         Should paths be normalized according to RFC 3986?
 This operation overwrites the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
 Envoy will respond with 400 to requests with malformed paths that fail path normalization.
 The default behavior is to normalize the path.
 This value may be overridden by the runtime variable
 :ref:`http_connection_manager.normalize_path<config_http_conn_man_runtime_normalize_path>`.
 See `Normalization and Comparison <https://datatracker.ietf.org/doc/html/rfc3986#section-6>`_
 for details of normalization.
 Note that Envoy does not perform
 `case normalization <https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.1>`_
 URI path normalization can be applied to a portion of requests by setting the
 ``envoy_default_header_validator.path_normalization`` runtime value.
        bool skip_path_normalization = 1;
        Specified by:
        getSkipPathNormalization in interface HeaderValidatorConfig.UriPathNormalizationOptionsOrBuilder
        Returns:
        The skipPathNormalization.

      • setSkipPathNormalization

        public HeaderValidatorConfig.UriPathNormalizationOptions.Builder setSkipPathNormalization​(boolean value)
         Should paths be normalized according to RFC 3986?
 This operation overwrites the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
 Envoy will respond with 400 to requests with malformed paths that fail path normalization.
 The default behavior is to normalize the path.
 This value may be overridden by the runtime variable
 :ref:`http_connection_manager.normalize_path<config_http_conn_man_runtime_normalize_path>`.
 See `Normalization and Comparison <https://datatracker.ietf.org/doc/html/rfc3986#section-6>`_
 for details of normalization.
 Note that Envoy does not perform
 `case normalization <https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.1>`_
 URI path normalization can be applied to a portion of requests by setting the
 ``envoy_default_header_validator.path_normalization`` runtime value.
        bool skip_path_normalization = 1;
        Parameters:
        value - The skipPathNormalization to set.
        Returns:
        This builder for chaining.

      • clearSkipPathNormalization

        public HeaderValidatorConfig.UriPathNormalizationOptions.Builder clearSkipPathNormalization()
         Should paths be normalized according to RFC 3986?
 This operation overwrites the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
 Envoy will respond with 400 to requests with malformed paths that fail path normalization.
 The default behavior is to normalize the path.
 This value may be overridden by the runtime variable
 :ref:`http_connection_manager.normalize_path<config_http_conn_man_runtime_normalize_path>`.
 See `Normalization and Comparison <https://datatracker.ietf.org/doc/html/rfc3986#section-6>`_
 for details of normalization.
 Note that Envoy does not perform
 `case normalization <https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.1>`_
 URI path normalization can be applied to a portion of requests by setting the
 ``envoy_default_header_validator.path_normalization`` runtime value.
        bool skip_path_normalization = 1;
        Returns:
        This builder for chaining.

      • getSkipMergingSlashes

        public boolean getSkipMergingSlashes()
         Determines if adjacent slashes in the path are merged into one.
 This operation overwrites the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
 Setting this option to true will cause incoming requests with path ``//dir///file`` to not match against
 route with ``prefix`` match set to ``/dir``. Defaults to ``false``. Note that slash merging is not part of
 `HTTP spec <https://datatracker.ietf.org/doc/html/rfc3986>`_ and is provided for convenience.
 Merging of slashes in URI path can be applied to a portion of requests by setting the
 ``envoy_default_header_validator.merge_slashes`` runtime value.
        bool skip_merging_slashes = 2;
        Specified by:
        getSkipMergingSlashes in interface HeaderValidatorConfig.UriPathNormalizationOptionsOrBuilder
        Returns:
        The skipMergingSlashes.

      • setSkipMergingSlashes

        public HeaderValidatorConfig.UriPathNormalizationOptions.Builder setSkipMergingSlashes​(boolean value)
         Determines if adjacent slashes in the path are merged into one.
 This operation overwrites the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
 Setting this option to true will cause incoming requests with path ``//dir///file`` to not match against
 route with ``prefix`` match set to ``/dir``. Defaults to ``false``. Note that slash merging is not part of
 `HTTP spec <https://datatracker.ietf.org/doc/html/rfc3986>`_ and is provided for convenience.
 Merging of slashes in URI path can be applied to a portion of requests by setting the
 ``envoy_default_header_validator.merge_slashes`` runtime value.
        bool skip_merging_slashes = 2;
        Parameters:
        value - The skipMergingSlashes to set.
        Returns:
        This builder for chaining.

      • clearSkipMergingSlashes

        public HeaderValidatorConfig.UriPathNormalizationOptions.Builder clearSkipMergingSlashes()
         Determines if adjacent slashes in the path are merged into one.
 This operation overwrites the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
 Setting this option to true will cause incoming requests with path ``//dir///file`` to not match against
 route with ``prefix`` match set to ``/dir``. Defaults to ``false``. Note that slash merging is not part of
 `HTTP spec <https://datatracker.ietf.org/doc/html/rfc3986>`_ and is provided for convenience.
 Merging of slashes in URI path can be applied to a portion of requests by setting the
 ``envoy_default_header_validator.merge_slashes`` runtime value.
        bool skip_merging_slashes = 2;
        Returns:
        This builder for chaining.

      • getPathWithEscapedSlashesActionValue

        public int getPathWithEscapedSlashesActionValue()
         The action to take when request URL path contains escaped slash sequences (``%2F``, ``%2f``, ``%5C`` and ``%5c``).
 This operation may overwrite the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
        .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions.PathWithEscapedSlashesAction path_with_escaped_slashes_action = 3;
        Specified by:
        getPathWithEscapedSlashesActionValue in interface HeaderValidatorConfig.UriPathNormalizationOptionsOrBuilder
        Returns:
        The enum numeric value on the wire for pathWithEscapedSlashesAction.

      • setPathWithEscapedSlashesActionValue

        public HeaderValidatorConfig.UriPathNormalizationOptions.Builder setPathWithEscapedSlashesActionValue​(int value)
         The action to take when request URL path contains escaped slash sequences (``%2F``, ``%2f``, ``%5C`` and ``%5c``).
 This operation may overwrite the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
        .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions.PathWithEscapedSlashesAction path_with_escaped_slashes_action = 3;
        Parameters:
        value - The enum numeric value on the wire for pathWithEscapedSlashesAction to set.
        Returns:
        This builder for chaining.

      • setPathWithEscapedSlashesAction

        public HeaderValidatorConfig.UriPathNormalizationOptions.Builder setPathWithEscapedSlashesAction​(HeaderValidatorConfig.UriPathNormalizationOptions.PathWithEscapedSlashesAction value)
         The action to take when request URL path contains escaped slash sequences (``%2F``, ``%2f``, ``%5C`` and ``%5c``).
 This operation may overwrite the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
        .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions.PathWithEscapedSlashesAction path_with_escaped_slashes_action = 3;
        Parameters:
        value - The pathWithEscapedSlashesAction to set.
        Returns:
        This builder for chaining.

      • clearPathWithEscapedSlashesAction

        public HeaderValidatorConfig.UriPathNormalizationOptions.Builder clearPathWithEscapedSlashesAction()
         The action to take when request URL path contains escaped slash sequences (``%2F``, ``%2f``, ``%5C`` and ``%5c``).
 This operation may overwrite the original request URI path and the new path is used for processing of
 the request by HTTP filters and proxied to the upstream service.
        .envoy.extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.UriPathNormalizationOptions.PathWithEscapedSlashesAction path_with_escaped_slashes_action = 3;
        Returns:
        This builder for chaining.