org.apache.spark

Class SSLOptions

Object

org.apache.spark.SSLOptions

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class SSLOptions
extends Object
implements scala.Product, scala.Serializable

SSLOptions class is a common container for SSL configuration options. It offers methods to generate specific objects to configure SSL for different communication protocols.

SSLOptions is intended to provide the maximum common set of SSL settings, which are supported by the protocol, which it can generate the configuration for. Since Akka doesn't support client authentication with SSL, SSLOptions cannot support it either.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SSLOptions(boolean enabled, scala.Option<java.io.File> keyStore, scala.Option<String> keyStorePassword, scala.Option<String> keyPassword, scala.Option<java.io.File> trustStore, scala.Option<String> trustStorePassword, scala.Option<String> protocol, scala.collection.immutable.Set<String> enabledAlgorithms)

Method Summary

Methods

Modifier and Type	Method and Description
scala.Option<com.typesafe.config.Config>	createAkkaConfig() Creates an Akka configuration object which contains all the SSL settings represented by this object.
scala.Option<org.eclipse.jetty.util.ssl.SslContextFactory>	createJettySslContextFactory() Creates a Jetty SSL context factory according to the SSL settings represented by this object.
boolean	enabled()
scala.collection.immutable.Set<String>	enabledAlgorithms()
scala.Option<String>	keyPassword()
scala.Option<java.io.File>	keyStore()
scala.Option<String>	keyStorePassword()
static SSLOptions	parse(SparkConf conf, String ns, scala.Option<SSLOptions> defaults) Resolves SSLOptions settings from a given Spark configuration object at a given namespace.
scala.Option<String>	protocol()
String	toString() Returns a string representation of this SSLOptions with all the passwords masked.
scala.Option<java.io.File>	trustStore()
scala.Option<String>	trustStorePassword()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

SSLOptions

public SSLOptions(boolean enabled,
          scala.Option<java.io.File> keyStore,
          scala.Option<String> keyStorePassword,
          scala.Option<String> keyPassword,
          scala.Option<java.io.File> trustStore,
          scala.Option<String> trustStorePassword,
          scala.Option<String> protocol,
          scala.collection.immutable.Set<String> enabledAlgorithms)

Method Detail

parse

public static SSLOptions parse(SparkConf conf,
               String ns,
               scala.Option<SSLOptions> defaults)

Resolves SSLOptions settings from a given Spark configuration object at a given namespace.

The following settings are allowed: $ - [ns].enabled - true or false, to enable or disable SSL respectively $ - [ns].keyStore - a path to the key-store file; can be relative to the current directory $ - [ns].keyStorePassword - a password to the key-store file $ - [ns].keyPassword - a password to the private key $ - [ns].trustStore - a path to the trust-store file; can be relative to the current directory $ - [ns].trustStorePassword - a password to the trust-store file $ - [ns].protocol - a protocol name supported by a particular Java version $ - [ns].enabledAlgorithms - a comma separated list of ciphers

For a list of protocols and ciphers supported by particular Java versions, you may go to Oracle blog page.

You can optionally specify the default configuration. If you do, for each setting which is missing in SparkConf, the corresponding setting is used from the default configuration.

Parameters:

conf - Spark configuration object where the settings are collected from

ns - the namespace name

defaults - the default configuration

Returns:

SSLOptions object

enabled

public boolean enabled()

keyStore

public scala.Option<java.io.File> keyStore()

keyStorePassword

public scala.Option<String> keyStorePassword()

keyPassword

public scala.Option<String> keyPassword()

trustStore

public scala.Option<java.io.File> trustStore()

trustStorePassword

public scala.Option<String> trustStorePassword()

protocol

public scala.Option<String> protocol()

enabledAlgorithms

public scala.collection.immutable.Set<String> enabledAlgorithms()

createJettySslContextFactory

public scala.Option<org.eclipse.jetty.util.ssl.SslContextFactory> createJettySslContextFactory()

Creates a Jetty SSL context factory according to the SSL settings represented by this object.

createAkkaConfig

public scala.Option<com.typesafe.config.Config> createAkkaConfig()

Creates an Akka configuration object which contains all the SSL settings represented by this object. It can be used then to compose the ultimate Akka configuration.

toString

public String toString()

Returns a string representation of this SSLOptions with all the passwords masked.

Overrides:

toString in class Object