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
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,19 @@ View the Java docs [here](https://nuix.github.io/Nuix-Java-Engine-Baseline/).
11
11
12
12
**Written By:** Jason Wells
13
13
14
-
This repository contains a series of examples making use of the Java Engine API and can be used as a starting point for your own Nuix Java Engine based project. This project aims to provide a core implementation of functionality around the API for you to make immediate use of or build upon. If you are looking for a simpler example demonstrating core concepts regarding getting the Nuix Java Engine API up and running, see the [Java SDK Starter repository](https://github.com/Nuix/java-sdk-starter).
14
+
This repository contains a series of examples making use of the Java Engine API and can be used as a foundation for your own Nuix Java Engine based project. This project provides implementation of some commonly desired functionality one may want around using the Nuix Engine API:
15
15
16
-
# Getting Started
16
+
- Environment configuration checks with hints at addressed misconfigurations
17
+
- License resolution with fallbacks when initially desired license is not available
18
+
- Logging initialization
19
+
- Diagnostics generation
20
+
- Third party dependency checking
17
21
18
-
## Setup
22
+
This project can provide you a quick way to get up and running with some additional functionality built on top. Due to some of the extra features included, this project may not be the easiest way to wrap you head around the fundamental steps needed to use the Nuix Java Engine API. If you are looking for a more straight forward example demonstrating core concepts regarding getting the Nuix Java Engine API up and running, see the [Java SDK Starter repository](https://github.com/Nuix/java-sdk-starter).
19
23
20
-
### Nuix Java Engine Distributable
24
+
# Setup
25
+
26
+
## Nuix Java Engine Distributable
21
27
22
28
We will need to obtain a Nuix Java Engine API distributable release. This contains the various binaries and dependencies needed to run the Nuix Java Engine API.
23
29
@@ -26,7 +32,7 @@ We will need to obtain a Nuix Java Engine API distributable release. This conta
26
32
1. Edit the system environment variables, adding a new variable named `NUIX_ENGINE_DIR` assigning the directory in the previous step as the value. The project refers to this environment variable to resolve these dependencies.
27
33
1. (Optional) If you wish to obtain your license from either Nuix Management Server (NMS) or Nuix Cloud License Server (CLS) you may want to specify authentication credentials. The project supports obtaining the user name and password from environment variables `NUIX_USERNAME` and `NUIX_PASSWORD` (although does not require this).
28
34
29
-
###IDE
35
+
## IDE
30
36
31
37
This project makes use of [Gradle](https://gradle.org/) and has been tested with [IntelliJ Idea IDE](https://www.jetbrains.com/idea/). It may work with other IDEs such as [Eclipse](https://www.eclipse.org/eclipseide/) as well, but it has only been tested in IntelliJ Idea.
32
38
@@ -38,7 +44,7 @@ This project makes use of [Gradle](https://gradle.org/) and has been tested with
38
44
1. Start IntelliJ Idea and open project by selecting `\Nuix-Java-Engine-Baseline\IntelliJ\build.gradle.kts`.
39
45
1. Import process should begin. This can take a few minutes as dependencies are pulled down from the internet, dependencies are indexed, etc.
40
46
41
-
##NuixEngine Class
47
+
# NuixEngine Class
42
48
43
49
Making use of the Nuix Java Engine API, at a high level, involves:
The`run` method will internally call the `NuixEngine.getUtilities` method. This in turn will do the following:
83
+
In the example above, the`run` method will internally call the `NuixEngine.getUtilities` method. This in turn will do the following:
78
84
1. Call `NuixEngine.checkPreconditions` which will check some environmental settings, using sensible defaults when possible and throwing informative errors when it cannot.
79
85
1. Initialize log4j2 logging for you.
80
86
1. Constructuct `GlobalContainer` and `Engine` instances for you with some lifetime management hooked into JVM shut down.
0 commit comments