The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in IETF BCP14 (RFC2119 & RFC8174)
Copyright (c) 2023 General Motors GTO LLC Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. SPDX-FileType: DOCUMENTATION SPDX-FileCopyrightText: 2023 General Motors GTO LLC SPDX-License-Identifier: Apache-2.0
Language specific uProtocol libraries (the library), builds the protobuf defined data model from Eclipse-uProtocol Core-API project and adds validators, serializers, and builders specific to the protocol for said data model not covered in protobuf generated code. The library is also responsible to declare the language specific uP-L1 & uP-L2 interfaces uTransport, RpcClient, and RpcServer.
|
Note
|
All projects/libraries MUST be released under a permissive license (Apache 2.0, MIT, etc..) and located in GitHub Eclipse-uProtocol project and MUST also depend only on other permissive license libraries. |
The following section will shall elaborate on the contents and structure of these libraries.
-
The root namespace (package name) MUST be
org.eclipse.uprotocol -
Modules defined in table SDK Modules below MUST be implemented in their own folder (namespace)
-
Each module SHOULD separate the implementation of the specification as defined in table Module Folders/Namespace below.
| Folder | Description |
|---|---|
|
static methods to validate the data model |
|
Any code that is responsible to Serialize and deserialize the data model |
|
Factory methods to build the data model per business logic (i.e. to build CloudEvents, UUIDs, etc..) |
Modules are packages (folders) that reside under the src director. SDK Modules table below lists the required modules.
| Folder | Specification | Description |
|---|---|---|
|
How things are addressed in uProtocol |
|
|
Unique ID & timestamp specification |
|
|
Specification of how uProtocol data models can be expressed using CloudEvents data model |
|
|
uP-L1 Transport Interface & data model.
|
|
|
APIs used to invokemethods() (for clients) and register RpcRequest Listeners (servers) to simplify implementation of the RPC design pattern. |
-
SHOULD include a test suite under the folder
test -
MUST be able to run the test suite such that merge requests (commits) cannot be merged till tests are passed
-
SHOULD cover 100% of all code and specifications defined in Source
-
MUST be easily built in both a Windows and Linux development environment. Any build requirements (i.e. package dependencies) need to be properly documented in the README
-
MUST be able to be imported to any wellknown IDE (Eclipse, IntelliJ, VSCode, etc..) and include self contained build system to build the code and dependencies(ex. maven, gradle, clang, soong, etc…).
-
MUST fetch external dependency libraries as handle build dependencies, MUST NOT copy external dependencies
-
MUST NOT depend on external copyright or copyleft libraries/modules, only permissive licenses such as Apache 2.0, MIT, shall be accepted etc..