spiffe
/
java-spiffe
mirror of https://github.com/spiffe/java-spiffe.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Amendments in javadoc in java-spiffe-helper. 

Signed-off-by: Max Lambrecht <maxlambrecht@gmail.com>
This commit is contained in:
Max Lambrecht 2020-06-15 13:36:28 -03:00
parent 0e7413ad09
commit f132b04a17
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
java-spiffe-helper/src/main/java/spiffe/helper/keystore/KeyStoreHelper.java
View File

@ -22,8 +22,8 @@ import java.util.concurrent.CountDownLatch;
import java.util.logging.Level; import java.util.logging.Level;
/** /**
* A <code>KeyStoreHelper</code> represents a helper for storing X.509 SVIDs and bundles, * Represents a helper for storing X.509 SVIDs and bundles that are automatically rotated via the Workload API,
* that are automatically rotated via the Workload API, in a Java KeyStore and a TrustStore in files in disk. * in a Java KeyStore and a TrustStore in files in disk.
* <p> * <p>
* It stores the Private Key along with the chain of certificates in a KeyStore, and the * It stores the Private Key along with the chain of certificates in a KeyStore, and the
* trusted bundles in a separate KeyStore (TrustStore). * trusted bundles in a separate KeyStore (TrustStore).
@ -51,7 +51,9 @@ public class KeyStoreHelper {
/** /**
* Create an instance of a KeyStoreHelper for fetching X.509 SVIDs and bundles * Constructor.
* <p>
* Creates an instance of a KeyStoreHelper for fetching X.509 SVIDs and bundles
* from a Workload API and store them in a binary Java KeyStore in disk. * from a Workload API and store them in a binary Java KeyStore in disk.
* <p> * <p>
* It blocks until the initial update has been received from the Workload API. * It blocks until the initial update has been received from the Workload API.
@ -226,6 +228,9 @@ public class KeyStoreHelper {
*/ */
String spiffeSocketPath; String spiffeSocketPath;
/**
* Optional. The workload api client to fetch the X.509 materials from the Workload API.
*/
WorkloadApiClient client; WorkloadApiClient client;
@Builder @Builder

2
java-spiffe-helper/src/main/java/spiffe/helper/keystore/KeyStoreType.java
View File

@ -1,7 +1,7 @@
package spiffe.helper.keystore; package spiffe.helper.keystore;
/** /**
* KeyStore types supported by the KeyStoreHelper * KeyStore types supported by the KeyStoreHelper.
*/ */
public enum KeyStoreType { public enum KeyStoreType {