(sling-org-apache-sling-auth-oauth-client) 02/02: chore: improve Javadoc for ClientConnection

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rombert pushed a commit to branch chore/api-fixes
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-auth-oauth-client.git

commit 182084544fc14ed03f02eca9592f003b276def43
Author: Robert Munteanu <ro...@apache.org>
AuthorDate: Thu Dec 12 11:59:21 2024 +0100

    chore: improve Javadoc for ClientConnection
---
 .../org/apache/sling/auth/oauth_client/ClientConnection.java  | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/main/java/org/apache/sling/auth/oauth_client/ClientConnection.java b/src/main/java/org/apache/sling/auth/oauth_client/ClientConnection.java
index 995edc4..7bd450e 100644
--- a/src/main/java/org/apache/sling/auth/oauth_client/ClientConnection.java
+++ b/src/main/java/org/apache/sling/auth/oauth_client/ClientConnection.java
@@ -18,8 +18,19 @@ package org.apache.sling.auth.oauth_client;
 
 /**
  * Identifies an OAuth or OIDC connection
+ * 
+ * <p>Used in the public API to identify the client connection for which to retrieve or clear tokens.</p>
+ * 
+ * <p>Connections are published as OSGi services and should be retrieved using the <tt>name</tt> property.</p>
+ * 
+ * <pre>{@code private @Reference(target = "(name=my-connection-name)")} ClientConnection connection;}</pre>
+ * 
+ * @see OAuthTokenAccess
  */
 public interface ClientConnection {
 
+    /**
+     * @return the name of the connection
+     */
     String name();
 }