Package com.github.fmjsjx.libnetty.handler.ssl

Class SslContextProviders

java.lang.Object

com.github.fmjsjx.libnetty.handler.ssl.SslContextProviders

public class SslContextProviders
extends java.lang.Object

Implementations of SslContextProvider.

Since:

1.1

Method Summary

Modifier and Type	Method	Description
static SslContextProvider	forClient(java.io.File trustCertCollectionFile)	Returns a simple implementation of SslContextProvider which holding an SslContext trusted certificates for verifying the remote endpoint's certificate.
static SslContextProvider	forServer(java.io.File keyCertChainFile, java.io.File keyFile)	Returns a simple implementation of SslContextProvider which holding a server-side SslContext.
static SslContextProvider	forServer(java.io.File keyCertChainFile, java.io.File keyFile, java.lang.String keyPassword)	Returns a simple implementation of SslContextProvider which holding a server-side SslContext.
static SslContextProvider	insecureForClient()	Returns a simple implementation of SslContextProvider which holding an insecure SslContext for client.
static PermutableSslContextProvider	permutable(io.netty.handler.ssl.SslContext sslContext)	Returns a PermutableSslContextProvider instance holding the specified SslContext.
static SslContextProvider	selfSignedForServer()	Returns a simple implementation of SslContextProvider which holding a self-signed certificate SslContext for server.
static SslContextProvider	simple(io.netty.handler.ssl.SslContext sslContext)	Returns a simple implementation of SslContextProvider which just holding the specified SslContext.
static SslContextProvider	watchingForClient(java.io.File keyCertChainFile, java.io.File keyFile)	Returns an SslContextProvider which will auto rebuild SslContext when the watching certificate file just be modified.
static SslContextProvider	watchingForServer(java.io.File keyCertChainFile, java.io.File keyFile)	Returns an SslContextProvider which will auto rebuild SslContext when the watching certificate file just be modified.

Methods inherited from class java.lang.Object

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

Method Detail

selfSignedForServer

public static final SslContextProvider selfSignedForServer()
                                                    throws SSLRuntimeException

Returns a simple implementation of SslContextProvider which holding a self-signed certificate SslContext for server.

Returns:

a SslContextProvider holding a self-signed certificate SslContext for server

Throws:

SSLRuntimeException - if any SSL error occurs

forServer

public static final SslContextProvider forServer(java.io.File keyCertChainFile,
                                                 java.io.File keyFile)
                                          throws SSLRuntimeException

Returns a simple implementation of SslContextProvider which holding a server-side SslContext.

Parameters:

keyCertChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

Returns:

a SslContextProvider

Throws:

SSLRuntimeException - if any SSL error occurs

See Also:

forServer(File, File, String)

forServer

public static final SslContextProvider forServer(java.io.File keyCertChainFile,
                                                 java.io.File keyFile,
                                                 java.lang.String keyPassword)
                                          throws SSLRuntimeException

Returns a simple implementation of SslContextProvider which holding a server-side SslContext.

Parameters:

keyCertChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile, or null if it's not password-protected

Returns:

a SslContextProvider

Throws:

SSLRuntimeException - if any SSL error occurs

See Also:

forServer(File, File)

watchingForServer

public static final SslContextProvider watchingForServer(java.io.File keyCertChainFile,
                                                         java.io.File keyFile)
                                                  throws SSLRuntimeException,
                                                         java.io.IOException

Returns an SslContextProvider which will auto rebuild SslContext when the watching certificate file just be modified.

Parameters:

keyCertChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

Returns:

a SslContextProvider

Throws:

SSLRuntimeException - if any SSL error occurs

java.io.IOException - if any IO error occurs

watchingForClient

public static final SslContextProvider watchingForClient(java.io.File keyCertChainFile,
                                                         java.io.File keyFile)
                                                  throws SSLRuntimeException,
                                                         java.io.IOException

Returns an SslContextProvider which will auto rebuild SslContext when the watching certificate file just be modified.

Parameters:

keyCertChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

Returns:

a SslContextProvider

Throws:

SSLRuntimeException - if any SSL error occurs

java.io.IOException - if any IO error occurs

insecureForClient

public static final SslContextProvider insecureForClient()
                                                  throws SSLRuntimeException

Returns a simple implementation of SslContextProvider which holding an insecure SslContext for client.

Returns:

a SslContextProvider holding insecure SslContext for client

Throws:

SSLRuntimeException - if any SSL error occurs

forClient

public static final SslContextProvider forClient(java.io.File trustCertCollectionFile)
                                          throws SSLRuntimeException

Returns a simple implementation of SslContextProvider which holding an SslContext trusted certificates for verifying the remote endpoint's certificate.

The file should contain an X.509 certificate collection in PEM format.

Parameters:

trustCertCollectionFile - file contains an X.509 certificate collection in PEM format

Returns:

a SslContextProvider

Throws:

SSLRuntimeException - if any SSL error occurs

simple

public static final SslContextProvider simple(io.netty.handler.ssl.SslContext sslContext)

Returns a simple implementation of SslContextProvider which just holding the specified SslContext.

Parameters:

sslContext - a SslContext

Returns:

a SslContextProvider

permutable

public static final PermutableSslContextProvider permutable(io.netty.handler.ssl.SslContext sslContext)

Returns a PermutableSslContextProvider instance holding the specified SslContext.

Parameters:

sslContext - sslContext a SslContext

Returns:

a PermutableSslContextProvider

Since:

2.0