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

Class NetSslContextBuilder

java.lang.Object

org.apache.pulsar.common.util.SslContextAutoRefreshBuilder<javax.net.ssl.SSLContext>

org.apache.pulsar.common.util.keystoretls.NetSslContextBuilder

public class NetSslContextBuilder
extends SslContextAutoRefreshBuilder<javax.net.ssl.SSLContext>

Similar to `DefaultSslContextBuilder`, which build `javax.net.ssl.SSLContext` for web service.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	tlsAllowInsecureConnection
protected FileModifiedTimeUpdater	tlsKeyStore
protected java.lang.String	tlsKeyStorePassword
protected java.lang.String	tlsKeyStoreType
protected java.lang.String	tlsProvider
protected boolean	tlsRequireTrustedClientCertOnConnect
protected FileModifiedTimeUpdater	tlsTrustStore
protected java.lang.String	tlsTrustStorePassword
protected java.lang.String	tlsTrustStoreType

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

lastRefreshTime, refreshTime

Constructor Summary

Constructors

Constructor	Description
NetSslContextBuilder(java.lang.String sslProviderString, java.lang.String keyStoreTypeString, java.lang.String keyStore, java.lang.String keyStorePasswordPath, boolean allowInsecureConnection, java.lang.String trustStoreTypeString, java.lang.String trustStore, java.lang.String trustStorePasswordPath, boolean requireTrustedClientCertOnConnect, long certRefreshInSec)

Method Summary

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

tlsRequireTrustedClientCertOnConnect

protected final boolean tlsRequireTrustedClientCertOnConnect

tlsProvider

protected final java.lang.String tlsProvider

tlsKeyStoreType

protected final java.lang.String tlsKeyStoreType

tlsKeyStorePassword

protected final java.lang.String tlsKeyStorePassword

tlsKeyStore

protected final FileModifiedTimeUpdater tlsKeyStore

tlsTrustStoreType

protected final java.lang.String tlsTrustStoreType

tlsTrustStorePassword

protected final java.lang.String tlsTrustStorePassword

tlsTrustStore

protected final FileModifiedTimeUpdater tlsTrustStore

Constructor Detail

NetSslContextBuilder

public NetSslContextBuilder(java.lang.String sslProviderString,
                            java.lang.String keyStoreTypeString,
                            java.lang.String keyStore,
                            java.lang.String keyStorePasswordPath,
                            boolean allowInsecureConnection,
                            java.lang.String trustStoreTypeString,
                            java.lang.String trustStore,
                            java.lang.String trustStorePasswordPath,
                            boolean requireTrustedClientCertOnConnect,
                            long certRefreshInSec)

Method Detail

update

public javax.net.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<javax.net.ssl.SSLContext>

Returns:

Throws:

java.security.GeneralSecurityException

java.io.IOException

javax.net.ssl.SSLException

java.io.FileNotFoundException

getSslContext

public javax.net.ssl.SSLContext getSslContext()

Description copied from class: SslContextAutoRefreshBuilder

Returns cached SSLContext.

Specified by:

getSslContext in class SslContextAutoRefreshBuilder<javax.net.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<javax.net.ssl.SSLContext>

Returns:

true if files modified