Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<sdk-packages>> 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 <<sdk-packages>> 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.

Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* The client-side interface for interacting with a USubscription service instance.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/tree/v1.6.0-alpha.5/up-l3/usubscription/v3">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/tree/v1.6.0-alpha.6/up-l3/usubscription/v3">
* USubscription service specification</a>
*/
public interface USubscriptionClient {
Expand Down
38 changes: 0 additions & 38 deletions src/main/java/org/eclipse/uprotocol/cloudevent/README.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* A client for sending Notification messages to a uEntity.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l2/api.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l2/api.adoc">
* Communication Layer API Specifications</a>
*/
// [impl->dsn~communication-layer-api-declaration~1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
/**
* A client for publishing messages to a topic.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l2/api.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l2/api.adoc">
* Communication Layer API Specifications</a>
*/
// [impl->dsn~communication-layer-api-declaration~1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/**
* A client for performing Remote Procedure Calls (RPC) on (other) uEntities.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l2/api.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l2/api.adoc">
* Communication Layer API specification</a>
*/
// [impl->dsn~communication-layer-api-declaration~1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* A server for exposing Remote Procedure Call (RPC) endpoints.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l2/api.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l2/api.adoc">
* Communication Layer API specification</a>
*/
// [impl->dsn~communication-layer-api-declaration~1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* A client for subscribing to topics.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l2/api.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l2/api.adoc">
* Communication Layer API Specifications</a>
*/
// [impl->dsn~communication-layer-api-declaration~1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*
* Implementations contain the details for what should occur when a message is received.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l1/README.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l1/README.adoc">
* uProtocol Transport Layer specification</a>
*/
// [impl->dsn~ulistener-declaration~1]
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/eclipse/uprotocol/transport/UTransport.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* UTransport implementations contain the details for connecting to the underlying transport technology and
* sending UMessage using the configured technology.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/up-l1/README.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/up-l1/README.adoc">
* uProtocol Transport Layer specification</a>
*/
// [impl->dsn~utransport-declaration~1]
Expand All @@ -46,7 +46,7 @@ public interface UTransport {
* <p>
* The listener will be invoked for each message that matches the given source filter pattern
* according to the rules defined by the
* <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/basics/uri.adoc">UUri
* <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/basics/uri.adoc">UUri
* specification</a>.
* <p>
* This default implementation invokes {@link #registerListener(UUri, UUri, UListener)} with the
Expand All @@ -67,7 +67,7 @@ default CompletionStage<Void> registerListener(UUri sourceFilter, UListener list
* <p>
* The listener will be invoked for each message that matches the given source and sink filter patterns
* according to the rules defined by the
* <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/basics/uri.adoc">UUri
* <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/basics/uri.adoc">UUri
* specification</a>.
*
* @param sourceFilter The <em>source</em> address pattern that messages need to match.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://github.com/eclipse-uprotocol/uprotocol-spec/blob/v1.6.0-alpha.5/basics/uri.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/uprotocol-spec/blob/v1.6.0-alpha.6/basics/uri.adoc">
* uProtocol URI Specification</a>
*/
public final class UriSerializer {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* A factory for creating uProtocol UUIDs.
*
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/basics/uuid.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/basics/uuid.adoc">
* uProtocol UUID Specification</a>
*/
// [impl->dsn~uuid-spec~1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</a>
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.5/basics/uuid.adoc">
* @see <a href="https://github.com/eclipse-uprotocol/up-spec/blob/v1.6.0-alpha.6/basics/uuid.adoc">
* uProtocol UUID specification</a>
*/
public static boolean isUProtocol(UUID uuid) {
Expand Down