Package com.oracle.coherence.grpc

Class CredentialsHelper

java.lang.Object

com.oracle.coherence.grpc.CredentialsHelper

public class CredentialsHelper
extends Object

A helper class to resolve gRPC credentials.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROP_CREDENTIALS	The system property to use to set the type of credentials to use.
static String	PROP_TLS_CA	The system property that sets the location of the TLS CA file.
static String	PROP_TLS_CERT	The system property that sets the location of the TLS cert file.
static String	PROP_TLS_KEY	The system property that sets the location of the TLS key file.
static String	PROP_TLS_KEYPASS	The system property that sets the password for the TLS key file.
static String	PROP_TLS_KEYPASS_URI	The system property that sets the URI of a file to read to obtain the password for the TLS key file.

Method Summary

Modifier and Type	Method	Description
static io.grpc.ChannelCredentials	createChannelCredentials(String sChannelName)	Deprecated. server credentials are configured by the socket provider for a gRPC channel, see createChannelCredentials(String, SocketProviderBuilder)
static io.grpc.ChannelCredentials	createChannelCredentials(String sChannelName, SocketProviderBuilder socketBuilder)	Create the ChannelCredentials to use for the client channel.
static io.grpc.ServerCredentials	createServerCredentials()	Deprecated. server credentials are configured by the socket provider for a gRPC proxy service, see createServerCredentials(SocketProviderBuilder)
static io.grpc.ServerCredentials	createServerCredentials(SocketProviderBuilder socketBuilder)	Create the ServerCredentials to use for the gRPC Proxy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_TLS_KEY

public static final String PROP_TLS_KEY

The system property that sets the location of the TLS key file.

See Also:

Constant Field Values

PROP_TLS_KEYPASS

public static final String PROP_TLS_KEYPASS

The system property that sets the password for the TLS key file.

See Also:

Constant Field Values

PROP_TLS_KEYPASS_URI

public static final String PROP_TLS_KEYPASS_URI

The system property that sets the URI of a file to read to obtain the password for the TLS key file.

See Also:

Constant Field Values

PROP_TLS_CERT

public static final String PROP_TLS_CERT

The system property that sets the location of the TLS cert file.

See Also:

Constant Field Values

PROP_TLS_CA

public static final String PROP_TLS_CA

The system property that sets the location of the TLS CA file.

See Also:

Constant Field Values

PROP_CREDENTIALS

public static final String PROP_CREDENTIALS

The system property to use to set the type of credentials to use.

See Also:

Constant Field Values

Method Detail

createServerCredentials

@Deprecated(since="22.06.2")
public static io.grpc.ServerCredentials createServerCredentials()

Deprecated.

server credentials are configured by the socket provider for a gRPC proxy service, see createServerCredentials(SocketProviderBuilder)

Create the ServerCredentials to use for the gRPC Proxy.

Returns:

the ServerCredentials to use for the gRPC Proxy

createServerCredentials

public static io.grpc.ServerCredentials createServerCredentials(SocketProviderBuilder socketBuilder)

Create the ServerCredentials to use for the gRPC Proxy.

Parameters:

socketBuilder - the optional SocketProviderBuilder to use to provide the TLS configuration

Returns:

the ServerCredentials to use for the gRPC Proxy

createChannelCredentials

@Deprecated(since="22.06.2")
public static io.grpc.ChannelCredentials createChannelCredentials(String sChannelName)

Deprecated.

server credentials are configured by the socket provider for a gRPC channel, see createChannelCredentials(String, SocketProviderBuilder)

Create the ChannelCredentials to use for the client channel.

If the property PROP_CREDENTIALS is "plaintext" then a non-TLS credentials will be created.

If the property PROP_CREDENTIALS is "insecure" then TLS credentials will be created using an insecure trust manager that will not verify the server certs.

If the property PROP_CREDENTIALS is "tls" then TLS credentials will be created using a specified key (from the PROP_TLS_KEY) and cert from (from the PROP_TLS_CERT). Optionally a key password (from the PROP_TLS_KEYPASS) and a CA (from the PROP_TLS_CA) may also be provided.

If the property PROP_CREDENTIALS is not set, "plaintext" will be used.

Parameters:

sChannelName - the name of the channel

Returns:

the ChannelCredentials to use for the client channel.

createChannelCredentials

public static io.grpc.ChannelCredentials createChannelCredentials(String sChannelName,
                                                                  SocketProviderBuilder socketBuilder)

Create the ChannelCredentials to use for the client channel.

If the property PROP_CREDENTIALS is "plaintext" then a non-TLS credentials will be created.

If the property PROP_CREDENTIALS is "insecure" then TLS credentials will be created using an insecure trust manager that will not verify the server certs.

If the property PROP_CREDENTIALS is "tls" then TLS credentials will be created using a specified key (from the PROP_TLS_KEY) and cert from (from the PROP_TLS_CERT). Optionally a key password (from the PROP_TLS_KEYPASS) and a CA (from the PROP_TLS_CA) may also be provided.

If the property PROP_CREDENTIALS is not set, "plaintext" will be used.

Parameters:

sChannelName - the name of the channel

Returns:

the ChannelCredentials to use for the client channel.