Uses of Class
com.senzing.sdk.SzException

Packages that use SzException

Package	Description
com.senzing.sdk	This package provides the interfaces, utility classes, enumerations, constants and exception types pertaining to the Senzing SDK for Java.
com.senzing.sdk.core	This package provides the "core" implementation of the Senzing SDK for Java defined in the com.senzing.sdk package.

Uses of SzException in com.senzing.sdk

Subclasses of SzException in com.senzing.sdk

Modifier and Type	Class	Description
class	SzBadInputException	Defines an exceptional condition when an invalid input value is provided to a Senzing operation preventing the successful completion of that operation.
class	SzConfigurationException	Defines an exceptional condition when a failure has occurred pertaining to the Senzing configuration.
class	SzDatabaseConnectionLostException	Extends SzRetryableException to define an exceptional condition where a database connection was lost causing a Senzing operation to fail.
class	SzDatabaseException	Extends SzUnrecoverableException to define an exceptional condition triggered by a database error from which we cannot recover (e.g.: missing or unexpected schema definition).
class	SzDatabaseTransientException	Extends SzRetryableException to define an exceptional condition where an operation failed because a database condition that is transient and would like be resolved on a repeated attempt.
class	SzLicenseException	Extends SzUnrecoverableException to define an exceptional condition triggered by an invalid, expired or exhausted Senzing license.
class	SzNotFoundException	Extends SzBadInputException to define an exceptional condition where the provided bad input to a Senzing operation is an identifier that could not be used to successfully locate required data for that operation.
class	SzNotInitializedException	Extends SzUnrecoverableException to define an exceptional condition triggered by Senzing not being initialized.
class	SzReplaceConflictException	Describes an exceptional condition when an attempt is made to replace a Senzing value with a new value providing it has not not already been changed, however, the current value is no longer the expected value and has therefore already been changed.
class	SzRetryableException	Defines an exceptional condition where the failure is an intermittent condition and the operation may be retried with the same parameters with an expectation of success.
class	SzRetryTimeoutExceededException	Extends SzRetryableException to define an exceptional condition where an operation failed because a timeout was exceeded.
class	SzUnhandledException	Extends SzUnrecoverableException to define an exceptional condition caused by an otherwise unhandled and unexpected failure in the Senzing SDK.
class	SzUnknownDataSourceException	Extends SzBadInputException to define an exceptional condition where a specified data source code is not configured in the current active configuration and therefore the data source could not be found.
class	SzUnrecoverableException	Defines an exceptional condition where the failure is not recoverable and all operations should be stopped until the system can be modified to resolve the condition causing the failure.

Methods in com.senzing.sdk that throw SzException

Modifier and Type	Method	Description
String	SzConfig.addDataSource(String dataSourceCode)	Adds a new data source that is identified by the specified data source code to this configuration.
default String	SzEngine.addRecord(SzRecordKey recordKey, String recordDefinition)	Convenience method for calling SzEngine.addRecord(SzRecordKey, String, Set) using SzFlag.SZ_ADD_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.addRecord(SzRecordKey recordKey, String recordDefinition, Set<SzFlag> flags)	Loads the record described by the specified String record definition having the specified data source code and record ID using the specified Set of SzFlag values.
String	SzDiagnostic.checkDatastorePerformance(int secondsToRun)	Runs non-destruction DB performance tests and returns detail of the result as a JSON String.
void	SzEngine.closeExport(long exportHandle)	This function closes an export handle of a previously opened export to clean up system resources.
long	SzEngine.countRedoRecords()	Gets the number of redo records pending to be processed.
SzConfig	SzConfigManager.createConfig()	Creates a new SzConfig instance using the default configuration template and returns the SzConfig representing that configuration.
SzConfig	SzConfigManager.createConfig(long configId)	Gets the configuration definition that is registered with the specified config ID and returns a new SzConfig instance representing that configuration.
SzConfig	SzConfigManager.createConfig(String configDefinition)	Creates a new SzConfig instance using the specified configuration definition and returns the SzConfig representing that configuration.
void	SzConfig.deleteDataSource(String dataSourceCode)	Deletes the data source identified by the specified data source code from this configuration.
default String	SzEngine.deleteRecord(SzRecordKey recordKey)	Convenience method for calling SzEngine.deleteRecord(SzRecordKey, Set) using SzFlag.SZ_DELETE_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.deleteRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Delete a previously loaded record identified by the data source code and record ID from the specified SzRecordKey.
String	SzConfig.export()	Obtains the configuration definition (typically formatted as JSON) for this configuration.
default long	SzEngine.exportCsvEntityReport(String csvColumnList)	Convenience method for calling SzEngine.exportCsvEntityReport(String, Set) using SzFlag.SZ_EXPORT_DEFAULT_FLAGS as the value for the flags parameter.
long	SzEngine.exportCsvEntityReport(String csvColumnList, Set<SzFlag> flags)	Initiates an export of entity data in CSV format and returns an "export handle" that can be used to read the export data and must be closed when complete.
default long	SzEngine.exportJsonEntityReport()	Convenience method for calling SzEngine.exportJsonEntityReport(Set) using SzFlag.SZ_EXPORT_DEFAULT_FLAGS as the value for the flags parameter.
long	SzEngine.exportJsonEntityReport(Set<SzFlag> flags)	Initiates an export of entity data as JSON-lines format and returns an "export handle" that can be used to read the export data and must be closed when complete.
String	SzEngine.fetchNext(long exportHandle)	Fetches the next line of entity data from the export identified by the specified export handle.
default String	SzEngine.findInterestingEntities(long entityId)	Convenience method for calling SzEngine.findInterestingEntities(long, Set) with SzFlag.SZ_FIND_INTERESTING_ENTITIES_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findInterestingEntities(long entityId, Set<SzFlag> flags)	An experimental method to obtain interesting entities pertaining to the entity identified by the specified entity ID using the specified Set of SzFlag instances.
default String	SzEngine.findInterestingEntities(SzRecordKey recordKey)	Convenience method for calling SzEngine.findInterestingEntities(SzRecordKey, Set) with SzFlag.SZ_FIND_INTERESTING_ENTITIES_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findInterestingEntities(SzRecordKey recordKey, Set<SzFlag> flags)	An experimental method to obtain interesting entities pertaining to the entity that contains a specific record that is identified by the data source code and record ID associated with the specified SzRecordKey using the specified Set of SzFlag instances.
default String	SzEngine.findNetwork(SzEntityIds entityIds, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities)	Convenience method for calling SzEngine.findNetwork(SzEntityIds, int, int, int, Set) with SzFlag.SZ_FIND_NETWORK_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findNetwork(SzEntityIds entityIds, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Finds a network of entity relationships surrounding the paths between a set of entities identified by one or more entity ID's specified in an instance of SzEntityIds -- which is a Set of non-null Long entity ID's.
default String	SzEngine.findNetwork(SzRecordKeys recordKeys, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities)	Convenience method for calling SzEngine.findNetwork(SzRecordKeys, int, int, int, Set) with SzFlag.SZ_FIND_NETWORK_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findNetwork(SzRecordKeys recordKeys, int maxDegrees, int buildOutDegrees, int buildOutMaxEntities, Set<SzFlag> flags)	Finds a network of entity relationships surrounding the paths between a set of entities having the constituent records identified by the data source code and record ID pairs contained in the specified instance of SzRecordKeys -- which is a Set of one or more non-null SzRecordKey instances.
default String	SzEngine.findPath(long startEntityId, long endEntityId, int maxDegrees)	Convenience method for calling SzEngine.findPath(long, long, int, SzEntityIds, Set, Set) using null as the value for both the "avoid entity ID's" and the "required data sources" parameters and SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.findPath(long startEntityId, long endEntityId, int maxDegrees, SzEntityIds avoidEntityIds, Set<String> requiredDataSources)	Convenience method for calling SzEngine.findPath(long, long, int, SzEntityIds, Set, Set) using SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findPath(long startEntityId, long endEntityId, int maxDegrees, SzEntityIds avoidEntityIds, Set<String> requiredDataSources, Set<SzFlag> flags)	Finds a relationship path between two entities identified by their entity ID's.
default String	SzEngine.findPath(long startEntityId, long endEntityId, int maxDegrees, Set<SzFlag> flags)	Convenience method for calling SzEngine.findPath(long, long, int, SzEntityIds, Set, Set) using null as the value for both the "avoid entity ID's" and the "required data sources" parameters.
default String	SzEngine.findPath(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees)	Convenience method for calling SzEngine.findPath(SzRecordKey, SzRecordKey, int, SzRecordKeys, Set, Set) using null as the value for both the "avoid record keys" and the "required data sources" parameters and SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.findPath(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, SzRecordKeys avoidRecordKeys, Set<String> requiredDataSources)	Convenience method for calling SzEngine.findPath(SzRecordKey, SzRecordKey, int, SzRecordKeys, Set, Set) using SzFlag.SZ_FIND_PATH_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.findPath(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, SzRecordKeys avoidRecordKeys, Set<String> requiredDataSources, Set<SzFlag> flags)	Finds a relationship path between two entities identified by the data source codes and record ID's of their constituent records given by the specified start and end SzRecordKey instances.
default String	SzEngine.findPath(SzRecordKey startRecordKey, SzRecordKey endRecordKey, int maxDegrees, Set<SzFlag> flags)	Convenience method for calling SzEngine.findPath(SzRecordKey, SzRecordKey, int, SzRecordKeys, Set, Set) using null as the value for both the "avoid record keys" and the "required data sources" parameters.
long	SzEnvironment.getActiveConfigId()	Gets the currently active configuration ID for the SzEnvironment.
SzConfigManager	SzEnvironment.getConfigManager()	Provides a reference to the SzConfigManager instance associated with this SzEnvironment.
String	SzConfigManager.getConfigs()	Gets the list of saved configuration ID's with their comments and timestamps and return the JSON String describing them.
String	SzConfig.getDataSources()	Extracts the data sources from this configuration and returns the JSON text describing the data sources from the configuration.
String	SzDiagnostic.getDatastoreInfo()	Gathers detailed information on the data store and returns it as a JSON String.
long	SzConfigManager.getDefaultConfigId()	Gets the configuration ID of the default configuration for the repository and returns it.
SzDiagnostic	SzEnvironment.getDiagnostic()	Provides a reference to the SzDiagnostic instance associated with this SzEnvironment.
SzEngine	SzEnvironment.getEngine()	Provides a reference to the SzEngine instance associated with this SzEnvironment.
default String	SzEngine.getEntity(long entityId)	Convenience method for calling SzEngine.getEntity(long,Set) using SzFlag.SZ_ENTITY_DEFAULT_FLAGS as the value for theflags parameter.
String	SzEngine.getEntity(long entityId, Set<SzFlag> flags)	This method is used to retrieve information about a specific resolved entity.
default String	SzEngine.getEntity(SzRecordKey recordKey)	Convenience method for calling SzEngine.getEntity(SzRecordKey,Set) using SzFlag.SZ_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.getEntity(SzRecordKey recordKey, Set<SzFlag> flags)	This method is used to retrieve information about the resolved entity that contains a specific record that is identified by the data source code and record ID associated with the specified SzRecordKey.
String	SzDiagnostic.getFeature(long featureId)	Experimental/internal method for obtaining diagnostic feature definition for the specified feature identifier.
String	SzProduct.getLicense()	Returns the currently configured license details.
SzProduct	SzEnvironment.getProduct()	Provides a reference to the SzProduct instance associated with this SzEnvironment.
default String	SzEngine.getRecord(SzRecordKey recordKey)	Convenience method for calling SzEngine.getRecord(SzRecordKey, Set) using SzFlag.SZ_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.getRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Retrieves the record identified by the data source code and record ID from the specified SzRecordKey.
String	SzEngine.getRedoRecord()	Retrieves a pending redo record from the reevaluation queue.
String	SzEngine.getStats()	Returns the current internal engine workload statistics for the process.
String	SzProduct.getVersion()	Returns the currently installed version details.
default String	SzEngine.getVirtualEntity(Set<SzRecordKey> recordKeys)	Convenience method for calling SzEngine.getVirtualEntity(Set, Set) using SzFlag.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.getVirtualEntity(Set<SzRecordKey> recordKeys, Set<SzFlag> flags)	Describes a hypothetically entity that would be composed of the one or more records identified by the data source code and record ID pairs in the specified Set of SzRecordKey instances.
default String	SzEngine.howEntity(long entityId)	Convenience method for calling SzEngine.howEntity(long, Set) using SzFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.howEntity(long entityId, Set<SzFlag> flags)	Determines how an entity identified by the specified entity ID was constructed from its constituent records.
default String	SzEngine.preprocessRecord(String recordDefinition)	Convenience method for calling SzEngine.preprocessRecord(String, Set) using SzFlag.SZ_PREPROCESS_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.preprocessRecord(String recordDefinition, Set<SzFlag> flags)	Performs a hypothetical load of a the record described by the specified String record definition using the specified Set of SzFlag values.
void	SzEngine.primeEngine()	May optionally be called to pre-initialize some of the heavier weight internal resources of the SzEngine.
default String	SzEngine.processRedoRecord(String redoRecord)	Convenience method for calling SzEngine.processRedoRecord(String, Set) using SzFlag.SZ_REDO_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.processRedoRecord(String redoRecord, Set<SzFlag> flags)	Processes the specified redo record using the specified flags.
void	SzDiagnostic.purgeRepository()	Purges all data in the configured repository.
default String	SzEngine.reevaluateEntity(long entityId)	Convenience method for calling SzEngine.reevaluateEntity(long, Set) using SzFlag.SZ_REEVALUATE_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.reevaluateEntity(long entityId, Set<SzFlag> flags)	Reevaluate a resolved entity identified by the specified entity ID.
default String	SzEngine.reevaluateRecord(SzRecordKey recordKey)	Convenience method for calling SzEngine.reevaluateRecord(SzRecordKey, Set) using SzFlag.SZ_REEVALUATE_RECORD_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.reevaluateRecord(SzRecordKey recordKey, Set<SzFlag> flags)	Reevaluate the record identified by the data source code and record ID from the specified SzRecordKey.
long	SzConfigManager.registerConfig(String configDefinition)	Registers the configuration described by the specified JSON in the repository with an auto-generated comment and returns the identifier for referencing the the config in the entity repository.
long	SzConfigManager.registerConfig(String configDefinition, String configComment)	Registers the configuration described by the specified configuration definition in the repository with the specified comment and returns the identifier for referencing the the config in the entity repository.
void	SzEnvironment.reinitialize(long configId)	Reinitializes the SzEnvironment with the specified configuration ID.
void	SzConfigManager.replaceDefaultConfigId(long currentDefaultConfigId, long newDefaultConfigId)	Replaces the current configuration ID of the repository with the specified new configuration ID providing the current configuration ID of the repository is equal to the specified old configuration ID.
default String	SzEngine.searchByAttributes(String attributes)	Convenience method for calling SzEngine.searchByAttributes(String, String, Set) with a null value for the search profile parameter and SzFlag.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.searchByAttributes(String attributes, String searchProfile)	Convenience method for calling SzEngine.searchByAttributes(String, String, Set) using SzFlag.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.searchByAttributes(String attributes, String searchProfile, Set<SzFlag> flags)	This method searches for entities that match or relate to the provided search attributes using the optionally specified search profile.
default String	SzEngine.searchByAttributes(String attributes, Set<SzFlag> flags)	Convenience method for calling SzEngine.searchByAttributes(String, String, Set) with a null value for the search profile parameter.
long	SzConfigManager.setDefaultConfig(String configDefinition)	Registers the specified config definition with an auto-generated comment and then sets the default configuration ID for the repository to the configuration ID that is the result of that registration.
long	SzConfigManager.setDefaultConfig(String configDefinition, String configComment)	Registers the specified config definition with the specified comment and then sets the default configuration ID for the repository to the configuration ID that is the result of that registration, returning the config ID under which the configuration was registered.
void	SzConfigManager.setDefaultConfigId(long configId)	Sets the default configuration for the repository to the specified configuration ID.
default String	SzEngine.whyEntities(long entityId1, long entityId2)	Convenience method for calling SzEngine.whyEntities(long, long, Set) with SzFlag.SZ_WHY_ENTITIES_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.whyEntities(long entityId1, long entityId2, Set<SzFlag> flags)	Determines the ways in which two entities identified by the specified entity ID's are related to each other.
default String	SzEngine.whyRecordInEntity(SzRecordKey recordKey)	Convenience method for calling SzEngine.whyRecordInEntity(SzRecordKey, Set) with SzFlag.SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.whyRecordInEntity(SzRecordKey recordKey, Set<SzFlag> flags)	Determines why the record identified by the data source code and record ID in the specified in an SzRecordKey is included in its respective entity.
default String	SzEngine.whyRecords(SzRecordKey recordKey1, SzRecordKey recordKey2)	Convenience method for calling SzEngine.whyRecords(SzRecordKey, SzRecordKey, Set) with SzFlag.SZ_WHY_RECORDS_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.whyRecords(SzRecordKey recordKey1, SzRecordKey recordKey2, Set<SzFlag> flags)	Determines ways in which two records identified by the data source code and record ID pairs from the specified SzRecordKey instances are related to each other.
default String	SzEngine.whySearch(String attributes, long entityId)	Convenience method for calling SzEngine.whySearch(String, long, String, Set) with a null value for the search profile parameter and SzFlag.SZ_WHY_SEARCH_DEFAULT_FLAGS as the value for the flags parameter.
default String	SzEngine.whySearch(String attributes, long entityId, String searchProfile)	Convenience method for calling SzEngine.whySearch(String, long, String, Set) using SzFlag.SZ_WHY_SEARCH_DEFAULT_FLAGS as the value for the flags parameter.
String	SzEngine.whySearch(String attributes, long entityId, String searchProfile, Set<SzFlag> flags)	Compares the specified search attribute criteria against the entity identified by the specified entity ID to determine why that entity was or was not included in the results of a "search by attributes" operation.
default String	SzEngine.whySearch(String attributes, long entityId, Set<SzFlag> flags)	Convenience method for calling SzEngine.whySearch(String, long, String, Set) with a null value for the search profile parameter.

Uses of SzException in com.senzing.sdk.core

Methods in com.senzing.sdk.core that throw SzException

Modifier and Type	Method	Description
long	SzCoreEnvironment.getActiveConfigId()
SzConfigManager	SzCoreEnvironment.getConfigManager()
SzDiagnostic	SzCoreEnvironment.getDiagnostic()
SzEngine	SzCoreEnvironment.getEngine()
SzProduct	SzCoreEnvironment.getProduct()
void	SzCoreEnvironment.reinitialize(long configId)