Difference between revisions of "Project Proposals/JVPP"
From fd.io
(→Description) |
(→Administrata) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 12: | Line 12: | ||
== Description == | == Description == | ||
| + | |||
| + | === Architecture === | ||
| + | |||
JVPP is a VPP module providing Java APIs for VPP. Java APIs provide a way for a JVM application to access and manage VPP. Main use of JVPP is in Honeycomb project. Honeycomb relies heavily on JVPP to access and manage VPP. | JVPP is a VPP module providing Java APIs for VPP. Java APIs provide a way for a JVM application to access and manage VPP. Main use of JVPP is in Honeycomb project. Honeycomb relies heavily on JVPP to access and manage VPP. | ||
| + | |||
| + | JVPP contains of manually crafted code together with generated classes. Classes are being generated by python based on VPP API json files. Generated code represents various Java classes (Callbacks, callfacades, DTOs, types ...) and jni header files. | ||
| + | |||
[[File:Overview_of_JVPP_usage.jpg|center|603px|JVPP overview]] | [[File:Overview_of_JVPP_usage.jpg|center|603px|JVPP overview]] | ||
| + | <div align="center">Overview of JVPP usage</div> | ||
| + | |||
| + | === Plugin Support === | ||
| + | VppRegistry opens connection to VPP (VppConnection) and manages JVPP plugins. Each plugin needs to be registered in the VppRegistry. Registration involves plugin initialization (providing JNI implementation with JVppCallback reference, VPP client identifier and VPP shared memory queue address). | ||
| + | |||
| + | [[File:Architecture-JVPP.jpg|center|563px|Architecture of JVPP]] | ||
| + | <div align="center">JVPP - Architecture</div> | ||
| + | |||
| + | API user sends message by calling a method of appropriate plugin interface. The call is delegated to JNI implementation provided by the particular plugin. When JNI code receives reply, it invokes callback method of JVppCallback | ||
| + | that corresponds to the received message reply. | ||
| + | |||
| + | [[File:JVPP Architecture example.jpg|center|673px|JVppCore as an example of JVPP plugin architecture]] | ||
| + | <div align="center">JVppCore as an example of JVPP plugin architecture</div> | ||
| + | Components marked with an asterisk (*) contain manually crafted code, which in addition to generated classes form jvpp. Exception applies to Callbacks and DTOs, since there are manually crafted marker interfaces in callback and dto package (dto/JVppRequest, dto/JVppReply, dto/JVppDump, dto/JVppReplyDump, callback/JVppCallback) | ||
== Scope == | == Scope == | ||
| + | Project main goal is to provide Java API for VPP, to enable access and management of VPP. | ||
| + | |||
| + | '''JVPP project scope:''' | ||
| + | * jvpp-gen | ||
| + | ** Java API generator, allows Java applications to interact with VPP. | ||
| + | * jvpp-registry | ||
| + | ** Provides common features: registration of plugins, managing VPP conection, callback handling, common functions... | ||
| + | * jvpp-plugins | ||
| + | ** Provides Java APIs for VPP core APIs and several VPP plugin APIs. Currently supported plugins: Acl, Nat, Nsh, GTPU, PPPoE | ||
| + | |||
| + | '''Out of scope:''' | ||
| + | * Vpp-vapi | ||
| + | ** VPP binary APIs, part of the base VPP project. | ||
| + | |||
<!-- Project scope. The project scope should be well defined. It should be possible from the scope to crisply answer whether something belongs or not within the scope of this particular project. Scopes should not be overly broad. A Project scope must also lie within the overall scope set by the board for projects in fd.io: | <!-- Project scope. The project scope should be well defined. It should be possible from the scope to crisply answer whether something belongs or not within the scope of this particular project. Scopes should not be overly broad. A Project scope must also lie within the overall scope set by the board for projects in fd.io: | ||
- IO | - IO | ||
| Line 33: | Line 67: | ||
== Initial Committers == | == Initial Committers == | ||
| − | * [mailto:mcmarada@cisco.com Michal Cmarada], | + | * [mailto:mcmarada@cisco.com Michal Cmarada], LF-ID: mcmarada, |
| − | * [mailto:margradz@gmail.com Marek Grądzki], | + | * [mailto:margradz@gmail.com Marek Grądzki], LF-ID: mgradzki, |
| − | * [mailto:Tibor.Kral@pantheon.tech Tibor Kral], | + | * [mailto:Tibor.Kral@pantheon.tech Tibor Kral], LF-ID: tibor.kral |
| − | * [mailto:raszabo@cisco.com Rastislav Szabo], | + | * [mailto:raszabo@cisco.com Rastislav Szabo], LF-ID: raszabo |
| − | * [mailto:jtollet@cisco.com Jerome Tollet], | + | * [mailto:jtollet@cisco.com Jerome Tollet], LF-ID: jtollet |
== Vendor Neutral == | == Vendor Neutral == | ||
| − | + | No current or expected issues with vendor neutrality. | |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Meets Board Policy (including IPR, being within Board defined Scope etc) == | == Meets Board Policy (including IPR, being within Board defined Scope etc) == | ||
| Line 63: | Line 82: | ||
== Administrata == | == Administrata == | ||
* Request for Project proposal consideration | * Request for Project proposal consideration | ||
| − | ** Email: | + | ** Email: [https://lists.fd.io/g/tsc/topic/jvpp_proposal/28733531?p=,,,20,0,0,0::recentpostdate%2Fsticky,,,20,2,0,28733531 JVPP proposal] |
| − | ** Date: | + | ** Date: 12th of December 2018. |
Latest revision as of 15:33, 12 December 2018
Contents
Name
JVPP - Java API for VPP
Project Contact Name and Email
Repository Name
jvpp
Description
Architecture
JVPP is a VPP module providing Java APIs for VPP. Java APIs provide a way for a JVM application to access and manage VPP. Main use of JVPP is in Honeycomb project. Honeycomb relies heavily on JVPP to access and manage VPP.
JVPP contains of manually crafted code together with generated classes. Classes are being generated by python based on VPP API json files. Generated code represents various Java classes (Callbacks, callfacades, DTOs, types ...) and jni header files.
Overview of JVPP usage
Plugin Support
VppRegistry opens connection to VPP (VppConnection) and manages JVPP plugins. Each plugin needs to be registered in the VppRegistry. Registration involves plugin initialization (providing JNI implementation with JVppCallback reference, VPP client identifier and VPP shared memory queue address).
JVPP - Architecture
API user sends message by calling a method of appropriate plugin interface. The call is delegated to JNI implementation provided by the particular plugin. When JNI code receives reply, it invokes callback method of JVppCallback that corresponds to the received message reply.
JVppCore as an example of JVPP plugin architecture
Components marked with an asterisk (*) contain manually crafted code, which in addition to generated classes form jvpp. Exception applies to Callbacks and DTOs, since there are manually crafted marker interfaces in callback and dto package (dto/JVppRequest, dto/JVppReply, dto/JVppDump, dto/JVppReplyDump, callback/JVppCallback)
Scope
Project main goal is to provide Java API for VPP, to enable access and management of VPP.
JVPP project scope:
- jvpp-gen
- Java API generator, allows Java applications to interact with VPP.
- jvpp-registry
- Provides common features: registration of plugins, managing VPP conection, callback handling, common functions...
- jvpp-plugins
- Provides Java APIs for VPP core APIs and several VPP plugin APIs. Currently supported plugins: Acl, Nat, Nsh, GTPU, PPPoE
Out of scope:
- Vpp-vapi
- VPP binary APIs, part of the base VPP project.
Initial Committers
- Michal Cmarada, LF-ID: mcmarada,
- Marek Grądzki, LF-ID: mgradzki,
- Tibor Kral, LF-ID: tibor.kral
- Rastislav Szabo, LF-ID: raszabo
- Jerome Tollet, LF-ID: jtollet
Vendor Neutral
No current or expected issues with vendor neutrality.
Meets Board Policy (including IPR, being within Board defined Scope etc)
Meets board policy as expressed in Technical Community Charter and IP Policy
Administrata
- Request for Project proposal consideration
- Email: JVPP proposal
- Date: 12th of December 2018.
