Enum HttpConnectionManager.ForwardClientCertDetails
java.lang.Object
java.lang.Enum<HttpConnectionManager.ForwardClientCertDetails>
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ForwardClientCertDetails
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<HttpConnectionManager.ForwardClientCertDetails>
- Enclosing class:
HttpConnectionManager
public static enum HttpConnectionManager.ForwardClientCertDetails
extends Enum<HttpConnectionManager.ForwardClientCertDetails>
implements com.google.protobuf.ProtocolMessageEnum
How to handle the :ref:`config_http_conn_man_headers_x-forwarded-client-cert` (XFCC) HTTP header.Protobuf enum
envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ForwardClientCertDetails-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAlways forward the XFCC header in the request, regardless of whether the client connection is mTLS.When the client connection is mTLS, append the client certificate information to the request’s XFCC header and forward it.When the client connection is mTLS (Mutual TLS), forward the XFCC header in the request.Do not send the XFCC header to the next hop.When the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intAlways forward the XFCC header in the request, regardless of whether the client connection is mTLS.static final intWhen the client connection is mTLS, append the client certificate information to the request’s XFCC header and forward it.static final intWhen the client connection is mTLS (Mutual TLS), forward the XFCC header in the request.private static final com.google.protobuf.Internal.EnumLiteMap<HttpConnectionManager.ForwardClientCertDetails> static final intWhen the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop.static final intDo not send the XFCC header to the next hop.private final intprivate static final HttpConnectionManager.ForwardClientCertDetails[] -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionforNumber(int value) static final com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<HttpConnectionManager.ForwardClientCertDetails> valueOf(int value) Deprecated.valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.Returns the enum constant of this type with the specified name.values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
SANITIZE
Do not send the XFCC header to the next hop. This is the default value.
SANITIZE = 0; -
FORWARD_ONLY
When the client connection is mTLS (Mutual TLS), forward the XFCC header in the request.
FORWARD_ONLY = 1; -
APPEND_FORWARD
When the client connection is mTLS, append the client certificate information to the request’s XFCC header and forward it.
APPEND_FORWARD = 2; -
SANITIZE_SET
When the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop.
SANITIZE_SET = 3; -
ALWAYS_FORWARD_ONLY
Always forward the XFCC header in the request, regardless of whether the client connection is mTLS.
ALWAYS_FORWARD_ONLY = 4; -
UNRECOGNIZED
-
-
Field Details
-
SANITIZE_VALUE
public static final int SANITIZE_VALUEDo not send the XFCC header to the next hop. This is the default value.
SANITIZE = 0;- See Also:
-
FORWARD_ONLY_VALUE
public static final int FORWARD_ONLY_VALUEWhen the client connection is mTLS (Mutual TLS), forward the XFCC header in the request.
FORWARD_ONLY = 1;- See Also:
-
APPEND_FORWARD_VALUE
public static final int APPEND_FORWARD_VALUEWhen the client connection is mTLS, append the client certificate information to the request’s XFCC header and forward it.
APPEND_FORWARD = 2;- See Also:
-
SANITIZE_SET_VALUE
public static final int SANITIZE_SET_VALUEWhen the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop.
SANITIZE_SET = 3;- See Also:
-
ALWAYS_FORWARD_ONLY_VALUE
public static final int ALWAYS_FORWARD_ONLY_VALUEAlways forward the XFCC header in the request, regardless of whether the client connection is mTLS.
ALWAYS_FORWARD_ONLY = 4;- See Also:
-
internalValueMap
private static final com.google.protobuf.Internal.EnumLiteMap<HttpConnectionManager.ForwardClientCertDetails> internalValueMap -
VALUES
-
value
private final int value
-
-
Constructor Details
-
ForwardClientCertDetails
private ForwardClientCertDetails(int value)
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
value- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
forNumber
- Parameters:
value- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
public static com.google.protobuf.Internal.EnumLiteMap<HttpConnectionManager.ForwardClientCertDetails> internalGetValueMap() -
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static HttpConnectionManager.ForwardClientCertDetails valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
desc- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-