Package org.apache.pulsar.common.util

Class NettyServerSslContextBuilder

java.lang.Object

org.apache.pulsar.common.util.SslContextAutoRefreshBuilder<io.netty.handler.ssl.SslContext>

org.apache.pulsar.common.util.NettyServerSslContextBuilder

public class NettyServerSslContextBuilder
extends SslContextAutoRefreshBuilder<io.netty.handler.ssl.SslContext>

SSL context builder for Netty Server side.

Field Summary

Fields

Modifier and Type	Field	Description
protected io.netty.handler.ssl.SslProvider	sslProvider
protected boolean	tlsAllowInsecureConnection
protected FileModifiedTimeUpdater	tlsCertificateFilePath
protected java.util.Set<java.lang.String>	tlsCiphers
protected FileModifiedTimeUpdater	tlsKeyFilePath
protected java.util.Set<java.lang.String>	tlsProtocols
protected boolean	tlsRequireTrustedClientCertOnConnect
protected FileModifiedTimeUpdater	tlsTrustCertsFilePath

Fields inherited from class org.apache.pulsar.common.util.SslContextAutoRefreshBuilder

lastRefreshTime, refreshTime

Constructor Summary

Constructors

Constructor	Description
NettyServerSslContextBuilder(io.netty.handler.ssl.SslProvider sslProvider, boolean allowInsecure, java.lang.String trustCertsFilePath, java.lang.String certificateFilePath, java.lang.String keyFilePath, java.util.Set<java.lang.String> ciphers, java.util.Set<java.lang.String> protocols, boolean requireTrustedClientCertOnConnect, long delayInSeconds)

Method Summary

Modifier and Type	Method	Description
io.netty.handler.ssl.SslContext	getSslContext()	Returns cached SSLContext.
boolean	needUpdate()	Returns whether the key files modified after a refresh time, and context need update.
io.netty.handler.ssl.SslContext	update()	updates and returns cached SSLContext.

Methods inherited from class org.apache.pulsar.common.util.SslContextAutoRefreshBuilder

get

Methods inherited from class java.lang.Object

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

Field Detail

tlsAllowInsecureConnection

protected final boolean tlsAllowInsecureConnection

tlsTrustCertsFilePath

protected final FileModifiedTimeUpdater tlsTrustCertsFilePath

tlsCertificateFilePath

protected final FileModifiedTimeUpdater tlsCertificateFilePath

tlsKeyFilePath

protected final FileModifiedTimeUpdater tlsKeyFilePath

tlsCiphers

protected final java.util.Set<java.lang.String> tlsCiphers

tlsProtocols

protected final java.util.Set<java.lang.String> tlsProtocols

tlsRequireTrustedClientCertOnConnect

protected final boolean tlsRequireTrustedClientCertOnConnect

sslProvider

protected final io.netty.handler.ssl.SslProvider sslProvider

Constructor Detail

NettyServerSslContextBuilder

public NettyServerSslContextBuilder(io.netty.handler.ssl.SslProvider sslProvider,
                                    boolean allowInsecure,
                                    java.lang.String trustCertsFilePath,
                                    java.lang.String certificateFilePath,
                                    java.lang.String keyFilePath,
                                    java.util.Set<java.lang.String> ciphers,
                                    java.util.Set<java.lang.String> protocols,
                                    boolean requireTrustedClientCertOnConnect,
                                    long delayInSeconds)

Method Detail

update

public io.netty.handler.ssl.SslContext update()
                                       throws javax.net.ssl.SSLException,
                                              java.io.FileNotFoundException,
                                              java.security.GeneralSecurityException,
                                              java.io.IOException

Description copied from class: SslContextAutoRefreshBuilder

updates and returns cached SSLContext.

Specified by:

update in class SslContextAutoRefreshBuilder<io.netty.handler.ssl.SslContext>

Returns:

Throws:

java.security.GeneralSecurityException

java.io.IOException

javax.net.ssl.SSLException

java.io.FileNotFoundException

getSslContext

public io.netty.handler.ssl.SslContext getSslContext()

Description copied from class: SslContextAutoRefreshBuilder

Returns cached SSLContext.

Specified by:

getSslContext in class SslContextAutoRefreshBuilder<io.netty.handler.ssl.SslContext>

Returns:

needUpdate

public boolean needUpdate()

Description copied from class: SslContextAutoRefreshBuilder

Returns whether the key files modified after a refresh time, and context need update.

Specified by:

needUpdate in class SslContextAutoRefreshBuilder<io.netty.handler.ssl.SslContext>

Returns:

true if files modified