Table of Contents

Search

  1. Preface
  2. Introduction to Vibe Data Stream Custom Entity Types
  3. Managing Custom Entity Types
  4. Custom Entities from Maven Archetypes
  5. REST APIs
  6. HTTP Request and Response Parameters
  7. Sample JSON Requests and Responses
  8. Glossary

Developer Guide

Developer Guide

Components of a Custom Entity Type

Components of a Custom Entity Type

Organize the components of the custom entity type by using a particular directory structure.
A custom entity type consists of the following components:
VDS Plug-in XML File (Required)
An XML file called
vdsplugin.xml
. The XML file describes configuration and plug-in details for the custom entity type.
VDS Plug-in JAR File (Required)
The VDS plug-in JAR file contains the implementation of a VDS interface.
Plug-in Dependant Java Class Libraries (Optional)
The Java class libraries are libraries on which the implementation of the custom entity type depends. Store the Java class libraries in a directory called
lib
. The lib directory can contain multiple JAR files.
Plug-in Dependant Native Libraries (Optional)
Native libraries are shared objects (
.so
files) for Linux and dynamically loaded library (
DLL
files) for Windows. Native libraries are required if the Java libraries have native dependencies. Store the native libraries in a directory called
native
. The native directory can contain multiple .so or DLL files.
Create all the components in the same directory. For example, to create the components in a directory called
plugin
, use the following directory structure:
plugin |- vdsplugin.xml VDS plug-in XML file |- <MyVDSPlugin>.jar VDS plug-in JAR file +- lib Directory that contains Java class libraries | |- <JavaClassLibrary1>.jar | |- <JavaClassLibrary2>.jar +- native Directory that contains native libraries | |- <SharedObject1>.so | |- <SharedObject2>.so
The angle brackets (
<
and
>
) indicate that you can replace the name in the example with a name of your choice.

0 COMMENTS

We’d like to hear from you!