From b50485780bad54e4110f4dfb0ee141d9f705ffbb Mon Sep 17 00:00:00 2001 From: Kai Hudalla Date: Thu, 18 Sep 2025 08:47:17 +0200 Subject: [PATCH] [#196] Update to up-spec v1.6.0-alpha.6 Updated up-spec submodule to v1.6.0-alpha.6 tag, updated README and removed obsolete cloudevent package folder. Fixes #196 --- README.adoc | 8 ++-- .../usubscription/v3/USubscriptionClient.java | 2 +- .../eclipse/uprotocol/cloudevent/README.adoc | 38 ------------------- .../uprotocol/communication/Notifier.java | 2 +- .../uprotocol/communication/Publisher.java | 2 +- .../uprotocol/communication/RpcClient.java | 2 +- .../uprotocol/communication/RpcServer.java | 2 +- .../uprotocol/communication/Subscriber.java | 2 +- .../uprotocol/transport/UListener.java | 2 +- .../uprotocol/transport/UTransport.java | 6 +-- .../uri/serializer/UriSerializer.java | 2 +- .../uprotocol/uuid/factory/UuidFactory.java | 2 +- .../uprotocol/uuid/factory/UuidUtils.java | 2 +- up-spec | 2 +- 14 files changed, 18 insertions(+), 56 deletions(-) delete mode 100644 src/main/java/org/eclipse/uprotocol/cloudevent/README.adoc diff --git a/README.adoc b/README.adoc index 92db57c6..aa3ed024 100644 --- a/README.adoc +++ b/README.adoc @@ -4,7 +4,7 @@ [.specitem,oft-sid="uman~up-java-readme~1",oft-covers="req~up-language-documentation~1",tags="LanguageLibrary"] == Overview -This is the https://github.com/eclipse-uprotocol/uprotocol-spec/blob/v1.6.0-alpha.5/languages.adoc[uProtocol v1.6.0-alpha.5 Language Library] for the Java programming language. The library is organized into packages that are described in <> below and organized by the layers of the protocol. +This is the https://github.com/eclipse-uprotocol/uprotocol-spec/blob/v1.6.0-alpha.6/languages.adoc[uProtocol v1.6.0-alpha.6 Language Library] for the Java programming language. The library is organized into packages that are described in <> below and organized by the layers of the protocol. Each package folder contains a `README.adoc` file that describes the purpose of the package and how to use it. @@ -38,15 +38,15 @@ The following dependency needs to be added to your Maven POM file, setting `${up | xref:src/main/java/org/eclipse/uprotocol/client/README.adoc[`*client*`] | Top level client-facing interfaces to communication with USubscription, UDiscovery, and UTwin services. -| https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l3/README.adoc[Application Layer (uP-L3)] +| https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l3/README.adoc[Application Layer (uP-L3)] | xref:src/main/java/org/eclipse/uprotocol/communication/README.adoc[`*communication*`] | Common implementation of communication messaging patterns (publisher, subscriber, RpcClient, RpcServer, etc..) that are built on top of the L1 transport interface (see below). -| https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l2/api.adoc[Communication Layer (uP-L2)] +| https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l2/api.adoc[Communication Layer (uP-L2)] | xref:src/main/java/org/eclipse/uprotocol/transport/README.adoc[`*transport*`] | Interface and data model for how to send() and receive() messages in a common way across various transport technologies (ex. zenoh, mqtt, http, etc...). the interface is implemented by transports (ex. up-transport-android-java), and the interface is then used to build the uProtocol layer 2 communication layer implementation. -| https://github.com/eclipse-uprotocol/uprotocol-spec/blob/v1.6.0-alpha.5/up-l1/README.adoc[Transport Layer (uP-L1)] +| https://github.com/eclipse-uprotocol/uprotocol-spec/blob/v1.6.0-alpha.6/up-l1/README.adoc[Transport Layer (uP-L1)] | xref:src/main/java/org/eclipse/uprotocol/uri/README.adoc[`*uuri*`] | uProtocol addressing scheme (UUri) builders, validators, and serializers. diff --git a/src/main/java/org/eclipse/uprotocol/client/usubscription/v3/USubscriptionClient.java b/src/main/java/org/eclipse/uprotocol/client/usubscription/v3/USubscriptionClient.java index 6f487724..32967f9a 100644 --- a/src/main/java/org/eclipse/uprotocol/client/usubscription/v3/USubscriptionClient.java +++ b/src/main/java/org/eclipse/uprotocol/client/usubscription/v3/USubscriptionClient.java @@ -32,7 +32,7 @@ /** * The client-side interface for interacting with a USubscription service instance. * - * @see + * @see * USubscription service specification */ public interface USubscriptionClient { diff --git a/src/main/java/org/eclipse/uprotocol/cloudevent/README.adoc b/src/main/java/org/eclipse/uprotocol/cloudevent/README.adoc deleted file mode 100644 index c431a8c0..00000000 --- a/src/main/java/org/eclipse/uprotocol/cloudevent/README.adoc +++ /dev/null @@ -1,38 +0,0 @@ -= uProtocol CloudEvents -:toc: -:sectnums: - - -== Overview - -https://github.com/eclipse-uprotocol/up-spec/blob/main/basics/cloudevents.adoc[uProtocol CloudEvents] is a common message envelope that could be used to carry uProtocol messages across the transport. CloudEvents were historically used exclusively in older versions of uProtocol (ex. 1.3.6) and as such are maintained in this project for backwards compatibility support. - -This module contains the following classes: - -.uProtocol CloudEvent Interfaces -[#ce-interfaces, cols="1,3"] -|=== -|Class |Description - -| `*UCloudEvent*` -|A class that wraps a CloudEvent and provides utility methods to extract uProtocol specific attributes from the CloudEvent - -| `*UCloudEventAttributes*` -|A class that represents the uProtocol specific attributes that are added to the CloudEvent - -|`*CloudEventFactory*` -|Factory class that builds the various types of CloudEvents for uProtocol (publish, notification, request, response) - -| `*CloudEventSerializer*` -| A class that serializes and deserializes CloudEvents to and from protobuf and/or JSON formats used in some transports like MQTT in the past - -| `*CloudEventValidator*` -| Validates that the CloudEvent contains the correct uProtocol information and format for the various messages types (publish, notification, request, response) - -|=== - - - - - - diff --git a/src/main/java/org/eclipse/uprotocol/communication/Notifier.java b/src/main/java/org/eclipse/uprotocol/communication/Notifier.java index 887aa87b..3a089e2b 100644 --- a/src/main/java/org/eclipse/uprotocol/communication/Notifier.java +++ b/src/main/java/org/eclipse/uprotocol/communication/Notifier.java @@ -21,7 +21,7 @@ /** * A client for sending Notification messages to a uEntity. * - * @see + * @see * Communication Layer API Specifications */ // [impl->dsn~communication-layer-api-declaration~1] diff --git a/src/main/java/org/eclipse/uprotocol/communication/Publisher.java b/src/main/java/org/eclipse/uprotocol/communication/Publisher.java index 42080664..89839eea 100644 --- a/src/main/java/org/eclipse/uprotocol/communication/Publisher.java +++ b/src/main/java/org/eclipse/uprotocol/communication/Publisher.java @@ -17,7 +17,7 @@ /** * A client for publishing messages to a topic. * - * @see + * @see * Communication Layer API Specifications */ // [impl->dsn~communication-layer-api-declaration~1] diff --git a/src/main/java/org/eclipse/uprotocol/communication/RpcClient.java b/src/main/java/org/eclipse/uprotocol/communication/RpcClient.java index f7c7de54..ecf8d9fd 100644 --- a/src/main/java/org/eclipse/uprotocol/communication/RpcClient.java +++ b/src/main/java/org/eclipse/uprotocol/communication/RpcClient.java @@ -19,7 +19,7 @@ /** * A client for performing Remote Procedure Calls (RPC) on (other) uEntities. * - * @see + * @see * Communication Layer API specification */ // [impl->dsn~communication-layer-api-declaration~1] diff --git a/src/main/java/org/eclipse/uprotocol/communication/RpcServer.java b/src/main/java/org/eclipse/uprotocol/communication/RpcServer.java index 3956fb77..81f205f9 100644 --- a/src/main/java/org/eclipse/uprotocol/communication/RpcServer.java +++ b/src/main/java/org/eclipse/uprotocol/communication/RpcServer.java @@ -21,7 +21,7 @@ /** * A server for exposing Remote Procedure Call (RPC) endpoints. * - * @see + * @see * Communication Layer API specification */ // [impl->dsn~communication-layer-api-declaration~1] diff --git a/src/main/java/org/eclipse/uprotocol/communication/Subscriber.java b/src/main/java/org/eclipse/uprotocol/communication/Subscriber.java index cb2c0620..e7207240 100644 --- a/src/main/java/org/eclipse/uprotocol/communication/Subscriber.java +++ b/src/main/java/org/eclipse/uprotocol/communication/Subscriber.java @@ -25,7 +25,7 @@ /** * A client for subscribing to topics. * - * @see + * @see * Communication Layer API Specifications */ // [impl->dsn~communication-layer-api-declaration~1] diff --git a/src/main/java/org/eclipse/uprotocol/transport/UListener.java b/src/main/java/org/eclipse/uprotocol/transport/UListener.java index b0971d8b..a016ff80 100644 --- a/src/main/java/org/eclipse/uprotocol/transport/UListener.java +++ b/src/main/java/org/eclipse/uprotocol/transport/UListener.java @@ -19,7 +19,7 @@ * * Implementations contain the details for what should occur when a message is received. * - * @see + * @see * uProtocol Transport Layer specification */ // [impl->dsn~ulistener-declaration~1] diff --git a/src/main/java/org/eclipse/uprotocol/transport/UTransport.java b/src/main/java/org/eclipse/uprotocol/transport/UTransport.java index 407b70e7..e5846aab 100644 --- a/src/main/java/org/eclipse/uprotocol/transport/UTransport.java +++ b/src/main/java/org/eclipse/uprotocol/transport/UTransport.java @@ -26,7 +26,7 @@ * UTransport implementations contain the details for connecting to the underlying transport technology and * sending UMessage using the configured technology. * - * @see + * @see * uProtocol Transport Layer specification */ // [impl->dsn~utransport-declaration~1] @@ -46,7 +46,7 @@ public interface UTransport { *

* The listener will be invoked for each message that matches the given source filter pattern * according to the rules defined by the - * UUri + * UUri * specification. *

* This default implementation invokes {@link #registerListener(UUri, UUri, UListener)} with the @@ -67,7 +67,7 @@ default CompletionStage registerListener(UUri sourceFilter, UListener list *

* The listener will be invoked for each message that matches the given source and sink filter patterns * according to the rules defined by the - * UUri + * UUri * specification. * * @param sourceFilter The source address pattern that messages need to match. diff --git a/src/main/java/org/eclipse/uprotocol/uri/serializer/UriSerializer.java b/src/main/java/org/eclipse/uprotocol/uri/serializer/UriSerializer.java index c3272864..1c91ead3 100644 --- a/src/main/java/org/eclipse/uprotocol/uri/serializer/UriSerializer.java +++ b/src/main/java/org/eclipse/uprotocol/uri/serializer/UriSerializer.java @@ -25,7 +25,7 @@ * Provides functionality for serializing and deserializing {@link UUri}s to/from their * corresponding URI representation as defined by the uProtocol specification. * - * @see + * @see * uProtocol URI Specification */ public final class UriSerializer { diff --git a/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidFactory.java b/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidFactory.java index 9e12747b..a524c02a 100644 --- a/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidFactory.java +++ b/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidFactory.java @@ -21,7 +21,7 @@ /** * A factory for creating uProtocol UUIDs. * - * @see + * @see * uProtocol UUID Specification */ // [impl->dsn~uuid-spec~1] diff --git a/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidUtils.java b/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidUtils.java index 7f536d8e..33b40f64 100644 --- a/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidUtils.java +++ b/src/main/java/org/eclipse/uprotocol/uuid/factory/UuidUtils.java @@ -57,7 +57,7 @@ private static boolean isRfc9562Variant(UUID uuid) { * @return {@code true} if is a uProtocol UUID or {@code false} if uuid is {@code null} * or is not a v7 UUID. * @see RFC 9562 - * @see + * @see * uProtocol UUID specification */ public static boolean isUProtocol(UUID uuid) { diff --git a/up-spec b/up-spec index af556f65..3130bc5b 160000 --- a/up-spec +++ b/up-spec @@ -1 +1 @@ -Subproject commit af556f65b7ebedf89fcc1a5b678346a96b6e28c5 +Subproject commit 3130bc5bfe661f60509b9d5e1d03995d608a18b2