Index (Nuix-Java-Engine-Baseline 9.10 API)

A B C D E F G I J L M N P R S T U V W
All Classes All Packages

A

accept(T) - Method in interface com.nuix.enginebaseline.ThrowCapableConsumer
Any - com.nuix.enginebaseline.NuixLicenseResolver.LicenseResolutionSource: The license resolution is not constrained to any particular source.

B

buildEngine() - Method in class com.nuix.enginebaseline.NuixEngine: Builds an engine instance.

C

certificateTrustCallback - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
close() - Method in class com.nuix.enginebaseline.NuixEngine: Cleans up resources associated with this instance: Calls close on underlying Engine instance Drop reference to obtained Utilities object Unregisters shutdown hook Shuts down logging
closeGlobalContainer() - Static method in class com.nuix.enginebaseline.NuixEngine
Cloud - com.nuix.enginebaseline.NuixLicenseResolver.LicenseResolutionSource: The license should be resolved from the Nuix Cloud License Server (CLS).
com.nuix.enginebaseline - package com.nuix.enginebaseline
compareTo(NuixVersion) - Method in class com.nuix.enginebaseline.NuixVersion: Provides comparison logic when comparing two instances.
completedCallback - Variable in class com.nuix.enginebaseline.RubyScriptRunner
credentialsCallback - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
Custom - com.nuix.enginebaseline.NuixLicenseResolver.LicenseResolutionSource: Similar to Any, but the user provides a custom list of sources.
customSource - Variable in class com.nuix.enginebaseline.NuixLicenseResolver

D

Dongle - com.nuix.enginebaseline.NuixLicenseResolver.LicenseResolutionSource: The license should be resolved from physical dongles attached to the machine.

E

engine - Variable in class com.nuix.enginebaseline.NuixEngine
engineDistributionDirectorySupplier - Variable in class com.nuix.enginebaseline.NuixEngine
ensureGlobalContainer() - Method in class com.nuix.enginebaseline.NuixEngine: If we do not yet have a global container instance, creates one.
errorOutput - Variable in class com.nuix.enginebaseline.RubyScriptRunner

F

finalDecider - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
fromAnySource() - Static method in class com.nuix.enginebaseline.NuixLicenseResolver: Creates an instance which places no constraints on where the license is obtained from.
fromCloud() - Static method in class com.nuix.enginebaseline.NuixLicenseResolver: Creates an instance specifically for resolving a license from the Nuix Cloud License Server (CLS).
fromCustomSource(String) - Static method in class com.nuix.enginebaseline.NuixLicenseResolver: Creates an instance that will specify a custom source.
fromDongle() - Static method in class com.nuix.enginebaseline.NuixLicenseResolver: Creates an instance specifically for resolving a physical dongle based license.
fromServer(String) - Static method in class com.nuix.enginebaseline.NuixLicenseResolver: Creates an instance specifically for resolving a license from a Nuix Management Server (NMS) instance.
fromServer(String, int) - Static method in class com.nuix.enginebaseline.NuixLicenseResolver: Creates an instance specifically for resolving a license from a Nuix Management Server (NMS) instance.

G

getBugfix() - Method in class com.nuix.enginebaseline.NuixVersion: Gets the determined bugfix portion of this version instance (0.0.x.0)
getBuild() - Method in class com.nuix.enginebaseline.NuixVersion: Gets the determined build portion of this version instance (0.0.0.x)
getKnownFeatures() - Static method in class com.nuix.enginebaseline.NuixLicenseFeaturesLogger: Returns a String array containing a list of known license features
getMajor() - Method in class com.nuix.enginebaseline.NuixVersion: Gets the determined major portion of this version instance (X.0.0.0)
getMinor() - Method in class com.nuix.enginebaseline.NuixVersion: Gets the determined minor portion of this version instance (0.X.0.0)
getNuixVersion() - Method in class com.nuix.enginebaseline.NuixEngine: Gets a NuixVersion object representing the Engine version as obtained by calling Engine.getVersion
Note that if Engine instance has not yet been initialized this returns "0.0.0.0"
getNuixVersionString() - Method in class com.nuix.enginebaseline.NuixEngine: Returns the Nuix engine version by internally calling Engine.getVersion
Note that if Engine instance has not yet been initialized this returns "0.0.0.0"
getUtilities() - Method in class com.nuix.enginebaseline.NuixEngine: Gets Utilities object to begin making use of the Nuix API.

I

initializeLogging() - Method in class com.nuix.enginebaseline.NuixEngine: Initializes some logging details.
interrupt() - Method in class com.nuix.enginebaseline.RubyScriptRunner: Interrupts running script thread if there is one running.
isAlive() - Method in class com.nuix.enginebaseline.RubyScriptRunner: Checks if script thread exists and is currently running.
isAtLeast(NuixVersion) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is greater than or equal to this instance
isAtLeast(String) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is greater than or equal to this instance
isEqualTo(NuixVersion) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is equal to this instance
isEqualTo(String) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is equal to this instance
isGreaterThan(NuixVersion) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is greater than this instance
isGreaterThan(String) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is greater than this instance
isLessThan(NuixVersion) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is less than this instance
isLessThan(String) - Method in class com.nuix.enginebaseline.NuixVersion: Determines whether another instance's version is less than this instance

J

join() - Method in class com.nuix.enginebaseline.RubyScriptRunner: Joins script thread (if it exists) via Thread.join().
join(long) - Method in class com.nuix.enginebaseline.RubyScriptRunner: Joins script thread (if it exists) via Thread.join(long).

L

LicenseResolver - Interface in com.nuix.enginebaseline: An interface for providing NuixEngine license resolution.
licenseSource - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
log - Variable in class com.nuix.enginebaseline.NuixEngine
logAllDependencyInfo(Utilities) - Method in class com.nuix.enginebaseline.NuixEngine: Logs information about all Nuix third party dependencies
logDirectorySupplier - Variable in class com.nuix.enginebaseline.NuixEngine
logFeaturesOfLicense(LicenceProperties) - Static method in class com.nuix.enginebaseline.NuixLicenseFeaturesLogger: Logs a listing of whether each feature is present or not on the provided license.

M

maxWorkerCount - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
minWorkerCount - Variable in class com.nuix.enginebaseline.NuixLicenseResolver

N

NuixDiagnostics - Class in com.nuix.enginebaseline: Provides methods for generating Nuix diagnostics files.
NuixDiagnostics() - Constructor for class com.nuix.enginebaseline.NuixDiagnostics
NuixEngine - Class in com.nuix.enginebaseline: This class represents a wrapper over the Nuix Engine API.
NuixEngine() - Constructor for class com.nuix.enginebaseline.NuixEngine
NuixLicenseFeaturesLogger - Class in com.nuix.enginebaseline: Helper class for logging what features are present on a given license.
NuixLicenseFeaturesLogger() - Constructor for class com.nuix.enginebaseline.NuixLicenseFeaturesLogger
NuixLicenseResolver - Class in com.nuix.enginebaseline: This class provides license resolution for a NuixEngine instance.
NuixLicenseResolver() - Constructor for class com.nuix.enginebaseline.NuixLicenseResolver
NuixLicenseResolver.LicenseResolutionSource - Enum in com.nuix.enginebaseline: An enum with options about how this license resolver should locate its license.
nuixLicenseResolvers - Variable in class com.nuix.enginebaseline.NuixEngine
NuixVersion - Class in com.nuix.enginebaseline: Provides a wrapper around Nuix version string that allows for comparison of versions.
NuixVersion() - Constructor for class com.nuix.enginebaseline.NuixVersion: Creates a new instance defaulting to version 0.0.0
NuixVersion(int) - Constructor for class com.nuix.enginebaseline.NuixVersion: Creates a new instance using the provided major version: major.0.0.0
NuixVersion(int, int) - Constructor for class com.nuix.enginebaseline.NuixVersion: Creates a new instance using the provided major and minor versions: major.minor.0.0
NuixVersion(int, int, int) - Constructor for class com.nuix.enginebaseline.NuixVersion: Creates a new instance using the provided major, minor and bugfix versions: major.minor.bugfix.0
NuixVersion(int, int, int, int) - Constructor for class com.nuix.enginebaseline.NuixVersion: Creates a new instance using the provided major, minor, bugfix and build versions: major.minor.bugfix.build

P

parse(String) - Static method in class com.nuix.enginebaseline.NuixVersion: Parses a version string into a NuixVersion instance.

R

requiredFeatures - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
resolveLicense(Engine) - Method in interface com.nuix.enginebaseline.LicenseResolver: Attempts to license the provided Engine instance using resolution and filtering configuration of this instance.
resolveLicense(Engine) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Attempts to license the provided Engine instance using resolution and filtering configuration of this instance.
RubyScriptRunner - Class in com.nuix.enginebaseline: Provides an easy way to execute Ruby scripts.
RubyScriptRunner() - Constructor for class com.nuix.enginebaseline.RubyScriptRunner
run(ThrowCapableConsumer<Utilities>) - Method in class com.nuix.enginebaseline.NuixEngine: Convenience method for running an operation with a licensed engine instance and then automatically closing this instance.
runFileAsync(File, String, Map<String, Object>) - Method in class com.nuix.enginebaseline.RubyScriptRunner: Runs a ruby script asynchronously
runRubyScriptAsync(String, BiConsumer<Object, BiVariableMap>) - Method in class com.nuix.enginebaseline.NuixEngine: Runs the Ruby script contained in the provided String, defaulting to logging standard/error script output.
runRubyScriptAsync(String, Map<String, Object>, BiConsumer<Object, BiVariableMap>) - Method in class com.nuix.enginebaseline.NuixEngine: Runs the Ruby script contained in the provided String, defaulting to logging standard/error script output.
runRubyScriptAsync(String, Map<String, Object>, Consumer<String>, Consumer<String>, BiConsumer<Object, BiVariableMap>) - Method in class com.nuix.enginebaseline.NuixEngine: Runs the Ruby script contained in the provided String.
runRubyScriptFileAsync(File, BiConsumer<Object, BiVariableMap>) - Method in class com.nuix.enginebaseline.NuixEngine: Runs the Ruby script contained in the specified file, defaulting to logging standard/error script output.
runRubyScriptFileAsync(File, Map<String, Object>, BiConsumer<Object, BiVariableMap>) - Method in class com.nuix.enginebaseline.NuixEngine: Runs the Ruby script contained in the specified file, defaulting to logging standard/error script output.
runRubyScriptFileAsync(File, Map<String, Object>, Consumer<String>, Consumer<String>, BiConsumer<Object, BiVariableMap>) - Method in class com.nuix.enginebaseline.NuixEngine: Runs the Ruby script contained in the specified file.
runScriptAsync(String, String, Map<String, Object>) - Method in class com.nuix.enginebaseline.RubyScriptRunner: Runs a ruby script asynchronously

S

saveDiagnosticsToDirectory(File) - Static method in class com.nuix.enginebaseline.NuixDiagnostics: Convenience method for saving a diagnostics file to a directory.
saveDiagnosticsToDirectory(String) - Static method in class com.nuix.enginebaseline.NuixDiagnostics: Convenience method for saving a diagnostics file to a directory.
saveDiagnosticsToFile(File) - Static method in class com.nuix.enginebaseline.NuixDiagnostics: Saves a Nuix diagnostics zip file at the specified path.
saveDiagnosticsToFile(String) - Static method in class com.nuix.enginebaseline.NuixDiagnostics: Saves a Nuix diagnostics zip file at the specified path.
scriptingContainer - Variable in class com.nuix.enginebaseline.RubyScriptRunner
scriptThread - Variable in class com.nuix.enginebaseline.RubyScriptRunner
Server - com.nuix.enginebaseline.NuixLicenseResolver.LicenseResolutionSource: The license should be resolved from a Nuix Management Server (NMS) instance.
serverHost - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
serverPort - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
setBugfix(int) - Method in class com.nuix.enginebaseline.NuixVersion: Sets the determined bugfix portion of this version instance (0.0.x.0)
setBuild(int) - Method in class com.nuix.enginebaseline.NuixVersion: Sets the build portion of this version instance (0.0.0.x)
setEngineDistributionDirectory(File) - Method in class com.nuix.enginebaseline.NuixEngine: For various reasons, this class needs to be able to resolve the location of a Nuix Engine distribution.
setEngineDistributionDirectoryFromEnvVar() - Method in class com.nuix.enginebaseline.NuixEngine: For various reasons, this class needs to be able to resolve the location of a Nuix Engine distribution.
setEngineDistributionDirectoryFromEnvVar(String) - Method in class com.nuix.enginebaseline.NuixEngine: For various reasons, this class needs to be able to resolve the location of a Nuix Engine distribution.
setEngineDistributionDirectorySupplier(Supplier<File>) - Method in class com.nuix.enginebaseline.NuixEngine: For various reasons, this class needs to be able to resolve the location of a Nuix Engine distribution.
setErrorOutputConsumer(Consumer<String>) - Method in class com.nuix.enginebaseline.RubyScriptRunner: Sets the Consumer which will receive error output while script is running.
setLogDirectory(File) - Method in class com.nuix.enginebaseline.NuixEngine: When logging is initialized a directory is specified in which log files are to be written.
setLogDirectorySupplier(Supplier<File>) - Method in class com.nuix.enginebaseline.NuixEngine: When logging is initialized a directory is specified in which log files are to be written.
setMajor(int) - Method in class com.nuix.enginebaseline.NuixVersion: Sets the major portion of this version instance (X.0.0.0)
setMinor(int) - Method in class com.nuix.enginebaseline.NuixVersion: Sets the minor portion of this version instance (0.X.0.0)
setStandardOutputConsumer(Consumer<String>) - Method in class com.nuix.enginebaseline.RubyScriptRunner: Sets the Consumer which will receive standard output while script is running.
setUserDataDirectory(File) - Method in class com.nuix.enginebaseline.NuixEngine: The Nuix Engine will need to be capable of resolving various artifacts such as metadata profiles, processing profiles, export profiles, word lists, etc.
setUserDataDirectorySupplier(Supplier<File>) - Method in class com.nuix.enginebaseline.NuixEngine: The Nuix Engine will need to be capable of resolving various artifacts such as metadata profiles, processing profiles, export profiles, word lists, etc.
shutdownHook - Variable in class com.nuix.enginebaseline.NuixEngine
standardOutput - Variable in class com.nuix.enginebaseline.RubyScriptRunner
summarizeLicense(AvailableLicence) - Static method in class com.nuix.enginebaseline.NuixLicenseFeaturesLogger: Generates a String summarizing the details of the provided AvailableLicence.
summarizeLicense(Licence) - Static method in class com.nuix.enginebaseline.NuixLicenseFeaturesLogger: Generates a String summarizing the details of the provided License.

T

targetShortName - Variable in class com.nuix.enginebaseline.NuixLicenseResolver
ThrowCapableConsumer<T> - Interface in com.nuix.enginebaseline: An interface similar to Consumer, but allows for throwing checked exceptions.
toString() - Method in class com.nuix.enginebaseline.NuixLicenseResolver
toString() - Method in class com.nuix.enginebaseline.NuixVersion: Converts this instance back to a version string from its components, such as: "7.8.0.10"

U

userDataDirectorySupplier - Variable in class com.nuix.enginebaseline.NuixEngine
usingAnyAvailableLicense() - Static method in class com.nuix.enginebaseline.NuixEngine: Create a new instance which will attempt to retrieve its license from anywhere it can.
usingFirstAvailableLicense(LicenseResolver...) - Static method in class com.nuix.enginebaseline.NuixEngine: Creates a new instance which will attempt to retrieve its license from one of the provided LicenseResolver instances in the order specified.
usingFirstAvailableLicense(List<LicenseResolver>) - Static method in class com.nuix.enginebaseline.NuixEngine: Creates a new instance which will attempt to retrieve its license from one of the provided LicenseResolver instances in the order specified.
utilities - Variable in class com.nuix.enginebaseline.NuixEngine

V

valueOf(String) - Static method in enum com.nuix.enginebaseline.NuixLicenseResolver.LicenseResolutionSource: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.nuix.enginebaseline.NuixLicenseResolver.LicenseResolutionSource: Returns an array containing the constants of this enum type, in the order they are declared.

W

whenScriptCompletes(BiConsumer<Object, BiVariableMap>) - Method in class com.nuix.enginebaseline.RubyScriptRunner: Allows you to provide a callback to be invoked when script finishes.
withCertificateTrustCallback(CertificateTrustCallback) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Specifies a certificate trust callback.
withFinalDecisionMadeBy(Function<Stream<AvailableLicence>, Optional<AvailableLicence>>) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Allows you to provide a function which makes the final decision as to which available license to obtain.
withLicenseCredentials(String, String) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Allows you to specify the specific username and password to use for license authentication (CLS/NMS)
withLicenseCredentialsProvider(CredentialsCallback) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Allows you to provider a license credentials callback used for license authentication (CLS/NMS).
withLicenseCredentialsResolvedFromEnvVars() - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Specifies that license authentication credentials will be obtained from environment variables.
withLicenseCredentialsResolvedFromEnvVars(String, String) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Allows you to specify Environment variables to resolve the license authentication username and password from.
withMaxWorkerCount(int) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Specifies a maximum worker count a license can have to be acceptable.
withMinWorkerCount(int) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Specifies a minimum worker count a given license must have to be acceptable.
withRequiredFeatures(String...) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Specifies a list of one or more features that a license must have to be acceptable.
withRequiredFeatures(Collection<String>) - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Specifies a list of one or more features that a license must have to be acceptable.
withTrustAllCertificates() - Method in class com.nuix.enginebaseline.NuixLicenseResolver: Specifies a certificate trust callback that blindly accepts all certificates.

A B C D E F G I J L M N P R S T U V W
All Classes All Packages