Class CorsPolicy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CorsPolicyOrBuilder, java.io.Serializable

    public final class CorsPolicy
    extends com.google.protobuf.GeneratedMessage
    implements CorsPolicyOrBuilder
     Cors policy configuration.
    
     .. attention::
    
     This message has been deprecated. Please use
     :ref:`CorsPolicy in filter extension <envoy_v3_api_msg_extensions.filters.http.cors.v3.CorsPolicy>`
     as as alternative.
    
     [#next-free-field: 14]
     
    Protobuf type envoy.config.route.v3.CorsPolicy
    See Also:
    Serialized Form
    • Field Detail

      • bitField0_

        private int bitField0_
      • enabledSpecifierCase_

        private int enabledSpecifierCase_
      • enabledSpecifier_

        private java.lang.Object enabledSpecifier_
      • ALLOW_ORIGIN_STRING_MATCH_FIELD_NUMBER

        public static final int ALLOW_ORIGIN_STRING_MATCH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • allowOriginStringMatch_

        private java.util.List<StringMatcher> allowOriginStringMatch_
      • ALLOW_METHODS_FIELD_NUMBER

        public static final int ALLOW_METHODS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • allowMethods_

        private volatile java.lang.Object allowMethods_
      • ALLOW_HEADERS_FIELD_NUMBER

        public static final int ALLOW_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • allowHeaders_

        private volatile java.lang.Object allowHeaders_
      • EXPOSE_HEADERS_FIELD_NUMBER

        public static final int EXPOSE_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • exposeHeaders_

        private volatile java.lang.Object exposeHeaders_
      • maxAge_

        private volatile java.lang.Object maxAge_
      • ALLOW_CREDENTIALS_FIELD_NUMBER

        public static final int ALLOW_CREDENTIALS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • allowCredentials_

        private com.google.protobuf.BoolValue allowCredentials_
      • FILTER_ENABLED_FIELD_NUMBER

        public static final int FILTER_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SHADOW_ENABLED_FIELD_NUMBER

        public static final int SHADOW_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ALLOW_PRIVATE_NETWORK_ACCESS_FIELD_NUMBER

        public static final int ALLOW_PRIVATE_NETWORK_ACCESS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • allowPrivateNetworkAccess_

        private com.google.protobuf.BoolValue allowPrivateNetworkAccess_
      • FORWARD_NOT_MATCHING_PREFLIGHTS_FIELD_NUMBER

        public static final int FORWARD_NOT_MATCHING_PREFLIGHTS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • forwardNotMatchingPreflights_

        private com.google.protobuf.BoolValue forwardNotMatchingPreflights_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final CorsPolicy DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<CorsPolicy> PARSER
    • Constructor Detail

      • CorsPolicy

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

        private CorsPolicy()
    • 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
      • getAllowOriginStringMatchList

        public java.util.List<StringMatcher> getAllowOriginStringMatchList()
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
         string matchers match.
         
        repeated .envoy.type.matcher.v3.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatchList in interface CorsPolicyOrBuilder
      • getAllowOriginStringMatchOrBuilderList

        public java.util.List<? extends StringMatcherOrBuilder> getAllowOriginStringMatchOrBuilderList()
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
         string matchers match.
         
        repeated .envoy.type.matcher.v3.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatchOrBuilderList in interface CorsPolicyOrBuilder
      • getAllowOriginStringMatchCount

        public int getAllowOriginStringMatchCount()
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
         string matchers match.
         
        repeated .envoy.type.matcher.v3.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatchCount in interface CorsPolicyOrBuilder
      • getAllowOriginStringMatch

        public StringMatcher getAllowOriginStringMatch​(int index)
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
         string matchers match.
         
        repeated .envoy.type.matcher.v3.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatch in interface CorsPolicyOrBuilder
      • getAllowOriginStringMatchOrBuilder

        public StringMatcherOrBuilder getAllowOriginStringMatchOrBuilder​(int index)
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
         string matchers match.
         
        repeated .envoy.type.matcher.v3.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatchOrBuilder in interface CorsPolicyOrBuilder
      • getAllowMethods

        public java.lang.String getAllowMethods()
         Specifies the content for the ``access-control-allow-methods`` header.
         
        string allow_methods = 2;
        Specified by:
        getAllowMethods in interface CorsPolicyOrBuilder
        Returns:
        The allowMethods.
      • getAllowMethodsBytes

        public com.google.protobuf.ByteString getAllowMethodsBytes()
         Specifies the content for the ``access-control-allow-methods`` header.
         
        string allow_methods = 2;
        Specified by:
        getAllowMethodsBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for allowMethods.
      • getAllowHeaders

        public java.lang.String getAllowHeaders()
         Specifies the content for the ``access-control-allow-headers`` header.
         
        string allow_headers = 3;
        Specified by:
        getAllowHeaders in interface CorsPolicyOrBuilder
        Returns:
        The allowHeaders.
      • getAllowHeadersBytes

        public com.google.protobuf.ByteString getAllowHeadersBytes()
         Specifies the content for the ``access-control-allow-headers`` header.
         
        string allow_headers = 3;
        Specified by:
        getAllowHeadersBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for allowHeaders.
      • getExposeHeaders

        public java.lang.String getExposeHeaders()
         Specifies the content for the ``access-control-expose-headers`` header.
         
        string expose_headers = 4;
        Specified by:
        getExposeHeaders in interface CorsPolicyOrBuilder
        Returns:
        The exposeHeaders.
      • getExposeHeadersBytes

        public com.google.protobuf.ByteString getExposeHeadersBytes()
         Specifies the content for the ``access-control-expose-headers`` header.
         
        string expose_headers = 4;
        Specified by:
        getExposeHeadersBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for exposeHeaders.
      • getMaxAge

        public java.lang.String getMaxAge()
         Specifies the content for the ``access-control-max-age`` header.
         
        string max_age = 5;
        Specified by:
        getMaxAge in interface CorsPolicyOrBuilder
        Returns:
        The maxAge.
      • getMaxAgeBytes

        public com.google.protobuf.ByteString getMaxAgeBytes()
         Specifies the content for the ``access-control-max-age`` header.
         
        string max_age = 5;
        Specified by:
        getMaxAgeBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for maxAge.
      • hasAllowCredentials

        public boolean hasAllowCredentials()
         Specifies whether the resource allows credentials.
         
        .google.protobuf.BoolValue allow_credentials = 6;
        Specified by:
        hasAllowCredentials in interface CorsPolicyOrBuilder
        Returns:
        Whether the allowCredentials field is set.
      • getAllowCredentials

        public com.google.protobuf.BoolValue getAllowCredentials()
         Specifies whether the resource allows credentials.
         
        .google.protobuf.BoolValue allow_credentials = 6;
        Specified by:
        getAllowCredentials in interface CorsPolicyOrBuilder
        Returns:
        The allowCredentials.
      • getAllowCredentialsOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getAllowCredentialsOrBuilder()
         Specifies whether the resource allows credentials.
         
        .google.protobuf.BoolValue allow_credentials = 6;
        Specified by:
        getAllowCredentialsOrBuilder in interface CorsPolicyOrBuilder
      • hasFilterEnabled

        public boolean hasFilterEnabled()
         Specifies the % of requests for which the CORS filter is enabled.
        
         If neither ``enabled``, ``filter_enabled``, nor ``shadow_enabled`` are specified, the CORS
         filter will be enabled for 100% of the requests.
        
         If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
         specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
         
        .envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 9;
        Specified by:
        hasFilterEnabled in interface CorsPolicyOrBuilder
        Returns:
        Whether the filterEnabled field is set.
      • getFilterEnabled

        public RuntimeFractionalPercent getFilterEnabled()
         Specifies the % of requests for which the CORS filter is enabled.
        
         If neither ``enabled``, ``filter_enabled``, nor ``shadow_enabled`` are specified, the CORS
         filter will be enabled for 100% of the requests.
        
         If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
         specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
         
        .envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 9;
        Specified by:
        getFilterEnabled in interface CorsPolicyOrBuilder
        Returns:
        The filterEnabled.
      • getFilterEnabledOrBuilder

        public RuntimeFractionalPercentOrBuilder getFilterEnabledOrBuilder()
         Specifies the % of requests for which the CORS filter is enabled.
        
         If neither ``enabled``, ``filter_enabled``, nor ``shadow_enabled`` are specified, the CORS
         filter will be enabled for 100% of the requests.
        
         If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
         specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
         
        .envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 9;
        Specified by:
        getFilterEnabledOrBuilder in interface CorsPolicyOrBuilder
      • hasShadowEnabled

        public boolean hasShadowEnabled()
         Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
         enforced.
        
         This field is intended to be used when ``filter_enabled`` and ``enabled`` are off. One of those
         fields have to explicitly disable the filter in order for this setting to take effect.
        
         If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
         Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
         and track the request's ``Origin`` to determine if it's valid but will not enforce any policies.
         
        .envoy.config.core.v3.RuntimeFractionalPercent shadow_enabled = 10;
        Specified by:
        hasShadowEnabled in interface CorsPolicyOrBuilder
        Returns:
        Whether the shadowEnabled field is set.
      • getShadowEnabled

        public RuntimeFractionalPercent getShadowEnabled()
         Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
         enforced.
        
         This field is intended to be used when ``filter_enabled`` and ``enabled`` are off. One of those
         fields have to explicitly disable the filter in order for this setting to take effect.
        
         If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
         Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
         and track the request's ``Origin`` to determine if it's valid but will not enforce any policies.
         
        .envoy.config.core.v3.RuntimeFractionalPercent shadow_enabled = 10;
        Specified by:
        getShadowEnabled in interface CorsPolicyOrBuilder
        Returns:
        The shadowEnabled.
      • getShadowEnabledOrBuilder

        public RuntimeFractionalPercentOrBuilder getShadowEnabledOrBuilder()
         Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
         enforced.
        
         This field is intended to be used when ``filter_enabled`` and ``enabled`` are off. One of those
         fields have to explicitly disable the filter in order for this setting to take effect.
        
         If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
         Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
         and track the request's ``Origin`` to determine if it's valid but will not enforce any policies.
         
        .envoy.config.core.v3.RuntimeFractionalPercent shadow_enabled = 10;
        Specified by:
        getShadowEnabledOrBuilder in interface CorsPolicyOrBuilder
      • hasAllowPrivateNetworkAccess

        public boolean hasAllowPrivateNetworkAccess()
         Specify whether allow requests whose target server's IP address is more private than that from
         which the request initiator was fetched.
        
         More details refer to https://developer.chrome.com/blog/private-network-access-preflight.
         
        .google.protobuf.BoolValue allow_private_network_access = 12;
        Specified by:
        hasAllowPrivateNetworkAccess in interface CorsPolicyOrBuilder
        Returns:
        Whether the allowPrivateNetworkAccess field is set.
      • getAllowPrivateNetworkAccess

        public com.google.protobuf.BoolValue getAllowPrivateNetworkAccess()
         Specify whether allow requests whose target server's IP address is more private than that from
         which the request initiator was fetched.
        
         More details refer to https://developer.chrome.com/blog/private-network-access-preflight.
         
        .google.protobuf.BoolValue allow_private_network_access = 12;
        Specified by:
        getAllowPrivateNetworkAccess in interface CorsPolicyOrBuilder
        Returns:
        The allowPrivateNetworkAccess.
      • getAllowPrivateNetworkAccessOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getAllowPrivateNetworkAccessOrBuilder()
         Specify whether allow requests whose target server's IP address is more private than that from
         which the request initiator was fetched.
        
         More details refer to https://developer.chrome.com/blog/private-network-access-preflight.
         
        .google.protobuf.BoolValue allow_private_network_access = 12;
        Specified by:
        getAllowPrivateNetworkAccessOrBuilder in interface CorsPolicyOrBuilder
      • hasForwardNotMatchingPreflights

        public boolean hasForwardNotMatchingPreflights()
         Specifies if preflight requests not matching the configured allowed origin should be forwarded
         to the upstream. Default is true.
         
        .google.protobuf.BoolValue forward_not_matching_preflights = 13;
        Specified by:
        hasForwardNotMatchingPreflights in interface CorsPolicyOrBuilder
        Returns:
        Whether the forwardNotMatchingPreflights field is set.
      • getForwardNotMatchingPreflights

        public com.google.protobuf.BoolValue getForwardNotMatchingPreflights()
         Specifies if preflight requests not matching the configured allowed origin should be forwarded
         to the upstream. Default is true.
         
        .google.protobuf.BoolValue forward_not_matching_preflights = 13;
        Specified by:
        getForwardNotMatchingPreflights in interface CorsPolicyOrBuilder
        Returns:
        The forwardNotMatchingPreflights.
      • getForwardNotMatchingPreflightsOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getForwardNotMatchingPreflightsOrBuilder()
         Specifies if preflight requests not matching the configured allowed origin should be forwarded
         to the upstream. Default is true.
         
        .google.protobuf.BoolValue forward_not_matching_preflights = 13;
        Specified by:
        getForwardNotMatchingPreflightsOrBuilder in interface CorsPolicyOrBuilder
      • 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 CorsPolicy parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static CorsPolicy parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static CorsPolicy parseFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public static CorsPolicy parseDelimitedFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

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

        public static CorsPolicy parseFrom​(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public CorsPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public CorsPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected CorsPolicy.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getDefaultInstance

        public static CorsPolicy getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<CorsPolicy> parser()
      • getParserForType

        public com.google.protobuf.Parser<CorsPolicy> 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 CorsPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder