Package io.grpc

Class TlsChannelCredentials.Builder

java.lang.Object

io.grpc.TlsChannelCredentials.Builder

Enclosing class:

TlsChannelCredentials

public static final class TlsChannelCredentials.Builder
extends java.lang.Object

Builder for TlsChannelCredentials.

Method Summary

Modifier and Type	Method	Description
ChannelCredentials	build()	Construct the credentials.
TlsChannelCredentials.Builder	keyManager(java.io.File certChain, java.io.File privateKey)	Use the provided certificate chain and private key as the client's identity.
TlsChannelCredentials.Builder	keyManager(java.io.File certChain, java.io.File privateKey, java.lang.String privateKeyPassword)	Use the provided certificate chain and possibly-encrypted private key as the client's identity.
TlsChannelCredentials.Builder	keyManager(java.io.InputStream certChain, java.io.InputStream privateKey)	Use the provided certificate chain and private key as the client's identity.
TlsChannelCredentials.Builder	keyManager(java.io.InputStream certChain, java.io.InputStream privateKey, java.lang.String privateKeyPassword)	Use the provided certificate chain and possibly-encrypted private key as the client's identity.
TlsChannelCredentials.Builder	keyManager(javax.net.ssl.KeyManager... keyManagers)	Have the provided key manager select the client's identity.
TlsChannelCredentials.Builder	requireFakeFeature()	Requires TlsChannelCredentials.Feature.FAKE to be understood.
TlsChannelCredentials.Builder	trustManager(java.io.File rootCerts)	Use the provided root certificates to verify the server's identity instead of the system's default.
TlsChannelCredentials.Builder	trustManager(java.io.InputStream rootCerts)	Use the provided root certificates to verify the server's identity instead of the system's default.
TlsChannelCredentials.Builder	trustManager(javax.net.ssl.TrustManager... trustManagers)	Have the provided trust manager verify the server's identity instead of the system's default.

Methods inherited from class java.lang.Object

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

Method Detail

requireFakeFeature

public TlsChannelCredentials.Builder requireFakeFeature()

Requires TlsChannelCredentials.Feature.FAKE to be understood. For use in testing consumers of this credential.

keyManager

public TlsChannelCredentials.Builder keyManager(java.io.File certChain,
                                                java.io.File privateKey)
                                         throws java.io.IOException

Use the provided certificate chain and private key as the client's identity. Generally they should be PEM-encoded and the key is an unencrypted PKCS#8 key (file headers have "BEGIN CERTIFICATE" and "BEGIN PRIVATE KEY").

Throws:

java.io.IOException

keyManager

public TlsChannelCredentials.Builder keyManager(java.io.File certChain,
                                                java.io.File privateKey,
                                                java.lang.String privateKeyPassword)
                                         throws java.io.IOException

Use the provided certificate chain and possibly-encrypted private key as the client's identity. Generally they should be PEM-encoded and the key is a PKCS#8 key. If the private key is unencrypted, then password must be null.

Throws:

java.io.IOException

keyManager

public TlsChannelCredentials.Builder keyManager(java.io.InputStream certChain,
                                                java.io.InputStream privateKey)
                                         throws java.io.IOException

Use the provided certificate chain and private key as the client's identity. Generally they should be PEM-encoded and the key is an unencrypted PKCS#8 key (file headers have "BEGIN CERTIFICATE" and "BEGIN PRIVATE KEY").

Throws:

java.io.IOException

keyManager

public TlsChannelCredentials.Builder keyManager(java.io.InputStream certChain,
                                                java.io.InputStream privateKey,
                                                java.lang.String privateKeyPassword)
                                         throws java.io.IOException

Use the provided certificate chain and possibly-encrypted private key as the client's identity. Generally they should be PEM-encoded and the key is a PKCS#8 key. If the private key is unencrypted, then password must be null.

Throws:

java.io.IOException

keyManager

public TlsChannelCredentials.Builder keyManager(javax.net.ssl.KeyManager... keyManagers)

Have the provided key manager select the client's identity. Although multiple are allowed, only the first instance implementing a particular interface is used. So generally there will just be a single entry and it implements X509KeyManager.

trustManager

public TlsChannelCredentials.Builder trustManager(java.io.File rootCerts)
                                           throws java.io.IOException

Use the provided root certificates to verify the server's identity instead of the system's default. Generally they should be PEM-encoded with all the certificates concatenated together (file header has "BEGIN CERTIFICATE", and would occur once per certificate).

Throws:

java.io.IOException

trustManager

public TlsChannelCredentials.Builder trustManager(java.io.InputStream rootCerts)
                                           throws java.io.IOException

Use the provided root certificates to verify the server's identity instead of the system's default. Generally they should be PEM-encoded with all the certificates concatenated together (file header has "BEGIN CERTIFICATE", and would occur once per certificate).

Throws:

java.io.IOException

trustManager

public TlsChannelCredentials.Builder trustManager(javax.net.ssl.TrustManager... trustManagers)

Have the provided trust manager verify the server's identity instead of the system's default. Although multiple are allowed, only the first instance implementing a particular interface is used. So generally there will just be a single entry and it implements X509TrustManager.

build

public ChannelCredentials build()

Construct the credentials.