Package com.senzing.sdk

Interface SzEnvironment

All Known Implementing Classes:

SzCoreEnvironment

public interface SzEnvironment

Provides a factory interface for obtaining the references to the Senzing SDK singleton instances that have been initialized.

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.
SzConfig	getConfig()	Provides a reference to the SzConfig instance associated with this SzEnvironment.
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 destroy() method called.
void	reinitialize(long configId)	Reinitializes the SzEnvironment with the specified configuration ID.

Method Details

getProduct

SzProduct getProduct()
              throws IllegalStateException,
SzException

Provides a reference to the SzProduct instance associated with this 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.

getConfig

SzConfig getConfig()
            throws IllegalStateException,
SzException

Provides a reference to the SzConfig instance associated with this 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 SzConfig instance.

getEngine

SzEngine getEngine()
            throws IllegalStateException,
SzException

Provides a reference to the SzEngine instance associated with this 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.

getConfigManager

SzConfigManager getConfigManager()
                          throws IllegalStateException,
SzException

Provides a reference to the SzConfigManager instance associated with this 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

SzDiagnostic getDiagnostic()
                    throws IllegalStateException,
SzException

Provides a reference to the SzDiagnostic instance associated with this 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.

getActiveConfigId

long getActiveConfigId()
                throws IllegalStateException,
SzException

Gets the currently active configuration ID for the SzEnvironment.

Returns:

The currently active configuration ID.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

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

reinitialize

void reinitialize(long configId)
           throws IllegalStateException,
SzException

Reinitializes the SzEnvironment with the specified configuration ID.

Parameters:

configId - The configuraiton ID with which to initialize.

Throws:

IllegalStateException - If this SzEnvironment instance has been destroyed.

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

destroy

void destroy()

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.

isDestroyed

boolean isDestroyed()

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

Returns:

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