This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git
The following commit(s) were added to refs/heads/master by this push:
new 15fb7a3b chore(oidc-rp): mark APIs are ProviderType and note they are
experimental
15fb7a3b is described below
commit 15fb7a3b3acd6df6108ba957064e1abbcacc7614
Author: Robert Munteanu <[email protected]>
AuthorDate: Thu Nov 14 14:52:54 2024 +0100
chore(oidc-rp): mark APIs are ProviderType and note they are experimental
---
org.apache.sling.servlets.oidc-rp/README.md | 12 +++---------
.../apache/sling/extensions/oauth_client/package-info.java | 1 +
.../sling/extensions/oauth_client/support/package-info.java | 1 +
3 files changed, 5 insertions(+), 9 deletions(-)
diff --git a/org.apache.sling.servlets.oidc-rp/README.md
b/org.apache.sling.servlets.oidc-rp/README.md
index 663cd246..6eb89f61 100644
--- a/org.apache.sling.servlets.oidc-rp/README.md
+++ b/org.apache.sling.servlets.oidc-rp/README.md
@@ -1,8 +1,8 @@
# Apache Sling OAuth 2.0 client with OIDC support
-> [!WARNING]
-> This bundle is under development, do not use in production without reviewing
the
-> outstanding [todos](#todos).
+> [!IMPORTANT]
+> The Java APIs exported by this bundle are considered **experimental** and
are marked as being
+> @ProviderType. Expect them to change frequently until they are considered
stable.
This bundle adds support for Sling-based applications to function as an OAuth
2.0 client
([RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749)) and implements the
basis for being an
@@ -283,12 +283,6 @@ $ docker run --rm --volume
$(pwd)/keycloak-data:/opt/keycloak/data -p 8081:8080
$ docker run --rm --volume (pwd)/keycloak-data:/opt/keycloak/data -p 8081:8080
-e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin
quay.io/keycloak/keycloak:20.0.3 export --realm sling --users realm_file --file
/opt/keycloak/data/export/sling.json
```
-## Todos
-
-The following items should be addressed for the bundle to be able to
completely support OAuth applications:
-
-- mark all APIs with `@ProviderType` during pre-1.0 releases to allow evolving
the APIs easier
-
### Future plans
- make the OAuthEnabledSlingServlet handle any method, not just get
diff --git
a/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/package-info.java
b/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/package-info.java
index 0df37da9..26fe4f67 100644
---
a/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/package-info.java
+++
b/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/package-info.java
@@ -15,6 +15,7 @@
* limitations under the License.
*/
@Version("0.1.0")
[email protected]
package org.apache.sling.extensions.oauth_client;
import org.osgi.annotation.versioning.Version;
diff --git
a/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/support/package-info.java
b/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/support/package-info.java
index 1d0565b0..a593e5d2 100644
---
a/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/support/package-info.java
+++
b/org.apache.sling.servlets.oidc-rp/src/main/java/org/apache/sling/extensions/oauth_client/support/package-info.java
@@ -15,6 +15,7 @@
* limitations under the License.
*/
@Version("0.1.0")
[email protected]
package org.apache.sling.extensions.oauth_client.support;
import org.osgi.annotation.versioning.Version;
