SslContext (Netty 3.10.5.Final API文档 - 即时通讯网(52im.net))

java.lang.Object
- org.jboss.netty.handler.ssl.SslContext

直接已知子类:: JdkSslContext, OpenSslServerContext

public abstract class SslContext
extends java.lang.Object

A secure socket protocol implementation which acts as a factory for SSLEngine and SslHandler. Internally, it is implemented via JDK's SSLContext or OpenSSL's SSL_CTX.

Making your server support SSL/TLS

 // In your ChannelPipelineFactory:
 ChannelPipeline p = Channels.pipeline();
 SslContext sslCtx = SslContext.newServerContext(...);
 p.addLast("ssl", sslCtx.newEngine());
 ...

Making your client support SSL/TLS

 // In your ChannelPipelineFactory:
 ChannelPipeline p = Channels.pipeline();
 SslContext sslCtx = SslContext.newClientContext(...);
 p.addLast("ssl", sslCtx.newEngine(host, port));
 ...

方法概要

方法
限定符和类型	方法和说明
`SslBufferPool`	`bufferPool()` Returns the `SslBufferPool` used by the `SSLEngine` and `SslHandler` created by this context.
`abstract java.util.List<java.lang.String>`	`cipherSuites()` Returns the list of enabled cipher suites, in the order of preference.
`static SslProvider`	`defaultClientProvider()` Returns the default client-side implementation provider currently in use.
`static SslProvider`	`defaultServerProvider()` Returns the default server-side implementation provider currently in use.
`abstract boolean`	`isClient()` Returns the `true` if and only if this context is for client-side.
`boolean`	`isServer()` Returns `true` if and only if this context is for server-side.
`static SslContext`	`newClientContext()` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(java.io.File certChainFile)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(java.io.File certChainFile, javax.net.ssl.TrustManagerFactory trustManagerFactory)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(SslBufferPool bufPool, java.io.File certChainFile, javax.net.ssl.TrustManagerFactory trustManagerFactory, java.lang.Iterable<java.lang.String> ciphers, java.lang.Iterable<java.lang.String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(SslProvider provider)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(SslProvider provider, java.io.File certChainFile)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(SslProvider provider, java.io.File certChainFile, javax.net.ssl.TrustManagerFactory trustManagerFactory)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(SslProvider provider, SslBufferPool bufPool, java.io.File certChainFile, javax.net.ssl.TrustManagerFactory trustManagerFactory, java.lang.Iterable<java.lang.String> ciphers, java.lang.Iterable<java.lang.String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(SslProvider provider, javax.net.ssl.TrustManagerFactory trustManagerFactory)` Creates a new client-side `SslContext`.
`static SslContext`	`newClientContext(javax.net.ssl.TrustManagerFactory trustManagerFactory)` Creates a new client-side `SslContext`.
`abstract javax.net.ssl.SSLEngine`	`newEngine()` Creates a new `SSLEngine`.
`abstract javax.net.ssl.SSLEngine`	`newEngine(java.lang.String peerHost, int peerPort)` Creates a new `SSLEngine` using advisory peer information.
`SslHandler`	`newHandler()` Creates a new `SslHandler`.
`SslHandler`	`newHandler(java.lang.String peerHost, int peerPort)` Creates a new `SslHandler` with advisory peer information.
`static SslContext`	`newServerContext(java.io.File certChainFile, java.io.File keyFile)` Creates a new server-side `SslContext`.
`static SslContext`	`newServerContext(java.io.File certChainFile, java.io.File keyFile, java.lang.String keyPassword)` Creates a new server-side `SslContext`.
`static SslContext`	`newServerContext(SslBufferPool bufPool, java.io.File certChainFile, java.io.File keyFile, java.lang.String keyPassword, java.lang.Iterable<java.lang.String> ciphers, java.lang.Iterable<java.lang.String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Creates a new server-side `SslContext`.
`static SslContext`	`newServerContext(SslProvider provider, java.io.File certChainFile, java.io.File keyFile)` Creates a new server-side `SslContext`.
`static SslContext`	`newServerContext(SslProvider provider, java.io.File certChainFile, java.io.File keyFile, java.lang.String keyPassword)` Creates a new server-side `SslContext`.
`static SslContext`	`newServerContext(SslProvider provider, SslBufferPool bufPool, java.io.File certChainFile, java.io.File keyFile, java.lang.String keyPassword, java.lang.Iterable<java.lang.String> ciphers, java.lang.Iterable<java.lang.String> nextProtocols, long sessionCacheSize, long sessionTimeout)` Creates a new server-side `SslContext`.
`abstract java.util.List<java.lang.String>`	`nextProtocols()` Returns the list of application layer protocols for the TLS NPN/ALPN extension, in the order of preference.
`abstract long`	`sessionCacheSize()` Returns the size of the cache used for storing SSL session objects.
`abstract long`	`sessionTimeout()` Returns the timeout for the cached SSL session objects, in seconds.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - defaultServerProvider
```
public static SslProvider defaultServerProvider()
```
    Returns the default server-side implementation provider currently in use.
    
    返回:
    SslProvider.OPENSSL if OpenSSL is available. SslProvider.JDK otherwise.
  - defaultClientProvider
```
public static SslProvider defaultClientProvider()
```
    Returns the default client-side implementation provider currently in use.
    
    返回:
    SslProvider.JDK, because it is the only implementation at the moment
  - newServerContext
```
public static SslContext newServerContext(java.io.File certChainFile,
                          java.io.File keyFile)
                                   throws javax.net.ssl.SSLException
```
    Creates a new server-side SslContext.
    
    参数:
    certChainFile - an X.509 certificate chain file in PEM format
    keyFile - a PKCS#8 private key file in PEM format
    
    返回:
    a new server-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newServerContext
```
public static SslContext newServerContext(java.io.File certChainFile,
                          java.io.File keyFile,
                          java.lang.String keyPassword)
                                   throws javax.net.ssl.SSLException
```
    Creates a new server-side SslContext.
    
    参数:
    certChainFile - 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. null if it's not password-protected.
    
    返回:
    a new server-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newServerContext
```
public static SslContext newServerContext(SslBufferPool bufPool,
                          java.io.File certChainFile,
                          java.io.File keyFile,
                          java.lang.String keyPassword,
                          java.lang.Iterable<java.lang.String> ciphers,
                          java.lang.Iterable<java.lang.String> nextProtocols,
                          long sessionCacheSize,
                          long sessionTimeout)
                                   throws javax.net.ssl.SSLException
```
    Creates a new server-side SslContext.
    
    参数:
    bufPool - the buffer pool which will be used by the returned SslContext. null to use the default buffer pool.
    certChainFile - 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. null if it's not password-protected.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.
    sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.
    
    返回:
    a new server-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newServerContext
```
public static SslContext newServerContext(SslProvider provider,
                          java.io.File certChainFile,
                          java.io.File keyFile)
                                   throws javax.net.ssl.SSLException
```
    Creates a new server-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an X.509 certificate chain file in PEM format
    keyFile - a PKCS#8 private key file in PEM format
    
    返回:
    a new server-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newServerContext
```
public static SslContext newServerContext(SslProvider provider,
                          java.io.File certChainFile,
                          java.io.File keyFile,
                          java.lang.String keyPassword)
                                   throws javax.net.ssl.SSLException
```
    Creates a new server-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - 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. null if it's not password-protected.
    
    返回:
    a new server-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newServerContext
```
public static SslContext newServerContext(SslProvider provider,
                          SslBufferPool bufPool,
                          java.io.File certChainFile,
                          java.io.File keyFile,
                          java.lang.String keyPassword,
                          java.lang.Iterable<java.lang.String> ciphers,
                          java.lang.Iterable<java.lang.String> nextProtocols,
                          long sessionCacheSize,
                          long sessionTimeout)
                                   throws javax.net.ssl.SSLException
```
    Creates a new server-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    bufPool - the buffer pool which will be used by the returned SslContext. null to use the default buffer pool.
    certChainFile - 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. null if it's not password-protected.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.
    sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.
    
    返回:
    a new server-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext()
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(java.io.File certChainFile)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    certChainFile - an X.509 certificate chain file in PEM format
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(javax.net.ssl.TrustManagerFactory trustManagerFactory)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(java.io.File certChainFile,
                          javax.net.ssl.TrustManagerFactory trustManagerFactory)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    certChainFile - an X.509 certificate chain file in PEM format. null to use the system default
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(SslBufferPool bufPool,
                          java.io.File certChainFile,
                          javax.net.ssl.TrustManagerFactory trustManagerFactory,
                          java.lang.Iterable<java.lang.String> ciphers,
                          java.lang.Iterable<java.lang.String> nextProtocols,
                          long sessionCacheSize,
                          long sessionTimeout)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    bufPool - the buffer pool which will be used by the returned SslContext. null to use the default buffer pool.
    certChainFile - an X.509 certificate chain file in PEM format. null to use the system default
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.
    sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(SslProvider provider)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(SslProvider provider,
                          java.io.File certChainFile)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an X.509 certificate chain file in PEM format. null to use the system default
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(SslProvider provider,
                          javax.net.ssl.TrustManagerFactory trustManagerFactory)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(SslProvider provider,
                          java.io.File certChainFile,
                          javax.net.ssl.TrustManagerFactory trustManagerFactory)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    certChainFile - an X.509 certificate chain file in PEM format. null to use the system default
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - newClientContext
```
public static SslContext newClientContext(SslProvider provider,
                          SslBufferPool bufPool,
                          java.io.File certChainFile,
                          javax.net.ssl.TrustManagerFactory trustManagerFactory,
                          java.lang.Iterable<java.lang.String> ciphers,
                          java.lang.Iterable<java.lang.String> nextProtocols,
                          long sessionCacheSize,
                          long sessionTimeout)
                                   throws javax.net.ssl.SSLException
```
    Creates a new client-side SslContext.
    
    参数:
    provider - the SslContext implementation to use. null to use the current default one.
    bufPool - the buffer pool which will be used by the returned SslContext. null to use the default buffer pool.
    certChainFile - an X.509 certificate chain file in PEM format. null to use the system default
    trustManagerFactory - the TrustManagerFactory that provides the TrustManagers that verifies the certificates sent from servers. null to use the default.
    ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.
    nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.
    sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.
    sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.
    
    返回:
    a new client-side SslContext
    
    抛出:
    
    javax.net.ssl.SSLException
  - isServer
```
public final boolean isServer()
```
    Returns true if and only if this context is for server-side.
  - bufferPool
```
public final SslBufferPool bufferPool()
```
    Returns the SslBufferPool used by the SSLEngine and SslHandler created by this context.
  - isClient
```
public abstract boolean isClient()
```
    Returns the true if and only if this context is for client-side.
  - cipherSuites
```
public abstract java.util.List<java.lang.String> cipherSuites()
```
    Returns the list of enabled cipher suites, in the order of preference.
  - sessionCacheSize
```
public abstract long sessionCacheSize()
```
    Returns the size of the cache used for storing SSL session objects.
  - sessionTimeout
```
public abstract long sessionTimeout()
```
    Returns the timeout for the cached SSL session objects, in seconds.
  - nextProtocols
```
public abstract java.util.List<java.lang.String> nextProtocols()
```
    Returns the list of application layer protocols for the TLS NPN/ALPN extension, in the order of preference.
    
    返回:
    the list of application layer protocols. null if NPN/ALPN extension has been disabled.
  - newEngine
```
public abstract javax.net.ssl.SSLEngine newEngine()
```
    Creates a new SSLEngine.
    
    返回:
    a new SSLEngine
  - newEngine
```
public abstract javax.net.ssl.SSLEngine newEngine(java.lang.String peerHost,
                                int peerPort)
```
    Creates a new SSLEngine using advisory peer information.
    
    参数:
    peerHost - the non-authoritative name of the host
    peerPort - the non-authoritative port
    
    返回:
    a new SSLEngine
  - newHandler
```
public final SslHandler newHandler()
```
    Creates a new SslHandler.
    
    返回:
    a new SslHandler
  - newHandler
```
public final SslHandler newHandler(java.lang.String peerHost,
                    int peerPort)
```
    Creates a new SslHandler with advisory peer information.
    
    参数:
    peerHost - the non-authoritative name of the host
    peerPort - the non-authoritative port
    
    返回:
    a new SslHandler

类 SslContext

Making your server support SSL/TLS

Making your client support SSL/TLS

方法概要

从类继承的方法 java.lang.Object

方法详细资料

defaultServerProvider

defaultClientProvider

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newServerContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

newClientContext

isServer

bufferPool

isClient

cipherSuites

sessionCacheSize

sessionTimeout

nextProtocols

newEngine

newEngine

newHandler

newHandler