UTransport Interface & Data Model

README.adoc

@@ -1,17 +1,11 @@
-image:https://github.com/eclipse-uprotocol/.github/raw/main/logo/uprotocol_logo.png[alt=uProtocol,640]
-
-image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[License,link=https://opensource.org/licenses/Apache-2.0]
-
 = Eclipse uProtocol Java SDK
 :toc:
 
 == Overview
 
-The main object of this module is to enable constructing and deconstructing uProtocol CloudEvents.
-
-The core module contains functional factory methods for creating CloudEvents as well as functional factory methods that make it more intuitive to create URIs that are used to configure source and sink (destination) elements in the uProtocol CloudEvents.
+The purpose of this module is to provide language specific code that builds the various data types defined in . The SDK also defines https://github.com/eclipse-uprotocol/uprotocol-spec/tree/main[uProtocol Specifications]. 
 
-This module contains the data model structures as well as core functionality for building uProtocol CloudEvents and URIs for sink and source attributes.
+The module contains factory methods and validators for all data types used in uProtocol. 
 
 The SDKs are then used by the code generators to auto-populate service stubs with generated code that builds CloudEvents. For more information on auto-generating service stubs, please refer to http://github.com/eclipse-uprotocol/uprotocol[uProtocol Main Project]
 
@@ -28,57 +22,29 @@ The SDKs are then used by the code generators to auto-populate service stubs wit
 </dependency>
 ----
 
+=== Using the sdk
 
-=== UriFactory
-
-Matches the uProtocol URI Format. and is used to define source and sink (destination) attributes of uProtocol CloudEvents.
-The factory builds URIs.
-
-URI is used as a method to uniquely identify devices, services, and resources on the network.
-
-*An Uri is built from the following elements:*
-
-* *UAuthority* - represents the device and domain of the software, the deployment. You can specify local or remote options.
-* *UEntity* - The Software Entity defines the software name and version.
-* *UResource* - The resource of the software can be a service name, and instance in the service and the name of the protobuf IDL message.
-
-==== UAuthority
-
-An Authority consists of a device and a domain per uProtocol URI format.
-
-An Authority represents the deployment location of a specific Software Entity.
-
-==== UEntity - uE
-
-An Software Entity is a piece of software deployed somewhere on a device. The uE is used in the source and sink parts of communicating software.
-
-A uE that *publishes* events is a *Service* role.
-
-A uE that *consumes* events is an *Application* role.
-
-A uE may combine bother Service and Application roles.
-
-
-==== UResource
-
-A service API - defined in the uE - has Resources and Methods. Both of these are represented by the UResource class.
-
-An UResource is something that can be manipulated/controlled/exposed by a service. 
-
-Resources are unique when prepended with UAuthority that represents the device and Software Entity that represents the service.
-
-An Resource represents a resource from a Service such as "door" and an optional specific instance such as "front_left".
-In addition, it can optionally contain the name of the resource Message type, such as "Door". 
+The SDK is composed of 4 main packages as shown in <<sdk-packages>> below:
 
-The Message type matches the protobuf service IDL that defines structured data types. A message is a data structure type used to define data that is passed in events and rpc methods.
+.SDK Packages
+[#sdk-packages,width=100%,cols="15%,25%,60%"]
+|===
+| Package | https://github.com/eclipse-uprotocol/uprotocol-spec[uprotocol-spec] | Purpose
 
-=== CloudEventFactory
-Factory class that builds the various types of CloudEvents for uProtocol (publish, notification, request, response)
+| link:src/main/java/org/eclipse/uprotocol/uri/README.adoc[`uuri`]
+| https://github.com/eclipse-uprotocol/uprotocol-spec/blob/main/basics/uri.adoc[URI, UAthority, UEntity, UResource]
+| Uniform Resource Identifier (RFC3986) used to address things (devices, software, methods, topics, etc...) on the network
 
-== Examples
+| link:src/main/java/org/eclipse/uprotocol/cloudevent/README.adoc[`cloudevent`] 
+| https://github.com/eclipse-uprotocol/uprotocol-spec/blob/main/up-l1/cloudevents.adoc[uProtocol CloudEvents]
+| Common way to represent uProtocol messages using CloudEvent data model
 
-The SDK contains comprehensive tests, the best place to look at how all the APIs are used are at:
+| link:src/main/java/org/eclipse/uprotocol/uuid/README.adoc[`uuid`] 
+| https://github.com/eclipse-uprotocol/uprotocol-spec/blob/main/basics/uuid.adoc[uProtocol UUIDs]
+| Identifier used to uniquely identify messages that are sent between devices. also includes timestamp for the message
 
-* link:src/test/java/org/eclipse/uprotocol/uri/factory/UriFactoryTest.java[UriFactoryTest.java]
+| link:src/main/java/org/eclipse/uprotocol/utransport/README.adoc[`utransport`] 
+| https://github.com/eclipse-uprotocol/uprotocol-spec/blob/main/up-l1/README.adoc[uP-L1 Specifications]
+| Interface (and data model) used for bidirectional point-2-point communication between uEs. Interface is to be implemented by the different communication technologies (ex. Binder, MQTT, Zenoh, SOME/IP, DDS, HTTP, etc…​)
 
-* link:src/test/java/org/eclipse/uprotocol/cloudevent/factory/CloudEventFactoryTest.java[CloudEventFactoryTest.java]
+|===

pom.xml

@@ -132,6 +132,27 @@
 
     <dependencyManagement>
         <dependencies>
+
+            <dependency>
+                <groupId>io.cloudevents</groupId>
+                <artifactId>cloudevents-protobuf</artifactId>
+                <version>2.4.2</version>
+            </dependency>
+
+
+            <dependency>
+                <groupId>com.google.errorprone</groupId>
+                <artifactId>error_prone_annotations</artifactId>
+                <version>2.11.0</version>
+            </dependency>
+
+
+            <dependency>
+                <groupId>org.checkerframework</groupId>
+                <artifactId>checker-qual</artifactId>
+                <version>3.12.0</version>
+            </dependency>
+
             <dependency>
                 <groupId>com.google.protobuf</groupId>
                 <artifactId>protobuf-bom</artifactId>
@@ -153,7 +174,7 @@
             <dependency>
                 <groupId>nl.jqno.equalsverifier</groupId>
                 <artifactId>equalsverifier</artifactId>
-                <version>3.10.1</version>
+                <version>3.14.1</version>
                 <scope>test</scope>
             </dependency>
 
@@ -173,6 +194,7 @@
         <dependency>
             <groupId>nl.jqno.equalsverifier</groupId>
             <artifactId>equalsverifier</artifactId>
+            <version>3.14.1</version>
             <scope>test</scope>
         </dependency>
 
@@ -188,7 +210,7 @@
         <dependency>
             <groupId>io.cloudevents</groupId>
             <artifactId>cloudevents-protobuf</artifactId>
-            <version>2.2.0</version>
+
         </dependency>
 
         <!-- CloudEvents support https://cloudevents.github.io/sdk-java/  https://github.com/cloudevents/sdk-java-->
@@ -223,21 +245,26 @@
         </dependency>
 
 
-        <dependency>
-            <groupId>com.google.truth.extensions</groupId>
-            <artifactId>truth-proto-extension</artifactId>
-            <version>1.1</version>
-            <scope>test</scope>
-        </dependency>
-
-
         <!-- https://search.maven.org/artifact/com.github.f4b6a3/uuid-creator -->
         <dependency>
             <groupId>com.github.f4b6a3</groupId>
             <artifactId>uuid-creator</artifactId>
             <version>5.1.2</version>
         </dependency>
 
+        <dependency>
+            <groupId>commons-validator</groupId>
+            <artifactId>commons-validator</artifactId>
+            <version>1.7</version>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.uprotocol </groupId>
+            <artifactId>uprotocol-core-api</artifactId>
+            <version>1.4.9-SNAPSHOT</version>
+            <scope>system</scope>
+            <systemPath>${project.basedir}/uprotocol-core-api-1.4.9-SNAPSHOT.jar</systemPath>
+        </dependency>
+
     </dependencies>
 
 </project>

src/main/java/org/eclipse/uprotocol/cloudevent/README.adoc

@@ -0,0 +1,21 @@
+= uProtocol CloudEvents
+:toc:
+:sectnums:
+
+
+== Overview
+
+https://github.com/eclipse-uprotocol/uprotocol-spec/blob/main/up-l1/cloudevents.adoc[uProtocol CloudEvents] is a common message envelope that could be used to carry way to represent uProtocol transport layer information `UUri` (source), `UPayload`, and `UAttributes`. `CloudEvents` are used by a number of Device-2-Cloud and Cloud-2-Device based transports such as MQTT and HTTP, however it could also be used by any transport (ex. Binder). 
+
+NOTE: CloudEvent is not, nor was not, meant to be _the_ only message format used below or above the transport layer.
+
+=== CloudEventFactory
+Factory class that builds the various types of CloudEvents for uProtocol (publish, notification, request, response)
+
+== Examples
+
+The SDK contains comprehensive tests, the best place to look at how all the APIs are used are at:
+
+* link:src/test/java/org/eclipse/uprotocol/uri/factory/UriFactoryTest.java[UriFactoryTest.java]
+
+* link:src/test/java/org/eclipse/uprotocol/cloudevent/factory/CloudEventFactoryTest.java[CloudEventFactoryTest.java]

src/main/java/org/eclipse/uprotocol/cloudevent/datamodel/UCloudEventType.java

@@ -29,7 +29,6 @@
  */
 public enum UCloudEventType {
     PUBLISH ("pub.v1"),
-    FILE ("file.v1"),
     REQUEST ("req.v1"),
     RESPONSE ("res.v1");
 

src/main/java/org/eclipse/uprotocol/cloudevent/factory/CloudEventFactory.java

@@ -23,8 +23,7 @@
 
 import org.eclipse.uprotocol.cloudevent.datamodel.UCloudEventAttributes;
 import org.eclipse.uprotocol.cloudevent.datamodel.UCloudEventType;
-import org.eclipse.uprotocol.uri.datamodel.UUri;
-import org.eclipse.uprotocol.uri.factory.UriFactory;
+
 import com.google.protobuf.Any;
 import com.google.protobuf.Empty;
 import com.google.rpc.Code;
@@ -159,8 +158,7 @@ static String generateCloudEventId() {
      *
      * @param id                 Event unique identifier.
      * @param source             Identifies who is sending this event in the format of a uProtocol URI that
-     *                           can be built from a {@link UUri} object using
-     *                           the {@link UriFactory}
+     *                           can be built from a {@link UUri} object.
      * @param protoPayloadBytes  The serialized Event data with the content type of "application/x-protobuf".
      * @param protoPayloadSchema The schema of the proto payload bytes, for example you can use <code>protoPayload.getTypeUrl()</code> on your service/app object.
      * @param attributes        Additional cloud event attributes that can be passed in. All attributes are optional and will be added only if they