Package org.apache.pulsar.common.util.keystoretls

Class NettySSLContextAutoRefreshBuilder

java.lang.Object

org.apache.pulsar.common.util.SslContextAutoRefreshBuilder<KeyStoreSSLContext>

org.apache.pulsar.common.util.keystoretls.NettySSLContextAutoRefreshBuilder

public class NettySSLContextAutoRefreshBuilder
extends SslContextAutoRefreshBuilder<KeyStoreSSLContext>

SSL context builder for Netty.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.pulsar.client.api.AuthenticationDataProvider	authData
protected final boolean	isServer
protected final boolean	tlsAllowInsecureConnection
protected final Set<String>	tlsCiphers
protected FileModifiedTimeUpdater	tlsKeyStore
protected String	tlsKeyStorePassword
protected String	tlsKeyStoreType
protected final Set<String>	tlsProtocols
protected final String	tlsProvider
protected boolean	tlsRequireTrustedClientCertOnConnect
protected final FileModifiedTimeUpdater	tlsTrustStore
protected final String	tlsTrustStorePassword
protected final String	tlsTrustStoreType

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

lastRefreshTime, refreshTime

Constructor Summary

Constructors

Constructor	Description
NettySSLContextAutoRefreshBuilder(String sslProviderString, boolean allowInsecureConnection, String trustStoreTypeString, String trustStore, String trustStorePassword, String keyStoreTypeString, String keyStore, String keyStorePassword, Set<String> ciphers, Set<String> protocols, long certRefreshInSec, org.apache.pulsar.client.api.AuthenticationDataProvider authData)
NettySSLContextAutoRefreshBuilder(String sslProviderString, String keyStoreTypeString, String keyStore, String keyStorePassword, boolean allowInsecureConnection, String trustStoreTypeString, String trustStore, String trustStorePassword, boolean requireTrustedClientCertOnConnect, Set<String> ciphers, Set<String> protocols, long certRefreshInSec)

Method Summary

Modifier and Type	Method	Description
KeyStoreSSLContext	getSslContext()	Returns cached SSLContext.
boolean	needUpdate()	Returns whether the key files modified after a refresh time, and context need update.
KeyStoreSSLContext	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 Details

tlsAllowInsecureConnection

protected final boolean tlsAllowInsecureConnection

tlsCiphers

protected final Set<String> tlsCiphers

tlsProtocols

protected final Set<String> tlsProtocols

tlsRequireTrustedClientCertOnConnect

protected boolean tlsRequireTrustedClientCertOnConnect

tlsProvider

protected final String tlsProvider

tlsTrustStoreType

protected final String tlsTrustStoreType

tlsTrustStorePassword

protected final String tlsTrustStorePassword

tlsTrustStore

protected final FileModifiedTimeUpdater tlsTrustStore

tlsKeyStoreType

protected String tlsKeyStoreType

tlsKeyStorePassword

protected String tlsKeyStorePassword

tlsKeyStore

protected FileModifiedTimeUpdater tlsKeyStore

authData

protected org.apache.pulsar.client.api.AuthenticationDataProvider authData

isServer

protected final boolean isServer

Constructor Details

NettySSLContextAutoRefreshBuilder

public NettySSLContextAutoRefreshBuilder(String sslProviderString,
 String keyStoreTypeString,
 String keyStore,
 String keyStorePassword,
 boolean allowInsecureConnection,
 String trustStoreTypeString,
 String trustStore,
 String trustStorePassword,
 boolean requireTrustedClientCertOnConnect,
 Set<String> ciphers,
 Set<String> protocols,
 long certRefreshInSec)

NettySSLContextAutoRefreshBuilder

public NettySSLContextAutoRefreshBuilder(String sslProviderString,
 boolean allowInsecureConnection,
 String trustStoreTypeString,
 String trustStore,
 String trustStorePassword,
 String keyStoreTypeString,
 String keyStore,
 String keyStorePassword,
 Set<String> ciphers,
 Set<String> protocols,
 long certRefreshInSec,
 org.apache.pulsar.client.api.AuthenticationDataProvider authData)

Method Details

update

public KeyStoreSSLContext update()
                          throws GeneralSecurityException,
IOException

Description copied from class: SslContextAutoRefreshBuilder

updates and returns cached SSLContext.

Specified by:

update in class SslContextAutoRefreshBuilder<KeyStoreSSLContext>

Returns:

Throws:

GeneralSecurityException

IOException

getSslContext

public KeyStoreSSLContext getSslContext()

Description copied from class: SslContextAutoRefreshBuilder

Returns cached SSLContext.

Specified by:

getSslContext in class SslContextAutoRefreshBuilder<KeyStoreSSLContext>

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<KeyStoreSSLContext>

Returns:

true if files modified