io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v4alpha

Enum HttpConnectionManager.ForwardClientCertDetails

java.lang.Object

java.lang.Enum<HttpConnectionManager.ForwardClientCertDetails>

io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v4alpha.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.v4alpha.HttpConnectionManager.ForwardClientCertDetails

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS_FORWARD_ONLY Always forward the XFCC header in the request, regardless of whether the client connection is mTLS.
APPEND_FORWARD When the client connection is mTLS, append the client certificate information to the request’s XFCC header and forward it.
FORWARD_ONLY When the client connection is mTLS (Mutual TLS), forward the XFCC header in the request.
SANITIZE Do not send the XFCC header to the next hop.
SANITIZE_SET When the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALWAYS_FORWARD_ONLY_VALUE Always forward the XFCC header in the request, regardless of whether the client connection is mTLS.
static int	APPEND_FORWARD_VALUE When the client connection is mTLS, append the client certificate information to the request’s XFCC header and forward it.
static int	FORWARD_ONLY_VALUE When the client connection is mTLS (Mutual TLS), forward the XFCC header in the request.
static int	SANITIZE_SET_VALUE When the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop.
static int	SANITIZE_VALUE Do not send the XFCC header to the next hop.

Method Summary

Modifier and Type	Method and Description
static HttpConnectionManager.ForwardClientCertDetails	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<HttpConnectionManager.ForwardClientCertDetails>	internalGetValueMap()
static HttpConnectionManager.ForwardClientCertDetails	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static HttpConnectionManager.ForwardClientCertDetails	valueOf(int value) Deprecated. Use forNumber(int) instead.
static HttpConnectionManager.ForwardClientCertDetails	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpConnectionManager.ForwardClientCertDetails[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SANITIZE

public static final HttpConnectionManager.ForwardClientCertDetails SANITIZE

 Do not send the XFCC header to the next hop. This is the default value.
 

SANITIZE = 0;

FORWARD_ONLY

public static final HttpConnectionManager.ForwardClientCertDetails FORWARD_ONLY

 When the client connection is mTLS (Mutual TLS), forward the XFCC header
 in the request.
 

FORWARD_ONLY = 1;

APPEND_FORWARD

public static final HttpConnectionManager.ForwardClientCertDetails 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

public static final HttpConnectionManager.ForwardClientCertDetails 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

public static final HttpConnectionManager.ForwardClientCertDetails ALWAYS_FORWARD_ONLY

 Always forward the XFCC header in the request, regardless of whether the
 client connection is mTLS.
 

ALWAYS_FORWARD_ONLY = 4;

UNRECOGNIZED

public static final HttpConnectionManager.ForwardClientCertDetails UNRECOGNIZED

Field Detail

SANITIZE_VALUE

public static final int SANITIZE_VALUE

 Do not send the XFCC header to the next hop. This is the default value.
 

SANITIZE = 0;

See Also:

Constant Field Values

FORWARD_ONLY_VALUE

public static final int FORWARD_ONLY_VALUE

 When the client connection is mTLS (Mutual TLS), forward the XFCC header
 in the request.
 

FORWARD_ONLY = 1;

See Also:

Constant Field Values

APPEND_FORWARD_VALUE

public static final int APPEND_FORWARD_VALUE

 When the client connection is mTLS, append the client certificate
 information to the request’s XFCC header and forward it.
 

APPEND_FORWARD = 2;

See Also:

Constant Field Values

SANITIZE_SET_VALUE

public static final int SANITIZE_SET_VALUE

 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;

See Also:

Constant Field Values

ALWAYS_FORWARD_ONLY_VALUE

public static final int ALWAYS_FORWARD_ONLY_VALUE

 Always forward the XFCC header in the request, regardless of whether the
 client connection is mTLS.
 

ALWAYS_FORWARD_ONLY = 4;

See Also:

Constant Field Values

Method Detail

values

public static HttpConnectionManager.ForwardClientCertDetails[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpConnectionManager.ForwardClientCertDetails c : HttpConnectionManager.ForwardClientCertDetails.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpConnectionManager.ForwardClientCertDetails valueOf(String name)

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 name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static HttpConnectionManager.ForwardClientCertDetails valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static HttpConnectionManager.ForwardClientCertDetails forNumber(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<HttpConnectionManager.ForwardClientCertDetails> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.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)