This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch spring6 in repository https://gitbox.apache.org/repos/asf/causeway.git
commit c974057dd55cc1229bfb78b8bc15b1b291c410ce Author: danhaywood <[email protected]> AuthorDate: Fri Mar 22 10:01:50 2024 +0000 CAUSEWAY-3666 : doc fixes reference 'simple' security module; 2.0.0-RC5 -> 2.0.0; remove stale link to graphql in the incubator --- .../components/docs/modules/ROOT/pages/about.adoc | 1 + .../ROOT/partials/module-nav/components.adoc | 1 + .../simple/CausewayModuleSecuritySimple.adoc} | 28 ++---- .../authentication/SimpleAuthenticator.adoc} | 30 +++--- .../simple/authorization/SimpleAuthorizor.adoc} | 29 ++---- .../modules/ROOT/pages/2024/2.0.0/mignotes.adoc | 12 +-- .../modules/ROOT/pages/2024/2.0.0/relnotes.adoc | 4 +- antora/playbooks/site-comguide.yml | 2 +- antora/playbooks/site-conguide.yml | 2 +- antora/playbooks/site-core.yml | 2 +- antora/playbooks/site-docs.yml | 2 +- antora/playbooks/site-extensions.yml | 2 +- antora/playbooks/site-incubator.yml | 2 +- antora/playbooks/site-persistence.yml | 2 +- antora/playbooks/site-refguide.yml | 2 +- antora/playbooks/site-regressiontests.yml | 2 +- antora/playbooks/site-relnotes.yml | 2 +- antora/playbooks/site-security.yml | 2 +- antora/playbooks/site-setupguide.yml | 2 +- antora/playbooks/site-testing.yml | 2 +- antora/playbooks/site-tooling.yml | 2 +- antora/playbooks/site-tutorials.yml | 2 +- antora/playbooks/site-userguide.yml | 2 +- antora/playbooks/site-valuetypes.yml | 2 +- antora/playbooks/site-vro.yml | 2 +- antora/playbooks/site-vw.yml | 2 +- antora/playbooks/site.ALL.yml | 2 +- antora/playbooks/site.NEXT.yml | 2 +- antora/playbooks/site.yml | 2 +- core/adoc/modules/_overview/pages/about.adoc | 111 +++++++++++++-------- .../adoc/modules/ROOT/partials/component-nav.adoc | 1 - mavendeps/adoc/modules/mavendeps/pages/about.adoc | 2 +- security/adoc/modules/ROOT/pages/about.adoc | 1 + .../src/main/adoc/modules/simple/pages/about.adoc | 7 +- 34 files changed, 140 insertions(+), 131 deletions(-) diff --git a/antora/components/docs/modules/ROOT/pages/about.adoc b/antora/components/docs/modules/ROOT/pages/about.adoc index 6321a93248..e2054912d8 100644 --- a/antora/components/docs/modules/ROOT/pages/about.adoc +++ b/antora/components/docs/modules/ROOT/pages/about.adoc @@ -76,6 +76,7 @@ _Development_ _Security_ * xref:security:bypass:about.adoc[Bypass] +* xref:security:simple:about.adoc[Simple] * xref:security:shiro:about.adoc[Shiro] * xref:security:spring:about.adoc[Spring] * xref:security:keycloak:about.adoc[Keycloak] diff --git a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc b/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc index e0fa53efb8..b0c412adf2 100644 --- a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc +++ b/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc @@ -6,6 +6,7 @@ ** Security *** xref:security:bypass:about.adoc[Bypass] +*** xref:security:simple:about.adoc[Simple] *** xref:security:shiro:about.adoc[Shiro] *** xref:security:spring:about.adoc[Spring] *** xref:security:keycloak:about.adoc[Keycloak] diff --git a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc b/antora/components/refguide-index/modules/security/pages/index/simple/CausewayModuleSecuritySimple.adoc similarity index 61% copy from antora/components/docs/modules/ROOT/partials/module-nav/components.adoc copy to antora/components/refguide-index/modules/security/pages/index/simple/CausewayModuleSecuritySimple.adoc index e0fa53efb8..c05d0b729c 100644 --- a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc +++ b/antora/components/refguide-index/modules/security/pages/index/simple/CausewayModuleSecuritySimple.adoc @@ -1,23 +1,15 @@ - += CausewayModuleSecuritySimple :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] -* Components - -** Security - -*** xref:security:bypass:about.adoc[Bypass] -*** xref:security:shiro:about.adoc[Shiro] -*** xref:security:spring:about.adoc[Spring] -*** xref:security:keycloak:about.adoc[Keycloak] - -** Viewers - -*** xref:vw:ROOT:about.adoc[Web UI (Wicket)] -*** xref:gqlv:ROOT:about.adoc[GraphQL API] -*** xref:vro:ROOT:about.adoc[REST API (Restful Objects)] +Simple in-memory authorization and authentication module. -** Persistence +== API -*** xref:pjpa:ROOT:about.adoc[JPA (EclipseLink)] -*** xref:pjdo:ROOT:about.adoc[JDO (DataNucleus)] +[source,java] +.CausewayModuleSecuritySimple.java +---- +class CausewayModuleSecuritySimple { + public static final String NAMESPACE; +} +---- diff --git a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc b/antora/components/refguide-index/modules/security/pages/index/simple/authentication/SimpleAuthenticator.adoc similarity index 61% copy from antora/components/docs/modules/ROOT/partials/module-nav/components.adoc copy to antora/components/refguide-index/modules/security/pages/index/simple/authentication/SimpleAuthenticator.adoc index e0fa53efb8..90ee2b5fd2 100644 --- a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc +++ b/antora/components/refguide-index/modules/security/pages/index/simple/authentication/SimpleAuthenticator.adoc @@ -1,23 +1,17 @@ - += SimpleAuthenticator :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] -* Components - -** Security - -*** xref:security:bypass:about.adoc[Bypass] -*** xref:security:shiro:about.adoc[Shiro] -*** xref:security:spring:about.adoc[Spring] -*** xref:security:keycloak:about.adoc[Keycloak] - -** Viewers - -*** xref:vw:ROOT:about.adoc[Web UI (Wicket)] -*** xref:gqlv:ROOT:about.adoc[GraphQL API] -*** xref:vro:ROOT:about.adoc[REST API (Restful Objects)] +Simple in-memory xref:refguide:core:index/security/authentication/Authenticator.adoc[Authenticator] implementation. -** Persistence +== API -*** xref:pjpa:ROOT:about.adoc[JPA (EclipseLink)] -*** xref:pjdo:ROOT:about.adoc[JDO (DataNucleus)] +[source,java] +.SimpleAuthenticator.java +---- +class SimpleAuthenticator { + boolean canAuthenticate(Class<? extends AuthenticationRequest> authenticationRequestClass) + InteractionContext authenticate(AuthenticationRequest request, String validationCode) + void logout() +} +---- diff --git a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc b/antora/components/refguide-index/modules/security/pages/index/simple/authorization/SimpleAuthorizor.adoc similarity index 61% copy from antora/components/docs/modules/ROOT/partials/module-nav/components.adoc copy to antora/components/refguide-index/modules/security/pages/index/simple/authorization/SimpleAuthorizor.adoc index e0fa53efb8..b23c3846e6 100644 --- a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc +++ b/antora/components/refguide-index/modules/security/pages/index/simple/authorization/SimpleAuthorizor.adoc @@ -1,23 +1,16 @@ - += SimpleAuthorizor :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] -* Components - -** Security - -*** xref:security:bypass:about.adoc[Bypass] -*** xref:security:shiro:about.adoc[Shiro] -*** xref:security:spring:about.adoc[Spring] -*** xref:security:keycloak:about.adoc[Keycloak] - -** Viewers - -*** xref:vw:ROOT:about.adoc[Web UI (Wicket)] -*** xref:gqlv:ROOT:about.adoc[GraphQL API] -*** xref:vro:ROOT:about.adoc[REST API (Restful Objects)] +Simple in-memory xref:refguide:core:index/security/authorization/Authorizor.adoc[Authorizor] implementation. -** Persistence +== API -*** xref:pjpa:ROOT:about.adoc[JPA (EclipseLink)] -*** xref:pjdo:ROOT:about.adoc[JDO (DataNucleus)] +[source,java] +.SimpleAuthorizor.java +---- +class SimpleAuthorizor { + boolean isVisible(InteractionContext ctx, Identifier identifier) + boolean isUsable(InteractionContext ctx, Identifier identifier) +} +---- diff --git a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc index dcbb06c9d8..305b7be489 100644 --- a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc @@ -7,15 +7,15 @@ This page will be added to as development progresses. == Programming Model (CAUSEWAY-3697) -Annotation attribute -`@DomainService(nature=..)` was marked for removal and no longer has any scope filtering effect. +Annotation attribute +`@DomainService(nature=..)` was marked for removal and no longer has any scope filtering effect. This filtering is or will be replaced by some other mechanism eg. configuration option. == Programming Model (CAUSEWAY-3692) -Annotation attribute +Annotation attribute `@Parameter(dependentDefaultsPolicy=..)` was renamed to -`@Parameter(precedingParamsPolicy=..)`, also enum +`@Parameter(precedingParamsPolicy=..)`, also enum `DependentDefaultsPolicy` was renamed to `PrecedingParamsPolicy` and enum value `UPDATE_DEPENDENT` was renamed to `RESET`. @@ -25,7 +25,7 @@ CausewayConfiguration also changed: ---- #old causeway.applib.annotation.parameter.dependentDefaultsPolicy=.. -#new +#new causeway.applib.annotation.parameter.precedingParametersPolicy=.. ---- @@ -80,7 +80,7 @@ For more details, see link:https://issues.apache.org/jira/browse/CAUSEWAY-3675[C == Mavendeps webapp module and the GraphQL viewer (CAUSEWAY-3676) The GraphQL viewer is a brand new viewer, automatically exposing your domain object model as a GraphQL API. -For more on this new feature, see the corresponding xref:relnotes::2024/2.0.0-RC5/relnotes.adoc#the-graphql-viewer-causeway-3676[release notes]. +For more on this new feature, see the corresponding xref:relnotes::2024/2.0.0/relnotes.adoc#the-graphql-viewer-causeway-3676[release notes]. As part of this work, the `org.apache.causeway.mavendeps:causeway-mavendeps-webapp` convenience module has been updated. It now references all 3 viewers (Wicket, Restful and GraphQL) as a one-stop shop for bringing in viewers. diff --git a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc index 1e78ff4b37..2109c95e74 100644 --- a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc @@ -1,5 +1,5 @@ -[[r2.0.0-RC5]] -= 2.0.0-RC5 +[[r2.0.0]] += 2.0.0 :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] :page-partial: diff --git a/antora/playbooks/site-comguide.yml b/antora/playbooks/site-comguide.yml index 53145f3188..43e6d6a97f 100644 --- a/antora/playbooks/site-comguide.yml +++ b/antora/playbooks/site-comguide.yml @@ -79,7 +79,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-conguide.yml b/antora/playbooks/site-conguide.yml index 4a16fb143e..6f745a9cab 100644 --- a/antora/playbooks/site-conguide.yml +++ b/antora/playbooks/site-conguide.yml @@ -71,7 +71,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-core.yml b/antora/playbooks/site-core.yml index 95c9355e17..f091efac74 100644 --- a/antora/playbooks/site-core.yml +++ b/antora/playbooks/site-core.yml @@ -96,7 +96,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-docs.yml b/antora/playbooks/site-docs.yml index adf26c5d00..7b28a91c6b 100644 --- a/antora/playbooks/site-docs.yml +++ b/antora/playbooks/site-docs.yml @@ -65,7 +65,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-extensions.yml b/antora/playbooks/site-extensions.yml index 7e9b67aba1..e762135df1 100644 --- a/antora/playbooks/site-extensions.yml +++ b/antora/playbooks/site-extensions.yml @@ -127,7 +127,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-incubator.yml b/antora/playbooks/site-incubator.yml index d0146f486e..9daaf6e341 100644 --- a/antora/playbooks/site-incubator.yml +++ b/antora/playbooks/site-incubator.yml @@ -80,7 +80,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-persistence.yml b/antora/playbooks/site-persistence.yml index eba8a1c3dc..9a392f8b73 100644 --- a/antora/playbooks/site-persistence.yml +++ b/antora/playbooks/site-persistence.yml @@ -79,7 +79,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-refguide.yml b/antora/playbooks/site-refguide.yml index 9dce4e7b18..325b489158 100644 --- a/antora/playbooks/site-refguide.yml +++ b/antora/playbooks/site-refguide.yml @@ -82,7 +82,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-regressiontests.yml b/antora/playbooks/site-regressiontests.yml index 5223b12880..a3f52f7600 100644 --- a/antora/playbooks/site-regressiontests.yml +++ b/antora/playbooks/site-regressiontests.yml @@ -71,7 +71,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-relnotes.yml b/antora/playbooks/site-relnotes.yml index a4ebcaf3b8..9256514a2b 100644 --- a/antora/playbooks/site-relnotes.yml +++ b/antora/playbooks/site-relnotes.yml @@ -69,7 +69,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-security.yml b/antora/playbooks/site-security.yml index e661ef6078..f6f55814f5 100644 --- a/antora/playbooks/site-security.yml +++ b/antora/playbooks/site-security.yml @@ -112,7 +112,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-setupguide.yml b/antora/playbooks/site-setupguide.yml index 12c881b64d..d1a3c8fafb 100644 --- a/antora/playbooks/site-setupguide.yml +++ b/antora/playbooks/site-setupguide.yml @@ -69,7 +69,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-testing.yml b/antora/playbooks/site-testing.yml index 40076d3a11..6f78420d0d 100644 --- a/antora/playbooks/site-testing.yml +++ b/antora/playbooks/site-testing.yml @@ -96,7 +96,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-tooling.yml b/antora/playbooks/site-tooling.yml index 582ceccbba..384f06584b 100644 --- a/antora/playbooks/site-tooling.yml +++ b/antora/playbooks/site-tooling.yml @@ -86,7 +86,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-tutorials.yml b/antora/playbooks/site-tutorials.yml index 208eb9de09..c97824b5be 100644 --- a/antora/playbooks/site-tutorials.yml +++ b/antora/playbooks/site-tutorials.yml @@ -78,7 +78,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-userguide.yml b/antora/playbooks/site-userguide.yml index dc9291b523..546c341abb 100644 --- a/antora/playbooks/site-userguide.yml +++ b/antora/playbooks/site-userguide.yml @@ -83,7 +83,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-valuetypes.yml b/antora/playbooks/site-valuetypes.yml index fec29a0a0c..ce60548b4e 100644 --- a/antora/playbooks/site-valuetypes.yml +++ b/antora/playbooks/site-valuetypes.yml @@ -83,7 +83,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-vro.yml b/antora/playbooks/site-vro.yml index 1d8866fc4e..9abd9e3b85 100644 --- a/antora/playbooks/site-vro.yml +++ b/antora/playbooks/site-vro.yml @@ -77,7 +77,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site-vw.yml b/antora/playbooks/site-vw.yml index 720075cfaf..fc2d9ab150 100644 --- a/antora/playbooks/site-vw.yml +++ b/antora/playbooks/site-vw.yml @@ -83,7 +83,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site.ALL.yml b/antora/playbooks/site.ALL.yml index c18ba14c57..32bfd7759f 100644 --- a/antora/playbooks/site.ALL.yml +++ b/antora/playbooks/site.ALL.yml @@ -302,7 +302,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site.NEXT.yml b/antora/playbooks/site.NEXT.yml index f3d9826038..bf889e1114 100644 --- a/antora/playbooks/site.NEXT.yml +++ b/antora/playbooks/site.NEXT.yml @@ -302,7 +302,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/antora/playbooks/site.yml b/antora/playbooks/site.yml index ba6324f947..7a42a70a7b 100644 --- a/antora/playbooks/site.yml +++ b/antora/playbooks/site.yml @@ -302,7 +302,7 @@ asciidoc: kroki-fetch-diagram: true kroki-server-url: https://kroki.io # (default) page-causewayprev: "2.0.0-RC4" - page-causewayrel: "2.0.0-RC5" + page-causewayrel: "2.0.0" output: dir: antora/target/site diff --git a/core/adoc/modules/_overview/pages/about.adoc b/core/adoc/modules/_overview/pages/about.adoc index a950c060ee..352b501230 100644 --- a/core/adoc/modules/_overview/pages/about.adoc +++ b/core/adoc/modules/_overview/pages/about.adoc @@ -2024,6 +2024,75 @@ org.apache.causeway.persistence:causeway-persistence-jpa-applib:jar:<managed> + == Security +[plantuml,Security,svg] +---- +@startuml +set separator none +title Security - Containers + +left to right direction + +skinparam { + arrowFontSize 10 + defaultTextAlignment center + wrapWidth 200 + maxMessageSize 100 +} + +hide stereotype + +skinparam rectangle<<Security.ApacheCausewaySecuritySimple>> { + BackgroundColor #438dd5 + FontColor #fffffe + BorderColor #2e6295 + shadowing false +} +skinparam rectangle<<Security>> { + BorderColor #9a9a9a + FontColor #9a9a9a + shadowing false +} + +rectangle "Security\n<size:10>[Software System]</size>" <<Security>> { + rectangle "==Apache Causeway Security - Simple\n<size:10>[Container: packaging: jar]</size>" <<Security.ApacheCausewaySecuritySimple>> as Security.ApacheCausewaySecuritySimple +} + +@enduml +---- + +.Projects/Modules (Security) +[cols="3a,5a", options="header"] +|=== +|Coordinates |Description + +|Apache Causeway Security - Simple +[source,yaml] +---- +Group: org.apache.causeway.security +Artifact: causeway-security-simple +Type: jar +Directory: /security/simple +---- +|.Components +**** +o.a.i.security.simple.authentication.SimpleAuthenticator + +o.a.i.security.simple.authorization.SimpleAuthorizor + +o.a.i.security.simple.realm.SimpleRealm + +**** + +.Dependencies +**** +org.apache.causeway.core:causeway-core-internaltestsupport:jar:<managed> + +org.apache.causeway.core:causeway-core-runtimeservices:jar:<managed> + +org.springframework.security:spring-security-crypto:jar:<managed> + +**** + +.Document Index Entries +**** +xref:refguide:security:index/simple/CausewayModuleSecuritySimple.adoc[CausewayModuleSecuritySimple], xref:refguide:security:index/simple/authentication/SimpleAuthenticator.adoc[SimpleAuthenticator], xref:refguide:security:index/simple/authorization/SimpleAuthorizor.adoc[SimpleAuthorizor] +**** +|=== + === Bypass [plantuml,Bypass,svg] @@ -6842,31 +6911,7 @@ Artifact: causeway-regressiontests-base Type: jar Directory: /regressiontests/base ---- -|.Components -**** -o.a.i.testdomain.jdo.JdoInventoryDao + -o.a.i.testdomain.jdo.JdoTestFixtures + -o.a.i.testdomain.jpa.JpaInventoryDao + -o.a.i.testdomain.jpa.JpaTestFixtures + -o.a.i.testdomain.jpa.springdata.EmployeeRepository + -o.a.i.testdomain.model.valuetypes.ValueTypeExampleService + -o.a.i.testdomain.publishing.PublishingTestFactoryAbstract$CommitListener + -o.a.i.testdomain.publishing.PublishingTestFactoryJdo + -o.a.i.testdomain.publishing.PublishingTestFactoryJpa + -o.a.i.testdomain.publishing.subscriber.CommandSubscriberForTesting + -o.a.i.testdomain.publishing.subscriber.EntityChangesSubscriberForTesting + -o.a.i.testdomain.publishing.subscriber.EntityPropertyChangeSubscriberForTesting + -o.a.i.testdomain.publishing.subscriber.ExecutionSubscriberForTesting + -o.a.i.testdomain.util.event.LifecycleEventSubscriberJdoForTesting + -o.a.i.testdomain.util.event.LifecycleEventSubscriberJpaForTesting + -o.a.i.testdomain.util.interaction.DomainObjectTesterFactory + -o.a.i.testdomain.util.interaction.InteractionBoundaryProbe + -o.a.i.testdomain.util.kv.KVStoreForTesting + -o.a.i.testdomain.util.rest.RestEndpointService + -o.a.i.testdomain.wrapperfactory.CounterRepository + -**** - -.Dependencies +|.Dependencies **** org.apache.causeway.extensions:causeway-extensions-fullcalendar-applib:jar:<managed> + org.apache.causeway.extensions:causeway-extensions-secman-encryption-jbcrypt:jar:<managed> + @@ -7349,12 +7394,6 @@ Directory: /incubator/extensions/core/commandreplay/primary ---- |A module for obtaining commands from a primary -.Components -**** -o.a.i.extensions.commandreplay.primary.config.PrimaryConfig + -o.a.i.extensions.commandreplay.primary.spiimpl.CaptureResultOfCommand + -**** - .Dependencies **** org.apache.causeway.core:causeway-core-config:jar:<managed> + @@ -7380,16 +7419,6 @@ Directory: /incubator/extensions/core/commandreplay/secondary |A module providing a Quartz Job to run on a secondary system, for obtaining commands from a primary and saving them so that they are replayed. -.Components -**** -o.a.i.extensions.commandreplay.secondary.analyser.CommandReplayAnalyserException + -o.a.i.extensions.commandreplay.secondary.analyser.CommandReplayAnalyserResult + -o.a.i.extensions.commandreplay.secondary.analysis.CommandReplayAnalysisService + -o.a.i.extensions.commandreplay.secondary.config.SecondaryConfig + -o.a.i.extensions.commandreplay.secondary.fetch.CommandFetcher + -o.a.i.extensions.commandreplay.secondary.job.ReplicateAndReplayJob + -**** - .Dependencies **** org.apache.causeway.core:causeway-core-config:jar:<managed> + diff --git a/incubator/adoc/modules/ROOT/partials/component-nav.adoc b/incubator/adoc/modules/ROOT/partials/component-nav.adoc index a2cd90222a..27cb630d1a 100644 --- a/incubator/adoc/modules/ROOT/partials/component-nav.adoc +++ b/incubator/adoc/modules/ROOT/partials/component-nav.adoc @@ -1,4 +1,3 @@ include::incubator:ROOT:partial$module-nav.adoc[] -include::incubator:graphql:partial$module-nav.adoc[GraphQL Viewer] // include::incubator:commandreplay:partial$module-nav.adoc[Command Replay] diff --git a/mavendeps/adoc/modules/mavendeps/pages/about.adoc b/mavendeps/adoc/modules/mavendeps/pages/about.adoc index 1635ef1c3e..57fe7fd09d 100644 --- a/mavendeps/adoc/modules/mavendeps/pages/about.adoc +++ b/mavendeps/adoc/modules/mavendeps/pages/about.adoc @@ -27,7 +27,7 @@ For convenience, it includes: However, it does _not_ include a security implementation, a viewer implementation or a persistence implementation, which you should add as required: -* security, add _one_ of xref:security:shiro:about.adoc[Shiro], xref:security:spring:about.adoc[Spring], xref:security:keycloak:about.adoc[Keycloak] or xref:security:bypass:about.adoc[Bypass] if prototyping +* security, add _one_ of xref:security:spring:about.adoc[Spring], xref:security:keycloak:about.adoc[Keycloak], xref:security:shiro:about.adoc[Shiro] or xref:security:simple:about.adoc[Simple], xref:security:bypass:about.adoc[Bypass] if prototyping * for persistence, add _one_ of xref:pjpa:ROOT:about.adoc[JPA/Eclipselink] or xref:pjdo:ROOT:about.adoc[JDO/DataNucleus]. diff --git a/security/adoc/modules/ROOT/pages/about.adoc b/security/adoc/modules/ROOT/pages/about.adoc index f5b61afd82..bc81259d33 100644 --- a/security/adoc/modules/ROOT/pages/about.adoc +++ b/security/adoc/modules/ROOT/pages/about.adoc @@ -25,6 +25,7 @@ The framework allows for different authorization mechanisms through the xref:ref There are several implementations of these SPIs to choose from; these make up the bulk of this guide. include::security:bypass:partial$module-nav.adoc[] +include::security:simple:partial$module-nav.adoc[] include::security:shiro:partial$module-nav.adoc[] include::security:keycloak:partial$module-nav.adoc[] include::security:spring:partial$module-nav.adoc[] diff --git a/security/simple/src/main/adoc/modules/simple/pages/about.adoc b/security/simple/src/main/adoc/modules/simple/pages/about.adoc index 0745cb76c7..9fd545da59 100644 --- a/security/simple/src/main/adoc/modules/simple/pages/about.adoc +++ b/security/simple/src/main/adoc/modules/simple/pages/about.adoc @@ -3,8 +3,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] :page-partial: -The simple in-meory implementation, allows both authentication and authorization to be -evaluated against a user provided `SimpleRealm` object. +The simple in-memory implementation, allows both authentication and authorization to be evaluated against a user provided `SimpleRealm` object. include::docs:mavendeps:partial$setup-and-configure-mavendeps-webapp.adoc[leveloffset=+1] @@ -46,7 +45,7 @@ public class AppManifest { .addUser("dick", pwdhash, List.of("reader_role", "order_role")) .addUser("bob", pwdhash, List.of("reader_role", "customer_role")) .addUser("joe", pwdhash, List.of("reader_role")); - } + } } ---- @@ -57,4 +56,4 @@ Make sure that no other `CausewayModuleSecurityXxx` module is imported. With security-simple installed, you should be able to login with credentials that are validated against the `SimpleRealm` as configured. -Password hashes should match the `org.springframework.security.crypto.password.PasswordEncoder` that needs to be registered with _Spring's_ context. +Password hashes should match the `org.springframework.security.crypto.password.PasswordEncoder` that needs to be registered with _Spring's_ context.
