Package com.senzing.sdk.core

Class SzCoreEnvironment

java.lang.Object

com.senzing.sdk.core.SzCoreEnvironment

All Implemented Interfaces:

SzEnvironment

public final class SzCoreEnvironment
extends Object
implements SzEnvironment

Provides the core implementation of SzEnvironment that directly initializes the Senzing SDK modules and provides management of the Senzing environment in this process. .

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SzCoreEnvironment.Builder	The builder class for creating an instance of SzCoreEnvironment.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_INSTANCE_NAME	The default instance name to use for the Senzing initialization.
static final String	DEFAULT_SETTINGS	The default "bootstrap" settings with which to initialize the SzCoreEnvironment when an explicit settings value has not been provided via SzCoreEnvironment.Builder.settings(String).

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys this SzEnvironment and invalidates any SDK singleton references that has previously provided.
long	getActiveConfigId()	Gets the currently active configuration ID for the SzEnvironment.
static SzCoreEnvironment	getActiveInstance()	Gets the current active instance of SzCoreEnvironment.
SzConfigManager	getConfigManager()	Provides a reference to the SzConfigManager instance associated with this SzEnvironment.
SzDiagnostic	getDiagnostic()	Provides a reference to the SzDiagnostic instance associated with this SzEnvironment.
SzEngine	getEngine()	Provides a reference to the SzEngine instance associated with this SzEnvironment.
SzProduct	getProduct()	Provides a reference to the SzProduct instance associated with this SzEnvironment.
boolean	isDestroyed()	Checks if this instance has had its SzEnvironment.destroy() method called.
static SzCoreEnvironment.Builder	newBuilder()	Creates a new instance of SzCoreEnvironment.Builder for setting up an instance of SzCoreEnvironment.
void	reinitialize(long configId)	Reinitializes the SzEnvironment with the specified configuration ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_INSTANCE_NAME

public static final String DEFAULT_INSTANCE_NAME

The default instance name to use for the Senzing initialization. The value is ""Senzing Instance". An explicit value can be provided via SzCoreEnvironment.Builder.instanceName(String) during initialization.

See Also:

• SzCoreEnvironment.Builder.instanceName(String)
• Constant Field Values

DEFAULT_SETTINGS

public static final String DEFAULT_SETTINGS

The default "bootstrap" settings with which to initialize the SzCoreEnvironment when an explicit settings value has not been provided via SzCoreEnvironment.Builder.settings(String). If this is used it will initialize Senzing when installed in its default path and provide full access access to only the SzProduct interface as well as limited access to the SzConfigManager interface (i.e.: for functionality not dealing with registered configuration ID's). The value of this constant is "{ }".

NOTE: Using these settings is only useful for accessing the the full functionality of the SzProduct interface and limited functionality of the SzConfigManager interface since SzEngine and SzDiagnostic require database access to connect to the Senzing repository. Further, some SzConfigManager functionality (particularly any functionality that works with registered configurations that have configuration ID's) also requires database access to connect to the Senzing repository.

The value of this constant is "{ }".

See Also:

• SzCoreEnvironment.Builder.settings(String)
• Constant Field Values

Method Details

newBuilder

public static SzCoreEnvironment.Builder newBuilder()

Creates a new instance of SzCoreEnvironment.Builder for setting up an instance of SzCoreEnvironment. Keep in mind that while multiple SzCoreEnvironment.Builder instances can exists, only one active instance of SzCoreEnvironment can exist at time. An active instance is one that has not yet been destroyed.

Returns:

The SzCoreEnvironment.Builder for configuring and initializing the SzCoreEnvironment.

getActiveInstance

public static SzCoreEnvironment getActiveInstance()

Gets the current active instance of SzCoreEnvironment. An active instance is is one that has been constructed and has not yet been destroyed. There can be at most one active instance. If no active instance exists then null is returned.

Returns:

The current active instance of SzCoreEnvironment, or null if there is no active instance.

getConfigManager

public SzConfigManager getConfigManager()
                                 throws IllegalStateException,
SzException

Description copied from interface: SzEnvironment

Provides a reference to the SzConfigManager instance associated with this SzEnvironment.

Usage:

// How to obtain an SzConfigManager instance
try {
    // obtain the SzEnvironment (varies by application)
    SzEnvironment env = getEnvironment();

    // get the config manager
    SzConfigManager configMgr = env.getConfigManager();

    ...

} catch (SzException e) {
    // handle or rethrow the exception
    logError("Failed to get SzConfigManager.", e);
}

Specified by:

getConfigManager in interface SzEnvironment

Returns:

The SzConfigManager instance associated with this SzEnvironment.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

SzException - If there was a failure in obtaining or initializing the SzConfigManager instance.

getDiagnostic

public SzDiagnostic getDiagnostic()
                           throws IllegalStateException,
SzException

Description copied from interface: SzEnvironment

Provides a reference to the SzDiagnostic instance associated with this SzEnvironment.

Usage:

// How to obtain an SzDiagnostic instance
try {
    // obtain the SzEnvironment (varies by application)
    SzEnvironment env = getEnvironment();

    SzDiagnostic diagnostic = env.getDiagnostic();

    ...

} catch (SzException e) {
    // handle or rethrow the exception
    logError("Failed to get SzDiagnostic.", e);
}

Specified by:

getDiagnostic in interface SzEnvironment

Returns:

The SzDiagnostic instance associated with this SzEnvironment.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

SzException - If there was a failure in obtaining or initializing the SzDiagnostic instance.

getEngine

public SzEngine getEngine()
                   throws IllegalStateException,
SzException

Description copied from interface: SzEnvironment

Provides a reference to the SzEngine instance associated with this SzEnvironment.

Usage:

// How to obtain an SzEngine instance
try {
    // obtain the SzEnvironment (varies by application)
    SzEnvironment env = getEnvironment();

    SzEngine engine = env.getEngine();

    ...

} catch (SzException e) {
    // handle or rethrow the exception
    logError("Failed to get SzEngine.", e);
}

Specified by:

getEngine in interface SzEnvironment

Returns:

The SzEngine instance associated with this SzEnvironment.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

SzException - If there was a failure in obtaining or initializing the SzEngine instance.

getProduct

public SzProduct getProduct()
                     throws IllegalStateException,
SzException

Description copied from interface: SzEnvironment

Provides a reference to the SzProduct instance associated with this SzEnvironment.

Usage:

// How to obtain an SzProduct instance
try {
    // obtain the SzEnvironment (varies by application)
    SzEnvironment env = getEnvironment();

    SzProduct product = env.getProduct();

    ...

} catch (SzException e) {
    // handle or rethrow the exception
    logError("Failed to get SzProduct.", e);
}

Specified by:

getProduct in interface SzEnvironment

Returns:

The SzProduct instance associated with this SzEnvironment.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

SzException - If there was a failure in obtaining or initializing the SzProduct instance.

destroy

public void destroy()

Description copied from interface: SzEnvironment

Destroys this SzEnvironment and invalidates any SDK singleton references that has previously provided. If this instance has already been destroyed then this method has no effect.

Usage:

// obtain the SzEnvironment (varies by application)
SzEnvironment env = getEnvironment();

if (!env.isDestroyed()) {
    // destroy the environment
    env.destroy();
}

Specified by:

destroy in interface SzEnvironment

isDestroyed

public boolean isDestroyed()

Description copied from interface: SzEnvironment

Checks if this instance has had its SzEnvironment.destroy() method called.

Usage:

// obtain the SzEnvironment (varies by application)
SzEnvironment env = getEnvironment();

if (!env.isDestroyed()) {
    // destroy the environment
    env.destroy();
}

Specified by:

isDestroyed in interface SzEnvironment

Returns:

true if this instance has had its SzEnvironment.destroy() method called, otherwise false.

getActiveConfigId

public long getActiveConfigId()
                       throws IllegalStateException,
SzException

Description copied from interface: SzEnvironment

Gets the currently active configuration ID for the SzEnvironment.

Usage:

// How to get the active config ID for the SzEnvironment
try {
    // obtain the SzEnvironment (varies by application)
    SzEnvironment env = getEnvironment();

    // get the active config ID
    long activeConfigId = env.getActiveConfigId();

    // do something with the active config ID (varies by application)
    SzConfigManager configMgr = env.getConfigManager();

    long defaultConfigId = configMgr.getDefaultConfigId();

    if (activeConfigId != defaultConfigId) {
        // reinitialize the environment with the default config ID
        env.reinitialize(defaultConfigId);
    }

} catch (SzException e) {
    // handle or rethrow the exception
    logError("Failed to verify the active config ID.", e);
}

Specified by:

getActiveConfigId in interface SzEnvironment

Returns:

The currently active configuration ID.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

SzException - If there was a failure in obtaining the active config ID.

reinitialize

public void reinitialize(long configId)
                  throws IllegalStateException,
SzException

Description copied from interface: SzEnvironment

Reinitializes the SzEnvironment with the specified configuration ID.

Usage:

// How to get the active config ID for the SzEnvironment
try {
    // obtain the SzEnvironment (varies by application)
    SzEnvironment env = getEnvironment();

    // get the active config ID
    long activeConfigId = env.getActiveConfigId();

    // do something with the active config ID (varies by application)
    SzConfigManager configMgr = env.getConfigManager();

    long defaultConfigId = configMgr.getDefaultConfigId();

    if (activeConfigId != defaultConfigId) {
        // reinitialize the environment with the default config ID
        env.reinitialize(defaultConfigId);
    }

} catch (SzException e) {
    // handle or rethrow the exception
    logError("Failed to verify the active config ID.", e);
}

Specified by:

reinitialize in interface SzEnvironment

Parameters:

configId - The configuration ID with which to initialize.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

SzException - If there was a failure reinitializing.