Using Java-Language K2 APIs

Many K2 applications have a user interface written in Java/JSP. For collection search, programming examples in Java are provided in the Verity K2 Client Programming Guide. For parametric indexes, programming examples of JSP interface elements are provided in the Verity K2 Parametric Developer Guide. For recommendations, examples of JSP interface elements are provided in the Verity K2 Recommendation Engine Guide.

K2 Java API Guides provide easy integration into a wide range of application servers and environments, including Java Server Pages, the Java Platform, and the .NET environment.

The K2 Java APIs provide a high-level object exposure that allows clients to communicate over a socket with a K2 Broker or K2 Server. These clients can be based on Java objects (using Java Server Pages).

Client APIs

VSearch Java API. Interface to Verity search functionality; used to perform collection-level search and tree search, to obtain system information, to authenticate access to repositories, to perform K2 login, and to obtain user/group information.

 

Documented in the VSearch JavaDoc document.

VView Java API. Interface to the Verity viewing service; used to convert indexed documents to HTML format—based in various templates—and display the results to the user.

 

Documented in the VView JavaDoc document.

Parametric Java API. Interface to the parametric engine and to parts of ODK; used to manipulate parametric indexes, conduct parametric selection, and render results.

 

Documented in the Parametric JavaDoc document and the Verity K2 Parametric Developer Guide.

ODK Java APIs. Interfaces to the Organization Developer’s Kit (ODK); used to provide classification features for documents, including taxonomies and topic sets. Includes programmatic support for collection indexing, thematic mapping, and the Logistic Regression Classifier (LRC). ODK makes use of the Parametric Java API to implement taxonomies within a parametric index.

 

Documented in the Parametric JavaDoc document and the Verity Organization Developer’s Kit Programming Guide.

Profiler Java API. Interface to the K2 Profiler service; used to evaluate documents against a set of predefined profiles (queries) to obtain a list of profiles matched to each document, plus relevance scores.

 

Documented in the Profiler JavaDoc document and the Verity K2 Profiler Programming Guide.

VRecommendation Java API. Interface to the Recommendation Engine; used to find desired users or documents given an input context.

 

Documented in the VSearch JavaDoc document.

VTransaction Java API. Interface to the Recommendation Engine; used to provide feedback to the Recommendation Engine to update document or user profiles.

 

Documented in the VSearch JavaDoc document.

FDK Java API. Interface to the Federated Developer’s Kit; used to access the federated infrastructure and Verity Federator, to execute simultaneous searches on multiple search engines.

 

Documented in the Verity Federated Developer’s Kit documentation.

Administration APIs

VAdministration Java API. Interface to K2 administrative functionality; used to change and manage the K2 system configuration. This API provides the same functionality as K2 Dashboard or the rcadmin command-line tool.

 

Documented in the VAdministration JavaDoc document.

VIndex Java API. Interface to the K2 Spider controller; used to administer indexing of collections. This API provides the same functionality as the K2 Spider C API.

 

Documented in the VIndex JavaDoc document.