org.apache.ftpserver.ssl.impl

Class DefaultSslConfiguration

java.lang.Object

org.apache.ftpserver.ssl.impl.DefaultSslConfiguration

All Implemented Interfaces:

SslConfiguration

public class DefaultSslConfiguration
extends Object
implements SslConfiguration

Internal class, do not use directly. Used to configure the SSL settings for the control channel or the data channel. Internal class, do not use directly.

Author:

Apache MINA Project

Constructor Summary

Constructors

Constructor and Description
DefaultSslConfiguration(KeyManagerFactory keyManagerFactory, TrustManagerFactory trustManagerFactory, ClientAuth clientAuthReqd, String sslProtocol, String[] enabledCipherSuites, String keyAlias) Internal constructor, do not use directly.

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 enabledProtocol) Return the SSL context for this configuration given the specified protocol

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSslConfiguration

public DefaultSslConfiguration(KeyManagerFactory keyManagerFactory,
                               TrustManagerFactory trustManagerFactory,
                               ClientAuth clientAuthReqd,
                               String sslProtocol,
                               String[] enabledCipherSuites,
                               String keyAlias)
                        throws GeneralSecurityException

Internal constructor, do not use directly. Instead, use SslConfigurationFactory

Throws:

GeneralSecurityException

Method Detail

getSocketFactory

public SSLSocketFactory getSocketFactory()
                                  throws GeneralSecurityException

Description copied from interface: SslConfiguration

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

Specified by:

getSocketFactory in interface 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

public SSLContext getSSLContext(String enabledProtocol)
                         throws GeneralSecurityException

Description copied from interface: SslConfiguration

Return the SSL context for this configuration given the specified protocol

Specified by:

getSSLContext in interface SslConfiguration

Parameters:

enabledProtocol - The protocol, SSL or TLS must be supported

Returns:

The SSLContext

Throws:

GeneralSecurityException

See Also:

SslConfiguration.getSSLContext(String)

getEnabledProtocol

public String getEnabledProtocol()

Description copied from interface: SslConfiguration

Returns the default ssl protocol

Specified by:

getEnabledProtocol in interface SslConfiguration

Returns:

The name of the protocol as a String

See Also:

SslConfiguration.getEnabledProtocol()

getClientAuth

public ClientAuth getClientAuth()

Description copied from interface: SslConfiguration

Return the required client authentication setting

Specified by:

getClientAuth in interface SslConfiguration

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

See Also:

SslConfiguration.getClientAuth()

getSSLContext

public SSLContext getSSLContext()
                         throws GeneralSecurityException

Description copied from interface: SslConfiguration

Return the SSL context for this configuration

Specified by:

getSSLContext in interface SslConfiguration

Returns:

The SSLContext

Throws:

GeneralSecurityException

See Also:

SslConfiguration.getSSLContext()

getEnabledCipherSuites

public String[] getEnabledCipherSuites()

Description copied from interface: SslConfiguration

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.

Specified by:

getEnabledCipherSuites in interface SslConfiguration

Returns:

An array of cipher suites, or null.

See Also:

SslConfiguration.getEnabledCipherSuites()