GDK Framework

The GDK framework consists of callback functions and two libraries. The callback function APIs can be divided into several categories:

Driver interface

 

Session interface

 

Schema interface

 

Field interface

 

Stream interface

 

Document set interface

 

Security interface

 

Driver interface callback functions are part of the Verity Developer’s Kit (VDK) API; other callback functions are part of the Verity Gateway Developer’s Kit (GDK). The following table identifies these functions:

 


Callback Function

Description

Driver Interface (from VDK)

VdkDrvNewCBFnc

Callback function to set up memory and resources when the gateway driver is first loaded.

VdkDrvFreeCBFnc

Callback function to release memory and other resources when the gateway driver is freed.

Session Interface

VgwSessionNewFnc

Callback function to set up memory, resources, and context information when a session is created.

VgwSessionFreeFnc

Callback function to release memory, resources and other context information when the session is freed.

VgwSessionGetInfoFnc

Callback function to retrieve configuration and status information packet associated with a session.

VgwSessionGetInfoFreeFnc

Callback function to release the resources associated with information packet containing configuration and status information.

Schema Interface

VgwGetSchemaFnc

Callback function to retrieve the schema, which are the fields (columns) and their data types, from a repository.

VgwGetSchemaFreeFnc

Callback function to release the resources associated with the schema when the schema is freed.

Field Interface

VgwDocFieldReadFnc

Callback function to retrieve values for the “external” fields (metadata) of a document in a repository.

VgwDocFieldReadFreeFnc

Callback function to release the resources associated with external fields after they have been retrieved.

Stream Interface

VgwStreamNewFnc

Callback function to set up memory and resources when a stream is created.

VgwStreamFreeFnc

Callback function to release memory and resources associated with the stream when the stream is no longer needed.

VgwStreamGetTokenFnc

Callback function to retrieve a token that contains a document’s contents or metadata.

VgwStreamFreeTokenFnc

Callback function to release resources associated with the token when the token is no longer needed.

Document Set Interface

VgwDocSetNewFnc

Callback function to create a context for a document set and perform other initialization.

VgwDocSetFreeFnc

Callback function to release memory and resources associated with the document set when the document set is no longer needed.

VgwDocSetReadFnc

Callback function to retrieve a table of document fields.

VgwDocSetReadFreeFnc

Callback function to release resources associated a table of document fields when the table is no longer needed.

Security Interface

VgwAuthenticateFnc

Callback function to create a certificate for an authenticated user, which is one with the correct credentials.

VgwAuthenticateFreeFnc

Callback function to free the certificate when it is no longer needed.

VgwSecurityGetInfoFnc

Callback function to retrieve security information, such as valid credential types.

VgwSecurityCheckDocsFnc

Callback function to determine which documents in a set of documents that are available to a user.

VgwDocExistFnc

Callback function to determine whether a document exists and is available to a user.