net.devh.boot.grpc.client.config

Class GrpcChannelProperties.Security

java.lang.Object

net.devh.boot.grpc.client.config.GrpcChannelProperties.Security

Enclosing class:

GrpcChannelProperties

public static class GrpcChannelProperties.Security
extends Object

A container with options for the channel's transport security.

Constructor Summary

Constructors

Constructor and Description
Security()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
void	copyDefaultsFrom(GrpcChannelProperties.Security config) Copies the defaults from the given configuration.
boolean	equals(Object o)
String	getAuthorityOverride() Gets the authority to check for during server certificate verification.
String	getCertificateChainPath() Gets the path to SSL certificate chain.
List<String>	getCiphers()
String	getPrivateKeyPath() Gets the path to the private key.
String[]	getProtocols()
String	getTrustCertCollectionPath() Gets the path to the trusted certificate collection.
int	hashCode()
boolean	isClientAuthEnabled() Gets whether client can authenticate using certificates.
void	setAuthorityOverride(String authorityOverride) Sets the authority to check for during server certificate verification.
void	setCertificateChainPath(String certificateChainPath) Sets the path to SSL certificate chain.
void	setCiphers(String ciphers)
void	setClientAuthEnabled(Boolean clientAuthEnabled) Set whether client can authenticate using certificates.
void	setPrivateKeyPath(String privateKeyPath) Sets the path to the private key.
void	setProtocols(String protocols)
void	setTrustCertCollectionPath(String trustCertCollectionPath) Sets the path to the trusted certificate collection.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Security

public Security()

Method Detail

isClientAuthEnabled

public boolean isClientAuthEnabled()

Gets whether client can authenticate using certificates.

Returns:

True, if the client can authenticate itself using certificates.

See Also:

setClientAuthEnabled(Boolean)

setClientAuthEnabled

public void setClientAuthEnabled(Boolean clientAuthEnabled)

Set whether client can authenticate using certificates. Defaults to false.

Parameters:

clientAuthEnabled - Whether the client can authenticate itself using certificates.

getCertificateChainPath

public String getCertificateChainPath()

Gets the path to SSL certificate chain.

Returns:

The path to the certificate chain or null, if security is not enabled.

See Also:

setCertificateChainPath(String)

setCertificateChainPath

public void setCertificateChainPath(String certificateChainPath)

Sets the path to SSL certificate chain. Required if isClientAuthEnabled() is true. The linked certificate will be used to authenticate the client.

Parameters:

certificateChainPath - The path to the certificate chain.

See Also:

SslContextBuilder.keyManager(File, File)

getPrivateKeyPath

public String getPrivateKeyPath()

Gets the path to the private key.

Returns:

The path to the private key or null, if security is not enabled.

See Also:

setPrivateKeyPath(String)

setPrivateKeyPath

public void setPrivateKeyPath(String privateKeyPath)

Sets the path to the private key. Required if isClientAuthEnabled() is true.

Parameters:

privateKeyPath - The path to the private key.

See Also:

SslContextBuilder.keyManager(File, File)

getTrustCertCollectionPath

public String getTrustCertCollectionPath()

Gets the path to the trusted certificate collection. If null or empty the use the system's default collection should be used.

Returns:

The path to the trusted certificate collection or null.

See Also:

setTrustCertCollectionPath(String)

setTrustCertCollectionPath

public void setTrustCertCollectionPath(String trustCertCollectionPath)

Sets the path to the trusted certificate collection. If not set (null) it will use the system's default collection (Default). This collection will be used to verify server certificates.

Parameters:

trustCertCollectionPath - The path to the trusted certificate collection.

See Also:

SslContextBuilder.trustManager(File)

getAuthorityOverride

public String getAuthorityOverride()

Gets the authority to check for during server certificate verification.

Returns:

The override for the authority to check for or null, there is no override configured.

See Also:

setAuthorityOverride(String)

setAuthorityOverride

public void setAuthorityOverride(String authorityOverride)

Sets the authority to check for during server certificate verification. By default the clients will use the name of the client to check the server certificate's common + alternative names.

Parameters:

authorityOverride - The authority to check for in the certificate, or null to use the default checks.

See Also:

AbstractManagedChannelImplBuilder.overrideAuthority(String)

getCiphers

public List<String> getCiphers()

Returns:

The cipher suite accepted for secure connections or null.

setCiphers

public void setCiphers(String ciphers)

Parameters:

ciphers - Cipher suite consisting of one or more cipher strings separated by colons, commas or spaces

getProtocols

public String[] getProtocols()

Returns:

The protocols accepted for secure connections or null.

setProtocols

public void setProtocols(String protocols)

Parameters:

protocols - Protocol list consisting of one or more protocols separated by colons, commas or spaces.

copyDefaultsFrom

public void copyDefaultsFrom(GrpcChannelProperties.Security config)

Copies the defaults from the given configuration. Values are considered "default" if they are null. Please note that the getters might return fallback values instead.

Parameters:

config - The config to copy the defaults from.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object