You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-18
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,18 @@
1
-
# java-sdk
1
+
# OpenTDF Java SDK
2
2
3
-
This repository provides the OpenTDF Java SDK.
4
-
It will be available from maven central as:
3
+
A Java implementation of the OpenTDF protocol, and access library for the services provided by the OpenTDF platform.
4
+
This SDK is available from Maven central as:
5
5
6
6
```xml
7
7
<dependency>
8
8
<groupId>io.opentdf/platform</groupId>
9
9
<artifactId>sdk</artifactId>
10
10
</dependency>
11
11
```
12
+
### Additional Maven Modules
13
+
- cmdline: Command line utility
12
14
13
-
14
-
15
-
## SDK Usage
16
-
17
-
### TDF File Creation and Reading
15
+
## Quick Start Example
18
16
19
17
```java
20
18
importio.opentdf.platform.sdk.Config;
@@ -48,7 +46,8 @@ public class Example {
48
46
49
47
### Cryptography Library
50
48
51
-
The SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/). SDK users may need to register the Bouncy Castle Provider; e.g.:
49
+
This SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/) library.
50
+
Note: When using this SDK, it may be necessary to register the Bouncy Castle Provider as follows:
52
51
53
52
```java
54
53
static{
@@ -58,23 +57,19 @@ The SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/)
58
57
59
58
### Logging
60
59
61
-
We use [slf4j](https://www.slf4j.org/), without providing a backend. We use log4j2 in our tests.
60
+
The Java SDK makes use of the [slf4j](https://www.slf4j.org/) library, without providing a backend. log4j2 in leveraged within the included automated tests.
62
61
63
62
### SSL - Untrusted Certificates
64
63
65
-
Use the SDKBuilder.withSSL... methods to build an SDKBuilder with:
64
+
Leverage the SDKBuilder.withSSL methods to create an SDKBuilder as follows:
66
65
67
66
- An SSLFactory: ```sdkBuilder.sslFactory(mySSLFactory)```
0 commit comments