Package com.senzing.g2.engine.internal
Class G2AuditJNI
- java.lang.Object
-
- com.senzing.g2.engine.internal.G2AuditJNI
-
- All Implemented Interfaces:
G2Fallible
,G2Audit
@Deprecated(since="2.9.0", forRemoval=true) public class G2AuditJNI extends Object implements G2Audit
Deprecated, for removal: This API element is subject to removal in a future version.Implements theG2Audit
interface to call the native function
-
-
Constructor Summary
Constructors Constructor Description G2AuditJNI()
Deprecated, for removal: This API element is subject to removal in a future version.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
cancelSession(long session)
Deprecated, for removal: This API element is subject to removal in a future version.Cancels an audit session and closes it even if it is in the middle of an operation (especiallyG2Audit.getSummaryData(long,StringBuffer)
.void
clearLastException()
Deprecated, for removal: This API element is subject to removal in a future version.Clears the information about the last error the system received.void
closeReport(long reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.This function closes the report handle that was previously obtained fromG2Audit.openSession()
and subsequently releases the associated system resources.int
closeReportV2(long reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.This function closes the report handle that was previously obtained fromG2Audit.openSession()
and subsequently releases the associated system resources.void
closeSession(long session)
Deprecated, for removal: This API element is subject to removal in a future version.Closes an audit session that was previously opened withG2Audit.openSession()
.int
destroy()
Deprecated, for removal: This API element is subject to removal in a future version.Uninitializes the G2 audit API.String
fetchNext(long reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.This function is used to fetch the next audit group from an audit report using the specified audit report handle.int
fetchNextV2(long reportHandle, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.This function is used to fetch the next audit group from an audit report using the specified audit report handle.long
getAuditReport(long session, String fromDataSource, String toDataSource, int matchLevel)
Deprecated, for removal: This API element is subject to removal in a future version.Uses the specified session handle obtained fromG2Audit.openSession()
to create an audit report for the entities connected at the specified match level having the specified data sources.int
getAuditReportV2(long session, String fromDataSource, String toDataSource, int matchLevel, Result<Long> reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.Uses the specified session handle obtained fromG2Audit.openSession()
to create an audit report for the entities connected at the specified match level having the specified data sources.String
getLastException()
Deprecated, for removal: This API element is subject to removal in a future version.Returns a string about the last error the system received.int
getLastExceptionCode()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the exception code of the last error the system received.int
getSummaryData(long session, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Obtains an audit summary using the specified session handle previously obtained fromG2Audit.openSession()
.int
getSummaryDataDirect(StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Obtains an audit summary without incurring the cost of generating an audit session first.int
getUsedMatchKeys(long session, String fromDataSource, String toDataSource, int type, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Using the specified audit session handle, obtains the match keys that are used for entities connected by the two specified data sources for the given match level.int
getUsedPrinciples(long session, String fromDataSource, String toDataSource, int type, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Using the specified audit session handle, obtains the principles that are used for entities connected by the two specified data sources for the given match level.int
initV2(String moduleName, String iniParams, boolean verboseLogging)
Deprecated, for removal: This API element is subject to removal in a future version.Initializes the G2 Audit API with the specified module name, init parameters and flag indicating verbose logging.int
initWithConfigIDV2(String moduleName, String iniParams, long initConfigID, boolean verboseLogging)
Deprecated, for removal: This API element is subject to removal in a future version.Initializes the G2 Audit API with the module name, initialization parameters, verbose logging flag and a specific configuration ID identifying the configuration to use.long
openSession()
Deprecated, for removal: This API element is subject to removal in a future version.Opens a new audit session and returns the session handle.int
reinitV2(long initConfigID)
Deprecated, for removal: This API element is subject to removal in a future version.Reinitializes with the specified configuration ID.
-
-
-
Method Detail
-
initV2
public int initV2(String moduleName, String iniParams, boolean verboseLogging)
Deprecated, for removal: This API element is subject to removal in a future version.Initializes the G2 Audit API with the specified module name, init parameters and flag indicating verbose logging. If theG2CONFIGFILE
init parameter is absent then the default configuration from the repository is used.- Specified by:
initV2
in interfaceG2Audit
- Parameters:
moduleName
- A short name given to this audit API instanceiniParams
- A JSON string containing configuration parametersverboseLogging
- Enable diagnostic logging which will print a massive amount of information to stdout- Returns:
- Zero (0) on success, non-zero on failure.
-
initWithConfigIDV2
public int initWithConfigIDV2(String moduleName, String iniParams, long initConfigID, boolean verboseLogging)
Deprecated, for removal: This API element is subject to removal in a future version.Initializes the G2 Audit API with the module name, initialization parameters, verbose logging flag and a specific configuration ID identifying the configuration to use.- Specified by:
initWithConfigIDV2
in interfaceG2Audit
- Parameters:
moduleName
- The module name with which to initialize.iniParams
- The JSON initialization parameters.initConfigID
- The specific configuration ID to initialize with.verboseLogging
- Whether or not to initialize with verbose logging.- Returns:
- Zero (0) on success, non-zero on failure.
-
reinitV2
public int reinitV2(long initConfigID)
Deprecated, for removal: This API element is subject to removal in a future version.Reinitializes with the specified configuration ID.
-
destroy
public int destroy()
Deprecated, for removal: This API element is subject to removal in a future version.Uninitializes the G2 audit API.
-
openSession
public long openSession()
Deprecated, for removal: This API element is subject to removal in a future version.Opens a new audit session and returns the session handle. If a failure occurs then a negative number is returned.- Specified by:
openSession
in interfaceG2Audit
- Returns:
- The audit session handle or a negative number if a failure occurs.
-
cancelSession
public void cancelSession(long session)
Deprecated, for removal: This API element is subject to removal in a future version.Cancels an audit session and closes it even if it is in the middle of an operation (especiallyG2Audit.getSummaryData(long,StringBuffer)
.- Specified by:
cancelSession
in interfaceG2Audit
- Parameters:
session
- The session handle that was obtained fromG2Audit.openSession()
.
-
closeSession
public void closeSession(long session)
Deprecated, for removal: This API element is subject to removal in a future version.Closes an audit session that was previously opened withG2Audit.openSession()
.- Specified by:
closeSession
in interfaceG2Audit
- Parameters:
session
- The session handle that was obtained fromG2Audit.openSession()
.
-
getSummaryData
public int getSummaryData(long session, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Obtains an audit summary using the specified session handle previously obtained fromG2Audit.openSession()
. The audit summary is provided as a JSON document written to the specifiedStringBuffer
.{ "SUMMARY_AUDIT_INFO": { "RESOLVED_ENTITY_COUNT": 6, "OBSERVED_ENTITY_COUNT": 12, "RECORD_COUNT": 12, "AUDIT_INFO": [ { "FROM_DATA_SOURCE": "DATA_SOURCE_A", "TO_DATA_SOURCE": "DATA_SOURCE_B", "FROM_ENTITY_COUNT": 3, "TO_ENTITY_COUNT": 3, "FROM_SINGLE_COUNT": 0, "TO_SINGLE_COUNT": 0, "FROM_OBS_ENTITY_COUNT": 3, "TO_OBS_ENTITY_COUNT": 3, "FROM_RECORD_COUNT": 3, "TO_RECORD_COUNT": 3, "MATCHED_COUNT": 0, "MATCHED_ENTITY_COUNT": 0, "POSSIBLE_MATCH_COUNT": 3, "DISCOVERED_RELATIONSHIP_COUNT": 0, "DISCLOSED_RELATIONSHIP_COUNT": 0 }, . . . ] } }
- Specified by:
getSummaryData
in interfaceG2Audit
- Parameters:
session
- The session handle that was obtained fromG2Audit.openSession()
.response
- TheStringBuffer
to write the audit summary JSON to.- Returns:
- Zero (0) on success, non-zero on failure.
-
getSummaryDataDirect
public int getSummaryDataDirect(StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Obtains an audit summary without incurring the cost of generating an audit session first. This is a faster way of obtaining the audit summary than first opening an audit session. The audit summary is provided as a JSON document written to the specifiedStringBuffer
.{ "SUMMARY_AUDIT_INFO": { "RESOLVED_ENTITY_COUNT": 6, "OBSERVED_ENTITY_COUNT": 12, "RECORD_COUNT": 12, "AUDIT_INFO": [ { "FROM_DATA_SOURCE": "DATA_SOURCE_A", "TO_DATA_SOURCE": "DATA_SOURCE_B", "FROM_ENTITY_COUNT": 3, "TO_ENTITY_COUNT": 3, "FROM_SINGLE_COUNT": 0, "TO_SINGLE_COUNT": 0, "FROM_OBS_ENTITY_COUNT": 3, "TO_OBS_ENTITY_COUNT": 3, "FROM_RECORD_COUNT": 3, "TO_RECORD_COUNT": 3, "MATCHED_COUNT": 0, "MATCHED_ENTITY_COUNT": 0, "POSSIBLE_MATCH_COUNT": 3, "DISCOVERED_RELATIONSHIP_COUNT": 0, "DISCLOSED_RELATIONSHIP_COUNT": 0 }, . . . ] } }
- Specified by:
getSummaryDataDirect
in interfaceG2Audit
- Parameters:
response
- TheStringBuffer
to write the audit summary JSON to.- Returns:
- Zero (0) on success, non-zero on failure.
-
getUsedMatchKeys
public int getUsedMatchKeys(long session, String fromDataSource, String toDataSource, int type, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Using the specified audit session handle, obtains the match keys that are used for entities connected by the two specified data sources for the given match level. Match levels are as follows:- 1: Match
- 2: Possible Match
- 3: Possibly Related
The JSON response is formatted as follows:
{ "DISTINCT_MATCH_KEY_INFO": { "MATCH_KEY_INFO": [ { "MATCH_KEY": "+ADDRESS+SSN", "COUNT": 2 }, { "MATCH_KEY": "+SSN", "COUNT": 6 } ] } }
- Specified by:
getUsedMatchKeys
in interfaceG2Audit
- Parameters:
session
- The session handle that was obtained fromG2Audit.openSession()
.fromDataSource
- The "from" data source code.toDataSource
- The "to" data source code.type
- The match level.response
- TheStringBuffer
to write the JSON response to.- Returns:
- Zero (0) on success, non-zero on failure.
-
getUsedPrinciples
public int getUsedPrinciples(long session, String fromDataSource, String toDataSource, int type, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.Using the specified audit session handle, obtains the principles that are used for entities connected by the two specified data sources for the given match level. Match levels are as follows:- 1: Match
- 2: Possible Match
- 3: Possibly Related
The JSON response is formatted as follows:
{ "DISTINCT_PRINCIPLE_INFO": { "PRINCIPLE_INFO": [ { "PRINCIPLE": "DISCLOSED", "COUNT": 8 }, { "PRINCIPLE": "DISCLOSED", "COUNT": 2 }, { "PRINCIPLE": "SF1E", "COUNT": 4 } ] } }
- Specified by:
getUsedPrinciples
in interfaceG2Audit
- Parameters:
session
- The session handle that was obtained fromG2Audit.openSession()
.fromDataSource
- The "from" data source code.toDataSource
- The "to" data source code.type
- The match level.response
- TheStringBuffer
to write the JSON response to.- Returns:
- Zero (0) on success, non-zero on failure.
-
getAuditReport
public long getAuditReport(long session, String fromDataSource, String toDataSource, int matchLevel)
Deprecated, for removal: This API element is subject to removal in a future version.Uses the specified session handle obtained fromG2Audit.openSession()
to create an audit report for the entities connected at the specified match level having the specified data sources. A handle to the report is returned and the pages of the report can be obtained viaG2Audit.fetchNextV2(long, StringBuffer)
(orG2Audit.fetchNext(long)
). Match levels are as follows:- 1: Match
- 2: Possible Match
- 3: Possibly Related
- Specified by:
getAuditReport
in interfaceG2Audit
- Parameters:
session
- The session handle that was obtained fromG2Audit.openSession()
.fromDataSource
- The "from" data source code.toDataSource
- The "to" data source code.matchLevel
- The match level.- Returns:
- A positive report handle on success and a negative number on failure.
-
getAuditReportV2
public int getAuditReportV2(long session, String fromDataSource, String toDataSource, int matchLevel, Result<Long> reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.Uses the specified session handle obtained fromG2Audit.openSession()
to create an audit report for the entities connected at the specified match level having the specified data sources. A handle to the report is returned and the pages of the report can be obtained viaG2Audit.fetchNextV2(long, StringBuffer)
(orG2Audit.fetchNext(long)
).- Specified by:
getAuditReportV2
in interfaceG2Audit
- Parameters:
session
- The session handle that was obtained fromG2Audit.openSession()
.fromDataSource
- The "from" data source code.toDataSource
- The "to" data source code.matchLevel
- The match level.reportHandle
- TheResult
that will be set with the report handle value on success.- Returns:
- Zero (0) on success, non-zero on failure.
-
fetchNext
public String fetchNext(long reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.This function is used to fetch the next audit group from an audit report using the specified audit report handle. The JSON text for the next audit group is returned. The audit group JSON is formatted as follows:{ "AUDIT_PAGE": { "AUDIT_GROUPS": [ { "BASE_RECORD": [ { "ENTITY_ID": 1, "PRINCIPLE": "SF1_PNAME_CSTAB", "MATCH_KEY": "+NAME+SSN+SSN_LAST4", "RECORD_ID": "test-1-2", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_222", "MATCH_TYPE": 1, "REF_SCORE": 9, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] } ], "AUDIT_RECORD": [ { "ENTITY_ID": 1, "PRINCIPLE": "SF1_PNAME_CSTAB", "MATCH_KEY": "+NAME+SSN+SSN_LAST4", "RECORD_ID": "test-1-3", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_333", "MATCH_TYPE": 1, "REF_SCORE": 9, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] } ], "ECL_RECORD": [ { "ENTITY_ID": 1, "PRINCIPLE": "", "MATCH_KEY": "", "RECORD_ID": "test-1-1", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_111", "MATCH_TYPE": 0, "REF_SCORE": 0, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] }, { "ENTITY_ID": 1, "PRINCIPLE": "SF1_PNAME_CSTAB", "MATCH_KEY": "+NAME+SSN+SSN_LAST4", "RECORD_ID": "test-1-4", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_444", "MATCH_TYPE": 1, "REF_SCORE": 9, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] } ], "AUDIT_KEY": "1", "AUDIT_NAME": "Washington George", "AUDIT_TYPE": "MATCH", "FROM_DATA_SOURCE": "DSRC_TYPE_222", "TO_DATA_SOURCE": "DSRC_TYPE_333" } ], "FROM_DATA_SOURCE": "DSRC_TYPE_222", "TO_DATA_SOURCE": "DSRC_TYPE_333", "MATCH_LEVEL": 1, "FIRST_RECORD_INDEX": 654321 } }
-
fetchNextV2
public int fetchNextV2(long reportHandle, StringBuffer response)
Deprecated, for removal: This API element is subject to removal in a future version.This function is used to fetch the next audit group from an audit report using the specified audit report handle. The JSON text for the next audit group is written to the specifiedStringBuffer
. The audit group JSON is formatted as follows:{ "AUDIT_PAGE": { "AUDIT_GROUPS": [ { "BASE_RECORD": [ { "ENTITY_ID": 1, "PRINCIPLE": "SF1_PNAME_CSTAB", "MATCH_KEY": "+NAME+SSN+SSN_LAST4", "RECORD_ID": "test-1-2", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_222", "MATCH_TYPE": 1, "REF_SCORE": 9, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] } ], "AUDIT_RECORD": [ { "ENTITY_ID": 1, "PRINCIPLE": "SF1_PNAME_CSTAB", "MATCH_KEY": "+NAME+SSN+SSN_LAST4", "RECORD_ID": "test-1-3", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_333", "MATCH_TYPE": 1, "REF_SCORE": 9, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] } ], "ECL_RECORD": [ { "ENTITY_ID": 1, "PRINCIPLE": "", "MATCH_KEY": "", "RECORD_ID": "test-1-1", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_111", "MATCH_TYPE": 0, "REF_SCORE": 0, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] }, { "ENTITY_ID": 1, "PRINCIPLE": "SF1_PNAME_CSTAB", "MATCH_KEY": "+NAME+SSN+SSN_LAST4", "RECORD_ID": "test-1-4", "ENTITY_TYPE": "TEST", "DATA_SOURCE": "DSRC_TYPE_444", "MATCH_TYPE": 1, "REF_SCORE": 9, "NAME_DATA": [ "Washington George" ], "ATTRIBUTE_DATA": [], "IDENTIFIER_DATA": [ "SSN_LAST4: 2623", "SSN: 353-35-2623", "SSN: 434-85-3685" ], "ADDRESS_DATA": [], "PHONE_DATA": [], "RELATIONSHIP_DATA": [], "ENTITY_DATA": [], "OTHER_DATA": [] } ], "AUDIT_KEY": "1", "AUDIT_NAME": "Washington George", "AUDIT_TYPE": "MATCH", "FROM_DATA_SOURCE": "DSRC_TYPE_222", "TO_DATA_SOURCE": "DSRC_TYPE_333" } ], "FROM_DATA_SOURCE": "DSRC_TYPE_222", "TO_DATA_SOURCE": "DSRC_TYPE_333", "MATCH_LEVEL": 1, "FIRST_RECORD_INDEX": 654321 } }
- Specified by:
fetchNextV2
in interfaceG2Audit
- Parameters:
reportHandle
- The report handle to retrieve data fromresponse
- TheStringBuffer
to write the JSON response to.- Returns:
- Zero (0) on success, non-zero on failure.
-
closeReport
public void closeReport(long reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.This function closes the report handle that was previously obtained fromG2Audit.openSession()
and subsequently releases the associated system resources.- Specified by:
closeReport
in interfaceG2Audit
- Parameters:
reportHandle
- The report handle to retrieve data from
-
closeReportV2
public int closeReportV2(long reportHandle)
Deprecated, for removal: This API element is subject to removal in a future version.This function closes the report handle that was previously obtained fromG2Audit.openSession()
and subsequently releases the associated system resources.- Specified by:
closeReportV2
in interfaceG2Audit
- Parameters:
reportHandle
- The report handle to retrieve data from- Returns:
- Zero (0) on success, non-zero on failure.
-
getLastException
public String getLastException()
Deprecated, for removal: This API element is subject to removal in a future version.Returns a string about the last error the system received. This is most commonly called after an API function returns an error code (non-zero or NULL)- Specified by:
getLastException
in interfaceG2Fallible
- Returns:
- An error message
-
getLastExceptionCode
public int getLastExceptionCode()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the exception code of the last error the system received. This is most commonly called after an API function returns an error code (non-zero or NULL)- Specified by:
getLastExceptionCode
in interfaceG2Fallible
- Returns:
- An error code
-
clearLastException
public void clearLastException()
Deprecated, for removal: This API element is subject to removal in a future version.Clears the information about the last error the system received.- Specified by:
clearLastException
in interfaceG2Fallible
-
-