This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/main by this push: new 7dad0324b87 CAUSEWAY-3842: debugs running preview.sh 7dad0324b87 is described below commit 7dad0324b87844550badd38094ad7141d91a0600 Author: Dan Haywood <d...@haywood-associates.co.uk> AuthorDate: Thu Apr 3 23:28:05 2025 +0100 CAUSEWAY-3842: debugs running preview.sh fix for generation of config files --- .../java/net/JavaNetURLConverter.adoc | 39 ++---- core/adoc/modules/_overview/pages/about.adoc | 124 ++++++++++++++---- core/config/generateConfigDocs.groovy | 11 +- .../adoc/modules/config/pages/sections/Other.adoc | 2 +- .../config/pages/sections/causeway.applib.adoc | 142 ++++++++++----------- .../pages/sections/causeway.core.meta-model.adoc | 2 +- .../causeway.core.meta-model.introspector.adoc | 6 +- .../causeway.core.meta-model.validator.adoc | 12 +- .../sections/causeway.core.runtime-services.adoc | 18 +-- .../pages/sections/causeway.core.runtime.adoc | 2 +- .../config/pages/sections/causeway.extensions.adoc | 58 ++++----- .../sections/causeway.persistence.commons.adoc | 6 +- .../sections/causeway.persistence.schema.adoc | 8 +- .../pages/sections/causeway.prototyping.adoc | 6 +- .../pages/sections/causeway.security.keycloak.adoc | 16 +-- .../pages/sections/causeway.security.spring.adoc | 4 +- .../config/pages/sections/causeway.testing.adoc | 4 +- .../pages/sections/causeway.value-types.adoc | 30 ++--- .../pages/sections/causeway.viewer.graphql.adoc | 28 ++-- .../sections/causeway.viewer.restfulobjects.adoc | 22 ++-- .../pages/sections/causeway.viewer.wicket.adoc | 34 ++--- .../modules/config/pages/sections/datanucleus.adoc | 8 +- .../modules/config/pages/sections/eclipselink.adoc | 14 +- .../modules/config/pages/sections/resteasy.adoc | 2 +- 24 files changed, 328 insertions(+), 270 deletions(-) diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime.adoc b/antora/components/refguide-index/modules/persistence/pages/index/jpa/integration/typeconverters/java/net/JavaNetURLConverter.adoc similarity index 60% copy from core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime.adoc copy to antora/components/refguide-index/modules/persistence/pages/index/jpa/integration/typeconverters/java/net/JavaNetURLConverter.adoc index 2da9ba5959d..6297c254e10 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime.adoc +++ b/antora/components/refguide-index/modules/persistence/pages/index/jpa/integration/typeconverters/java/net/JavaNetURLConverter.adoc @@ -1,33 +1,18 @@ -= Core Runtime -:page-role: -toc -narrow - - += JavaNetURLConverter :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 [...] -include::../section-hooks/causeway.core.runtime~pre.adoc[] - -[cols="3a,2a,5a", options="header"] -|=== -|Property -|Default -|Description -| -[[causeway.core.runtime.locale]] -causeway.core.runtime.locale - -| -| If set, then overrides the application's ``Locale#getDefault()`` - - -| -[[causeway.core.runtime.timezone]] -causeway.core.runtime.timezone - -| -| If set, then override's the application's timezone. +Maps an _URL_ to a simple String column in the corresponding database table. +Without this conversion, JPA maps _Serializable_ types to a byte array. +== API -|=== +[source,java] +.JavaNetURLConverter.java +---- +class JavaNetURLConverter { + String convertToDatabaseColumn(URL uuid) + URL convertToEntityAttribute(String datastoreValue) +} +---- -include::../section-hooks/causeway.core.runtime~post.adoc[] diff --git a/core/adoc/modules/_overview/pages/about.adoc b/core/adoc/modules/_overview/pages/about.adoc index 0643ed630b2..f87761dded8 100644 --- a/core/adoc/modules/_overview/pages/about.adoc +++ b/core/adoc/modules/_overview/pages/about.adoc @@ -2282,7 +2282,7 @@ org.springframework.data:spring-data-jpa:jar:<managed> + .Document Index Entries **** -xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayBookmarkConverter.adoc[CausewayBookmarkConverter], xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayLocalResourcePathConverter.adoc[CausewayLocalResourcePathConverter], xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayMarkupConverter.adoc[CausewayMarkupConverter], xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayPasswordConve [...] +xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayBookmarkConverter.adoc[CausewayBookmarkConverter], xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayLocalResourcePathConverter.adoc[CausewayLocalResourcePathConverter], xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayMarkupConverter.adoc[CausewayMarkupConverter], xref:refguide:persistence:index/jpa/integration/typeconverters/applib/CausewayPasswordConve [...] **** |Apache Causeway Persistence - JPA (metamodel) @@ -5226,7 +5226,7 @@ Directory: /extensions/vw/pdfjs/wicket/integration **** org.apache.causeway.extensions:causeway-extensions-pdfjs-applib:jar:<managed> + org.apache.causeway.viewer:causeway-viewer-wicket-ui:jar:<managed> + -org.webjars.npm:pdfjs-dist:jar:4.10.38 + +org.webjars.npm:pdfjs-dist:jar:5.0.375 + **** .Document Index Entries @@ -5846,7 +5846,6 @@ o.a.i.extensions.excel.applib.service.ExcelServiceDefault + org.apache.causeway.core:causeway-applib:jar:<managed> + org.apache.causeway.core:causeway-core-internaltestsupport:jar:<managed> + org.apache.causeway.core:causeway-core-runtime:jar:<managed> + -org.apache.causeway.persistence:causeway-persistence-jdo-applib:jar:<managed> + org.apache.poi:poi-ooxml:jar:<managed> + org.apache.poi:poi-ooxml-lite:jar:<managed> + **** @@ -6892,6 +6891,18 @@ skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsBase>> { BorderColor #2e6295 shadowing false } +skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsBaseJDO>> { + BackgroundColor #438dd5 + FontColor #fffffe + BorderColor #2e6295 + shadowing false +} +skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsBaseJPA>> { + BackgroundColor #438dd5 + FontColor #fffffe + BorderColor #2e6295 + shadowing false +} skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsBootstrapping>> { BackgroundColor #438dd5 FontColor #fffffe @@ -6988,7 +6999,13 @@ skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsPublishingJPA> BorderColor #2e6295 shadowing false } -skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsRest>> { +skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsRestJDO>> { + BackgroundColor #438dd5 + FontColor #fffffe + BorderColor #2e6295 + shadowing false +} +skinparam rectangle<<RegressionTests.ApacheCausewayRegressionTestsRestJPA>> { BackgroundColor #438dd5 FontColor #fffffe BorderColor #2e6295 @@ -7025,6 +7042,8 @@ skinparam rectangle<<RegressionTests>> { } rectangle "Regression Tests\n<size:10>[Software System]</size>" <<RegressionTests>> { + rectangle "==Apache Causeway Regression Tests - Cmd/Exec/Audit/Session - JPA\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionJPA>> as RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionJPA + rectangle "==Apache Causeway Regression Tests - Config\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsConfig>> as RegressionTests.ApacheCausewayRegressionTestsConfig rectangle "==Apache Causeway Regression Tests - Core WrapperFactory\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsCoreWrapperFactory>> as RegressionTests.ApacheCausewayRegressionTestsCoreWrapperFactory rectangle "==Apache Causeway Regression Tests - Cucumber\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsCucumber>> as RegressionTests.ApacheCausewayRegressionTestsCucumber rectangle "==Apache Causeway Regression Tests - Domain Model\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsDomainModel>> as RegressionTests.ApacheCausewayRegressionTestsDomainModel @@ -7033,24 +7052,27 @@ rectangle "Regression Tests\n<size:10>[Software System]</size>" <<RegressionTest rectangle "==Apache Causeway Regression Tests - Interact\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsInteract>> as RegressionTests.ApacheCausewayRegressionTestsInteract rectangle "==Apache Causeway Regression Tests - Layouts\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsLayouts>> as RegressionTests.ApacheCausewayRegressionTestsLayouts rectangle "==Apache Causeway Regression Tests - Persistence (JDO)\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsPersistenceJDO>> as RegressionTests.ApacheCausewayRegressionTestsPersistenceJDO + rectangle "==Apache Causeway Regression Tests\n<size:10>[Container: packaging: pom]</size>" <<RegressionTests.ApacheCausewayRegressionTests>> as RegressionTests.ApacheCausewayRegressionTests rectangle "==Apache Causeway Regression Tests - Persistence (JPA)\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsPersistenceJPA>> as RegressionTests.ApacheCausewayRegressionTestsPersistenceJPA rectangle "==Apache Causeway Regression Tests - Publishing (JPA)\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsPublishingJPA>> as RegressionTests.ApacheCausewayRegressionTestsPublishingJPA - rectangle "==Apache Causeway Regression Tests\n<size:10>[Container: packaging: pom]</size>" <<RegressionTests.ApacheCausewayRegressionTests>> as RegressionTests.ApacheCausewayRegressionTests - rectangle "==Apache Causeway Regression Tests - Rest\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsRest>> as RegressionTests.ApacheCausewayRegressionTestsRest + rectangle "==Apache Causeway Regression Tests - Rest JDO\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsRestJDO>> as RegressionTests.ApacheCausewayRegressionTestsRestJDO + rectangle "==Apache Causeway Regression Tests - Rest JPA\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsRestJPA>> as RegressionTests.ApacheCausewayRegressionTestsRestJPA rectangle "==Apache Causeway Regression Tests - Value Types\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsValueTypes>> as RegressionTests.ApacheCausewayRegressionTestsValueTypes rectangle "==Apache Causeway Regression Tests - Viewers Common\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsViewersCommon>> as RegressionTests.ApacheCausewayRegressionTestsViewersCommon rectangle "==Apache Causeway Regression Tests - Viewers JDO\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsViewersJDO>> as RegressionTests.ApacheCausewayRegressionTestsViewersJDO rectangle "==Apache Causeway Regression Tests - Viewers JPA\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsViewersJPA>> as RegressionTests.ApacheCausewayRegressionTestsViewersJPA rectangle "==Apache Causeway Regression Tests - Base\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsBase>> as RegressionTests.ApacheCausewayRegressionTestsBase + rectangle "==Apache Causeway Regression Tests - Base JDO\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsBaseJDO>> as RegressionTests.ApacheCausewayRegressionTestsBaseJDO + rectangle "==Apache Causeway Regression Tests - Base JPA\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsBaseJPA>> as RegressionTests.ApacheCausewayRegressionTestsBaseJPA rectangle "==Apache Causeway Regression Tests - Bootstrapping\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsBootstrapping>> as RegressionTests.ApacheCausewayRegressionTestsBootstrapping rectangle "==Apache Causeway Regression Tests - Cmd/Exec/Audit/Session\n<size:10>[Container: packaging: pom]</size>" <<RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSession>> as RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSession rectangle "==Apache Causeway Regression Tests - Cmd/Exec/Audit/Session - Generic\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionGeneric>> as RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionGeneric rectangle "==Apache Causeway Regression Tests - Cmd/Exec/Audit/Session - JDO\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionJDO>> as RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionJDO - rectangle "==Apache Causeway Regression Tests - Cmd/Exec/Audit/Session - JPA\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionJPA>> as RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSessionJPA - rectangle "==Apache Causeway Regression Tests - Config\n<size:10>[Container: packaging: jar]</size>" <<RegressionTests.ApacheCausewayRegressionTestsConfig>> as RegressionTests.ApacheCausewayRegressionTestsConfig } RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsBase : "<color:#707070>" +RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsBaseJDO : "<color:#707070>" +RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsBaseJPA : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsBootstrapping : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsCmdExecAuditSession : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsConfig : "<color:#707070>" @@ -7064,7 +7086,8 @@ RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> Regressio RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsPersistenceJDO : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsPersistenceJPA : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsPublishingJPA : "<color:#707070>" -RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsRest : "<color:#707070>" +RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsRestJDO : "<color:#707070>" +RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsRestJPA : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsValueTypes : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsViewersCommon : "<color:#707070>" RegressionTests.ApacheCausewayRegressionTests .[#707070,thickness=2].> RegressionTests.ApacheCausewayRegressionTestsViewersJDO : "<color:#707070>" @@ -7088,7 +7111,8 @@ Artifact: causeway-regressiontests Type: pom Directory: /regressiontests ---- -|Collection of JUnit tests covering core functionalities of the framework. +|Collection of JUnit tests covering core functionalities of the +framework. .Dependencies **** @@ -7134,7 +7158,6 @@ o.a.i.testdomain.wrapperfactory.CounterRepository + org.apache.causeway.extensions:causeway-extensions-fullcalendar-applib:jar:<managed> + org.apache.causeway.extensions:causeway-extensions-secman-encryption-jbcrypt:jar:<managed> + org.apache.causeway.extensions:causeway-extensions-secman-integration:jar:<managed> + -org.apache.causeway.extensions:causeway-extensions-secman-persistence-jdo:jar:<managed> + org.apache.causeway.extensions:causeway-extensions-sse-metamodel:jar:<managed> + org.apache.causeway.mavendeps:causeway-mavendeps-webapp:pom:<managed> + org.apache.causeway.persistence:causeway-persistence-commons:jar:<managed> + @@ -7150,6 +7173,44 @@ org.apache.causeway.viewer:causeway-viewer-wicket-viewer:jar:<managed> + org.apache.wicket:wicket-tester:jar:<managed> + **** +|Apache Causeway Regression Tests - Base JDO +[source,yaml] +---- +Group: org.apache.causeway.regressiontests +Artifact: causeway-regressiontests-base-jdo +Type: jar +Directory: /regressiontests/base-jdo +---- +|.Dependencies +**** +org.apache.causeway.extensions:causeway-extensions-secman-persistence-jdo:jar:<managed> + +org.apache.causeway.mavendeps:causeway-mavendeps-webapp:pom:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-restfulobjects-client:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-restfulobjects-jaxrsresteasy:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-wicket-viewer:jar:<managed> + +**** + +|Apache Causeway Regression Tests - Base JPA +[source,yaml] +---- +Group: org.apache.causeway.regressiontests +Artifact: causeway-regressiontests-base-jpa +Type: jar +Directory: /regressiontests/base-jpa +---- +|.Dependencies +**** +org.apache.causeway.extensions:causeway-extensions-secman-persistence-jpa:jar:<managed> + +org.apache.causeway.mavendeps:causeway-mavendeps-webapp:pom:<managed> + +org.apache.causeway.persistence:causeway-persistence-jpa-eclipselink:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-restfulobjects-client:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-restfulobjects-jaxrsresteasy:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-wicket-viewer:jar:<managed> + +**** + |Apache Causeway Regression Tests - Bootstrapping [source,yaml] ---- @@ -7360,8 +7421,7 @@ Directory: /regressiontests/persistence-jdo ---- |.Dependencies **** -org.apache.causeway.persistence:causeway-persistence-jdo-datanucleus:jar:<managed> + -org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base-jdo:jar:<managed> + org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + **** @@ -7376,7 +7436,7 @@ Directory: /regressiontests/persistence-jpa |.Dependencies **** org.apache.causeway.persistence:causeway-persistence-jpa-eclipselink:jar:<managed> + -org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base-jpa:jar:<managed> + org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + **** @@ -7391,24 +7451,42 @@ Directory: /regressiontests/publishing-jpa |.Dependencies **** org.apache.causeway.persistence:causeway-persistence-jpa-eclipselink:jar:<managed> + -org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base-jpa:jar:<managed> + org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + **** -|Apache Causeway Regression Tests - Rest +|Apache Causeway Regression Tests - Rest JDO [source,yaml] ---- Group: org.apache.causeway.regressiontests -Artifact: causeway-regressiontests-rest +Artifact: causeway-regressiontests-rest-jdo Type: jar -Directory: /regressiontests/rest +Directory: /regressiontests/rest-jdo ---- |.Dependencies **** org.apache.causeway.extensions:causeway-extensions-cors-impl:jar:<managed> + org.apache.causeway.mavendeps:causeway-mavendeps-webapp:pom:<managed> + -org.apache.causeway.persistence:causeway-persistence-jdo-datanucleus:jar:<managed> + -org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base-jdo:jar:<managed> + +org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-restfulobjects-client:jar:<managed> + +org.apache.causeway.viewer:causeway-viewer-restfulobjects-jaxrsresteasy:jar:<managed> + +**** + +|Apache Causeway Regression Tests - Rest JPA +[source,yaml] +---- +Group: org.apache.causeway.regressiontests +Artifact: causeway-regressiontests-rest-jpa +Type: jar +Directory: /regressiontests/rest-jpa +---- +|.Dependencies +**** +org.apache.causeway.extensions:causeway-extensions-cors-impl:jar:<managed> + +org.apache.causeway.mavendeps:causeway-mavendeps-webapp:pom:<managed> + +org.apache.causeway.persistence:causeway-persistence-jpa-eclipselink:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base-jpa:jar:<managed> + org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + org.apache.causeway.viewer:causeway-viewer-restfulobjects-client:jar:<managed> + org.apache.causeway.viewer:causeway-viewer-restfulobjects-jaxrsresteasy:jar:<managed> + @@ -7453,8 +7531,7 @@ Directory: /regressiontests/viewers-jdo |.Dependencies **** org.apache.causeway.mavendeps:causeway-mavendeps-webapp:pom:<managed> + -org.apache.causeway.persistence:causeway-persistence-jdo-datanucleus:jar:<managed> + -org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base-jdo:jar:<managed> + org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + org.apache.causeway.viewer:causeway-viewer-wicket-viewer:jar:<managed> + **** @@ -7470,8 +7547,7 @@ Directory: /regressiontests/viewers-jpa |.Dependencies **** org.apache.causeway.mavendeps:causeway-mavendeps-webapp:pom:<managed> + -org.apache.causeway.persistence:causeway-persistence-jpa-eclipselink:jar:<managed> + -org.apache.causeway.regressiontests:causeway-regressiontests-base:jar:<managed> + +org.apache.causeway.regressiontests:causeway-regressiontests-base-jpa:jar:<managed> + org.apache.causeway.testing:causeway-testing-fixtures-applib:jar:<managed> + org.apache.causeway.viewer:causeway-viewer-wicket-viewer:jar:<managed> + **** diff --git a/core/config/generateConfigDocs.groovy b/core/config/generateConfigDocs.groovy index 97c8ae49321..0c6fbe460a3 100644 --- a/core/config/generateConfigDocs.groovy +++ b/core/config/generateConfigDocs.groovy @@ -382,22 +382,19 @@ static String toAsciidoc(String str) { str = str.replaceAll( /\{@link[ ]+(?:[^ }]+)[^}]+?[ ]+([^})]+)}/, '$1') // {@link org.apache.causeway.applib.events.lifecycle.ObjectLoadedEvent.Noop ObjectLoadedEvent.Noop}: ObjectLoadedEvent.Noop str = str.replaceAll( /\{@link[ ]+?(?:[^ }]+?[ ]+?([^})]+))}/, '$1') // {@link Foo foo bar} and {@link Foo#bar foo bar} : "foo bar" str = str.replaceAll( /\{@link[ ]+?(?:[^}]+?[ ]+?([^})]+))}/, '$1') // {@link Foo#bar(abc, def) foo bar} and {@link Foo#bar() foo bar} : "foo bar" ; - str = str.replaceAll( /\{@link (?:(?:[^} ]|[.])+[.])*([^}]+)}/, '``$1``') // {@link org.apache.causeway.applib.annotation.Action#domainEvent()} : ``Action#domainEvent()`` - str = str.replaceAll( /<tt>(?:(?:[^<]|[.])+[.])*([^<]+)<\/tt>/, '``$1``') - str = str.replaceAll( /<code>(?:(?:[^<]|[.])+[.])*([^<]+)<\/code>/, '``$1``') + str = str.replaceAll( /\{@link (?:(?:[^} ]|[.])+[.])*([^}]+)}/, '<tt>$1</tt>') // {@link org.apache.causeway.applib.annotation.Action#domainEvent()} : <tt>Action#domainEvent()</tt> + str = str.replaceAll( /<tt>(?:(?:[^<]|[.])+[.])*([^<]+)<\/tt>/, '<tt>$1</tt>') + str = str.replaceAll( /<code>(?:(?:[^<]|[.])+[.])*([^<]+)<\/code>/, '<tt>$1</tt>') str = str.replaceAll( /@apiNote -/, 'TIP:') str = str.replaceAll( /@apiNote/, 'TIP:') str = str.replaceAll( /@implNote -/, 'NOTE:') str = str.replaceAll( /@implNote/, 'NOTE:') - str = str.replaceAll( /<tt>/, '`') - str = str.replaceAll( /<\/tt>/, '`') - str = str.replaceAll( /<code>/, '`') - str = str.replaceAll( /<\/code>/, '`') File tf = File.createTempFile("input",".html") tf.write(str) // write to the file if (str.contains("@link")) { + // debugging... there shouldn't be any @link left System.out.println(str); } diff --git a/core/config/src/main/adoc/modules/config/pages/sections/Other.adoc b/core/config/src/main/adoc/modules/config/pages/sections/Other.adoc index aec315522e4..b0f472f2eab 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/Other.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/Other.adoc @@ -17,7 +17,7 @@ causeway.schema.command. + param-identifier-strategy | by-id -| Whether the ``ParamDto#getName()`` field - which uniquely identifies a parameter within the action's of parameters - is populated with the parameter's formal Id (eg "firstName") or instead using the parameter's friendly name (eg "First Name"). +| Whether the `ParamDto#getName()` field - which uniquely identifies a parameter within the action's of parameters - is populated with the parameter's formal Id (eg "firstName") or instead using the parameter's friendly name (eg "First Name"). The default is to use the Id, but the name is provided as an alternative for compatibility with v1. Note that the name is potentially translated, so this could also cause issues within integration scenarios. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc index 5efa815812c..918d3dd599a 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.applib.adoc @@ -103,7 +103,7 @@ disk, switch.*:fa-exchange, random. + Providing a default set of patterns encourages a common set of verbs to be used. -The font awesome class for individual actions can be overridden using ``ActionLayout#cssClassFa()``. +The font awesome class for individual actions can be overridden using `ActionLayout#cssClassFa()`. | @@ -137,7 +137,7 @@ action-layout.css-class.patterns Providing a default set of patterns encourages a common set of verbs to be used. -The CSS class for individual actions can be overridden using ``ActionLayout#cssClass()``. +The CSS class for individual actions can be overridden using `ActionLayout#cssClass()`. | @@ -156,9 +156,9 @@ causeway.applib.annotation.action. + command-publishing | none -| The default for whether action invocations should be reified as a ``Command``, to be sent to any registered ``CommandSubscriber``s, typically for auditing purposes. +| The default for whether action invocations should be reified as a `Command`, to be sent to any registered `CommandSubscriber`s, typically for auditing purposes. -This setting can be overridden on a case-by-case basis using ``Action#commandPublishing()``. +This setting can be overridden on a case-by-case basis using `Action#commandPublishing()`. | @@ -167,11 +167,11 @@ causeway.applib.annotation.action. + domain-event.post-for-default | true -| Influences whether an ``ActionDomainEvent`` should be published (on the internal ``EventBusService``) whenever an action is being interacted with. +| Influences whether an `ActionDomainEvent` should be published (on the internal `EventBusService`) whenever an action is being interacted with. Up to five different events can be fired during an interaction, with the event's phase determining which (hide, disable, validate, executing and executed). Subscribers can influence the behaviour at each of these phases. -The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the ``Action#domainEvent()`` for the action in question +The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the `Action#domainEvent()` for the action in question * If set to some subtype of ActionDomainEvent.Noop, then _no_ event is sent. * If set to some subtype of ActionDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -184,11 +184,11 @@ causeway.applib.annotation.action. + execution-publishing | none -| The default for whether action invocations should be sent through to the ``ExecutionSubscriber`` for publishing. +| The default for whether action invocations should be sent through to the `ExecutionSubscriber` for publishing. -The service's onExecution method is called only once per transaction, with ``Execution`` collecting details of the identity of the target object, the action invoked, the action arguments and the returned object (if any). +The service's onExecution method is called only once per transaction, with `Execution` collecting details of the identity of the target object, the action invoked, the action arguments and the returned object (if any). -This setting can be overridden on a case-by-case basis using ``Action#executionPublishing() Action#executionPublishing()``. +This setting can be overridden on a case-by-case basis using `Action#executionPublishing() Action#executionPublishing()`. | @@ -199,7 +199,7 @@ collection-layout.default-view | table | Defines the initial view to display collections when rendered. -The value of this can be overridden on a case-by-case basis using ``CollectionLayout#defaultView()``. Note that this default configuration property is an enum and so defines only a fixed number of values, whereas the annotation returns a string; this is to allow for flexibility that individual viewers might support their own additional types. For example, the Wicket viewer supports +The value of this can be overridden on a case-by-case basis using `CollectionLayout#defaultView()`. Note that this default configuration property is an enum and so defines only a fixed number of values, whereas the annotation returns a string; this is to allow for flexibility that individual viewers might support their own additional types. For example, the Wicket viewer supports which can render objects that have a date on top of a calendar view. | @@ -210,7 +210,7 @@ collection-layout.paged | 12 | Defines the default number of objects that are shown in a "parented" collection of a domain object, result of invoking an action. -This can be overridden on a case-by-case basis using ``CollectionLayout#paged()``. +This can be overridden on a case-by-case basis using `CollectionLayout#paged()`. | @@ -220,9 +220,9 @@ collection-layout. + sequence-policy-if-unreferenced | -| How ``CollectionLayout#sequence()`` should be handled when calculating the slot-in order for unreferenced _Collections_. \{@code AS_PER_SEQUENCE} will use Dewey order based on available 'sequence' attributes, whereas \{@code ALPHABETICALLY} will use alphabetical order based on member names. +| How `CollectionLayout#sequence()` should be handled when calculating the slot-in order for unreferenced _Collections_. ++{++@code AS++_++PER++_++SEQUENCE} will use Dewey order based on available 'sequence' attributes, whereas ++{++@code ALPHABETICALLY} will use alphabetical order based on member names. -default: \{@code AS_PER_SEQUENCE} +default: ++{++@code AS++_++PER++_++SEQUENCE} | @@ -241,11 +241,11 @@ collection.domain-event. + post-for-default | true -| Influences whether an ``CollectionDomainEvent`` should be published (on the internal ``EventBusService``) whenever a collection is being interacted with. +| Influences whether an `CollectionDomainEvent` should be published (on the internal `EventBusService`) whenever a collection is being interacted with. Up to two different events can be fired during an interaction, with the event's phase determining which (hide, disable)Subscribers can influence the behaviour at each of these phases. -The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the ``Collection#domainEvent()`` for the collection action in question: +The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the `Collection#domainEvent()` for the collection action in question: * If set to some subtype of CollectionDomainEvent.Noop, then _no_ event is sent. * If set to some subtype of CollectionDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -260,15 +260,15 @@ css-class-ui-event. + post-for-default | -| Influences whether an ``CssClassUiEvent`` should be published (on the internal ``EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``CssClassUiEvent#setCssClass(String)`` change) the CSS classes that are used. +| Influences whether an `CssClassUiEvent` should be published (on the internal `EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `CssClassUiEvent#setCssClass(String)` change) the CSS classes that are used. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#cssClassUiEvent()`` @DomainObjectLayout(cssClassEvent=...)} for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `DomainObjectLayout#cssClassUiEvent()` @DomainObjectLayout(cssClassEvent=...)} for the domain object in question. * If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent. * If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. * If set to any other subtype, then an event _is_ sent. -The default is ``false``, because otherwise the mere presence of ``@DomainObjectLayout`` (perhaps for some attribute other than this one) will cause any imperative ``cssClass()`` method to be ignored. +The default is `false`, because otherwise the mere presence of `@DomainObjectLayout` (perhaps for some attribute other than this one) will cause any imperative `cssClass()` method to be ignored. | @@ -278,15 +278,15 @@ domain-object-layout.icon-ui-event. + post-for-default | -| Influences whether an ``IconUiEvent`` should be published (on the internal ``EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``IconUiEvent#setIconName(String)`` change) the icon that is used. +| Influences whether an `IconUiEvent` should be published (on the internal `EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `IconUiEvent#setIconName(String)` change) the icon that is used. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#iconUiEvent()`` @DomainObjectLayout(iconEvent=...)} for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `DomainObjectLayout#iconUiEvent()` @DomainObjectLayout(iconEvent=...)} for the domain object in question. * If set to some subtype of IconUiEvent.Noop, then _no_ event is sent. * If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. * If set to any other subtype, then an event _is_ sent. -The default is ``false``, because otherwise the mere presence of ``@DomainObjectLayout`` (perhaps for some attribute other than this one) will cause any imperative ``iconName()`` method to be ignored. +The default is `false`, because otherwise the mere presence of `@DomainObjectLayout` (perhaps for some attribute other than this one) will cause any imperative `iconName()` method to be ignored. | @@ -296,17 +296,17 @@ domain-object-layout. + layout-ui-event.post-for-default | -| Influences whether an ``LayoutUiEvent`` should be published (on the internal ``EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``LayoutUiEvent#setLayout(String)`` change) the layout that is used. +| Influences whether an `LayoutUiEvent` should be published (on the internal `EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `LayoutUiEvent#setLayout(String)` change) the layout that is used. -If a different layout value has been set, then a layout in the form ``xml`` use used (where ``zzz`` is the name of the layout). +If a different layout value has been set, then a layout in the form `xml` use used (where `zzz` is the name of the layout). -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#layoutUiEvent()`` @DomainObjectLayout(layoutEvent=...)} for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `DomainObjectLayout#layoutUiEvent()` @DomainObjectLayout(layoutEvent=...)} for the domain object in question. * If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent. * If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. * If set to any other subtype, then an event _is_ sent. -The default is ``false``, because otherwise the mere presence of ``@DomainObjectLayout`` (perhaps for some attribute other than this one) will cause any imperative ``layout()`` method to be ignored. +The default is `false`, because otherwise the mere presence of `@DomainObjectLayout` (perhaps for some attribute other than this one) will cause any imperative `layout()` method to be ignored. | @@ -317,7 +317,7 @@ domain-object-layout.paged | 25 | Defines the default number of objects that are shown in a "standalone" collection obtained as the result of invoking an action. -This can be overridden on a case-by-case basis using ``DomainObjectLayout#paged()``. +This can be overridden on a case-by-case basis using `DomainObjectLayout#paged()`. | @@ -337,15 +337,15 @@ domain-object-layout. + title-ui-event.post-for-default | -| Influences whether an ``TitleUiEvent`` should be published (on the internal ``EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``TitleUiEvent#setTitle(String)`` change) the title that is used. +| Influences whether an `TitleUiEvent` should be published (on the internal `EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `TitleUiEvent#setTitle(String)` change) the title that is used. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#titleUiEvent()`` @DomainObjectLayout(titleEvent=...)} for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `DomainObjectLayout#titleUiEvent()` @DomainObjectLayout(titleEvent=...)} for the domain object in question. * If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent. * If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. * If set to any other subtype, then an event _is_ sent. -The default is ``false``, because otherwise the mere presence of ``@DomainObjectLayout`` (perhaps for some attribute other than this one) will cause any imperative ``title()`` method to be ignored. +The default is `false`, because otherwise the mere presence of `@DomainObjectLayout` (perhaps for some attribute other than this one) will cause any imperative `title()` method to be ignored. | @@ -356,9 +356,9 @@ created-lifecycle-event. + post-for-default | true -| Influences whether an ``ObjectCreatedEvent`` should be published (on the internal ``EventBusService``) whenever a domain object has been created using ``FactoryService``. +| Influences whether an `ObjectCreatedEvent` should be published (on the internal `EventBusService`) whenever a domain object has been created using `FactoryService`. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...)`` for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question. * If set to some subtype of ObjectCreatedEvent.Noop, then _no_ event is sent. * If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -373,7 +373,7 @@ domain-object.editing | false | The default for whether the properties of domain objects can be edited, or whether instead they can be modified only using actions (or programmatically as a side-effect of actions on other objects). -This setting can be overridden on a case-by-case basis using ``DomainObject#getEditing() DomainObject#getEditing()`` +This setting can be overridden on a case-by-case basis using `DomainObject#getEditing() DomainObject#getEditing()` | @@ -383,9 +383,9 @@ domain-object. + entity-change-publishing | none -| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to ``EntityChangesSubscriber``s and sent through to ``EntityPropertyChangeSubscriber``. +| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to `EntityChangesSubscriber`s and sent through to `EntityPropertyChangeSubscriber`. -This setting can be overridden on a case-by-case basis using ``DomainObject#entityChangePublishing()`` +This setting can be overridden on a case-by-case basis using `DomainObject#entityChangePublishing()` Note: this applies only to domain entities, not view models. @@ -398,9 +398,9 @@ loaded-lifecycle-event. + post-for-default | true -| Influences whether an ``ObjectLoadedEvent`` should be published (on the internal ``EventBusService``) whenever a domain _entity_ has been loaded from the persistence store. +| Influences whether an `ObjectLoadedEvent` should be published (on the internal `EventBusService`) whenever a domain _entity_ has been loaded from the persistence store. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObject#loadedLifecycleEvent() @DomainObject(loadedLifecycleEvent=...)`` for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question. * If set to some subtype of ObjectLoadedEvent.Noop, then _no_ event is sent. * If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -417,9 +417,9 @@ persisted-lifecycle-event. + post-for-default | true -| Influences whether an ``ObjectPersistedEvent`` should be published (on the internal ``EventBusService``) whenever a domain _entity_ has been persisted (for the first time) to the persistence store. +| Influences whether an `ObjectPersistedEvent` should be published (on the internal `EventBusService`) whenever a domain _entity_ has been persisted (for the first time) to the persistence store. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObject#persistedLifecycleEvent() @DomainObject(persistedLifecycleEvent=...)`` for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question. * If set to some subtype of ObjectPersistedEvent.Noop, then _no_ event is sent. * If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -436,9 +436,9 @@ persisting-lifecycle-event. + post-for-default | true -| Influences whether an ``ObjectPersistingEvent`` should be published (on the internal ``EventBusService``) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store. +| Influences whether an `ObjectPersistingEvent` should be published (on the internal `EventBusService`) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObject#persistingLifecycleEvent() @DomainObject(persistingLifecycleEvent=...)`` for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question. * If set to some subtype of ObjectPersistingEvent.Noop, then _no_ event is sent. * If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -455,9 +455,9 @@ removing-lifecycle-event. + post-for-default | true -| Influences whether an ``ObjectRemovingEvent`` should be published (on the internal ``EventBusService``) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store. +| Influences whether an `ObjectRemovingEvent` should be published (on the internal `EventBusService`) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObject#removingLifecycleEvent() @DomainObject(removingLifecycleEvent=...)`` for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question. * If set to some subtype of ObjectRemovingEvent.Noop, then _no_ event is sent. * If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -465,7 +465,7 @@ The algorithm for determining whether (and what type of) an event is sent depend Note: this applies only to domain entities, not to view models. -Note: There is no corresponding ``removed`` callback, because (for the JDO persistence store at least) it is not possible to interact with a domain entity once it has been deleted. +Note: There is no corresponding `removed` callback, because (for the JDO persistence store at least) it is not possible to interact with a domain entity once it has been deleted. | @@ -476,9 +476,9 @@ updated-lifecycle-event. + post-for-default | true -| Influences whether an ``ObjectUpdatedEvent`` should be published (on the internal ``EventBusService``) whenever a persistent domain _entity_ has been updated in the persistence store. +| Influences whether an `ObjectUpdatedEvent` should be published (on the internal `EventBusService`) whenever a persistent domain _entity_ has been updated in the persistence store. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObject#updatedLifecycleEvent() @DomainObject(updatedLifecycleEvent=...)`` for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question. * If set to some subtype of ObjectUpdatedEvent.Noop, then _no_ event is sent. * If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -495,9 +495,9 @@ updating-lifecycle-event. + post-for-default | true -| Influences whether an ``ObjectUpdatingEvent`` should be published (on the internal ``EventBusService``) whenever a persistent domain _entity_ is about to be updated in the persistence store. +| Influences whether an `ObjectUpdatingEvent` should be published (on the internal `EventBusService`) whenever a persistent domain _entity_ is about to be updated in the persistence store. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObject#updatingLifecycleEvent() @DomainObject(updatingLifecycleEvent=...)`` for the domain object in question. +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question. * If set to some subtype of ObjectUpdatingEvent.Noop, then _no_ event is sent. * If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -514,9 +514,9 @@ parameter-layout.label-position | not-specified | Defines the default position for the label for an action parameter. -Can be overridden on a case-by-case basis using ``ParameterLayout#labelPosition()``. +Can be overridden on a case-by-case basis using `ParameterLayout#labelPosition()`. -If left as ``LabelPosition#NOT_SPECIFIED`` and not overridden, then the position depends upon the viewer implementation. +If left as `LabelPosition#NOT++_++SPECIFIED` and not overridden, then the position depends upon the viewer implementation. | @@ -528,7 +528,7 @@ preceding-parameters-policy | reset | Whether parameters should be reset to their default if an earlier parameter changes its value, or whether instead a parameter value, once changed by the end-user, should never be overwritten even if the end-user changes an earlier parameter value. -This setting can be overridden on a case-by-case basis using ``Parameter#precedingParamsPolicy() Parameter#precedingParametersPolicy()``. +This setting can be overridden on a case-by-case basis using `Parameter#precedingParamsPolicy() Parameter#precedingParametersPolicy()`. | @@ -539,9 +539,9 @@ property-layout.label-position | not-specified | Defines the default position for the label for a domain object property. -Can be overridden on a case-by-case basis using ``ParameterLayout#labelPosition()``. +Can be overridden on a case-by-case basis using `ParameterLayout#labelPosition()`. -If left as ``LabelPosition#NOT_SPECIFIED`` and not overridden, then the position depends upon the viewer implementation. +If left as `LabelPosition#NOT++_++SPECIFIED` and not overridden, then the position depends upon the viewer implementation. | @@ -551,9 +551,9 @@ property-layout. + sequence-policy-if-unreferenced | -| How ``PropertyLayout#sequence()`` should be handled when calculating the slot-in order for unreferenced _Properties_. \{@code AS_PER_SEQUENCE} will use Dewey order based on available 'sequence' attributes, whereas \{@code ALPHABETICALLY} will use alphabetical order based on member names. +| How `PropertyLayout#sequence()` should be handled when calculating the slot-in order for unreferenced _Properties_. ++{++@code AS++_++PER++_++SEQUENCE} will use Dewey order based on available 'sequence' attributes, whereas ++{++@code ALPHABETICALLY} will use alphabetical order based on member names. -default: \{@code AS_PER_SEQUENCE} +default: ++{++@code AS++_++PER++_++SEQUENCE} | @@ -562,9 +562,9 @@ causeway.applib.annotation. + property.command-publishing | none -| The default for whether property edits should be reified as a ``Command``, to be sent to any registered ``CommandSubscriber``s, either for auditing or for replayed against a secondary system, eg for regression testing. +| The default for whether property edits should be reified as a `Command`, to be sent to any registered `CommandSubscriber`s, either for auditing or for replayed against a secondary system, eg for regression testing. -This setting can be overridden on a case-by-case basis using ``Property#commandPublishing()``. +This setting can be overridden on a case-by-case basis using `Property#commandPublishing()`. | @@ -574,11 +574,11 @@ property.domain-event. + post-for-default | true -| Influences whether an ``PropertyDomainEvent`` should be published (on the internal ``EventBusService``) whenever an property is being interacted with. +| Influences whether an `PropertyDomainEvent` should be published (on the internal `EventBusService`) whenever an property is being interacted with. Up to five different events can be fired during an interaction, with the event's phase determining which (hide, disable, validate, executing and executed). Subscribers can influence the behaviour at each of these phases. -The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the ``Property#domainEvent()`` for the property in question: +The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the `Property#domainEvent()` for the property in question: * If set to some subtype of propertyDomainEvent.Noop, then _no_ event is sent. * If set to some subtype of propertyDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -591,11 +591,11 @@ causeway.applib.annotation. + property.execution-publishing | none -| The default for whether property edits should be sent through to the ``ExecutionSubscriber`` for publishing. +| The default for whether property edits should be sent through to the `ExecutionSubscriber` for publishing. -The service's ``ExecutionSubscriber#onExecution(Execution)`` publish} method is called only once per transaction, with ``Execution`` collecting details of the identity of the target object, the property edited, and the new value of the property. +The service's `ExecutionSubscriber#onExecution(Execution)` publish} method is called only once per transaction, with `Execution` collecting details of the identity of the target object, the property edited, and the new value of the property. -This setting can be overridden on a case-by-case basis using ``Property#executionPublishing()``. +This setting can be overridden on a case-by-case basis using `Property#executionPublishing()`. | @@ -606,9 +606,9 @@ css-class-ui-event. + post-for-default | true -| Influences whether an ``CssClassUiEvent`` should be published (on the internal ``EventBusService``) whenever a view model (annotated with @DomainObject#nature of ``Nature#VIEW_MODEL``) is about to be rendered in the UI - thereby allowing subscribers to optionally ``CssClassUiEvent#setCssClass(String)`` change) the CSS classes that are used. +| Influences whether an `CssClassUiEvent` should be published (on the internal `EventBusService`) whenever a view model (annotated with @DomainObject#nature of `Nature#VIEW++_++MODEL`) is about to be rendered in the UI - thereby allowing subscribers to optionally `CssClassUiEvent#setCssClass(String)` change) the CSS classes that are used. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#cssClassUiEvent() @DomainObjectLayout(cssClassEvent=...)`` for the domain object in question: +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question: * If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent. * If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -622,9 +622,9 @@ view-model-layout.icon-ui-event. + post-for-default | true -| Influences whether an ``IconUiEvent`` should be published (on the internal ``EventBusService``) whenever a view model (annotated with @DomainObject#nature of ``Nature#VIEW_MODEL``) is about to be rendered in the UI - thereby allowing subscribers to optionally ``IconUiEvent#setIconName(String)`` change) the icon that is used. +| Influences whether an `IconUiEvent` should be published (on the internal `EventBusService`) whenever a view model (annotated with @DomainObject#nature of `Nature#VIEW++_++MODEL`) is about to be rendered in the UI - thereby allowing subscribers to optionally `IconUiEvent#setIconName(String)` change) the icon that is used. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#iconUiEvent() @ViewModelLayout(iconEvent=...)`` for the domain object in question: +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question: * If set to some subtype of IconUiEvent.Noop, then _no_ event is sent. * If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -638,11 +638,11 @@ view-model-layout.layout-ui-event. + post-for-default | true -| Influences whether an ``LayoutUiEvent`` should be published (on the internal ``EventBusService``) whenever a view model (annotated with @DomainObject#nature of ``Nature#VIEW_MODEL``) is about to be rendered in the UI - thereby allowing subscribers to optionally ``LayoutUiEvent#setLayout(String)`` change) the layout that is used. +| Influences whether an `LayoutUiEvent` should be published (on the internal `EventBusService`) whenever a view model (annotated with @DomainObject#nature of `Nature#VIEW++_++MODEL`) is about to be rendered in the UI - thereby allowing subscribers to optionally `LayoutUiEvent#setLayout(String)` change) the layout that is used. -If a different layout value has been set, then a layout in the form ``xml`` use used (where ``zzz`` is the name of the layout). +If a different layout value has been set, then a layout in the form `xml` use used (where `zzz` is the name of the layout). -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#layoutUiEvent() @DomainObjectLayout(layoutEvent=...)`` for the domain object in question: +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question: * If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent. * If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -656,9 +656,9 @@ view-model-layout.title-ui-event. + post-for-default | true -| Influences whether an ``TitleUiEvent`` should be published (on the internal ``EventBusService``) whenever a view model (annotated with @DomainObject#nature of ``Nature#VIEW_MODEL``) is about to be rendered in the UI - thereby allowing subscribers to optionally ``TitleUiEvent#setTitle(String)`` change) the title that is used. +| Influences whether an `TitleUiEvent` should be published (on the internal `EventBusService`) whenever a view model (annotated with @DomainObject#nature of `Nature#VIEW++_++MODEL`) is about to be rendered in the UI - thereby allowing subscribers to optionally `TitleUiEvent#setTitle(String)` change) the title that is used. -The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``DomainObjectLayout#titleUiEvent() @DomainObjectLayout(titleEvent=...)`` for the domain object in question: +The algorithm for determining whether (and what type of) an event is sent depends on the value of the `)` for the domain object in question: * If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent. * If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set. @@ -672,7 +672,7 @@ view-model.validation. + semantic-checking.enable | -| Whether to check for inconsistencies between the usage of ``DomainObject`` and ``DomainObjectLayout``. +| Whether to check for inconsistencies between the usage of `DomainObject` and `DomainObjectLayout`. | diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.adoc index a27314a92c1..11a4a725fda 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.adoc @@ -29,7 +29,7 @@ programming-model. + ignore-deprecated | -| If set, then any aspects of the programming model (as implemented by ``FacetFactory``s that have been indicated as deprecated will simply be ignored/excluded from the metamodel. +| If set, then any aspects of the programming model (as implemented by `FacetFactory`s that have been indicated as deprecated will simply be ignored/excluded from the metamodel. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.introspector.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.introspector.adoc index de5e479634f..2551241578a 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.introspector.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.introspector.adoc @@ -20,7 +20,7 @@ lock-after-full-introspection | true | If true, then no new specifications will be allowed to be loaded once introspection has been complete. -Only applies if the introspector is configured to perform full introspection up-front (either because of ``IntrospectionMode#FULL`` or ``IntrospectionMode#LAZY_UNLESS_PRODUCTION`` when in production); otherwise is ignored. +Only applies if the introspector is configured to perform full introspection up-front (either because of `IntrospectionMode#FULL` or `IntrospectionMode#LAZY++_++UNLESS++_++PRODUCTION` when in production); otherwise is ignored. | @@ -31,7 +31,7 @@ introspector.mode | lazy-unless-production | Whether all known types should be fully introspected as part of the bootstrapping, or should only be partially introspected initially. -Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless ``#isValidateIncrementally()`` is disabled. +Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless `#isValidateIncrementally()` is disabled. | @@ -67,7 +67,7 @@ validate-incrementally This does _not_ apply if the introspector is configured to perform full introspection up-front AND when the metamodel is locked after initial bootstrapping (because in that case the lock check will simply prevent any new specs from being loaded). But it will apply otherwise. -In particular, this setting _can_ still apply even if the mode is set to full, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the ``WrapperFactory`` - this will cause introspection of that new type to be performed. +In particular, this setting _can_ still apply even if the mode is set to full, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the `WrapperFactory` - this will cause introspection of that new type to be performed. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.validator.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.validator.adoc index 000cf818c6b..7b7ecbcc487 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.validator.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.meta-model.validator.adoc @@ -40,7 +40,7 @@ causeway.core.meta-model.validator. + allow-logical-type-name-as-alias | -| Allows logical type name in ``Named`` also be included in the list of ``DomainObject#aliased()`` or ``DomainService#aliased()``. +| Allows logical type name in `Named` also be included in the list of `DomainObject#aliased()` or `DomainService#aliased()`. It is _highly advisable_ to leave this disabled. This option is meant as a practical way to enable to transition from old names to new logical type names. Especially when you have a large number of files that have to migrated and you want to do the migration in incremental steps. @@ -51,7 +51,7 @@ causeway.core.meta-model.validator. + explicit-logical-type-names | -| Whether to ensure that the logical-type-name of all objects must be specified explicitly, using either ``Named``. +| Whether to ensure that the logical-type-name of all objects must be specified explicitly, using either `Named`. It is _highly advisable_ to leave this set as enabled (the default). These logical-type-names should also (of course) be unique - among non-abstract types. @@ -63,7 +63,7 @@ jaxb-view-model. + date-time-type-adapter | true -| If set, then ensures that for all properties of JAXB-style view models where the property's type is a date or time, then that property has been correctly annotated with @``XmlJavaTypeAdapter`` (so that the property's value can be converted into a serializable form). +| If set, then ensures that for all properties of JAXB-style view models where the property's type is a date or time, then that property has been correctly annotated with @`XmlJavaTypeAdapter` (so that the property's value can be converted into a serializable form). | @@ -100,7 +100,7 @@ jaxb-view-model. + reference-type-adapter | true -| If set, then ensures that for all properties of JAXB-style view models where the property's type is an entity, then that entity's type has been correctly annotated with @``XmlJavaTypeAdapter`` (so that the property's value can be converted into a serializable form). +| If set, then ensures that for all properties of JAXB-style view models where the property's type is an entity, then that entity's type has been correctly annotated with @`XmlJavaTypeAdapter` (so that the property's value can be converted into a serializable form). | @@ -109,7 +109,7 @@ causeway.core.meta-model.validator. + jdoql.from-clause | true -| If set, then ensures that the 'FROM' clause within any JDOQL ``@Query``s annotations relates to a known entity type, and moreover that that type is compatible with the type on which the annotation appears: meaning its either a supertype of or the same type as the annotated type. +| If set, then ensures that the 'FROM' clause within any JDOQL `@Query`s annotations relates to a known entity type, and moreover that that type is compatible with the type on which the annotation appears: meaning its either a supertype of or the same type as the annotated type. | @@ -118,7 +118,7 @@ causeway.core.meta-model.validator. + jdoql.variables-clause | true -| If set, then ensures that the 'VARIABLES' clause within any JDOQL ``@Query``s relates to a known entity type. +| If set, then ensures that the 'VARIABLES' clause within any JDOQL `@Query`s relates to a known entity type. | diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime-services.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime-services.adoc index 07d89ef2bb7..827ea714952 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime-services.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime-services.adoc @@ -17,7 +17,7 @@ causeway.core.runtime-services. + application-features.init | not-specified -| Whether the ``ApplicationFeatureRepository`` (or the default implementation of that service, at least) should compute the set of ``ApplicationFeature`` that describe the metamodel eagerly, or lazily. +| Whether the `ApplicationFeatureRepository` (or the default implementation of that service, at least) should compute the set of `ApplicationFeature` that describe the metamodel eagerly, or lazily. | @@ -26,7 +26,7 @@ causeway.core.runtime-services. + email.override.bcc | -| Intended for testing purposes only, if set then the requested ``bcc:`` of the email will be ignored, and instead sent to this email address instead. +| Intended for testing purposes only, if set then the requested `bcc:` of the email will be ignored, and instead sent to this email address instead. | @@ -35,7 +35,7 @@ causeway.core.runtime-services. + email.override.cc | -| Intended for testing purposes only, if set then the requested ``cc:`` of the email will be ignored, and instead sent to this email address instead. +| Intended for testing purposes only, if set then the requested `cc:` of the email will be ignored, and instead sent to this email address instead. | @@ -44,7 +44,7 @@ causeway.core.runtime-services. + email.override.to | -| Intended for testing purposes only, if set then the requested ``to:`` of the email will be ignored, and instead sent to this email address instead. +| Intended for testing purposes only, if set then the requested `to:` of the email will be ignored, and instead sent to this email address instead. | @@ -57,7 +57,7 @@ email.sender.address If the username is not specified, is also used as the username to connect to the SMTP service. -This configuration property is mandatory (for the default implementation of the ``EmailService``, at least). +This configuration property is mandatory (for the default implementation of the `EmailService`, at least). | @@ -66,7 +66,7 @@ causeway.core.runtime-services. + email.throw-exception-on-fail | true -| If an email fails to send, whether to propagate the exception (meaning that potentially the end-user might see the exception), or whether instead to just indicate failure through the return value of the method (``EmailService#send(List, List, List, String, String, DataSource...)`` that's being called. +| If an email fails to send, whether to propagate the exception (meaning that potentially the end-user might see the exception), or whether instead to just indicate failure through the return value of the method (`)` that's being called. | @@ -78,7 +78,7 @@ bulk.threshold | 1 | Determines the threshold as to whether to execute a set of entity changes in blk, in other words without a transaction flush in between. -If the threshold is passed (by default, anything more than 1 entity to persist), then the ``RepositoryService#execInBulk(Callable)`` API is used. +If the threshold is passed (by default, anything more than 1 entity to persist), then the `RepositoryService#execInBulk(Callable)` API is used. | @@ -87,7 +87,7 @@ causeway.core.runtime-services. + exception-recognizer.dae.disable | -| Whether the ``ExceptionRecognizer`` implementation for Spring's DataAccessException - which attempts to sanitize any exceptions arising from object stores - should be disabled (meaning that exceptions will potentially propagate as more serious to the end user). +| Whether the `ExceptionRecognizer` implementation for Spring's DataAccessException - which attempts to sanitize any exceptions arising from object stores - should be disabled (meaning that exceptions will potentially propagate as more serious to the end user). | @@ -113,7 +113,7 @@ translation.resource-location | | Specifies the relative resource path to look for translation files. -If \{@code null} uses \{@code servletContext.getResource("/WEB-INF/")}. +If ++{++@code null} uses ++{++@code servletContext.getResource("/WEB-INF/")}. Replaces the former Servlet context parameter 'causeway.config.dir'; diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime.adoc index 2da9ba5959d..a0a5ec26ce5 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.core.runtime.adoc @@ -16,7 +16,7 @@ include::../section-hooks/causeway.core.runtime~pre.adoc[] causeway.core.runtime.locale | -| If set, then overrides the application's ``Locale#getDefault()`` +| If set, then overrides the application's `Locale#getDefault()` | diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.extensions.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.extensions.adoc index bf5851368df..55f30b5b9f0 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.extensions.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.extensions.adoc @@ -17,9 +17,9 @@ causeway.extensions.audit-trail. + persist | enabled -| Whether the ``EntityPropertyChangeSubscriber`` implementation provided by this extension (which persists property changes to the audit trail) is enabled or not. +| Whether the `EntityPropertyChangeSubscriber` implementation provided by this extension (which persists property changes to the audit trail) is enabled or not. -One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the default implementation of ``EntityPropertyChangeSubscriber`` that is provided by the _audittrail_ extension. Because entity property changes are published to _all_ subscribers on the class path, you can disable the default implementation from doing anything using this setting. +One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the default implementation of `EntityPropertyChangeSubscriber` that is provided by the _audittrail_ extension. Because entity property changes are published to _all_ subscribers on the class path, you can disable the default implementation from doing anything using this setting. | @@ -28,9 +28,9 @@ causeway.extensions.command-log. + persist | enabled -| Whether the ``CommandSubscriber`` implementation provided by this extension (which persists commands to the command log) is enabled or not. +| Whether the `CommandSubscriber` implementation provided by this extension (which persists commands to the command log) is enabled or not. -One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the default implementation of ``CommandSubscriber`` that is provided by the _commandlog_ extension. Because commands are published to _all_ subscribers on the class path, you can disable the default implementation from doing anything using this setting. +One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the default implementation of `CommandSubscriber` that is provided by the _commandlog_ extension. Because commands are published to _all_ subscribers on the class path, you can disable the default implementation from doing anything using this setting. | @@ -39,7 +39,7 @@ causeway.extensions.command-log. + run-background-commands.batch-size | 25 -| Limits the number of pending commands that the ``RunBackgroundCommandsJob`` will execute. After these have been executed, any ``RunBackgroundCommandsJobListener``s are called. +| Limits the number of pending commands that the `RunBackgroundCommandsJob` will execute. After these have been executed, any `RunBackgroundCommandsJobListener`s are called. By default, quartz runs this command every 10 seconds, so the size should be proportion to that. @@ -178,7 +178,7 @@ This flag is exposed as part of 'Access-Control-Allow-Credentials' header in a p By default this is not set (i.e. user credentials are not supported). -For more information, check the usage of the ``credentials`` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. +For more information, check the usage of the `credentials` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. | @@ -191,7 +191,7 @@ allowed-headers These header will also be returned as part of 'Access-Control-Allow-Headers' header in a pre-flight response. -For more information, check the usage of the ``headers`` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. +For more information, check the usage of the `headers` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. | @@ -204,9 +204,9 @@ allowed-methods A comma separated list of HTTP methods that can be used to access the resource, using cross-origin requests. These are the methods which will also be included as part of 'Access-Control-Allow-Methods' header in a pre-flight response. -Default is ``GET``, ``POST``, ``HEAD``, ``OPTIONS``. +Default is `GET`, `POST`, `HEAD`, `OPTIONS`. -For more information, check the usage of the ``methods`` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. +For more information, check the usage of the `methods` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. | @@ -217,11 +217,11 @@ allowed-origins | * | Which origins are allowed to make CORS requests. -The default is the wildcard ("*"), meaning any origin is allowed to access the resource, but this can be made more restrictive if necessary using a whitelist of comma separated origins eg: +The default is the wildcard ("++*++"), meaning any origin is allowed to access the resource, but this can be made more restrictive if necessary using a whitelist of comma separated origins eg: -``org`` +`org` -For more information, check the usage of the ``origins`` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. +For more information, check the usage of the `origins` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. | @@ -236,7 +236,7 @@ A comma separated list of headers other than the simple response headers that br Default is none. -For more information, check the usage of the ``headers`` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. +For more information, check the usage of the `headers` init parameter for https://github.com/eBay/cors-filter[EBay CORSFilter]. | @@ -245,9 +245,9 @@ causeway.extensions.execution-log. + persist | enabled -| Whether the ``ExecutionSubscriber`` implementation provided by this extension (which persists executions to the execution log) is enabled or not. +| Whether the `ExecutionSubscriber` implementation provided by this extension (which persists executions to the execution log) is enabled or not. -One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the default implementation of ``ExecutionSubscriber`` that is provided by the _executionLog_ extension. Because executions are published to _all_ subscribers on the class path, you can disable the default implementation from doing anything using this setting. +One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the default implementation of `ExecutionSubscriber` that is provided by the _executionLog_ extension. Because executions are published to _all_ subscribers on the class path, you can disable the default implementation from doing anything using this setting. | @@ -256,9 +256,9 @@ causeway.extensions. + execution-outbox.persist | enabled -| Whether the ``ExecutionSubscriber`` implementation provided by this extension (which persists executions to the outbox) is enabled or not. +| Whether the `ExecutionSubscriber` implementation provided by this extension (which persists executions to the outbox) is enabled or not. -One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the outbox implementation of ``ExecutionSubscriber`` that is provided by the _executionOutbox_ extension. Because executions are published to _all_ subscribers on the class path, you can disable the outbox implementation from doing anything using this setting. +One reason to use this option is if you wish to provide your own implementation that wraps or delegates to the outbox implementation of `ExecutionSubscriber` that is provided by the _executionOutbox_ extension. Because executions are published to _all_ subscribers on the class path, you can disable the outbox implementation from doing anything using this setting. | @@ -277,7 +277,7 @@ causeway.extensions.layout-loaders. + github.api-key | -| As per https://github.com/settings/tokens, must have permissions to the ``/search`` and ``/contents`` APIs for the specified repository. +| As per https://github.com/settings/tokens, must have permissions to the `/search` and `/contents` APIs for the specified repository. | @@ -286,7 +286,7 @@ causeway.extensions.layout-loaders. + github.repository | -| eg ``apache/causeway-app-simpleapp`` +| eg `apache/causeway-app-simpleapp` | @@ -310,7 +310,7 @@ delegated-users.initial-role-names | | The set of roles that users that have been automatically created are granted automatically. -Typically the regular user role (as per ``role-name``, default value of ``causeway-ext-secman-user``) will be one of the roles listed here, to provide the ability for the end-user to logout, among other things (!). +Typically the regular user role (as per `role-name`, default value of `causeway-ext-secman-user`) will be one of the roles listed here, to provide the ability for the end-user to logout, among other things (!). | @@ -333,7 +333,7 @@ permissions-evaluation-policy | allow-beats-veto | If there are conflicting (allow vs veto) permissions at the same scope, then this policy determines whether to prefer to allow the permission or to veto it. -This is only used an implementation of secman's ``PermissionsEvaluationService`` SPI has not been provided explicitly. +This is only used an implementation of secman's `PermissionsEvaluationService` SPI has not been provided explicitly. | @@ -384,7 +384,7 @@ These namespaces are intended to be sufficient to allow users with this admin ro These roles cannot be removed via user interface -WARNING: normally these should not be overridden. Instead, specify additional namespaces using ``NamespacePermissions#getAdditional()``. +WARNING: normally these should not be overridden. Instead, specify additional namespaces using `NamespacePermissions#getAdditional()`. @see NamespacePermissions#getAdditional() @@ -406,7 +406,7 @@ admin.role-name | | The name of security admin role. -Users with this role (in particular, the default user are granted access to a set of namespaces (``NamespacePermissions#getSticky()`` and ``NamespacePermissions#getAdditional()``) which are intended to be sufficient to allow users with this admin role to be able to administer the security module itself, for example to manage users and roles. +Users with this role (in particular, the default user are granted access to a set of namespaces (`NamespacePermissions#getSticky()` and `NamespacePermissions#getAdditional()`) which are intended to be sufficient to allow users with this admin role to be able to administer the security module itself, for example to manage users and roles. @see Admin#getUserName() @see NamespacePermissions#getSticky() @see NamespacePermissions#getAdditional() @@ -421,7 +421,7 @@ admin.user-name This user is automatically made a member of the role, from which it is granted permissions to administer other users. -The password for this user is set in ``Admin#getPassword()``. +The password for this user is set in `Admin#getPassword()`. @see #getPassword() @see #getRoleName() @@ -434,7 +434,7 @@ regular-user.role-name | | The role name for regular users of the application, granting them access to basic security features. -The exact set of permissions is hard-wired in the ``CausewayExtSecmanRegularUserRoleAndPermissions`` fixture. +The exact set of permissions is hard-wired in the `CausewayExtSecmanRegularUserRoleAndPermissions` fixture. | @@ -445,7 +445,7 @@ yaml-file | | Path to local YAML file, if present, to use as an alternative seeding strategy. -Eg. seed from a YAML file, that was previously exported by SecMan's ApplicationRoleManager_exportAsYaml mixin. +Eg. seed from a YAML file, that was previously exported by SecMan's ApplicationRoleManager++_++exportAsYaml mixin. | @@ -454,9 +454,9 @@ causeway.extensions.secman. + user-menu-me-action-policy | hide -| Whether the presence of SecMan should result in the automatic suppression of the ``UserMenu``'s ``me#act() me()`` action. +| Whether the presence of SecMan should result in the automatic suppression of the `UserMenu`'s `me#act() me()` action. -This is normally what is required as SecMan's ``ApplicationUser`` is a more comprehensive representation of the current user. If the default ``me#act() me()`` action is not suppressed, then the end-user will see two actions with the name "me" in the tertiary menu. +This is normally what is required as SecMan's `ApplicationUser` is a more comprehensive representation of the current user. If the default `me#act() me()` action is not suppressed, then the end-user will see two actions with the name "me" in the tertiary menu. | @@ -468,7 +468,7 @@ initial-role-names | | The set of roles that users registering with the app are granted automatically. -If using the wicket viewer, also requires causeway.viewer.wicket.suppress-signup to be set ``false``, along with any other of its other prereqs. +If using the wicket viewer, also requires causeway.viewer.wicket.suppress-signup to be set `false`, along with any other of its other prereqs. | diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.commons.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.commons.adoc index fa898a1ab10..c5a98025fbd 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.commons.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.commons.adoc @@ -29,11 +29,11 @@ entity-change-tracker. + suppress-auto-flush | true -| Normally any query submitted to ``RepositoryService#allMatches(Query)`` will trigger a flush first, unless auto-flush has been disabled. +| Normally any query submitted to `RepositoryService#allMatches(Query)` will trigger a flush first, unless auto-flush has been disabled. -However, this auto-flush behaviour can be troublesome if the query occurs as a side-effect of the evaluation of a derived property, whose value in turn is enlisted by an implementation of a subscriber (in particular ``EntityPropertyChangeSubscriber``) which captures the value of all properties (both persisted and derived). However, this behaviour can (at least under JDO), result in a ``ConcurrentModificationException``. +However, this auto-flush behaviour can be troublesome if the query occurs as a side-effect of the evaluation of a derived property, whose value in turn is enlisted by an implementation of a subscriber (in particular `EntityPropertyChangeSubscriber`) which captures the value of all properties (both persisted and derived). However, this behaviour can (at least under JDO), result in a `ConcurrentModificationException`. -By default, ``EntityChangeTracker`` will therefore temporarily suppress any auto-flushing while this is ongoing. The purpose of this configuration property is to never suppress, ie always autoflush. +By default, `EntityChangeTracker` will therefore temporarily suppress any auto-flushing while this is ongoing. The purpose of this configuration property is to never suppress, ie always autoflush. | diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.schema.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.schema.adoc index 9811f8fec54..8bfb139ae26 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.schema.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.persistence.schema.adoc @@ -28,7 +28,7 @@ auto-create-schemas | | List of additional schemas to be auto-created. -Explicitly creates given list of schemas by using the specified ``#getCreateSchemaSqlTemplate()`` to generate the actual SQL statement against the configured data-source. +Explicitly creates given list of schemas by using the specified `#getCreateSchemaSqlTemplate()` to generate the actual SQL statement against the configured data-source. This configuration mechanism does not consider any schema-auto-creation configuration (if any), that independently is provided the standard JPA way. @@ -41,11 +41,11 @@ create-schema-sql-template | CREATE SCHEMA IF NOT EXISTS %S | Vendor specific SQL syntax to create a DB schema. -This template is passed through ``String#format(String, Object...)`` to make the actual SQL statement thats to be used against the configured data-source. +This template is passed through `)` to make the actual SQL statement thats to be used against the configured data-source. -Default template is \{@literal CREATE SCHEMA IF NOT EXISTS %S} with the schema name converted to upper-case. +Default template is ++{++@literal CREATE SCHEMA IF NOT EXISTS %S} with the schema name converted to upper-case. -For MYSQL/MARIADB use escape like \{@code `%S`} +For MYSQL/MARIADB use escape like ++{++@code ++`++%S++`++} diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.prototyping.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.prototyping.adoc index b4999aa8309..334aef2d6b9 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.prototyping.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.prototyping.adoc @@ -21,7 +21,7 @@ generate-random-web-admin-password If a password is generated, it is logged to the logging subsystem (Log4j2). -Recommended (``true``) when ``#isWebAllowRemoteAccess()`` is also ``true``. +Recommended (`true`) when `#isWebAllowRemoteAccess()` is also `true`. | @@ -43,7 +43,7 @@ if-disabled-policy | disable | Whether and how to display any properties, actions and collections whose usability has been vetoed. -By default, such object members are shown as disabled, with the tooltip indicating why. Setting the property to SHOW_AS_DISABLED_WITH_DIAGNOSTICS shows additional detail in the tooltip. +By default, such object members are shown as disabled, with the tooltip indicating why. Setting the property to SHOW++_++AS++_++DISABLED++_++WITH++_++DIAGNOSTICS shows additional detail in the tooltip. This config property only applies in prototyping mode. @@ -56,7 +56,7 @@ if-hidden-policy | hide | Whether and how to display any properties, actions and collections whose visibility has been vetoed. -By default, such object members are of course hidden. However, this config property can be used to instead show these objects as disabled, with the tooltip indicating why the object member has been vetoed. Setting the property to SHOW_AS_DISABLED_WITH_DIAGNOSTICS shows additional detail in the tooltip. +By default, such object members are of course hidden. However, this config property can be used to instead show these objects as disabled, with the tooltip indicating why the object member has been vetoed. Setting the property to SHOW++_++AS++_++DISABLED++_++WITH++_++DIAGNOSTICS shows additional detail in the tooltip. This config property only applies in prototyping mode. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.keycloak.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.keycloak.adoc index ef4b7106e2e..c59fb066c6b 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.keycloak.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.keycloak.adoc @@ -34,7 +34,7 @@ causeway.security.keycloak. + client-role-prefix | -| If ``#isExtractClientRoles()`` client roles are to be extracted}, this allows the resultant role to be optionally prefixed. +| If `#isExtractClientRoles()` client roles are to be extracted}, this allows the resultant role to be optionally prefixed. | @@ -43,9 +43,9 @@ causeway.security.keycloak. + extract-client-roles | true -| Whether to (attempt to) extract client roles and copy into the ``DefaultOidcUser``. +| Whether to (attempt to) extract client roles and copy into the `DefaultOidcUser`. -By default, client roles are extracted using the "User Client Role" mapping type, into a token claim name "resource_access.$\{client_id}.roles" +By default, client roles are extracted using the "User Client Role" mapping type, into a token claim name "resource++_++access.$++{++client++_++id}.roles" This has been made a configuration option because some versions of Keycloak seemingly do not correctly extract these roles, see for example https://keycloak.discourse.group/t/resource-access-claim-missing-from-userinfo-until-i-change-the-name/1238/3[this discussion] and https://issues.redhat.com/browse/KEYCLOAK-9874[KEYCLOAK-9874]. @@ -56,9 +56,9 @@ causeway.security.keycloak. + extract-realm-roles | true -| Whether to (attempt to) extract realm roles and copy into the ``DefaultOidcUser``. +| Whether to (attempt to) extract realm roles and copy into the `DefaultOidcUser`. -By default, realm roles are obtained from the token claims using the "User Realm Role" mapping type, into a token claim name "realm_access.roles" +By default, realm roles are obtained from the token claims using the "User Realm Role" mapping type, into a token claim name "realm++_++access.roles" This has been made a configuration option because some versions of Keycloak seemingly do not correctly extract these roles, see for example https://keycloak.discourse.group/t/resource-access-claim-missing-from-userinfo-until-i-change-the-name/1238/3[this discussion] and https://issues.redhat.com/browse/KEYCLOAK-9874[KEYCLOAK-9874]. @@ -69,7 +69,7 @@ causeway.security.keycloak. + extract-roles | -| Whether to (attempt to) extract any available roles and into the ``DefaultOidcUser``. +| Whether to (attempt to) extract any available roles and into the `DefaultOidcUser`. This is to support any custom mapping type which maps into a token claim name called simply "roles" @@ -82,7 +82,7 @@ causeway.security.keycloak. + login-success-url | /wicket -| Specifies where users will be redirected after authenticating successfully if they have not visited a secured page prior to authenticating or \{@code alwaysUse} is true. +| Specifies where users will be redirected after authenticating successfully if they have not visited a secured page prior to authenticating or ++{++@code alwaysUse} is true. | @@ -108,7 +108,7 @@ causeway.security.keycloak. + role-prefix | -| If ``#isExtractRoles()`` roles are to be extracted}, this allows the resultant role to be optionally prefixed. +| If `#isExtractRoles()` roles are to be extracted}, this allows the resultant role to be optionally prefixed. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.spring.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.spring.adoc index 23841ea9cfb..4c3c6a2f2b6 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.spring.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.security.spring.adoc @@ -17,9 +17,9 @@ causeway.security.spring. + allow-csrf-filters | -| The framework on initialization by default disables any \{@code CsrfFilter}(s) it finds with _Spring Security_ registered filters. +| The framework on initialization by default disables any ++{++@code CsrfFilter}(s) it finds with _Spring Security_ registered filters. -Setting this option to \{@literal true} allows \{@code CsrfFilter}(s) to be configured. Yet EXPERIMENTAL. @see ``CsrfFilter`` @see "https://www.baeldung.com/spring-security-registered-filters" +Setting this option to ++{++@literal true} allows ++{++@code CsrfFilter}(s) to be configured. Yet EXPERIMENTAL. @see org.springframework.security.web.csrf.CsrfFilter @see https://www.baeldung.com/spring-security-registered-filters[baeldung] diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.testing.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.testing.adoc index 6b159609703..701eefc843b 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.testing.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.testing.adoc @@ -36,7 +36,7 @@ multiple-execution-strategy The default is to fixture scripts are executed only once per class. -Note that this policy can be overridden on a fixture-by-fixture basis if the fixture implements ``FixtureScriptWithExecutionStrategy``. +Note that this policy can be overridden on a fixture-by-fixture basis if the fixture implements `FixtureScriptWithExecutionStrategy`. | @@ -58,7 +58,7 @@ package-prefix | | Specifies the base package from which to search for fixture scripts. -Either this or ``#getContextClass()`` must be specified; ``#getContextClass()`` is used by preference. +Either this or `#getContextClass()` must be specified; `#getContextClass()` is used by preference. @see #getContextClass() diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.value-types.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.value-types.adoc index a3f572a87e6..876749eee17 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.value-types.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.value-types.adoc @@ -17,9 +17,9 @@ causeway.value-types.big-decimal. + display.min-scale | -| The minimum scale to use for all ``BigDecimal``s. +| The minimum scale to use for all `BigDecimal`s. -Is only used if the minimum scale has not been specified explicitly by some other means, typically either ``Digits#fraction()`` or an ORM semantic such as the (JPA) ``Column#scale()``. +Is only used if the minimum scale has not been specified explicitly by some other means, typically either `Digits#fraction()` or an ORM semantic such as the (JPA) `Column#scale()`. | @@ -46,13 +46,13 @@ causeway.value-types.big-decimal. + editing.use-grouping-separator | -| A common use of ``BigDecimal`` is as a money value. In some locales (eg English), the "," (comma) is the grouping (thousands) separator wihle the "." (period) acts as a decimal point, but in others (eg France, Italy) it is the other way around. +| A common use of `BigDecimal` is as a money value. In some locales (eg English), the "," (comma) is the grouping (thousands) separator wihle the "." (period) acts as a decimal point, but in others (eg France, Italy) it is the other way around. -Surprisingly perhaps, a string such as "123,99", when parsed ((by ``DecimalFormat``) in an English locale, is not rejected but instead is evaluated as the value 12399L. That's almost certainly not what the end-user would have expected, and results in a money value 100x too large. +Surprisingly perhaps, a string such as "123,99", when parsed ((by `DecimalFormat`) in an English locale, is not rejected but instead is evaluated as the value 12399L. That's almost certainly not what the end-user would have expected, and results in a money value 100x too large. The purpose of this configuration property is to remove the confusion by simply disallowing the thousands separator from being part of the input string. -For maximum safety, allowing the grouping separator is disallowed, but the alternate (original) behaviour can be reinstated by setting this config property back to ``true``. +For maximum safety, allowing the grouping separator is disallowed, but the alternate (original) behaviour can be reinstated by setting this config property back to `true`. The same configuration property is also used for rendering the value. @@ -67,11 +67,11 @@ use-scale-for-min-fractional-facet | true | Indicates how to derive the min fractional facet (the minimum number of digits after the decimal point). -If this flag is set, then the ``Digits#fraction()`` annotation or ORM equivalent (the JDO ``@Column#scale`` or the JPA ``Column#scale()``) should be used for the ``MinFractionalFacet`` as well as the ``MaxFractionalFacet``. +If this flag is set, then the `Digits#fraction()` annotation or ORM equivalent (the JDO `@Column#scale` or the JPA `Column#scale()`) should be used for the `MinFractionalFacet` as well as the `MaxFractionalFacet`. What this means in practice is that a numeric values will be rendered to the same number of fractional digits, irrespective of whether they are whole numbers or fractional. For example, with a scale of 2, then "123.4532" will be rendered as "123.45", while "123" will be rendered as "123.00". -If this flag is NOT set, or if it is set but there is no annotation, then the ``#minScale`` config property is used as a fallback. +If this flag is NOT set, or if it is set but there is no annotation, then the `#minScale` config property is used as a fallback. If there is no fallback, then it means that a big decimal such as "123.00" will be presented as just "123" (that is, the shortest possible textual representation). @@ -84,7 +84,7 @@ backend-url | | If set, adds plantuml support to the AsciiDoc value type. -Eg. via docker instance like \{@literal yuzutech/kroki}. +Eg. via docker instance like ++{++@literal yuzutech/kroki}. | @@ -93,7 +93,7 @@ causeway.value-types.kroki. + request-timeout | 5000ms -| Max time for requests to the ``#getBackendUrl()``, when waiting for a response. (default: 5 seconds) +| Max time for requests to the `#getBackendUrl()`, when waiting for a response. (default: 5 seconds) | @@ -219,9 +219,9 @@ causeway.value-types.big-decimal. + min-scale | -| The minimum scale to use for all ``BigDecimal``s. +| The minimum scale to use for all `BigDecimal`s. -Is only used if the minimum scale has not been specified explicitly by some other means, typically either ``Digits#fraction()`` or an ORM semantic such as the (JPA) ``Column#scale()``. @deprecated - use ``Display#getMinScale()`` instead +Is only used if the minimum scale has not been specified explicitly by some other means, typically either `Digits#fraction()` or an ORM semantic such as the (JPA) `Column#scale()`. @deprecated - use `Display#getMinScale()` instead | @@ -230,17 +230,17 @@ causeway.value-types.big-decimal. + use-grouping-separator | -| A common use of ``BigDecimal`` is as a money value. In some locales (eg English), the "," (comma) is the grouping (thousands) separator wihle the "." (period) acts as a decimal point, but in others (eg France, Italy) it is the other way around. +| A common use of `BigDecimal` is as a money value. In some locales (eg English), the "," (comma) is the grouping (thousands) separator wihle the "." (period) acts as a decimal point, but in others (eg France, Italy) it is the other way around. -Surprisingly perhaps, a string such as "123,99", when parsed ((by ``DecimalFormat``) in an English locale, is not rejected but instead is evaluated as the value 12399L. That's almost certainly not what the end-user would have expected, and results in a money value 100x too large. +Surprisingly perhaps, a string such as "123,99", when parsed ((by `DecimalFormat`) in an English locale, is not rejected but instead is evaluated as the value 12399L. That's almost certainly not what the end-user would have expected, and results in a money value 100x too large. The purpose of this configuration property is to remove the confusion by simply disallowing the thousands separator from being part of the input string. -For maximum safety, allowing the grouping separator is disallowed, but the alternate (original) behaviour can be reinstated by setting this config property back to ``true``. +For maximum safety, allowing the grouping separator is disallowed, but the alternate (original) behaviour can be reinstated by setting this config property back to `true`. The same configuration property is also used for rendering the value. -@deprecated - use ``Editing#isUseGroupingSeparator()`` instead. +@deprecated - use `Editing#isUseGroupingSeparator()` instead. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.graphql.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.graphql.adoc index 7e58bc3a822..f6322c03b4d 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.graphql.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.graphql.adoc @@ -25,7 +25,7 @@ causeway.viewer.graphql. + api-variant | query-and-mutations -| Which variant of API to expose: ``ApiVariant#QUERY_ONLY`` (which suppresses any actions that mutate the state of the system), or as ``ApiVariant#QUERY_AND_MUTATIONS`` (which additionally exposes actions that mutate the system as mutations) or alternatively as ``ApiVariant#QUERY_WITH_MUTATIONS_NON_SPEC_COMPLIANT``, a query-only schema that relaxes the read-only rule by exposing actions that mutate the system; it is therefore not compliant with the GraphQL spec), +| Which variant of API to expose: `ApiVariant#QUERY++_++ONLY` (which suppresses any actions that mutate the state of the system), or as `ApiVariant#QUERY++_++AND++_++MUTATIONS` (which additionally exposes actions that mutate the system as mutations) or alternatively as `ApiVariant#QUERY++_++WITH++_++MUTATIONS++_++NON++_++SPEC++_++COMPLIANT`, a query-only schema that relaxes the read-only rule by exposing actions that mutate the system; it is therefore not compliant with the GraphQL spec), | @@ -79,7 +79,7 @@ causeway.viewer.graphql.meta-data. + field-name | _meta -| Note that field names _cannot_ being with "__", as that is reserved by the underlying GraphQL implementation. +| Note that field names _cannot_ being with "++__++", as that is reserved by the underlying GraphQL implementation. | @@ -97,9 +97,9 @@ causeway.viewer.graphql.resources. + response-type | forbidden -| How resources (``Blob`` bytes, ``Clob`` chars, grids and icons) can be downloaded from the resource controller. +| How resources (`Blob` bytes, `Clob` chars, grids and icons) can be downloaded from the resource controller. -By default the download of these resources if ``ResponseType#FORBIDDEN``, but alternatively they can be enabled to download either ``ResponseType#DIRECT``ly or as an ``ResponseType#ATTACHMENT``. +By default the download of these resources if `ResponseType#FORBIDDEN`, but alternatively they can be enabled to download either `ResponseType#DIRECT`ly or as an `ResponseType#ATTACHMENT`. | @@ -109,7 +109,7 @@ scalar-marshaller. + local-date-format | yyyy-MM-dd -| For both JDK8's ``LocalDate`` and JodaTime's ``LocalDate`` +| For both JDK8's `LocalDate` and JodaTime's `LocalDate` | @@ -119,7 +119,7 @@ scalar-marshaller. + local-time-format | HH:mm:ss -| For both JDK8's ``LocalTime`` and JodaTime's ``LocalTime`` +| For both JDK8's `LocalTime` and JodaTime's `LocalTime` | @@ -129,7 +129,7 @@ scalar-marshaller. + zoned-date-time-format | yyyy-MM-dd'T'HH:mm:ssXXX -| for JDK8's ``ZonedDateTime`` and JodaTime's ``DateTime`` +| for JDK8's `ZonedDateTime` and JodaTime's `DateTime` | @@ -138,7 +138,7 @@ causeway.viewer.graphql. + schema-style | rich-and-simple -| Which ``SchemaStyle`` to expose, "simple" or "rich". By default both are exposed under top-level field names. @see Schema.Rich#getTopLevelFieldName() @see Schema.Simple#getTopLevelFieldName() +| Which `SchemaStyle` to expose, "simple" or "rich". By default both are exposed under top-level field names. @see Schema.Rich#getTopLevelFieldName() @see Schema.Simple#getTopLevelFieldName() | @@ -147,9 +147,9 @@ causeway.viewer.graphql.schema. + rich.enable-scenario-testing | -| If the ``#getSchemaStyle()`` is set to either ``SchemaStyle#RICH_ONLY`` or ``SchemaStyle#SIMPLE_AND_RICH``, then determines whether the "Scenario" field is included in order to allow given/when/then tests to be expressed. +| If the `#getSchemaStyle()` is set to either `SchemaStyle#RICH++_++ONLY` or `SchemaStyle#SIMPLE++_++AND++_++RICH`, then determines whether the "Scenario" field is included in order to allow given/when/then tests to be expressed. -Ignored if the ``#getSchemaStyle()`` is ``SchemaStyle#SIMPLE_ONLY``. +Ignored if the `#getSchemaStyle()` is `SchemaStyle#SIMPLE++_++ONLY`. | @@ -158,9 +158,9 @@ causeway.viewer.graphql.schema. + rich.top-level-field-name | rich -| If the ``#getSchemaStyle()`` is set to ``SchemaStyle#SIMPLE_AND_RICH``, defines the name of the top-level field under which the "rich" schema resides. +| If the `#getSchemaStyle()` is set to `SchemaStyle#SIMPLE++_++AND++_++RICH`, defines the name of the top-level field under which the "rich" schema resides. -Ignored for any other ``#getSchemaStyle()``. +Ignored for any other `#getSchemaStyle()`. | @@ -169,9 +169,9 @@ causeway.viewer.graphql.schema. + simple.top-level-field-name | simple -| If the ``#getSchemaStyle()`` is set to ``SchemaStyle#SIMPLE_AND_RICH``, defines the name of the top-level field under which the "simple" schema resides. +| If the `#getSchemaStyle()` is set to `SchemaStyle#SIMPLE++_++AND++_++RICH`, defines the name of the top-level field under which the "simple" schema resides. -Ignored for any other ``#getSchemaStyle()``. +Ignored for any other `#getSchemaStyle()`. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.restfulobjects.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.restfulobjects.adoc index b2fa577c3f9..3a72298dafc 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.restfulobjects.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.restfulobjects.adoc @@ -20,7 +20,7 @@ authentication.strategy-class-name restfulobjects.viewer.webmodule. + auth. + AuthenticationStrategyBasicAuth -| Defaults to ``AuthenticationStrategyBasicAuth``. +| Defaults to `AuthenticationStrategyBasicAuth`. | @@ -29,11 +29,11 @@ causeway.viewer.restfulobjects. + base-uri | -| If left unset (the default), then the RO viewer will use the ``UriInfo`` (injected using ``Context``) to figure out the base Uri (used to render ``href``s). +| If left unset (the default), then the RO viewer will use the `UriInfo` (injected using `Context`) to figure out the base Uri (used to render `href`s). This will be correct much of the time, but will almost certainly be wrong if there is a reverse proxy. -If set, eg ``com/``, then this value will be used instead. +If set, eg `com/`, then this value will be used instead. | @@ -42,9 +42,9 @@ causeway.viewer.restfulobjects. + honor-ui-hints | -| Whether to enable the ``x-ro-follow-links`` support, to minimize round trips. +| Whether to enable the `x-ro-follow-links` support, to minimize round trips. -The RO viewer provides the capability for the client to set the optional ``x-ro-follow-links`` query parameter, as described in section 34.4 of the RO spec v1.0. If used, the resultant representation includes the result of following the associated link, but through a server-side "join", somewhat akin to GraphQL. +The RO viewer provides the capability for the client to set the optional `x-ro-follow-links` query parameter, as described in section 34.4 of the RO spec v1.0. If used, the resultant representation includes the result of following the associated link, but through a server-side "join", somewhat akin to GraphQL. By default this functionality is disabled, this configuration property enables the feature. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0. @@ -66,7 +66,7 @@ causeway.viewer.restfulobjects. + strict-accept-checking | -| If set, then any unrecognised ``Accept`` headers will result in an HTTP _Not Acceptable_ response code (406). +| If set, then any unrecognised `Accept` headers will result in an HTTP _Not Acceptable_ response code (406). | @@ -84,7 +84,7 @@ causeway.viewer.restfulobjects. + suppress-member-disabled-reason | -| If set, then - should there be an interaction with an action, property or collection that is disabled - then this will prevent the ``disabledReason`` reason from being added to the returned representation. +| If set, then - should there be an interaction with an action, property or collection that is disabled - then this will prevent the `disabledReason` reason from being added to the returned representation. This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0. @@ -95,7 +95,7 @@ causeway.viewer.restfulobjects. + suppress-member-extensions | -| If set, then the ``x-causeway-format`` key (under ``extensions``) for properties will be suppressed. +| If set, then the `x-causeway-format` key (under `extensions`) for properties will be suppressed. This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0. @@ -106,7 +106,7 @@ causeway.viewer.restfulobjects. + suppress-member-id | -| If set, then the ``id`` key for all members will be suppressed. +| If set, then the `id` key for all members will be suppressed. This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0. @@ -117,7 +117,7 @@ causeway.viewer.restfulobjects. + suppress-member-links | -| If set, then the detail link (in other words ``]``) for all members will be suppressed. +| If set, then the detail link (in other words `++]++`) for all members will be suppressed. This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0. @@ -128,7 +128,7 @@ causeway.viewer.restfulobjects. + suppress-update-link | -| If set, then the update link (in other words `` ]`` to perform a bulk update of an object) will be suppressed. +| If set, then the update link (in other words ` ++]++` to perform a bulk update of an object) will be suppressed. This is disabled by default. If enabled, then the representations returned are non-standard with respect to the RO Spec v1.0. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc index 644ddad48aa..373f71c2ace 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/causeway.viewer.wicket.adoc @@ -17,7 +17,7 @@ causeway.viewer.wicket. + action-column-enabled | true -| Whether actions, that have explicit ``hidden = Where`` semantics to enable them in tables, should be gathered into an action column. That is, collections of domain objects are presented in the UI as tables, where corresponding domain object actions are gathered into an additional (typically trailing) column (labeled 'action-column'). +| Whether actions, that have explicit `hidden = Where` semantics to enable them in tables, should be gathered into an action column. That is, collections of domain objects are presented in the UI as tables, where corresponding domain object actions are gathered into an additional (typically trailing) column (labeled 'action-column'). | @@ -48,7 +48,7 @@ causeway.viewer.wicket.app | org.apache.causeway.viewer.wicket. + viewer.wicketapp. + CausewayWicketApplication -| Specifies the subclass of ``CausewayWicketApplication`` that is used to bootstrap Wicket. +| Specifies the subclass of `CausewayWicketApplication` that is used to bootstrap Wicket. There is usually very little reason to change this from its default. @@ -136,9 +136,9 @@ The default behaviour is to honour the original destination requested. causeway.viewer.wicket.css | -| URL of file to read any custom CSS, relative to ``static`` package on the class path. +| URL of file to read any custom CSS, relative to `static` package on the class path. -A typical value is ``css``. This will result in this file being read from the ``static/css`` directory (because static resources such as CSS are mounted by Spring by default under ``static`` package). +A typical value is `css`. This will result in this file being read from the `static/css` directory (because static resources such as CSS are mounted by Spring by default under `static` package). | @@ -177,7 +177,7 @@ popup-on-focus The default is to show the picker when the user clicks into the field. -Corresponds to the ``allowInputToggle`` config property of the underlying library, (TempusDominus). +Corresponds to the `allowInputToggle` config property of the underlying library, (TempusDominus). | @@ -186,7 +186,7 @@ causeway.viewer.wicket. + development-utilities.enable | -| Determines whether debug bar and other stuff influenced by ``DebugSettings#isDevelopmentUtilitiesEnabled()`` is enabled or not. +| Determines whether debug bar and other stuff influenced by `DebugSettings#isDevelopmentUtilitiesEnabled()` is enabled or not. By default, depends on the mode (prototyping = enabled, server = disabled). This property acts as an override. @@ -198,7 +198,7 @@ causeway.viewer.wicket.dialog-mode | sidebar | Whether the dialog mode rendered when invoking actions on domain objects should be to use the sidebar (the default) or to use a modal dialog. -This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle()``. +This can be overridden on a case-by-case basis using `ActionLayout#promptStyle()`. | @@ -209,7 +209,7 @@ dialog-mode-for-menu | modal | Whether the dialog mode rendered when invoking actions on domain services (that is, menus) should be to use a modal dialog (the default) or to use the sidebar panel. -This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle()``. +This can be overridden on a case-by-case basis using `ActionLayout#promptStyle()`. | @@ -229,9 +229,9 @@ The default is to enable (show) the text icon (if in prototyping mode). causeway.viewer.wicket.js | -| URL of file to read any custom JavaScript, relative to ``static`` package on the class path. +| URL of file to read any custom JavaScript, relative to `static` package on the class path. -A typical value is ``js``. This will result in this file being read from the ``static/js`` directory (because static resources such as CSS are mounted by Spring by default under ``static`` package). +A typical value is `js`. This will result in this file being read from the `static/js` directory (because static resources such as CSS are mounted by Spring by default under `static` package). | @@ -242,7 +242,7 @@ live-reload-url | | If specified, then is rendered on each page to enable live reload. -Configuring live reload also requires an appropriate plugin to the web browser (eg see http://livereload.com/[livereload.com] and a mechanism to trigger changes, eg by watching ``xml`` files. +Configuring live reload also requires an appropriate plugin to the web browser (eg see http://livereload.com/[livereload.com] and a mechanism to trigger changes, eg by watching `xml` files. | @@ -271,7 +271,7 @@ causeway.viewer.wicket. + max-title-length-in-tables | 12 -| The maximum number of characters to use to render the title of a domain object (alongside the icon) in any table, if not otherwise overridden by either ``#getMaxTitleLengthInParentedTables()`` or ``#getMaxTitleLengthInStandaloneTables()``. +| The maximum number of characters to use to render the title of a domain object (alongside the icon) in any table, if not otherwise overridden by either `#getMaxTitleLengthInParentedTables()` or `#getMaxTitleLengthInStandaloneTables()`. If truncated, then the remainder of the title will be replaced with ellipses (...). @@ -383,7 +383,7 @@ prompt-style | inline | Whether to use a modal dialog for property edits and for actions associated with properties. -This can be overridden on a case-by-case basis using ``@PropertyLayout#promptStyle`` and ``@ActionLayout#promptStyle``. +This can be overridden on a case-by-case basis using `@PropertyLayout#promptStyle` and `@ActionLayout#promptStyle`. This behaviour is disabled by default; the viewer will use an inline prompt in these cases, making for a smoother user experience. @@ -441,7 +441,7 @@ replace-disabled-tag-with-readonly- + tag | true -| In Firefox and more recent versions of Chrome 54+, cannot copy out of disabled fields; instead we use the readonly attribute (https://www.w3.org/TR/2014/REC-html5-20141028/forms.html#the-readonly-attribute) +| In Firefox and more recent versions of Chrome 54{plus}, cannot copy out of disabled fields; instead we use the readonly attribute (https://www.w3.org/TR/2014/REC-html5-20141028/forms.html#the-readonly-attribute) This behaviour is enabled by default but can be disabled using this flag @@ -475,7 +475,7 @@ suppress-password-reset | | Whether to suppress the password reset link on the sign-in page. -Although this is disabled by default (in other words the 'reset password' link is not suppressed), note that in addition the application must provide an implementation of the ``UserRegistrationService`` as well as a configured ``EmailNotificationService`` (same conditions as for the ``#isSuppressSignUp()`` sign-up link). +Although this is disabled by default (in other words the 'reset password' link is not suppressed), note that in addition the application must provide an implementation of the `UserRegistrationService` as well as a configured `EmailNotificationService` (same conditions as for the `#isSuppressSignUp()` sign-up link). | @@ -486,7 +486,7 @@ suppress-sign-up | | Whether to suppress the sign-up link on the sign-in page. -Although this is disabled by default (in other words the sign-up link is not suppressed), note that in addition the application must provide an implementation of the ``UserRegistrationService`` as well as a configured ``EmailNotificationService`` (same conditions as for the ``#isSuppressPasswordReset()`` password reset link). +Although this is disabled by default (in other words the sign-up link is not suppressed), note that in addition the application must provide an implementation of the `UserRegistrationService` as well as a configured `EmailNotificationService` (same conditions as for the `#isSuppressPasswordReset()` password reset link). | @@ -506,7 +506,7 @@ initial | Flatly | The initial theme to use. -Expected to be in the list of ``#getEnabled()`` themes. +Expected to be in the list of `#getEnabled()` themes. | diff --git a/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc b/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc index 87f9a13275e..75e038e9e6e 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/datanucleus.adoc @@ -18,7 +18,7 @@ datanucleus.cache.level2.mode | unspecified | The mode of operation of the L2 cache, deciding which entities are cached. -The default (UNSPECIFIED) is the same as DISABLE_SELECTIVE. +The default (UNSPECIFIED) is the same as DISABLE++_++SELECTIVE. For more details, see https://www.datanucleus.org/products/accessplatform_6_0/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs] and the https://www.datanucleus.org/products/accessplatform_6_0/jdo/persistence.html#cache_level2[DataNucleus Cache docs]. @@ -141,9 +141,9 @@ generate-database.mode | none | Whether to eagerly create all tables at startup. -For integration testing, this is generally preferred to using datanucleus.schema.autoCreateAll, because the ``autoCreateAll`` will only create tables lazily, when first persisted to. While lazily initialization is potentially quicker, it can cause issues (eg with rollup mapping to super class tables). +For integration testing, this is generally preferred to using datanucleus.schema.autoCreateAll, because the `autoCreateAll` will only create tables lazily, when first persisted to. While lazily initialization is potentially quicker, it can cause issues (eg with rollup mapping to super class tables). -Valid values: `**none**`, ``create``, ``drop-and-create``, ``drop``. +Valid values: *`none`*, `create`, `drop-and-create`, `drop`. For more details, see https://www.datanucleus.org/products/accessplatform_6_0/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs] and the https://www.datanucleus.org/products/accessplatform_6_0/jdo/persistence.html#schema[DataNucleus Schema Guide]. @@ -153,7 +153,7 @@ For more details, see https://www.datanucleus.org/products/accessplatform_6_0/jd datanucleus.schema.validate-all | -| Alias for defining ``validateTables``, ``validateColumns`` and ``validateConstraints`` as true. +| Alias for defining `validateTables`, `validateColumns` and `validateConstraints` as true. For more details, see https://www.datanucleus.org/products/accessplatform_6_0/jdo/persistence.html#pmf_properties[DataNucleus Config Property docs] and the https://www.datanucleus.org/products/accessplatform_6_0/jdo/persistence.html#schema[DataNucleus Schema Guide]. diff --git a/core/config/src/main/adoc/modules/config/pages/sections/eclipselink.adoc b/core/config/src/main/adoc/modules/config/pages/sections/eclipselink.adoc index fdbc5304cef..cf5f3baa6f9 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/eclipselink.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/eclipselink.adoc @@ -320,16 +320,16 @@ eclipselink.logging.timestamp eclipselink.profiler | NoProfiler -| The "``profiler``" property configures the type of profiler used to capture runtime statistics. +| The "`profiler`" property configures the type of profiler used to capture runtime statistics. *Allowed Values:* -* "``NoProfiler``" (DEFAULT) -* "``PerformanceMonitor``" - use ``PerformanceMonitor`` -* "``PerformanceProfiler``" - use ``PerformanceProfiler`` -* "``QueryMonitor``" - use ``QueryMonitor`` -* "``DMSProfiler``" - use ``DMSPerformanceProfiler`` -* the fully qualified name for a class that implements ``SessionProfiler`` interface +* "`NoProfiler`" (DEFAULT) +* "`PerformanceMonitor`" - use `PerformanceMonitor` +* "`PerformanceProfiler`" - use `PerformanceProfiler` +* "`QueryMonitor`" - use `QueryMonitor` +* "`DMSProfiler`" - use `DMSPerformanceProfiler` +* the fully qualified name for a class that implements `SessionProfiler` interface @see https://www.eclipse.org/eclipselink/documentation/2.7/jpa/extensions/persistenceproperties_ref.htm#profiler[eclipselink.profiler] diff --git a/core/config/src/main/adoc/modules/config/pages/sections/resteasy.adoc b/core/config/src/main/adoc/modules/config/pages/sections/resteasy.adoc index 4eefcca7fac..087d8be828b 100644 --- a/core/config/src/main/adoc/modules/config/pages/sections/resteasy.adoc +++ b/core/config/src/main/adoc/modules/config/pages/sections/resteasy.adoc @@ -30,7 +30,7 @@ resteasy.jaxrs.default-path | /restful | The path at which the RO viewer should be mounted. -Note that this is used rather than ``prefix`` because there is _NO_ implementation of ``Application``, so we rely on it being automatically created. +Note that this is used rather than `prefix` because there is _NO_ implementation of `Application`, so we rely on it being automatically created. @see https://github.com/resteasy/resteasy-spring-boot/blob/master/mds/USAGE.md[resteasy-spring-boot-starter docs]