You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2015/12/03 19:15:46 UTC
[28/51] [abbrv] isis git commit: ISIS-1234: extracted configuration
guide from rg.adoc.
ISIS-1234: extracted configuration guide from rg.adoc.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/1409af28
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/1409af28
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/1409af28
Branch: refs/heads/master
Commit: 1409af28ad6538ee5dd4cbac9079c7036f1f7b3a
Parents: f4f2631
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Thu Dec 3 17:23:45 2015 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Thu Dec 3 17:23:45 2015 +0000
----------------------------------------------------------------------
...tes_1.8.0-to-1.9.0_exception-recognizer.adoc | 2 +-
.../src/main/asciidoc/documentation.adoc | 4 +-
.../asciidoc/guides/_cg_asciidoc-templates.adoc | 8 +-
.../src/main/asciidoc/guides/_rg_classes.adoc | 2 +-
.../asciidoc/guides/_rg_methods_reserved.adoc | 2 +-
.../_rg_methods_reserved_manpage-cssClass.adoc | 4 +-
.../src/main/asciidoc/guides/_rg_runtime.adoc | 28 --
.../_rg_runtime_application-specific.adoc | 13 -
...me_application-specific_application-css.adoc | 8 -
...ime_application-specific_application-js.adoc | 9 -
.../guides/_rg_runtime_configuration-files.adoc | 40 --
.../guides/_rg_runtime_configuring-core.adoc | 455 -------------------
.../_rg_runtime_configuring-datanucleus.adoc | 18 -
...s_disabling-persistence-by-reachability.adoc | 88 ----
...atanucleus_eagerly-registering-entities.adoc | 23 -
...configuring-datanucleus_persistence-xml.adoc | 10 -
...time_configuring-datanucleus_properties.adoc | 66 ---
...ring-datanucleus_using-jndi-data-source.adoc | 75 ---
.../guides/_rg_runtime_deployment-types.adoc | 111 -----
.../_rg_runtime_specifying-components.adoc | 110 -----
.../asciidoc/guides/_rgant-ActionLayout.adoc | 2 +-
.../guides/_rgant-ActionLayout_cssClass.adoc | 2 +-
.../asciidoc/guides/_rgant-Action_command.adoc | 2 +-
.../guides/_rgant-Action_publishing.adoc | 2 +-
.../guides/_rgant-Action_restrictTo.adoc | 2 +-
.../guides/_rgant-CollectionLayout.adoc | 2 +-
.../_rgant-CollectionLayout_cssClass.adoc | 2 +-
.../guides/_rgant-CollectionLayout_paged.adoc | 2 +-
.../guides/_rgant-Collection_editing.adoc | 2 +-
.../guides/_rgant-DomainObjectLayout.adoc | 2 +-
.../_rgant-DomainObjectLayout_cssClass.adoc | 2 +-
.../guides/_rgant-DomainObjectLayout_paged.adoc | 2 +-
.../guides/_rgant-DomainObject_auditing.adoc | 2 +-
.../guides/_rgant-DomainObject_editing.adoc | 2 +-
.../guides/_rgant-DomainObject_publishing.adoc | 2 +-
.../asciidoc/guides/_rgant-ParameterLayout.adoc | 2 +-
.../guides/_rgant-ParameterLayout_cssClass.adoc | 2 +-
.../asciidoc/guides/_rgant-PostConstruct.adoc | 2 +-
.../asciidoc/guides/_rgant-PropertyLayout.adoc | 4 +-
.../guides/_rgant-PropertyLayout_cssClass.adoc | 2 +-
.../_rgant-PropertyLayout_labelPosition.adoc | 2 +-
.../guides/_rgant-Property_editing.adoc | 2 +-
.../asciidoc/guides/_rgant-ViewModelLayout.adoc | 2 +-
.../guides/_rgant-ViewModelLayout_cssClass.adoc | 2 +-
.../guides/_rgant-ViewModelLayout_paged.adoc | 2 +-
.../guides/_rgcfg_configuration-files.adoc | 40 ++
.../guides/_rgcfg_configuring-core.adoc | 455 +++++++++++++++++++
.../guides/_rgcfg_configuring-datanucleus.adoc | 18 +
...s_disabling-persistence-by-reachability.adoc | 88 ++++
...atanucleus_eagerly-registering-entities.adoc | 23 +
...configuring-datanucleus_persistence-xml.adoc | 10 +
...gcfg_configuring-datanucleus_properties.adoc | 66 +++
...ring-datanucleus_using-jndi-data-source.adoc | 75 +++
.../guides/_rgcfg_deployment-types.adoc | 111 +++++
.../guides/_rgcfg_specifying-components.adoc | 110 +++++
.../guides/_rgsvc-api_ClockService.adoc | 4 +-
.../guides/_rgsvc-api_CommandContext.adoc | 2 +-
...nObjectContainer_object-persistence-api.adoc | 2 +-
...pi_DomainObjectContainer_properties-api.adoc | 2 +-
.../guides/_rgsvc-api_EmailService.adoc | 2 +-
.../guides/_rgsvc-api_EventBusService.adoc | 2 +-
.../_rgsvc-api_FixtureScriptsDefault.adoc | 2 +-
.../_rgsvc-spi_ContentNegotiationService.adoc | 4 +-
.../guides/_rgsvc-spi_ExceptionRecognizer.adoc | 2 +-
.../_rgsvc-spi_UserRegistrationService.adoc | 2 +-
...g_how-tos_ui-hints_action-icons-and-css.adoc | 4 +-
...b_deployment_externalized-configuration.adoc | 2 +-
.../guides/_ugbtb_deployment_tomcat.adoc | 2 +-
...btb_more-advanced_decoupling_db-schemas.adoc | 2 +-
.../guides/_ugbtb_more-advanced_i18n.adoc | 4 +-
.../main/asciidoc/guides/_ugbtb_web-xml.adoc | 2 +-
.../guides/_ugsec_usage-by-isis-viewers.adoc | 2 +-
.../asciidoc/guides/_ugvro_hints-and-tips.adoc | 2 +-
.../guides/_ugvw_customisation_brand-logo.adoc | 2 +-
...ugvw_customisation_tweaking-css-classes.adoc | 4 +-
.../src/main/asciidoc/guides/_ugvw_layout.adoc | 2 +-
.../src/main/asciidoc/guides/rg.adoc | 12 +-
.../src/main/asciidoc/guides/rgcfg.adoc | 32 ++
.../src/main/asciidoc/guides/ug.adoc | 16 +-
79 files changed, 1112 insertions(+), 1124 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/_migration-notes_1.8.0-to-1.9.0_exception-recognizer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/_migration-notes_1.8.0-to-1.9.0_exception-recognizer.adoc b/adocs/documentation/src/main/asciidoc/_migration-notes_1.8.0-to-1.9.0_exception-recognizer.adoc
index 79f6a89..11683ab 100644
--- a/adocs/documentation/src/main/asciidoc/_migration-notes_1.8.0-to-1.9.0_exception-recognizer.adoc
+++ b/adocs/documentation/src/main/asciidoc/_migration-notes_1.8.0-to-1.9.0_exception-recognizer.adoc
@@ -42,7 +42,7 @@ public class EstatioIntegTestBuilder extends IsisSystemForTest.Builder {
If you fail to do this you will get an exception to the effect of duplicate service Ids being registered.
-Now that the `ExceptionRecognizerCompositeForJdoObjectStore` no longer needs to be explicitly registered, you might (very rarely) require the opposite situation, namely to disable the service. As this can't be done by just removing it from `isis.poperties`, you instead can set a new xref:rg.adoc#_rg_runtime_configuring-core[configuration property] `isis.services.ExceptionRecognizerCompositeForJdoObjectStore.disable`:
+Now that the `ExceptionRecognizerCompositeForJdoObjectStore` no longer needs to be explicitly registered, you might (very rarely) require the opposite situation, namely to disable the service. As this can't be done by just removing it from `isis.poperties`, you instead can set a new xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.ExceptionRecognizerCompositeForJdoObjectStore.disable`:
[source,ini]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/documentation.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/documentation.adoc b/adocs/documentation/src/main/asciidoc/documentation.adoc
index 90e7fef..d119f8c 100644
--- a/adocs/documentation/src/main/asciidoc/documentation.adoc
+++ b/adocs/documentation/src/main/asciidoc/documentation.adoc
@@ -69,9 +69,11 @@ pass:[<br/>]
|*Reference Guides:*
-* link:./guides/rg.html[Reference Guide^]
* link:./guides/rgant.html[Annotations^]
* link:./guides/rgsvc.html[Domain Services^]
+* link:./guides/rgcfg.html[Configuration Properties^]
+* link:./guides/rg.html[Classes, Methods and Schema^]
+
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc
index 04ebf6f..9b2cc8c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc
@@ -201,18 +201,18 @@ a hyperlink to a level 3 (chapter, section, subsection) within the reference gui
for example:
-pass:[<pre>xref:rg.adoc#_rg_runtime_application-specific_application-css[Application-specific CSS\]</pre>]
+pass:[<pre>xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS\]</pre>]
-|xref:rg.adoc#_rg_runtime_application-specific_application-css[Application-specific CSS]
+|xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS]
|`adrgcfg`
-|pass:[<pre>xref:rg.adoc#_rg_runtime_configuring-core[configuration properties]</pre>]
+|pass:[<pre>xref:rgcfg.adoc#_rgcfg_configuring-core[configuration properties]</pre>]
a hyperlink to the reference guide's catalogue of the Apache Isis configuration properties.
-|xref:rg.adoc#_rg_runtime_configuring-core[configuration properties]
+|xref:rgcfg.adoc#_rgcfg_configuring-core[configuration properties]
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_classes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_classes.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_classes.adoc
index 65d976f..0479db0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_classes.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rg_classes.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-This chapter describes the usage of various classes and interfaces that are not otherwise associated with xref:rgsvc.adoc#_rgsvc-api[domain] xref:rgsvc.adoc#_rgsvc-spi[services], xref:ug.adoc#_ug_object-layout[object layout] or xref:rg.adoc#_rg_runtime[configuration].
+This chapter describes the usage of various classes and interfaces that are not otherwise associated with xref:rgsvc.adoc#_rgsvc-api[domain] xref:rgsvc.adoc#_rgsvc-spi[services], xref:ug.adoc#_ug_object-layout[object layout] or xref:rgcfg.adoc#_rgcfg[configuration].
include::_rg_classes_AppManifest-bootstrapping.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved.adoc
index 7d285c6..762a8bb 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved.adoc
@@ -16,7 +16,7 @@ The table below lists the reserved methods that are recognized as part of Apache
|Description
|xref:rg.adoc#_rg_methods_reserved_manpage-cssClass[`cssClass()`]
-|Provides a CSS class for this object instance. In conjunction with xref:rg.adoc#_rg_runtime_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
+|Provides a CSS class for this object instance. In conjunction with xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
See also xref:rg.adoc#_rg_methods_reserved_manpage-title[`title()`] and xref:rg.adoc#_rg_methods_reserved_manpage-iconName[`iconName()`].
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved_manpage-cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved_manpage-cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved_manpage-cssClass.adoc
index fcc09f8..e0b388f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved_manpage-cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rg_methods_reserved_manpage-cssClass.adoc
@@ -10,7 +10,7 @@ The `cssClass()` returns a CSS class for a particular object instance.
The xref:ugvw.adoc#[Wicket viewer] wraps the object's representation in a containing `<div>` with the class added. This is done both for rendering the object either in a table or when rendering the object on its own page.
-In conjunction with xref:rg.adoc#_rg_runtime_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
+In conjunction with xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
For example, the (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp] uses this technique to add a strikethrough for completed todo items. This is shown on the home page:
@@ -30,7 +30,7 @@ public class ToDoItem ... {
}
----
-In the xref:rg.adoc#_rg_runtime_application-specific_application-css[application.css], the following styles were then added:
+In the xref:rgcfg.adoc#_rgcfg_application-specific_application-css[application.css], the following styles were then added:
[source,css]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime.adoc
deleted file mode 100644
index 7577e68..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime.adoc
+++ /dev/null
@@ -1,28 +0,0 @@
-[[_rg_runtime]]
-= Configuration Properties
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-Isis' own configuration properties are simple key-value pairs, typically held in the `WEBINF/isis.properties` file and other related files. This chapter describes how to configure an Apache Isis application.
-
-[NOTE]
-====
-Configuration properties for the viewers can be found in the xref:ugvw.adoc#[Wicket Viewer] chapter and the xref:ugvro.adoc#[RestfulObjects viewer] chapter. Likewise[details of configuring security (Apache Shiro) can be found in the xref:ugsec.adoc#[Security] chapter.
-
-Also, note that by default the configuration values are part of the built WAR file. Details on how to override these configuration properties externally for different environments can be found in the xref:ugbtb.adoc#_ugbtb_deployment[Deployment] chapter.
-====
-
-
-include::_rg_runtime_deployment-types.adoc[leveloffset=+1]
-include::_rg_runtime_configuration-files.adoc[leveloffset=+1]
-include::_rg_runtime_specifying-components.adoc[leveloffset=+1]
-include::_rg_runtime_configuring-core.adoc[leveloffset=+1]
-include::_rg_runtime_configuring-datanucleus.adoc[leveloffset=+1]
-include::_rg_runtime_application-specific.adoc[leveloffset=+1]
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific.adoc
deleted file mode 100644
index 9f5be17..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
-[[_rg_runtime_application-specific]]
-= Application-specific CSS and JS
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-NOTE: TODO
-
-
-include::_rg_runtime_application-specific_application-css.adoc[leveloffset=+1]
-include::_rg_runtime_application-specific_application-js.adoc[leveloffset=+1]
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-css.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-css.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-css.adoc
deleted file mode 100644
index 93100f1..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-css.adoc
+++ /dev/null
@@ -1,8 +0,0 @@
-[[_rg_runtime_application-specific_application-css]]
-= `application.css`
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-NOTE: TODO - `WEB-INF/css/application.css`
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-js.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-js.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-js.adoc
deleted file mode 100644
index 1699cf8..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_application-specific_application-js.adoc
+++ /dev/null
@@ -1,9 +0,0 @@
-[[_rg_runtime_application-specific_application-js]]
-= `application.js`
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-NOTE: TODO - `WEB-INF/scripts/application.js`
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuration-files.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuration-files.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuration-files.adoc
deleted file mode 100644
index 3d5d131..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuration-files.adoc
+++ /dev/null
@@ -1,40 +0,0 @@
-[[_rg_runtime_configuration-files]]
-= Configuration Files
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-When running an Apache Isis webapp, configuration properties are read from configuration files held in the `WEB-INF` directory.
-
-The `WEBINF/isis.properties` file is always read and must exist.
-
-In addition, the following other properties are searched for and if present also read:
-
-* `viewer_wicket.properties` - if the xref:ugvw.adoc#[Wicket viewer] is in use
-
-* `viewer_restfulobjects.properties` - if the xref:ugvro.adoc#[RestfulObjects viewer] is in use
-
-* `viewer.properties` - for any other viewer configuration (but there are none currently)
-
-* `persistor_datanucleus.properties` - assuming the JDO/DataNucleus objectstore is in use
-
-* `persistor.properties` - for any other objectstore configuration. +
-+
-This typically is used to hold `JDBC` ``URL``s, which is arguably a slight violation of the file (because there's nothing in Apache Isis to say that persistors have to use `JDBC`. However, it is generally convenient to put these `JDBC` settings into a single location. If you want, they could reside inin any of `persistor_datanucleus.properties`, `persistor.properties` or (even) `isis.properties`
-
-* `authentication_shiro.properties`, `authorization_shiro.properties`
-+
-assuming the Shiro Security is in use (but there are no security-related config properties currently; use shiro.ini for Shiro config)
-
-* `authentication.properties`, `authorization.properties` +
-+
-for any other security-related config properties (but there are none currently).
-
-You can if you wish simply store all properties in the `isis.properties` file; but we think that breaking properties out into sections is preferable.
-
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-core.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-core.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-core.adoc
deleted file mode 100644
index 63b1f9c..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-core.adoc
+++ /dev/null
@@ -1,455 +0,0 @@
-[[_rg_runtime_configuring-core]]
-= Configuring Core
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-This section lists the core/runtime configuration properties recognized by Apache Isis.
-
-[NOTE]
-====
-Configuration properties for the JDO/DataNucleus objectstore can be found in the xref:rg.adoc#_rg_runtime_configuring-datanucleus[Configuring DataNucleus] section later in this chapter, while configuration properties for the viewers can be found in the their respective chapters, xref:ugvw.adoc#_ugvw_configuration-properties[here for Wicket viewer], and xref:ugvro.adoc#_ugvro_configuration-properties[here for the Restful Objects viewer].
-====
-
-
-
-.Core Configuration Properties
-[cols="2a,1,3a", options="header"]
-|===
-|Property
-|Value +
-(default value)
-|Description
-
-|`isis.object.` +
-`editing`
-|`true`,`false` +
-(`true`)
-|Whether objects' properties and collections can be edited directly (for objects annotated with xref:rgant.adoc#_rgant-DomainObject_editing[`@DomainObject#editing()`]); see xref:rg.adoc#_rg_runtime_configuring-core_isis-objects-editing[below] for further discussion.
-
-
-|`isis.persistor.` +
-`disableConcurrencyChecking`
-|`true`,`false` +
-(`false`)
-| Disables concurrency checking globally. +
-
-Only intended for "emergency use" as a workaround while pending fix/patch to Apache Isis itself. (Note that there is no "datanucleus" in the property).
-
-|`isis.reflector.facet.` +
-`actionAnnotation.` +
-`domainEvent.postForDefault`
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`] is not specified (is set to `ActionDomainEvent.Default`).
-
-|`isis.reflector.facet.` +
-`collectionAnnotation.` +
-`domainEvent.postForDefault`
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-Collection_domainEvent[`@Collection#domainEvent()`] is not specified (is set to `CollectionDomainEvent.Default`).
-
-|`isis.reflector.facet.` +
-`cssClass.patterns`
-|regex:css1, regex2:css2,...
-|Comma separated list of key:value pairs, where the key is a regex matching action names (eg `delete.*`) and the value is a link:http://getbootstrap.com/css/[Bootstrap] CSS button class (eg `btn-warning) to be applied (as per `@CssClass()`) to all action members matching the regex. +
-
-See xref:ug.adoc#_ug_how-tos_ui-hints_action-icons-and-css[UI hints] for more details.
-
-|`isis.reflector.facet.` +
-`cssClassFa.patterns`
-|regex:fa-icon,regex2:fa-icon2,...
-|Comma separated list of key:value pairs, where the key is a regex matching action names (eg `create.*`) and the value is a link:http://fortawesome.github.io/Font-Awesome/icons/[font-awesome] icon name (eg `fa-plus`) to be applied (as per `@CssClassFa()`) to all action members matching the regex. +
-
-See xref:ug.adoc#_ug_how-tos_ui-hints_action-icons-and-css[UI hints] for more details.
-
-|`isis.reflector.facet.` +
-`domainObjectAnnotation.` +
-`createdLifecycleEvent.` +
-`postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObject_createdLifecycleEvent[`@DomainObject#createdLifecycleEvent()`] is not specified (is set to `ObjectCreatedEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectAnnotation.` +
-`loadedLifecycleEvent.` +
-`postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObject_loadedLifecycleEvent[`@DomainObject#loadedLifecycleEvent()`] is not specified (is set to `ObjectLoadedEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectAnnotation.` +
-`persistingLifecycleEvent.` +
-`postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObject_persistingLifecycleEvent[`@DomainObject#persistingLifecycleEvent()`] is not specified (is set to `ObjectPersistingEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectAnnotation.` +
-`persistedLifecycleEvent.` +
-`postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObject_persistedLifecycleEvent[`@DomainObject#persistedLifecycleEvent()`] is not specified (is set to `ObjectPersistedEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectAnnotation.` +
-`removingLifecycleEvent.` +
-`postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObject_removingLifecycleEvent[`@DomainObject#removingLifecycleEvent()`] is not specified (is set to `ObjectRemovingEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectAnnotation.` +
-`updatingLifecycleEvent.` +
-`postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObject_updatingLifecycleEvent[`@DomainObject#updatingLifecycleEvent()`] is not specified (is set to `ObjectUpdatingEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectAnnotation.` +
-`updatedLifecycleEvent.` +
-`postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObject_updatedLifecycleEvent[`@DomainObject#updatedLifecycleEvent()`] is not specified (is set to `ObjectUpdatedEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectLayoutAnnotation.` +
-`cssClassUiEvent.postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`@DomainObjectLayout#cssClassUiEvent()`] is not specified (is set to `CssClassUiEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectLayoutAnnotation.` +
-`iconUiEvent.postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`@DomainObjectLayout#iconUiEvent()`] is not specified (is set to `IconUiEvent.Default`).
-
-|`isis.reflector.facet.` +
-`domainObjectLayoutAnnotation.` +
-`titleUiEvent.postForDefault` +
-(`1.11.0-SNAPSHOT`)
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`] is not specified (is set to `TitleUiEvent.Default`).
-
-|`isis.reflector.facet.` +
-`filterVisibility`
-|`true`,`false` +
-(`true`)
-|Whether objects should be filtered for visibility. +
-
-See xref:rg.adoc#_rg_runtime_configuring-core_filterVisibility[section below] for further discussion.
-
-|`isis.reflector.facet.` +
-`propertyAnnotation.` +
-`domainEvent.postForDefault`
-|`true`,`false` +
-(`true`)
-|Whether an event should be posted if xref:rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`] is not specified (is set to `PropertyDomainEvent.Default`).
-
-|`isis.reflector.facets`
-|`FQCN`
-|Fully qualified class names of a custom implementation of `ProgrammingModel` interface. +
-
-See xref:ugbtb.adoc#_ugbtb_programming-model_finetuning[finetuning the programming model] for more details.
-
-|`isis.reflector.facets.` +
-`exclude`
-|`FQCN`,`FQCN2`,...
-|Fully qualified class names of (existing, built-in) facet factory classes to be included to the programming model. +
-
-See xref:ugbtb.adoc#_ugbtb_programming-model_finetuning[finetuning the programming model] for more details.
-
-|`isis.reflector.facets.` +
-`include`
-|`FQCN`,`FQCN2`,...
-|Fully qualified class names of (new, custom) facet factory classes to be included to the programming model. +
-See xref:ugbtb.adoc#_ugbtb_programming-model_finetuning[finetuning the programming model] for more details.
-
-
-|`isis.reflector.` +
-`layoutMetadataReaders`
-|`FQCN`,`FQCN2`,...
-|Fully qualified class names of classes to be instantiated to read layout metadata, as used in for xref:ug.adoc#_ug_object-layout_dynamic[dynamic layout]s. +
-
-See xref:ugbtb.adoc#_ugbtb_programming-model_layout-metadata-reader[Layout Metadata Reader] for more information.
-
-
-
-|`isis.reflector.validator`
-|`FQCN`
-|Custom implementation of `MetaModelValidator` (in the `org.apache.isis.core.metamodel.specloader.validator` package) +
-
-See xref:ugbtb.adoc#_ugbtb_programming-model_custom-validator[Custom Validator] to learn more.
-
-|`isis.reflector.validator.` +
-`allowDeprecated`
-|`true`,`false` +
-(`true`)
-| Whether deprecated annotations or naming conventions are tolerated or not. If not, then a metamodel validation error will be triggered, meaning the app won't boot (fail-fast).
-
-
-|`isis.services`
-|`FQCN`,`FQCN2`,...
-|Fully qualified class names of classes to be instantiated as domain services. +
-
-Each entry can be optionally prefixed by "n:" specifying the relative order on the menu (corresponds to xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`]).
-
-This property is IGNORED if the xref:rg.adoc#_rg_runtime_configuring-components[`isis.appManifest`] configuration property is specified, or if an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`] is provided programmatically.
-
-
-|`isis.services.` +
-`audit.objects`
-| `all`, `none` +
-(`all`)
-|Whether the changed properties of objects should be automatically audited (for objects annotated with xref:rgant.adoc#_rgant-DomainObject_auditing[`@DomainObject(auditing=Auditing.AS_CONFIGURED)`].
-
-|`isis.services.` +
-`command.actions`
-| `all`, `ignoreSafe`, `none` (`all`)
-|Whether actions should be automatically reified into commands (for actions annotated with xref:rgant.adoc#_rgant-Action_command[`@Action(command=CommandReification.AS_CONFIGURED)`]. +
-
-`ignoreQueryOnly` is an alias for `ignoreSafe`.
-
-
-|`isis.services.` +
-`container.disableAutoFlush`
-|`true`,`false` +
-(`false`)
-|Whether the `DomainObjectContainer` should automatically flush pending changes prior to querying (via `allMatches()`, `firstMatch()` and so on).
-
-|`isis.services.` +
-`container.disableAutoFlush`
-|`true`,`false` +
-(`false`)
-|Whether the `DomainObjectContainer` should automatically flush pending changes prior to querying (via `allMatches()`, `firstMatch()` and so on).
-
-
-
-|`isis.services.` +
-`ContentNegotiation-` +
-`ServiceXRoDomainType` +
-.prettyPrint
-| `true`,`false` +
-(depends)
-|If a domain object has been mapped to the specified JAXB `x-ro-domain-type`, then determines whether the result is pretty-printed or not. +
-+
-If no configuration property is available, then the defaults is determined by the xref:rg.adoc#_rg_runtime_deployment-types[deployment type]: production mode disables pretty printing, while prototype mode enables it.
-
-
-
-| `isis.service.` +
-`email.tls.enabled`
-|`true`,`false` +
-(`true`)
-|Whether to enable TLS for the email SMTP connection (used by xref:rgsvc.adoc#_rgsvc-api_EmailService[`EmailService`]). +
-
-NB: note that the key is mis-spelt, (`isis.service.email` rather than `isis.services.email`)
-
-| `isis.service.` +
-`email.sender.hostname` +
-| host (`_smtp.gmail.com_`)
-|The hostname of the external SMTP provider (used by xref:rgsvc.adoc#_rgsvc-api_EmailService[`EmailService`]). +
-
-NB: note that the key is mis-spelt, (`isis.service.email` rather than `isis.services.email`)
-
-| `isis.service.` +
-`email.port` +
-| port number (`_587_`)
-|The port number for the SMTP service on the the external SMTP host (used by xref:rgsvc.adoc#_rgsvc-api_EmailService[`EmailService`]). +
-
-NB: note that the key is mis-spelt, (`isis.service.email` rather than `isis.services.email`)
-
-
-| `isis.service.` +
-`email.sender.address` +
-| email address
-|The email address to use for sending out email (used by xref:rgsvc.adoc#_rgsvc-api_EmailService[`EmailService`]). *Mandatory*. +
-
-NB: note that the key is mis-spelt, (`isis.service.email` rather than `isis.services.email`)
-
-| `isis.service.` +
-`email.sender.password` +
-| email password
-|The corresponding password for the email address to use for sending out email (used by xref:rgsvc.adoc#_rgsvc-api_EmailService[`EmailService`]). *Mandatory*. +
-
-NB: note that the key is mis-spelt, (`isis.service.email` rather than `isis.services.email`)
-
-
-| `isis.services.` +
-`eventbus.implementation` +
-| `guava`, `axon`, +
-FQCN (`_guava_`)
-|which implementation to use by the xref:rgsvc.adoc#_rgsvc-api_EventBusService[`EventBusService`] as the underlying event bus.
-
-| `isis.services.` +
-`eventbus.allowLateRegistration` +
-|`true`,`false` +
-(`false`)
-|whether a domain service can register with the xref:rgsvc.adoc#_rgsvc-api_EventBusService[`EventBusService`] after any events have posted. +
-
-Since this almost certainly constitutes a bug in application code, by default this is disallowed.
-
-
-| `isis.services.` +
-`exceprecog.logRecognizedExceptions` +
-|`true`,`false` +
-(`false`)
-|whether recognized exceptions should also be logged. +
-
-Generally a recognized exception is one that is expected (for example a uniqueness constraint violated in the database) and which does not represent an error condition. This property logs the exception anyway, useful for debugging.
-
-
-| `isis.services.` +
-`ExceptionRecognizerComposite-` +
-`ForJdoObjectStore.disable` +
-|`true`,`false` +
-(`false`)
-|whether to disable the default recognizers registered by `ExceptionRecognizerCompositeForJdoObjectStore`. +
-
-This implementation provides a default set of recognizers to convert RDBMS constraints into user-friendly messages. In the (probably remote) chance that this functionality isn't required, they can be disabled through this flag.
-
-
-|`isis.services.` +
-`publish.objects`
-| `all`, `none` +
-(`all`)
-|Whether changed objects should be automatically published (for objects annotated with xref:rgant.adoc#_rgant-DomainObject_publishing[`@DomainObject(publishing=Publishing.AS_CONFIGURED)`].
-
-|`isis.services.` +
-`publish.actions`
-| `all`, `ignoreSafe`, `none` (`all`)
-|Whether actions should be automatically published (for actions annotated with xref:rgant.adoc#_rgant-Action_publishing[`@Action(publishing=Publishing.AS_CONFIGURED)`]. +
-
-
-|`isis.services.` +
-`ServicesInstallerFromAnnotation.` +
-`packagePrefix`
-|fully qualified package names (CSV)
-|to search for domain services (including all subpackages).
-
-This property is IGNORED if the xref:rg.adoc#_rg_runtime_configuring-components[`isis.appManifest`] configuration property is specified, or if an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`] is provided programmatically.
-
-
-|`isis.services.` +
-`translation.po.mode`
-| `read`,`write`
-|Whether to force the `TranslationService` into either read or write mode. +
-
-See xref:ugbtb.adoc#_ugbtb_more-advanced_i18n[i18n support] to learn more about the translation service.
-
-|`isis.viewers.` +
-`paged.parented`
-|positive integer (12)
-|Default page size for parented collections (as owned by an object, eg `Customer#getOrders()`)
-
-|`isis.viewers.` +
-`paged.standalone`
-|positive integer (25)
-|Default page size for standalone collections (as returned from an action invocation)
-
-
-|`isis.viewers.` +
-`propertyLayout.labelPosition`
-|`TOP`, `LEFT` +
-(`LEFT`)
-|Default for label position for all properties if not explicitly specified using xref:rgant.adoc#_rgant-PropertyLayout_labelPosition[`@PropertyLayout#labelPosition()`]
-
-|===
-
-
-
-[[_rg_runtime_configuring-core_filterVisibility]]
-== Filtering visibility
-
-The framework provides the `isis.reflector.facet.filterVisibility` configuration property that influences whether a returned object is visible to the end-user:
-
-* Action invocations: +
-
-If an action returns a collection that includes the object, then the object will be excluded from the list when rendered. If it returns a single object and the user does not have access to that object, then the action will seemingly return `null`
-
-* Collections: +
-
-If a parent object has a collection references another object to which the user does not have access, then (as for actions) the object will not be rendered in the list
-
-* Properties: +
-
-If an parent object has a (scalar) reference some other object to which the user does not have access, then the reference will be rendered as empty.
-
-* Choices and autoComplete lists: +
-
-If an object is returned in a list of choices or within an auto-complete list, and the user does not have access, then it is excluded from the rendered list.
-
-The original motivation for this feature was to transparently support such features as multi-tenancy (as per the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module). That is, if an entity is logically "owned" by a user, then the multi-tenancy support can be arranged to prevent some other user from viewing that object.
-
-By default this configuration property is enabled. To disable the visibility filtering, set the appropriate configuration property to `false`:
-
-[source,ini]
-----
-isis.reflector.facet.filterVisibility=false
-----
-
-Filtering is supported by the Wicket viewer, and by the xref:rgsvc.adoc#_rgsvc-api_WrapperFactory[`WrapperFactory`] domain service (provided the wrapper's execution mode is _not_ "skip rules"). However the Restful Objects viewer does _not_ currently support filtering.
-
-[NOTE]
-====
-In order for the framework to perform this filtering of collections, be aware that the framework takes a _copy_ of the original collection, filters on the collection, and returns that filtered collection rather than the original.
-
-There are no major side-effects from this algorithm, other than the fact that the referenced objects will (most likely) need to be resolved in order to determine if they are visible. This could conceivably have a performance impact in some cases.
-====
-
-
-[[_rg_runtime_configuring-core_isis-objects-editing]]
-== `objects.editing`
-
-This configuration property in effect allows editing to be disabled globally for an application:
-
-[source,ini]
-----
-isis.objects.editing=false
-----
-
-We recommend enabling this feature; it will help drive out the underlying business operations (processes and procedures) that require objects to change; these can then be captured as business actions.
-
-
-
-[[_rg_runtime_configuring-core_isis-viewers-propertyLayout-labelPosition]]
-== `propertyLayout.labelPosition`
-
-If you want a consistent look-n-feel throughout the app, eg all property labels to the top, then it'd be rather
-frustrating to have to annotate every property.
-
-Instead, a default can be specified in `isis.properties`:
-
-[source,ini]
-----
-isis.viewers.propertyLayout.labelPosition=TOP
-----
-
-or
-
-[source,ini]
-----
-isis.viewers.propertyLayout.labelPosition=LEFT
-----
-
-If these are not present then Apache Isis will render according to internal defaults. At the time of writing, this means labels are to the left for all datatypes except multiline strings.
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus.adoc
deleted file mode 100644
index 8892b58..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus.adoc
+++ /dev/null
@@ -1,18 +0,0 @@
-[[_rg_runtime_configuring-datanucleus]]
-= Configuring DataNucleus
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-Apache Isis programmatically configures DataNucleus; any Apache Isis properties with the prefix `isis.persistor.datanucleus.impl` are passed through directly to the JDO/DataNucleus objectstore (with the prefix stripped off, of course).
-
-DataNucleus will for itself also and read the `META-INF/persistence.xml`; at a minimum this defines the name of the "persistence unit". n theory it could also hold mappings, though in Apache Isis we tend to use annotations instead.
-
-Furthermore, DataNucleus will search for various other XML mapping files, eg `mappings.jdo`. A full list can be found http://www.datanucleus.org/products/datanucleus/jdo/metadata.html[here]. The metadata in these XML can be used to override the annotations of annotated entities; see xref:ugbtb.adoc#_ugbtb_more-advanced_overriding-jdo-annotations[Overriding JDO Annotatons] for further discussion.
-
-
-include::_rg_runtime_configuring-datanucleus_properties.adoc[leveloffset=+1]
-include::_rg_runtime_configuring-datanucleus_persistence-xml.adoc[leveloffset=+1]
-include::_rg_runtime_configuring-datanucleus_eagerly-registering-entities.adoc[leveloffset=+1]
-include::_rg_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc[leveloffset=+1]
-include::_rg_runtime_configuring-datanucleus_using-jndi-data-source.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc
deleted file mode 100644
index ba690ef..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc
+++ /dev/null
@@ -1,88 +0,0 @@
-[[_rg_runtime_configuring-datanucleus_disabling-persistence-by-reachability]]
-= Persistence by Reachability
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-By default, JDO/DataNucleus supports the concept of http://www.datanucleus.org/products/datanucleus/jdo/orm/cascading.html[persistence-by-reachability]. That is, if
-a non-persistent entity is associated with an already-persistent entity, then DataNucleus will detect this and will automatically persist the associated object. Put another way: there is no need to call Apache Isis' `DomainObjectContainer#persist(.)` or `DomainObjectContainer#persistIfNotAlready(.)` methods.
-
-However, convenient though this feature is, you may find that it causes performance issues.
-
-[WARNING]
-====
-DataNucleus' persistence-by-reachability may cause performance issues. We strongly recommend that you disable it.
-====
-
-One scenario in particular where this performance issues can arise is if your entities implement the `java.lang.Comparable` interface, and you have used Apache Isis' xref:rg.adoc#_rg_classes_utility_manpage-ObjectContracts[`ObjectContracts`] utility class. The issue here is that `ObjectContracts` implementation can cause DataNucleus to recursively rehydrate a larger number of associated entities. (More detail below).
-
-We therefore recommend that you disable persistence-by-reachability by adding the following to `persistor_datanucleus.properties`:
-
-[source,ini]
-----
-isis.persistor.datanucleus.impl.datanucleus.persistenceByReachabilityAtCommit=false
-----
-
-This change has been made to the xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype]
-
-If you do disable this feature, then you will (of course) need to ensure that you explicitly persist all entities using the `DomainObjectContainer#persist(.)` or `DomainObjectContainer#persistIfNotAlready(.)` methods.
-
-
-
-
-
-== The issue in more detail
-
-Consider these entities (http://yuml.me/edit/b8681268[yuml.me/b8681268]):
-
-image::{_imagesdir}runtime/configuring-datanucleus/disabling-persistence-by-reachability/party-agreementrole-agreement.png[width="750px"]
-
-
-
-In the course of a transaction, the `Agreement` entity is loaded into memory (not necessarily modified), and then new ``AgreementRole``s are associated to it.
-
-All these entities implement `Comparable` using `ObjectContracts`, and the implementation of ``AgreementRole``'s (simplified) is:
-
-[source,java]
-----
-public class AgreementRole {
- ...
- public int compareTo(AgreementRole other) {
- return ObjectContracts.compareTo(this, other, "agreement","startDate","party");
- }
-}
-----
-
-while ``Agreement``'s is implemented as:
-
-[source,java]
-----
-public class Agreement {
- ...
- public int compareTo(Agreement other) {
- return ObjectContracts.compareTo(this, other, "reference");
- }
-}
-----
-
-and ``Party``'s is similarly implemented as:
-
-[source,java]
-----
-public class Party {
- ...
- public int compareTo(Party other) {
- return ObjectContracts.compareTo(this, other, "reference");
- }
-}
-----
-
-DataNucleus's persistence-by-reachability algorithm adds the `AgreementRole` instances into a `SortedSet`, which causes `AgreementRole#compareTo()` to fire:
-
-* the evaluation of the "agreement" property delegates back to the `Agreement`, whose own `Agreement#compareTo()` uses the scalar `reference` property. As the `Agreement` is already in-memory, this does not trigger any further database queries
-
-* the evaluation of the "startDate" property is just a scalar property of the `AgreementRole`, so will already in-memory
-
-* the evaluation of the "party" property delegates back to the `Party`, whose own `Party#compareTo()` requires the uses the scalar `reference` property. However, since the `Party` is not yet in-memory, using the `reference` property triggers a database query to "rehydrate" the `Party` instance.
-
-In other words, in figuring out whether `AgreementRole` requires the persistence-by-reachability algorithm to run, it causes the adjacent associated entity `Party` to also be retrieved.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_eagerly-registering-entities.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_eagerly-registering-entities.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_eagerly-registering-entities.adoc
deleted file mode 100644
index 3abeb61..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_eagerly-registering-entities.adoc
+++ /dev/null
@@ -1,23 +0,0 @@
-[[_rg_runtime_configuring-datanucleus_eagerly-registering-entities]]
-= Eagerly Registering Entities
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-Both Apache Isis and DataNucleus have their own metamodels of the domain entities. Apache Isis builds its metamodel by walking the graph of types of the domain services. The JDO/DataNucleus objectstore then takes these types and registers them with DataNucleus.
-
-In some cases, though, not every entity type is discoverable from the API of the service actions. This is especially the case if you have lots of subtypes (where the action method specifies only the supertype). In such cases the Isis and JDO metamodels is built lazily, when an instance of that (sub)type is first encountered.
-
-Apache Isis is quite happy for the metamodel to be lazily created, and - to be fair - DataNucleus also works well in most cases. In some cases, though, we have found that the JDBC driver (eg HSQLDB) will deadlock if DataNucleus tries to submit some DDL (for a lazily discovered type) intermingled with DML (for updating). In any case, it's probably not good practice to have DataNucleus work this way.
-
-The framework thus provide mechanisms to search for all `@PersistenceCapable` entities under specified package(s), and registers them all eagerly. In fact there are two:
-
-* as of 1.9.0 the recommended (and simpler) approach is to specify an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`], either as a xref:rg.adoc#_rg_runtime_configuring-components[`isis.appManifest`] configuration property or programmatically.
-
-* for earlier versions the `isis.persistor.datanucleus.RegisterEntities.packagePrefix` configuration property can be specified. To bootstrap as a webapp this is usually specified in `persistor_datanucleus.properties`. (This is also supported in 1.9.0 if no `AppManifest` is specified. For integration testing this can be specified programatically.
-
-Further discussion on specifying the package(s) in integration testing (for either approach) can be found in the xref:ugtst.adoc#_ugtst_integ-test-support_bootstrapping[user guide].
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_persistence-xml.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_persistence-xml.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_persistence-xml.adoc
deleted file mode 100644
index 9227513..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_persistence-xml.adoc
+++ /dev/null
@@ -1,10 +0,0 @@
-[[_rg_runtime_configuring-datanucleus_persistence-xml]]
-= `persistence.xml`
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-NOTE: TODO
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_properties.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_properties.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_properties.adoc
deleted file mode 100644
index ba21167..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_properties.adoc
+++ /dev/null
@@ -1,66 +0,0 @@
-[[_rg_runtime_configuring-datanucleus_properties]]
-= Configuration Properties
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-These configuration properties are typically stored in `WEB-INF/persistor_datanucleus.properties`. However, you can place all configuration properties into `WEB-INF/isis.properties` if you wish (the configuration properties from all config files are merged together).
-
-== Configuration Properties for Apache Isis itself
-
-
-.JDO/DataNucleus Objectstore Configuration Properties
-[cols="2a,1,3a", options="header"]
-|===
-|Property
-|Value +
-(_default value_)
-|Description
-
-|`isis.persistor.` +
-`datanucleus.` +
-`classMetadataLoadedListener`
-|`FQCN`
-|The default (`o.a.i.os.jdo.dn.CreateSchemaObjectFromClassMetadata`) creates a DB schema object
-
-
-|`isis.persistor.datanucleus.` +
-`RegisterEntities.packagePrefix`
-|fully qualified package names (CSV)
-|that specifies the entities early rather than allow DataNucleus to find the entities lazily. Further xref:rg.adoc#_rg_runtime_configuring-datanucleus_eagerly-registering-entities[discussion below].
-
-This property is IGNORED if the xref:rg.adoc#_rg_runtime_configuring-components[`isis.appManifest`] configuration property is specified, or if an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`] is provided programmatically.
-
-
-|`isis.persistor.datanucleus.` +
-`PublishingService.serializedForm`
-| zipped
-|
-
-|===
-
-
-
-== Configuration Properties passed through directly to DataNucleus.
-
-.JDO/DataNucleus Objectstore Configuration Properties
-[cols="2a,1,3a", options="header"]
-|===
-|Property
-|Value +
-(_default value_)
-|Description
-
-|`isis.persistor.datanucleus.impl.*`
-|
-| Passed through directly to Datanucleus (with `isis.persistor.datanucleus.impl` prefix stripped)
-
-|`isis.persistor.datanucleus.impl.` +
-`datanucleus.persistenceByReachabilityAtCommit`
-|`false`
-|We recommend this setting is disabled. +
-Further xref:rg.adoc#_rg_runtime_configuring-datanucleus_disabling-persistence-by-reachability[discussion below].
-
-|===
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_using-jndi-data-source.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_using-jndi-data-source.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_using-jndi-data-source.adoc
deleted file mode 100644
index 1cac414..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_configuring-datanucleus_using-jndi-data-source.adoc
+++ /dev/null
@@ -1,75 +0,0 @@
-[[_rg_runtime_configuring-datanucleus_using-jndi-data-source]]
-= Using JNDI DataSource
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-Isis' JDO objectstore can be configured either to connect to the database using its own connection pool, or by using a container-managed datasource.
-
-
-
-== Application managed
-
-Using a connection pool managed directly by the application (that is, by Apache Isis' JDO objectstore and ultimately by DataNucleus) requires a single set of configuration properties to be specified.
-
-In the `WEB-INF\persistor_datanucleus.properties` file, specify the connection driver, url, username and password.
-
-For example:
-
-[source,ini]
-----
-isis.persistor.datanucleus.impl.javax.jdo.option.ConnectionDriverName=net.sf.log4jdbc.DriverSpy
-isis.persistor.datanucleus.impl.javax.jdo.option.ConnectionURL=jdbc:log4jdbc:hsqldb:mem:test
-isis.persistor.datanucleus.impl.javax.jdo.option.ConnectionUserName=sa
-isis.persistor.datanucleus.impl.javax.jdo.option.ConnectionPassword=
-----
-
-Those configuration properties that start with the prefix `isis.persistor.datanucleus.impl.` are passed through directly to DataNucleus (with the prefix removed).
-
-
-
-
-
-== Container managed (JNDI)
-
-Using a datasource managed by the servlet container requires three separate bits of configuration.
-
-Firstly, specify the name of the datasource in the `WEB-INF\persistor_datanucleus.properties` file. For example:
-
-If connection pool settings are also present in this file, they will simply be ignored. Any other configuration properties that start with the prefix `isis.persistor.datanucleus.impl.` are passed through directly to DataNucleus (with the prefix removed).
-
-Secondly, in the `WEB-INF/web.xml`, declare the resource reference:
-
-[source,xml]
-----
-<resource-ref>
- <description>db</description>
- <res-ref-name>jdbc/simpleapp</res-ref-name>
- <res-type>javax.sql.DataSource</res-type>
- <res-auth>Container</res-auth>
-</resource-ref>
-----
-
-Finally, declare the datasource as required by the servlet container. For example, if using Tomcat 7, the datasource can be specified by adding the following to `$TOMCAT_HOME/conf/context.xml`:
-
-[source,xml]
-----
-<Resource name="jdbc/simpleapp"
- auth="Container"
- type="javax.sql.DataSource"
- maxActive="100"
- maxIdle="30"
- maxWait="10000"
- username="sa"
- password="p4ssword"
- driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
- url="jdbc:sqlserver://127.0.0.1:1433;instance=.;databaseName=simpleapp"/>
-----
-
-You will also need to make sure that the JDBC driver is on the servlet container's classpath. For Tomcat, this means copying the driver to `$TOMCAT_HOME/lib`.
-
-[NOTE]
-====
-According to Tomcat's documentation, it is supposedly possible to copy the `conf/context.xml` to the name of the webapp, eg `conf/mywebapp.xml`, and scope the connection to that webapp only. I was unable to get this working, however.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_deployment-types.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_deployment-types.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_deployment-types.adoc
deleted file mode 100644
index a8ce098..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_deployment-types.adoc
+++ /dev/null
@@ -1,111 +0,0 @@
-[[_rg_runtime_deployment-types]]
-= Deployment Types
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-Apache Isis distinguishes between the application being run in development mode vs running in production mode. The framework calls this the "deployment type" (corresponding internally to the `DeploymentType` class).
-
-(For mostly historical reasons) development mode is actually called `SERVER_PROTOTYPE`, while production mode is called just `SERVER`. (There is also a deprecated mode called `SERVER_EXPLORATION`; for all intents and purposes this can considered as an alias of `SERVER_PROTOTYPE`).
-
-When running in development/prototyping mode, certain capabilities are enabled; most notably any actions restricted to prototyping mode (using xref:rgant.adoc#_rgant-Action_restrictTo[`@Action#restrictTo()`]) will be available.
-
-
-
-== Using the Wicket Viewer
-
-Most of the you're likely to run Apache Isis using the xref:ugvw.adoc#[Wicket viewer]. In this case Apache Isis' "deployment type" concept maps to Wicket's "configuration" concept:
-
-.Apache Isis' deployment type corresponds to Apache Wicket's configuration
-[cols="1,1,2", options="header"]
-|===
-| Apache Isis +
-(Deployment Type)
-| Apache Wicket +
-(Configuration)
-| Notes
-
-| `SERVER_PROTOTYPE`
-| `development`
-| running in development/prototyping mode
-
-| `SERVER`
-| `deployment`
-| running in production mode
-
-|===
-
-
-Wicket's mechanism for specifying the "configuration" is to use a context parameter in `web.xml`; Apache Isis automatically infers its own deployment type from this. In other words:
-
-* to specify SERVER (production) mode, use: +
-+
-[source,xml]
-.`web.xml`
-----
-<context-param>
- <param-name>configuration</param-name>
- <param-value>deployment</param-value>
-</context-param>
-----
-
-* to specify `SERVER_PROTOTYPING` (development) mode, use: +
-+
-[source,xml]
-.`web.xml`
-----
-<context-param>
- <param-name>configuration</param-name>
- <param-value>deployment</param-value>
-</context-param>
-----
-
-
-== Restful Objects viewer only
-
-Most Apache Isis applications will consist of at least the xref:ugvw.adoc#[Wicket viewer] and optionally the xref:ugvro.adoc#[RestfulObjects viewer]. When both viewers are deployed in the same app, then the bootstrapping is performed by Wicket, and so the deployment type is configured as described in the previous section.
-
-In some cases though you may be using Apache Isis to provide a REST API only, that is, you won't have deployed the Wicket viewer. In these cases your app will be bootstrapped using Apache Isis' xref:ugbtb.adoc#_ugbtb_web-xml_servlet-context-listeners[ `IsisWebAppBootstrapper`].
-
-In this case the deployment type is specified through an Apache Isis-specific context parameter, called `isis.deploymentType`:
-
-* to specify `SERVER` (production) mode, use: +
-+
-[source,xml]
-.`web.xml`
-----
-<context-param>
- <param-name>isis.deploymentType</param-name>
- <param-value>server</param-value>
-</context-param>
-----
-
-* to specify `SERVER_PROTOTYPE` (development) mode, use: +
-+
-[source,xml]
-.`web.xml`
-----
-<context-param>
- <param-name>isis.deploymentType</param-name>
- <param-value>server-prototype</param-value>
-</context-param>
-----
-
-
-
-== Overriding the deployment type
-
-If bootstrapping the application using Apache Isis' xref:ugbtb.adoc#_ugbtb_deployment_cmd-line[`org.apache.isis.WebServer`] then it is possible to override the deployment type using the `-t` (or `--type`) flag.
-
-For example:
-
-[source,bash]
-----
-java -jar ... org.apache.isis.WebServer -t SERVER
-----
-
-where "..." is the (usually rather long) list of JAR files and class directories that will make up your application.
-
-This works for both the xref:ugvw.adoc#[Wicket viewer] and the xref:ugvro.adoc#[RestfulObjects viewer].
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_specifying-components.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_specifying-components.adoc b/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_specifying-components.adoc
deleted file mode 100644
index 2049ab2..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rg_runtime_specifying-components.adoc
+++ /dev/null
@@ -1,110 +0,0 @@
-[[_rg_runtime_configuring-components]]
-= Specifying components
-: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-Bootstrapping an Apache Isis application involves identifying both:
-
-* the major components (authentication, persistence mechanisms, viewers) of Apache Isis, and also
-* specifying the domain services and persistent entities that make up the application itself.
-
-As of 1.9.0 there are two different ways to perform this bootstrapping. The recommended (newer) approach is to use an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`], specified either programmatically or through the configuration properties. This allows the components, services and entities to be specified from a single class. The alternative (and older, pre 1.9.0) approach is to specify this information individually, through configuration properties.
-
-To specify the `AppManifest` as a configuration property, use:
-
-.Core Configuration Properties (ignored if `isis.appManifest` is present)
-[cols="2a,1,3a", options="header"]
-|===
-|Property
-|Value +
-(_default value_)
-|Implements
-
-|`isis.appManifest`
-|`FQCN`
-|`o.a.i.applib.AppManifest` +
-
-By convention this implementation resides in an `myapp-app` Maven module (as opposed to `myapp-dom` or `myapp-fixture`). See the xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype] for details.
-
-|===
-
-From this the framework can determine the domain services, persistent entities and security (authentication and authorization) mechanisms to use. Other configuration (including fixtures) can also be specified this way.
-
-
-If the `AppManifest` approach is _not_ being used, then the following configuration properties are used to specify the major components of Apache Isis to use:
-
-.Core Configuration Properties (ignored if `isis.appManifest` is present)
-[cols="2a,1,3a", options="header"]
-|===
-|Property
-|Value +
-(_default value_)
-|Implements
-
-|`isis.authentication`
-|`shiro`, `bypass`, `FQCN` +
-(`_shiro_`)
-|`o.a.i.core.runtime.authentication.` `AuthenticationManagerInstaller` +
-
-This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`] is provided programmatically.
-
-
-|`isis.authorization`
-|`shiro`, `bypass`, `FQCN` +
-(`_shiro_`)
-|`o.a.i.core.runtime.authorization.` `AuthorizationManagerInstaller` +
-
-This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`] is provided programmatically.
-
-|`isis.persistor`
-|`datanucleus`
-(`_datanucleus_`)
-|`o.a.i.core.runtime.installerregistry.installerapi.` `PersistenceMechanismInstaller`
-
-This property is IGNORED completely in 1.9.0+; the `datanucleus` implementation is always used.
-
-
-|`isis.services-installer`
-|`configuration`, `configuration-and-annotation`, `FQCN` +
-(`_configuration_`)
-|`org.apache.isis.core.runtime.services.` `ServicesInstaller` +
-
-The mechanism to discover and load domain services:
-
-* `configuration-and-annotation` will search for `@DomainService`-annotated classes and also read from `isis.services` configuration property
-
-* `configuration` will only read from the `isis.services` configuration property. +
-
-* Otherwise an alternative implementation of the `o.a.i.core.runtime.services.ServicesInstaller` internal API can be provided. +
-
-This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:rg.adoc#_rg_classes_super_manpage-AppManifest[`AppManifest`] is provided programmatically.
-
-
-|===
-
-[TIP]
-====
-The values `"shiro"`, `"bypass"` etc are actually aliases for concrete implementations listed in Apache Isis' `installer-registry.properties` file (in `isis-core-runtime.jar`). It is -- at least in theory -- possible to specify a fully qualified class name to replace either of the two security components.
-====
-
-If the `AppManifest` is _not_ being used then there are number of other configuration properties that also must be specified: `isis.services`, `isis.services.ServicesInstallerFromAnnotation.packagePrefix` and `isis.persistor.datanucleus.RegisterEntities.packagePrefix` and `isis.fixtures`; these are listed in the sections below.
-
-
-
-== Viewer Configuration
-
-Viewers are specified by way of the filters and servlets in the xref:ugbtb.adoc#_ugbtb_web-xml[`web.xml`] file; these are not bootstrapped by the framework, rather it is the other way around. However, we can also hint to the framework as to which viewers are in use by way of a context parameter:
-
-[source,xml]
-----
-<context-param>
- <param-name>isis.viewers</param-name>
- <param-value>wicket,restfulobjects</param-value>
-</context-param>
-----
-
-The net effect of this configuration is simply to ensure that the `viewer_wicket.properties` and/or the `viewer_restfulobjects.properties` files are read.
-
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout.adoc
index 96a368f..963c41c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout.adoc
@@ -34,7 +34,7 @@ For a domain service action to be contributed, the domain services must have a x
|xref:rgant.adoc#_rgant-ActionLayout_cssClass[`cssClass()`]
|Any string valid as a CSS class
-|an additional CSS class around the HTML that represents for the action, to allow targetted styling in xref:rg.adoc#_rg_runtime_application-specific_application-css[`application.css`]. +
+|an additional CSS class around the HTML that represents for the action, to allow targetted styling in xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`]. +
Supported by the xref:ugvw.adoc#[Wicket viewer] but currently ignored by the xref:ugvro.adoc#[RestfulObjects viewer].
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout_cssClass.adoc
index 5404e16..fb090cf 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout_cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-ActionLayout_cssClass.adoc
@@ -6,7 +6,7 @@
-The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the action. xref:rg.adoc#_rg_runtime_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
+The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the action. xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:rgant.adoc#_rgant-PropertyLayout_cssClass[properties], xref:rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_command.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_command.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_command.adoc
index 7c7cb3a..3d870ee 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_command.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_command.adoc
@@ -30,7 +30,7 @@ If background ``Command``s are used, then an external scheduler, using xref:ugbt
The `command()` attribute determines whether the action invocation should be reified into a `Command` object (by the xref:rgsvc.adoc#_rgsvc-api_CommandContext[`CommandContext`] service).
-The default is `AS_CONFIGURED`, meaning that the xref:rg.adoc#_rg_runtime_configuring-core[configuration property] `isis.services.command.actions` is used to determine the whether the action is reified:
+The default is `AS_CONFIGURED`, meaning that the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.command.actions` is used to determine the whether the action is reified:
* `all` +
+
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_publishing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_publishing.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_publishing.adoc
index b0733ac..482ca93 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_publishing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_publishing.adoc
@@ -10,7 +10,7 @@
The `publishing()` attribute determines whether and how an action invocation is published via the registered implementation of a xref:rgsvc.adoc#_rgsvc-spi_PublishingService[`PublishingService`]). This attribute is also supported for xref:rgant.adoc#_rgant-DomainObject_publishing[domain objects], where it controls whether changed objects are published as events.
A common use case is to notify external "downstream" systems of changes in the state of the Isis application.
-The default value for the attribute is `AS_CONFIGURED`, meaning that the xref:rg.adoc#_rg_runtime_configuring-core[configuration property] `isis.services.publish.actions` is used to determine the whether the action is published:
+The default value for the attribute is `AS_CONFIGURED`, meaning that the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.actions` is used to determine the whether the action is published:
* `all` +
+
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_restrictTo.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_restrictTo.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_restrictTo.adoc
index 5225599..6a07c22 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_restrictTo.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-Action_restrictTo.adoc
@@ -7,7 +7,7 @@
-By default actions are available irrespective of the xref:rg.adoc#_rg_runtime_deployment-types[deployment mode]. The `restrictTo()` attribute specifies whether the action should instead be restricted to only available in prototyping mode.
+By default actions are available irrespective of the xref:rgcfg.adoc#_rgcfg_deployment-types[deployment mode]. The `restrictTo()` attribute specifies whether the action should instead be restricted to only available in prototyping mode.
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout.adoc
index e227ebe..3362a94 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout.adoc
@@ -21,7 +21,7 @@ The table below summarizes the annotation's attributes.
|xref:rgant.adoc#_rgant-CollectionLayout_cssClass[`cssClass()`]
|Any string valid as a CSS class
-|the css class that a collection should have, to allow more targetted styling in xref:rg.adoc#_rg_runtime_application-specific_application-css[`application.css`]
+|the css class that a collection should have, to allow more targetted styling in xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`]
|xref:rgant.adoc#_rgant-CollectionLayout_defaultView[`defaultView()`]
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_cssClass.adoc
index 1bdae08..c8d3d19 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_cssClass.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the collection. xref:rg.adoc#_rg_runtime_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
+The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the collection. xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element.
This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:rgant.adoc#_rgant-ActionLayout_cssClass[actions], xref:rgant.adoc#_rgant-PropertyLayout_cssClass[properties] and xref:rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_paged.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_paged.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_paged.adoc
index 3266bb9..f371d7a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_paged.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-CollectionLayout_paged.adoc
@@ -27,7 +27,7 @@ public class Order {
----
-It is also possible to specify a global default for the page size of standalone collections, using the xref:rg.adoc#_rg_runtime_configuring-core[configuration property] `isis.viewer.paged.parented`.
+It is also possible to specify a global default for the page size of standalone collections, using the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.viewer.paged.parented`.
http://git-wip-us.apache.org/repos/asf/isis/blob/1409af28/adocs/documentation/src/main/asciidoc/guides/_rgant-Collection_editing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Collection_editing.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Collection_editing.adoc
index 870424c..ed198ea 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Collection_editing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-Collection_editing.adoc
@@ -21,7 +21,7 @@ Whether a collection is enabled or disabled depends upon these factors:
* whether the domain object has been configured as immutable through the xref:rgant.adoc#_rgant-DomainObject_editing[`@DomainObject#editing()`] attribute
-* else (that is, if the domain object's editability is specified as being `AS_CONFIGURED`), then the value of the xref:rg.adoc#_rg_runtime_configuring-core[configuration property] `isis.objects.editing`. If set to `false`, then the object's collections (and properties) are *not* editable
+* else (that is, if the domain object's editability is specified as being `AS_CONFIGURED`), then the value of the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.objects.editing`. If set to `false`, then the object's collections (and properties) are *not* editable
* else, then the value of the `@Collection(editing=...)` attribute itself.