You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by rd...@apache.org on 2018/08/17 19:48:21 UTC
[16/16] tinkerpop git commit: Removed deprecated settings from docs,
updated javadoc
Removed deprecated settings from docs, updated javadoc
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/bbc0265c
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/bbc0265c
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/bbc0265c
Branch: refs/heads/TINKERPOP-2023
Commit: bbc0265c06f803d06ec2b6a600d4632d3f7d7d9b
Parents: 6434d04
Author: Robert Dale <ro...@gmail.com>
Authored: Fri Aug 17 15:47:27 2018 -0400
Committer: Robert Dale <ro...@gmail.com>
Committed: Fri Aug 17 15:47:27 2018 -0400
----------------------------------------------------------------------
.../src/reference/gremlin-applications.asciidoc | 8 ----
.../tinkerpop/gremlin/driver/Cluster.java | 42 +++++++++++---------
.../tinkerpop/gremlin/driver/Settings.java | 10 ++---
.../tinkerpop/gremlin/server/Settings.java | 34 ++++++++--------
4 files changed, 46 insertions(+), 48 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/bbc0265c/docs/src/reference/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc
index d13e2ef..8372a8a 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -730,9 +730,6 @@ The following table describes the various configuration options for the Gremlin
|connectionPool.channelizer |The fully qualified classname of the client `Channelizer` that defines how to connect to the server. |`Channelizer.WebSocketChannelizer`
|connectionPool.enableSsl |Determines if SSL should be enabled or not. If enabled on the server then it must be enabled on the client. |false
|connectionPool.keepAliveInterval |Length of time in milliseconds to wait on an idle connection before sending a keep-alive request. Set to zero to disable this feature. |1800000
-|connectionPool.keyCertChainFile |The X.509 certificate chain file in PEM format. |_none_
-|connectionPool.keyFile |The `PKCS#8` private key file in PEM format. |_none_
-|connectionPool.keyPassword |The password of the `keyFile` if it is password-protected. |_none_
|connectionPool.keyStore |The private key in JKS or PKCS#12 format. |_none_
|connectionPool.keyStorePassword |The password of the `keyStore` if it is password-protected. |_none_
|connectionPool.keyStoreType |`JKS` (Java 8 default) or `PKCS12` (Java 9+ default)|_none_
@@ -751,7 +748,6 @@ The following table describes the various configuration options for the Gremlin
|connectionPool.sslCipherSuites |The list of JSSE ciphers to support for SSL connections. If specified, only the ciphers that are listed and supported will be enabled. If not specified, the JVM default is used. |_none_
|connectionPool.sslEnabledProtocols |The list of SSL protocols to support for SSL connections. If specified, only the protocols that are listed and supported will be enabled. If not specified, the JVM default is used. |_none_
|connectionPool.sslSkipCertValidation |Configures the `TrustManager` to trust all certs without any validation. Should not be used in production.|false
-|connectionPool.trustCertChainFile |File location for a SSL Certificate Chain to use when SSL is enabled. If this value is not provided and SSL is enabled, the default `TrustManager` will be used. |_none_
|connectionPool.trustStore |File location for a SSL Certificate Chain to use when SSL is enabled. If this value is not provided and SSL is enabled, the default `TrustManager` will be used. |_none_
|connectionPool.trustStorePassword |The password of the `trustStore` if it is password-protected |_none_
|hosts |The list of hosts that the driver will connect to. |localhost
@@ -1156,16 +1152,12 @@ The following table describes the various configuration options that Gremlin Ser
|serializers[X].className |The full class name of the `MessageSerializer` implementation. |_none_
|serializers[X].config |A `Map` containing `MessageSerializer` specific configurations. |_none_
|ssl.enabled |Determines if SSL is turned on or not. |false
-|ssl.keyCertChainFile |The X.509 certificate chain file in PEM format.|_none_
-|ssl.keyFile |The `PKCS#8` private key file in PEM format.|_none_
-|ssl.keyPassword |The password of the `keyFile` if it is password-protected. |_none_
|ssl.keyStore |The private key in JKS or PKCS#12 format. |_none_
|ssl.keyStorePassword |The password of the `keyStore` if it is password-protected. |_none_
|ssl.keyStoreType |`JKS` (Java 8 default) or `PKCS12` (Java 9+ default) |_none_
|ssl.needClientAuth | Optional. One of NONE, OPTIONAL, REQUIRE. Enables client certificate authentication at the enforcement level specified. Can be used in combination with Authenticator. |_none_
|ssl.sslCipherSuites |The list of JSSE ciphers to support for SSL connections. If specified, only the ciphers that are listed and supported will be enabled. If not specified, the JVM default is used. |_none_
|ssl.sslEnabledProtocols |The list of SSL protocols to support for SSL connections. If specified, only the protocols that are listed and supported will be enabled. If not specified, the JVM default is used. |_none_
-|ssl.trustCertChainFile | Required when needClientAuth is OPTIONAL or REQUIRE. Trusted certificates for verifying the remote endpoint's certificate. The file should contain an X.509 certificate chain in PEM format. |_none_
|ssl.trustStore |Required when needClientAuth is OPTIONAL or REQUIRE. Trusted certificates for verifying the remote endpoint's certificate. If this value is not provided and SSL is enabled, the default `TrustManager` will be used. |_none_
|ssl.trustStorePassword |The password of the `trustStore` if it is password-protected |_none_
|strictTransactionManagement |Set to `true` to require `aliases` to be submitted on every requests, where the `aliases` become the scope of transaction management. |false
http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/bbc0265c/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
index 6e4ef25..7ae8d2d 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
@@ -569,11 +569,11 @@ public final class Cluster {
private String keyCertChainFile = null;
private String keyFile = null;
private String keyPassword = null;
- private String keyStore;
- private String keyStorePassword;
- private String trustStore;
- private String trustStorePassword;
- private String keyStoreType;
+ private String keyStore = null;
+ private String keyStorePassword = null;
+ private String trustStore = null;
+ private String trustStorePassword = null;
+ private String keyStoreType = null;
private List<String> sslEnabledProtocols = new ArrayList<>();
private List<String> sslCipherSuites = new ArrayList<>();
private boolean sslSkipCertValidation = false;
@@ -655,9 +655,8 @@ public final class Cluster {
/**
* File location for a SSL Certificate Chain to use when SSL is enabled. If this value is not provided and
- * SSL is enabled, the {@link TrustManager} will be established with a self-signed certificate which is NOT
- * suitable for production purposes.
- * @deprecated
+ * SSL is enabled, the default {@link TrustManager} will be used.
+ * @deprecated As of release 3.2.10, replaced by {@link trustStore}
*/
@Deprecated
public Builder trustCertificateChainFile(final String certificateChainFile) {
@@ -677,7 +676,7 @@ public final class Cluster {
/**
* The X.509 certificate chain file in PEM format.
- * @deprecated
+ * @deprecated As of release 3.2.10, replaced by {@link keyStore}
*/
@Deprecated
public Builder keyCertChainFile(final String keyCertChainFile) {
@@ -687,7 +686,7 @@ public final class Cluster {
/**
* The PKCS#8 private key file in PEM format.
- * @deprecated
+ * @deprecated As of release 3.2.10, replaced by {@link keyStore}
*/
@Deprecated
public Builder keyFile(final String keyFile) {
@@ -697,7 +696,7 @@ public final class Cluster {
/**
* The password of the {@link #keyFile}, or {@code null} if it's not password-protected.
- * @deprecated
+ * @deprecated As of release 3.2.10, replaced by {@link keyStorePassword}
*/
@Deprecated
public Builder keyPassword(final String keyPassword) {
@@ -706,7 +705,7 @@ public final class Cluster {
}
/**
- *
+ * The file location of the private key in JKS or PKCS#12 format.
*/
public Builder keyStore(final String keyStore) {
this.keyStore = keyStore;
@@ -714,7 +713,7 @@ public final class Cluster {
}
/**
- *
+ * The password of the {@link #keyStore}, or {@code null} if it's not password-protected.
*/
public Builder keyStorePassword(final String keyStorePassword) {
this.keyStorePassword = keyStorePassword;
@@ -722,7 +721,8 @@ public final class Cluster {
}
/**
- *
+ * The file location for a SSL Certificate Chain to use when SSL is enabled. If
+ * this value is not provided and SSL is enabled, the default {@link TrustManager} will be used.
*/
public Builder trustStore(final String trustStore) {
this.trustStore = trustStore;
@@ -730,7 +730,7 @@ public final class Cluster {
}
/**
- *
+ * The password of the {@link #trustStore}, or {@code null} if it's not password-protected.
*/
public Builder trustStorePassword(final String trustStorePassword) {
this.trustStorePassword = trustStorePassword;
@@ -738,7 +738,7 @@ public final class Cluster {
}
/**
- *
+ * The format of the {@link keyStore}, either {@code JKS} or {@code PKCS12}
*/
public Builder keyStoreType(final String keyStoreType) {
this.keyStoreType = keyStoreType;
@@ -746,7 +746,9 @@ public final class Cluster {
}
/**
- *
+ * A list of SSL protocols to enable. @see <a href=
+ * "https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SunJSSE_Protocols">JSSE
+ * Protocols</a>
*/
public Builder sslEnabledProtocols(final List<String> sslEnabledProtocols) {
this.sslEnabledProtocols = sslEnabledProtocols;
@@ -754,7 +756,9 @@ public final class Cluster {
}
/**
- *
+ * A list of cipher suites to enable. @see <a href=
+ * "https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SupportedCipherSuites">Cipher
+ * Suites</a>
*/
public Builder sslCipherSuites(final List<String> sslCipherSuites) {
this.sslCipherSuites = sslCipherSuites;
@@ -762,7 +766,7 @@ public final class Cluster {
}
/**
- *
+ * If true, trust all certificates and do not perform any validation.
*/
public Builder sslSkipCertValidation(final boolean sslSkipCertValidation) {
this.sslSkipCertValidation = sslSkipCertValidation;
http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/bbc0265c/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java
index 4d54792..fedd337 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Settings.java
@@ -258,28 +258,28 @@ final class Settings {
/**
* The trusted certificate in PEM format.
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link trustStore}
*/
@Deprecated
public String trustCertChainFile = null;
/**
* The X.509 certificate chain file in PEM format.
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link keyStore}
*/
@Deprecated
public String keyCertChainFile = null;
/**
* The PKCS#8 private key file in PEM format.
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link keyStore}
*/
@Deprecated
public String keyFile = null;
/**
* The password of the {@link #keyFile}, or {@code null} if it's not password-protected.
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link keyStorePassword}
*/
@Deprecated
public String keyPassword = null;
@@ -329,7 +329,7 @@ final class Settings {
public List<String> sslCipherSuites = new ArrayList<>();
/**
- *
+ * If true, trust all certificates and do not perform any validation.
*/
public boolean sslSkipCertValidation = false;
http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/bbc0265c/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
index c918f8b..4acfea0 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java
@@ -51,6 +51,8 @@ import java.util.Optional;
import java.util.ServiceLoader;
import java.util.UUID;
+import javax.net.ssl.TrustManager;
+
/**
* Server settings as configured by a YAML file.
*
@@ -457,7 +459,7 @@ public class Settings {
/**
* The X.509 certificate chain file in PEM format.
*
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link keyStore}
*/
@Deprecated
public String keyCertChainFile = null;
@@ -465,7 +467,7 @@ public class Settings {
/**
* The PKCS#8 private key file in PEM format.
*
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link keyStore}
*/
@Deprecated
public String keyFile = null;
@@ -474,7 +476,7 @@ public class Settings {
* The password of the {@link #keyFile}, or {@code null} if it's not
* password-protected.
*
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link keyStorePassword}
*/
@Deprecated
public String keyPassword = null;
@@ -484,48 +486,48 @@ public class Settings {
* file should contain an X.509 certificate chain in PEM format. {@code null}
* uses the system default.
*
- * @deprecated Use JSSE-based settings
+ * @deprecated As of release 3.2.10, replaced by {@link trustStore}
*/
@Deprecated
public String trustCertChainFile = null;
/**
- * JSSE keystore file path. Similar to setting JSSE property
- * {@code javax.net.ssl.keyStore}.
+ * The file location of the private key in JKS or PKCS#12 format.
*/
public String keyStore;
/**
- * JSSE keystore password. Similar to setting JSSE property
- * {@code javax.net.ssl.keyStorePassword}.
+ * The password of the {@link #keyStore}, or {@code null} if it's not password-protected.
*/
public String keyStorePassword;
/**
- * JSSE truststore file path. Similar to setting JSSE property
- * {@code javax.net.ssl.trustStore}.
+ * Trusted certificates for verifying the remote client's certificate. If
+ * this value is not provided and SSL is enabled, the default {@link TrustManager} will be used.
*/
public String trustStore;
/**
- * JSSE truststore password. Similar to setting JSSE property
- * {@code javax.net.ssl.trustStorePassword}.
+ * The password of the {@link #trustStore}, or {@code null} if it's not password-protected.
*/
public String trustStorePassword;
/**
- * JSSE keystore format. Similar to setting JSSE property
- * {@code javax.net.ssl.keyStoreType}.
+ * The format of the {@link keyStore}, either {@code JKS} or {@code PKCS12}
*/
public String keyStoreType;
/**
- * @see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SunJSSE_Protocols">JSSE Protocols</a>
+ * A list of SSL protocols to enable. @see <a href=
+ * "https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SunJSSE_Protocols">JSSE
+ * Protocols</a>
*/
public List<String> sslEnabledProtocols = new ArrayList<>();
/**
- * @see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SupportedCipherSuites">Cipher Suites</a>
+ * A list of cipher suites to enable. @see <a href=
+ * "https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SupportedCipherSuites">Cipher
+ * Suites</a>
*/
public List<String> sslCipherSuites = new ArrayList<>();