org.apache.ftpserver.ssl

Interface SslConfiguration

All Known Implementing Classes:

DefaultSslConfiguration

public interface SslConfiguration

SSL configuration

Author:

Apache MINA Project

Method Summary

Modifier and Type	Method and Description
ClientAuth	getClientAuth() Return the required client authentication setting
String[]	getEnabledCipherSuites() Returns the cipher suites that should be enabled for this connection.
String	getEnabledProtocol() Returns the default ssl protocol
SSLSocketFactory	getSocketFactory() Returns the socket factory that can be used to create sockets using this SslConfiguration.
SSLContext	getSSLContext() Return the SSL context for this configuration
SSLContext	getSSLContext(String protocol) Return the SSL context for this configuration given the specified protocol

Method Detail

getSocketFactory

SSLSocketFactory getSocketFactory()
                           throws GeneralSecurityException

Returns the socket factory that can be used to create sockets using this SslConfiguration.

Returns:

the socket factory that can be used to create sockets using this SslConfiguration.

Throws:

GeneralSecurityException - if any error occurs while creating the socket factory.

getSSLContext

SSLContext getSSLContext()
                  throws GeneralSecurityException

Return the SSL context for this configuration

Returns:

The SSLContext

Throws:

GeneralSecurityException

getSSLContext

SSLContext getSSLContext(String protocol)
                  throws GeneralSecurityException

Return the SSL context for this configuration given the specified protocol

Parameters:

protocol - The protocol, SSL or TLS must be supported

Returns:

The SSLContext

Throws:

GeneralSecurityException

getEnabledCipherSuites

String[] getEnabledCipherSuites()

Returns the cipher suites that should be enabled for this connection. Must return null if the default (as decided by the JVM) cipher suites should be used.

Returns:

An array of cipher suites, or null.

getEnabledProtocol

String getEnabledProtocol()

Returns the default ssl protocol

Returns:

The name of the protocol as a String

getClientAuth

ClientAuth getClientAuth()

Return the required client authentication setting

Returns:

ClientAuth.NEED if client authentication is required, ClientAuth.WANT is client authentication is wanted or ClientAuth.NONE if no client authentication is the be performed