Commit 0a8bc482 authored by Andy Wilkinson's avatar Andy Wilkinson Committed by Stephane Nicoll

Add documentation for Ssl properties

Closes gh-2049
parent dbcbebca
...@@ -26,36 +26,63 @@ package org.springframework.boot.context.embedded; ...@@ -26,36 +26,63 @@ package org.springframework.boot.context.embedded;
public class Ssl { public class Ssl {
/** /**
* Client authentication mode ("want", "need"). * Whether client authentication is wanted ("want") or needed ("need"). Requires a trust store.
*/ */
private ClientAuth clientAuth; private ClientAuth clientAuth;
/**
* Supported SSL ciphers.
*/
private String[] ciphers; private String[] ciphers;
/**
* Alias that identifies the key in the key store.
*/
private String keyAlias; private String keyAlias;
/**
* Password used to access the key in the key store.
*/
private String keyPassword; private String keyPassword;
/** /**
* Path to the key store (typically a jks file). * Path to the key store that holds the SSL certificate (typically a jks file).
*/ */
private String keyStore; private String keyStore;
/** /**
* Login password of the key store. * Password used to access the key store.
*/ */
private String keyStorePassword; private String keyStorePassword;
/**
* Type of the key store.
*/
private String keyStoreType; private String keyStoreType;
/**
* Provider for the key store.
*/
private String keyStoreProvider; private String keyStoreProvider;
/**
* Trust store that holds SSL certificates.
*/
private String trustStore; private String trustStore;
/**
* Password used to access the trust store.
*/
private String trustStorePassword; private String trustStorePassword;
/**
* Type of the trust store.
*/
private String trustStoreType; private String trustStoreType;
/**
* Provider for the trust store.
*/
private String trustStoreProvider; private String trustStoreProvider;
/** /**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment