Package io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3

Class HttpConnectionManager.PathNormalizationOptions

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpConnectionManager.PathNormalizationOptionsOrBuilder, java.io.Serializable
    Enclosing class:
    HttpConnectionManager
    public static final class HttpConnectionManager.PathNormalizationOptions
extends com.google.protobuf.GeneratedMessage
implements HttpConnectionManager.PathNormalizationOptionsOrBuilder
     [#not-implemented-hide:] Transformations that apply to path headers. Transformations are applied
 before any processing of requests by HTTP filters, routing, and matching. Only the normalized
 path will be visible internally if a transformation is enabled. Any path rewrites that the
 router performs (e.g. :ref:`regex_rewrite
 <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>` or :ref:`prefix_rewrite
 <envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`) will apply to the ``:path`` header
 destined for the upstream.

 Note: access logging and tracing will show the original ``:path`` header.
    Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.PathNormalizationOptions
    See Also:
    Serialized Form

    • Constructor Detail

      • PathNormalizationOptions

        private PathNormalizationOptions​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • PathNormalizationOptions

        private PathNormalizationOptions()

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • hasForwardingTransformation

        public boolean hasForwardingTransformation()
         [#not-implemented-hide:] Normalization applies internally before any processing of requests by
 HTTP filters, routing, and matching *and* will affect the forwarded ``:path`` header. Defaults
 to :ref:`NormalizePathRFC3986
 <envoy_v3_api_msg_type.http.v3.PathTransformation.Operation.NormalizePathRFC3986>`. When not
 specified, this value may be overridden by the runtime variable
 :ref:`http_connection_manager.normalize_path<config_http_conn_man_runtime_normalize_path>`.
 Envoy will respond with 400 to paths that are malformed (e.g. for paths that fail RFC 3986
 normalization due to disallowed characters.)
        .envoy.type.http.v3.PathTransformation forwarding_transformation = 1;
        Specified by:
        hasForwardingTransformation in interface HttpConnectionManager.PathNormalizationOptionsOrBuilder
        Returns:
        Whether the forwardingTransformation field is set.

      • getForwardingTransformation

        public PathTransformation getForwardingTransformation()
         [#not-implemented-hide:] Normalization applies internally before any processing of requests by
 HTTP filters, routing, and matching *and* will affect the forwarded ``:path`` header. Defaults
 to :ref:`NormalizePathRFC3986
 <envoy_v3_api_msg_type.http.v3.PathTransformation.Operation.NormalizePathRFC3986>`. When not
 specified, this value may be overridden by the runtime variable
 :ref:`http_connection_manager.normalize_path<config_http_conn_man_runtime_normalize_path>`.
 Envoy will respond with 400 to paths that are malformed (e.g. for paths that fail RFC 3986
 normalization due to disallowed characters.)
        .envoy.type.http.v3.PathTransformation forwarding_transformation = 1;
        Specified by:
        getForwardingTransformation in interface HttpConnectionManager.PathNormalizationOptionsOrBuilder
        Returns:
        The forwardingTransformation.

      • getForwardingTransformationOrBuilder

        public PathTransformationOrBuilder getForwardingTransformationOrBuilder()
         [#not-implemented-hide:] Normalization applies internally before any processing of requests by
 HTTP filters, routing, and matching *and* will affect the forwarded ``:path`` header. Defaults
 to :ref:`NormalizePathRFC3986
 <envoy_v3_api_msg_type.http.v3.PathTransformation.Operation.NormalizePathRFC3986>`. When not
 specified, this value may be overridden by the runtime variable
 :ref:`http_connection_manager.normalize_path<config_http_conn_man_runtime_normalize_path>`.
 Envoy will respond with 400 to paths that are malformed (e.g. for paths that fail RFC 3986
 normalization due to disallowed characters.)
        .envoy.type.http.v3.PathTransformation forwarding_transformation = 1;
        Specified by:
        getForwardingTransformationOrBuilder in interface HttpConnectionManager.PathNormalizationOptionsOrBuilder

      • hasHttpFilterTransformation

        public boolean hasHttpFilterTransformation()
         [#not-implemented-hide:] Normalization only applies internally before any processing of
 requests by HTTP filters, routing, and matching. These will be applied after full
 transformation is applied. The ``:path`` header before this transformation will be restored in
 the router filter and sent upstream unless it was mutated by a filter. Defaults to no
 transformations.
 Multiple actions can be applied in the same Transformation, forming a sequential
 pipeline. The transformations will be performed in the order that they appear. Envoy will
 respond with 400 to paths that are malformed (e.g. for paths that fail RFC 3986
 normalization due to disallowed characters.)
        .envoy.type.http.v3.PathTransformation http_filter_transformation = 2;
        Specified by:
        hasHttpFilterTransformation in interface HttpConnectionManager.PathNormalizationOptionsOrBuilder
        Returns:
        Whether the httpFilterTransformation field is set.

      • getHttpFilterTransformation

        public PathTransformation getHttpFilterTransformation()
         [#not-implemented-hide:] Normalization only applies internally before any processing of
 requests by HTTP filters, routing, and matching. These will be applied after full
 transformation is applied. The ``:path`` header before this transformation will be restored in
 the router filter and sent upstream unless it was mutated by a filter. Defaults to no
 transformations.
 Multiple actions can be applied in the same Transformation, forming a sequential
 pipeline. The transformations will be performed in the order that they appear. Envoy will
 respond with 400 to paths that are malformed (e.g. for paths that fail RFC 3986
 normalization due to disallowed characters.)
        .envoy.type.http.v3.PathTransformation http_filter_transformation = 2;
        Specified by:
        getHttpFilterTransformation in interface HttpConnectionManager.PathNormalizationOptionsOrBuilder
        Returns:
        The httpFilterTransformation.

      • getHttpFilterTransformationOrBuilder

        public PathTransformationOrBuilder getHttpFilterTransformationOrBuilder()
         [#not-implemented-hide:] Normalization only applies internally before any processing of
 requests by HTTP filters, routing, and matching. These will be applied after full
 transformation is applied. The ``:path`` header before this transformation will be restored in
 the router filter and sent upstream unless it was mutated by a filter. Defaults to no
 transformations.
 Multiple actions can be applied in the same Transformation, forming a sequential
 pipeline. The transformations will be performed in the order that they appear. Envoy will
 respond with 400 to paths that are malformed (e.g. for paths that fail RFC 3986
 normalization due to disallowed characters.)
        .envoy.type.http.v3.PathTransformation http_filter_transformation = 2;
        Specified by:
        getHttpFilterTransformationOrBuilder in interface HttpConnectionManager.PathNormalizationOptionsOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static HttpConnectionManager.PathNormalizationOptions parseFrom​(java.nio.ByteBuffer data)
                                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.PathNormalizationOptions parseFrom​(java.nio.ByteBuffer data,
                                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.PathNormalizationOptions parseFrom​(com.google.protobuf.ByteString data)
                                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.PathNormalizationOptions parseFrom​(com.google.protobuf.ByteString data,
                                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.PathNormalizationOptions parseFrom​(byte[] data,
                                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HttpConnectionManager.PathNormalizationOptions parseFrom​(java.io.InputStream input,
                                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static HttpConnectionManager.PathNormalizationOptions parseDelimitedFrom​(java.io.InputStream input,
                                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static HttpConnectionManager.PathNormalizationOptions parseFrom​(com.google.protobuf.CodedInputStream input,
                                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • getParserForType

        public com.google.protobuf.Parser<HttpConnectionManager.PathNormalizationOptions> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

        public HttpConnectionManager.PathNormalizationOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder