io.grpc

Enum TlsChannelCredentials.Feature

java.lang.Object

java.lang.Enum<TlsChannelCredentials.Feature>

io.grpc.TlsChannelCredentials.Feature

All Implemented Interfaces:

Serializable, Comparable<TlsChannelCredentials.Feature>

Enclosing class:

TlsChannelCredentials

public static enum TlsChannelCredentials.Feature
extends Enum<TlsChannelCredentials.Feature>

Features to understand TLS configuration. Additional enum values may be added in the future.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM_MANAGERS Key managers and trust managers may be specified as KeyManager and TrustManager objects.
FAKE A feature that no consumer should understand.
MTLS Client identity may be provided and server verification can be tuned.

Method Summary

Modifier and Type	Method and Description
static TlsChannelCredentials.Feature	valueOf(String name) Returns the enum constant of this type with the specified name.
static TlsChannelCredentials.Feature[]	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

FAKE

public static final TlsChannelCredentials.Feature FAKE

A feature that no consumer should understand. It should be used for unit testing to confirm a call to incomprehensible() is implemented properly.

MTLS

public static final TlsChannelCredentials.Feature MTLS

Client identity may be provided and server verification can be tuned. This feature requires observing TlsChannelCredentials.getCertificateChain(), TlsChannelCredentials.getPrivateKey(), and TlsChannelCredentials.getPrivateKeyPassword() as well as TlsChannelCredentials.getRootCertificates(). The certificate chain and private key are used to configure a key manager to provide the client's identity. If no certificate chain and private key are provided the client will have no identity. The root certificates are used to configure a trust manager for verifying the server's identity. If no root certificates are provided the trust manager will default to the system's root certificates.

CUSTOM_MANAGERS

public static final TlsChannelCredentials.Feature CUSTOM_MANAGERS

Key managers and trust managers may be specified as KeyManager and TrustManager objects. This feature requires observing TlsChannelCredentials.getKeyManagers() and TlsChannelCredentials.getTrustManagers(). Generally MTLS should also be supported, as that is the more common method of configuration. When a manager is non-null, then it is wholly responsible for key or trust material and usage; there is no need to check other manager sources like TlsChannelCredentials.getCertificateChain() or TlsChannelCredentials.getPrivateKey() (if KeyManager is available), or TlsChannelCredentials.getRootCertificates() (if TrustManager is available).

If other manager sources are available (e.g., getPrivateKey() != null), then they may be alternative representations of the same configuration and the consumer is free to use those alternative representations if it prefers. But before doing so it must first check that it understands that alternative representation by using TlsChannelCredentials.incomprehensible(java.util.Set<io.grpc.TlsChannelCredentials.Feature>) without the CUSTOM_MANAGERS feature.

Method Detail

values

public static TlsChannelCredentials.Feature[] 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 (TlsChannelCredentials.Feature c : TlsChannelCredentials.Feature.values())
    System.out.println(c);

Returns:

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

valueOf

public static TlsChannelCredentials.Feature 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