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/06/29 08:19:57 UTC
[5/8] isis git commit: ISIS-1133: converting "Isis" to "Apache Isis"
in the docs.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure.adoc
index 860a5a3..550a170 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure.adoc
@@ -9,17 +9,17 @@ Apache Isis works by building a metamodel of the domain objects: entities, view
In the automatically generated UI a property is rendered as a field. This can be either of a value type (a string, number, date, boolean etc) or can be a reference to another entity. A collection is generally rendered as a table.
-In order for Isis to build its metamodel the domain objects must follow some conventions: what we call the _Apache Isis Programming Model_. This is just an extension of the pojo / JavaBean standard of yesteryear: properties and collections are getters/setters, while actions are simply any remaining `public` methods.
+In order for Apache Isis to build its metamodel the domain objects must follow some conventions: what we call the _Apache Isis Programming Model_. This is just an extension of the pojo / JavaBean standard of yesteryear: properties and collections are getters/setters, while actions are simply any remaining `public` methods.
Additional metamodel semantics are inferred both imperatively from _supporting methods_ and declaratively from annotations.
-In this section we discuss the mechanics of writing domain objects that comply with Isis programming model.
+In this section we discuss the mechanics of writing domain objects that comply with Apache Isis' programming model.
[TIP]
====
-In fact, Isis programming model is extensible; you can teach Isis new programming conventions and you can remove existing ones; ultimately they amount to syntax. The only real fundamental that can't be changed is the notion that objects consist of properties, collections and actions.
+In fact, the Apache Isis programming model is extensible; you can teach Apache Isis new programming conventions and you can remove existing ones; ultimately they amount to syntax. The only real fundamental that can't be changed is the notion that objects consist of properties, collections and actions.
-You can learn more about extending Isis programming model xref:ug.adoc#_ug_extending_programming-model[here].
+You can learn more about extending Apache Isis programming model xref:ug.adoc#_ug_extending_programming-model[here].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_actions.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_actions.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_actions.adoc
index 24031d6..5e29c34 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_actions.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_actions.adoc
@@ -11,9 +11,9 @@ NOTE: TODO
[NOTE]
====
-While Isis support actions whose parameters' types are scalar (values such as `String`, `int`, or references such as `Customer`), the framework (currently) does not support parameter types that are collections or maps.
+While Apache Isis support actions whose parameters' types are scalar (values such as `String`, `int`, or references such as `Customer`), the framework (currently) does not support parameter types that are collections or maps.
-The workaround is to mark the collection as `@Programmatic`, as described in xref:ug.adoc#_ug_how-tos_class-structure_ignoring-methods[Ignoring Methods]. This ensures that the collection is ignored by Isis.
+The workaround is to mark the collection as `@Programmatic`, as described in xref:ug.adoc#_ug_how-tos_class-structure_ignoring-methods[Ignoring Methods]. This ensures that the collection is ignored by Apache Isis.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_collections.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_collections.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_collections.adoc
index b23920d..faeeb8c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_collections.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_collections.adoc
@@ -10,11 +10,11 @@ IMPORTANT: WIP
[NOTE]
====
-While Isis support collections of references, the framework (currently) does not support collections of values. That is, it isn't possible to define a collection of type `Set<String>`.
+While Apache Isis support collections of references, the framework (currently) does not support collections of values. That is, it isn't possible to define a collection of type `Set<String>`.
-Or, actually, you can, because that is a valid mapping supported by JDO/DataNucleus . However, Isis has no default visualization.
+Or, actually, you can, because that is a valid mapping supported by JDO/DataNucleus . However, Apache Isis has no default visualization.
-One workaround is to mark the collection as xref:rg.adoc#_rg_annotations_manpage-Progammatic[`@Progammatic`]. This ensures that the collection is ignored by Isis.
+One workaround is to mark the collection as xref:rg.adoc#_rg_annotations_manpage-Progammatic[`@Progammatic`]. This ensures that the collection is ignored by Apache Isis.
Another workaround is to wrap each value in a view model, as explained in this xref:ug.adoc#_ug_more-advanced_tips-n-tricks_simulating-collections-of-values[tip].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_ignoring-methods.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_ignoring-methods.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_ignoring-methods.adoc
index 523668b..1f55ab9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_ignoring-methods.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_ignoring-methods.adoc
@@ -9,7 +9,7 @@
IMPORTANT: WIP
-Sometimes you want to define a `public` method on a domain object that is not intended to be rendered in Isis' UI.
+Sometimes you want to define a `public` method on a domain object that is not intended to be rendered in Apache Isis' UI.
To exclude such methods, use the xref:rg.adoc#_rg_annotations_manpage-Programmatic[`@Programmatic`] annotation.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_inject-services.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_inject-services.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_inject-services.adoc
index 175499d..d4aa645 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_inject-services.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_inject-services.adoc
@@ -74,7 +74,7 @@ Note that the method name can be anything; it doesn't need to be related to the
== Constructor injection
-Simply to note that constructor injection is _not_ supported by Isis (and is unlikely to be, because the JDO specification for entities requires a no-arg constructor).
+Simply to note that constructor injection is _not_ supported by Apache Isis (and is unlikely to be, because the JDO specification for entities requires a no-arg constructor).
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties-vs-parameters.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties-vs-parameters.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties-vs-parameters.adoc
index 91cec84..7871a6a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties-vs-parameters.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties-vs-parameters.adoc
@@ -11,9 +11,9 @@ IMPORTANT: WIP
In many cases the value types of properties and of action parameters align. For example, a `Customer` entity might have a `surname` property, and there might also be corresponding `changeSurname`. Ideally we want the surname property and surname action parameter to use the same value type.
-Having first-class support for this is a goal of Isis, and it is already possible (by writing some plumbing and glue code using Isis and DataNucleus APIs) to get some way towards this ideal. However, in the vast majority of cases it is much easier and more practical to simply use standard value types such as `java.lang.String`.
+Having first-class support for this is a goal of Apache Isis, and it is already possible (by writing some plumbing and glue code using Isis and DataNucleus APIs) to get some way towards this ideal. However, in the vast majority of cases it is much easier and more practical to simply use standard value types such as `java.lang.String`.
-However, the JDO/DataNucleus annotations for specifying semantics such as optionality or maximum length are restricted to only apply to fields and to methods; they cannot be applied to action parameters. It is therefore necessary to use Isis' equivalent annotations for action parameters.
+However, the JDO/DataNucleus annotations for specifying semantics such as optionality or maximum length are restricted to only apply to fields and to methods; they cannot be applied to action parameters. It is therefore necessary to use Apache Isis' equivalent annotations for action parameters.
The table below summarises the equivalence of some of the most common cases.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties.adoc
index 188929e..030c216 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_class-structure_properties.adoc
@@ -23,7 +23,7 @@ The annotations for mapping value types tend to be different for properties vs a
JDO/DataNucleus' default is that a property is assumed to be mandatory if it is a primitive type (eg `int`, `boolean`), but optional if a reference type (eg `String`, `BigDecimal` etc). To override optionality in JDO/DataNucleus the `@Column(allowsNull="...")` annotations is used.
-Apache Isis on the other hand assumes that all properties (and action parameters, for that matter) are mandatory, not optional. These defaults can also be overridden using Isis' own annotations, specifically `@Property(optionality=...)`.
+Apache Isis on the other hand assumes that all properties (and action parameters, for that matter) are mandatory, not optional. These defaults can also be overridden using Apache Isis' own annotations, specifically `@Property(optionality=...)`.
These different defaults can lead to incompatibilities between the two frameworks. To counteract that, Apache Isis also recognizes and honours JDO's `@Column(allowsNull=...)`.
@@ -75,7 +75,7 @@ whereby a single table holds the properties of the subtype, and also holds the p
In the first "rollup" case, we can have a situation where - logically speaking - the property is mandatory in the subtype - but it must be mapped as nullable in the database because it is n/a for any other subtypes that are rolled up.
-In this situation we must tell JDO that the column is optional, but to Isis we want to enforce it being mandatory. This can be done using the `@Property(optionality=Optionality.MANDATORY)` annotation.
+In this situation we must tell JDO that the column is optional, but to Apache Isis we want to enforce it being mandatory. This can be done using the `@Property(optionality=Optionality.MANDATORY)` annotation.
For example:
@@ -93,10 +93,10 @@ public class SomeSubtype extends SomeSuperType {
[TIP]
====
-The `@Property(optionality=...)` annotation is equivalent to the older but still supported `@Optional` annotation and `@Mandatory` annotations. Its benefit is that it lumps together all Isis' property metadata in a single annotation. Its downside is that it is rather verbose if the only semantic that needs to be specified -- as is often the case -- is optionality.
+The `@Property(optionality=...)` annotation is equivalent to the older but still supported `@Optional` annotation and `@Mandatory` annotations. Its benefit is that it lumps together all Apache Isis' property metadata in a single annotation. Its downside is that it is rather verbose if the only semantic that needs to be specified -- as is often the case -- is optionality.
====
-An alternative way to achieve this is to leave the JDO annotation on the field (where it is invisible to Isis), and rely on Isis' default, eg:
+An alternative way to achieve this is to leave the JDO annotation on the field (where it is invisible to Apache Isis), and rely on Isis' default, eg:
[source,java]
----
@@ -104,7 +104,7 @@ An alternative way to achieve this is to leave the JDO annotation on the field (
public class SomeSubtype extends SomeSuperType {
@javax.jdo.annotations.Column(allowNulls="true")
private LocalDate date;
- // mandatory in Isis by default
+ // mandatory in Apache Isis by default
public LocalDate getDate() { }
public void setDate(LocalDate d) { }
}
@@ -215,7 +215,7 @@ public void setAttachment(final Blob attachment) {
}
----
-The three `@javax.jdo.annotations.Column` annotations are required because the mapping classes that Isis provides (https://github.com/apache/isis/blob/isis-1.4.0/component/objectstore/jdo/jdo-datanucleus/src/main/java/org/apache/isis/objectstore/jdo/datanucleus/valuetypes/IsisBlobMapping.java#L59[IsisBlobMapping] and https://github.com/apache/isis/blob/isis-1.4.0/component/objectstore/jdo/jdo-datanucleus/src/main/java/org/apache/isis/objectstore/jdo/datanucleus/valuetypes/IsisClobMapping.java#L59[IsisClobMapping]) map to 3 columns. (It is not an error to omit these `@Column` annotations, but without them the names of the table columns are simply suffixed `_0`, `_1`, `_2` etc.
+The three `@javax.jdo.annotations.Column` annotations are required because the mapping classes that Apache Isis provides (https://github.com/apache/isis/blob/isis-1.4.0/component/objectstore/jdo/jdo-datanucleus/src/main/java/org/apache/isis/objectstore/jdo/datanucleus/valuetypes/IsisBlobMapping.java#L59[IsisBlobMapping] and https://github.com/apache/isis/blob/isis-1.4.0/component/objectstore/jdo/jdo-datanucleus/src/main/java/org/apache/isis/objectstore/jdo/datanucleus/valuetypes/IsisClobMapping.java#L59[IsisClobMapping]) map to 3 columns. (It is not an error to omit these `@Column` annotations, but without them the names of the table columns are simply suffixed `_0`, `_1`, `_2` etc.
If the `Blob` is mandatory, then use:
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_domain-services.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_domain-services.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_domain-services.adoc
index 626d253..2555d16 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_domain-services.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_domain-services.adoc
@@ -7,12 +7,12 @@
-It's worth extending the <<_hexagonal_architecture, Hexagonal Architecture> to show where domain services -- and in particular the domain services provided by link:http://www.isisaddons.org[Isis Addons] (non-ASF) -- fit in:
+It's worth extending the xref:ug.adoc#_ug_core-concepts_philosophy_hexagonal-architecture[Hexagonal Architecture] to show where domain services -- and in particular the domain services provided by link:http://www.isisaddons.org[Isis Addons] (non-ASF) -- fit in:
.The hexagonal architecture with Isis addons
image::{_imagesdir}how-tos/domain-services/hexagonal-architecture-addons.png[width="700px"]
-Here, we can see that the addons provide services both to the Isis framework (for example security, command and auditing) and also - by way of dependency injection - to the domain objects (eg tags, excel, settings). Of course, you can also write your own domain services as well, for example to interface with some external CMS system, say.
+Here, we can see that the addons provide services both to the Apache Isis framework (for example security, command and auditing) and also - by way of dependency injection - to the domain objects (eg tags, excel, settings). Of course, you can also write your own domain services as well, for example to interface with some external CMS system, say.
The Apache Isis framework also provides numerous in-built domain services. These are catalogued in the reference guide, see xref:rg.adoc#_rg_services-api[here] and xref:rg.adoc#_rg_services-spi[here].
@@ -142,7 +142,7 @@ public interface EmailService {
Services can optionally declare lifecycle callbacks to initialize them (when the app is deployed) and to shut them down (when the app is undeployed).
-An Isis session _is_ available when initialization occurs (so services can interact with the object store, for example).
+An Apache Isis session _is_ available when initialization occurs (so services can interact with the object store, for example).
The framework will call any `public` method annotated with xref:rg.adoc#_rg_annotations_manpage-PostConstruct[`@PostConstruct`] with either no arguments of an argument of type `Map<String,String>`
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_entity-relationships_managed-1-to-m-bidirectional-relationships.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_entity-relationships_managed-1-to-m-bidirectional-relationships.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_entity-relationships_managed-1-to-m-bidirectional-relationships.adoc
index ec5681e..cbb9135 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_entity-relationships_managed-1-to-m-bidirectional-relationships.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_entity-relationships_managed-1-to-m-bidirectional-relationships.adoc
@@ -40,9 +40,9 @@ Moreover, when maintaining a bidirectional 1-n relationship that is automaticall
[WARNING]
====
-If you don't do this then you may (as of Isis 1.4.1) hit an NullPointerException. This may be a bug in DataNucleus, we are not completely sure, but the above idiom seems to fix the issue.
+If you don't do this then you may (as of Apache Isis 1.4.1) hit an NullPointerException. This may be a bug in DataNucleus, we are not completely sure, but the above idiom seems to fix the issue.
-For more information, see http://isis.markmail.org/thread/ipu2lzqqikqdglox[this thread] on the Isis users mailing list, including this http://markmail.org/message/hblptpw675mlw723[message] with the above recommendation.
+For more information, see http://isis.markmail.org/thread/ipu2lzqqikqdglox[this thread] on the Apache Isis users mailing list, including this http://markmail.org/message/hblptpw675mlw723[message] with the above recommendation.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_ui-hints.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_ui-hints.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_ui-hints.adoc
index 62a57b6..9602831 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_ui-hints.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_how-tos_ui-hints.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The Isis programming model includes several mechanisms for a domain object to provide UI hints. These range from their title (so an end-user can distinguish one object from another) through to hints that can impact their CSS styling.
+The Apache Isis programming model includes several mechanisms for a domain object to provide UI hints. These range from their title (so an end-user can distinguish one object from another) through to hints that can impact their CSS styling.
include::_ug_how-tos_ui-hints_object-titles-and-icons.adoc[leveloffset=+1]
include::_ug_how-tos_ui-hints_names-and-descriptions.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_isis-maven-plugin.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_isis-maven-plugin.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_isis-maven-plugin.adoc
index 2a80765..64f9898 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_isis-maven-plugin.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_isis-maven-plugin.adoc
@@ -1,5 +1,5 @@
[[_ug_isis-maven-plugin]]
-= Isis Maven Plugin
+= Apache Isis Maven Plugin
: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/
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling.adoc
index cd8e635..2bbc0a4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling.adoc
@@ -7,13 +7,13 @@
We use Java packages as a way to group related domain objects together; the package name forms a namespace. We can then
reason about all the classes in that package/namespace as a single unit, or module.
-This section describes how to use Isis' features to ensure that your domain application remains decoupled. The techniques described here are also the ones that have been adopted by the various http://github.com/isisaddons[Isis Addons] modules (not ASF) for security, commands, auditing etc.
+This section describes how to use Apache Isis' features to ensure that your domain application remains decoupled. The techniques described here are also the ones that have been adopted by the various http://github.com/isisaddons[Isis Addons] modules (not ASF) for security, commands, auditing etc.
The following sections describe how to re-assemble an application, in particular where some modules are in-house but others are potentially third-party (eg the Isis Addons modules).
[NOTE]
====
-There is some overlap with OSGi and Java 9's Jigsaw concepts of "module"; in the future we expect to refactor Isis to leverage these module systems.
+There is some overlap with OSGi and Java 9's Jigsaw concepts of "module"; in the future we expect to refactor Apache Isis to leverage these module systems.
====
include::_ug_more-advanced_decoupling_db-schemas.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling_db-schemas.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling_db-schemas.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling_db-schemas.adoc
index 06189a0..6e91b1c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling_db-schemas.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_decoupling_db-schemas.adoc
@@ -62,7 +62,7 @@ on the initialization of each class into the JDO metamodel.
[TIP]
====
-Actually, the above statement isn't quite true. In DN 3.2.x (as used by Isis up to v1.8.0) there was no support for schemas. As of Isis 1.9.0-SNAPSHOT and DN 4.0 there is now support. But we implemented this feature initially against DN 3.2.x, and it still works, so for now we've decided to leave it in.
+Actually, the above statement isn't quite true. In DN 3.2.x (as used by Apache Isis up to v1.8.0) there was no support for schemas. As of Apache Isis 1.9.0-SNAPSHOT and DN 4.0 there is now support. But we implemented this feature initially against DN 3.2.x, and it still works, so for now we've decided to leave it in.
====
Therefore Apache Isis attaches a listener, `CreateSchemaObjectFromClassMetadata`, that checks for the schema's existence, and creates the schema if required.
@@ -146,6 +146,6 @@ This latter interface provides access to the properties passed through to JDO/Da
[IMPORTANT]
====
-If you do extend Isis' `CreateSchemaObjectFromClassMetadata` class for some other database, please https://issues.apache.org/jira/browse/ISIS[contribute back] your improvements.
+If you do extend Apache Isis' `CreateSchemaObjectFromClassMetadata` class for some other database, please https://issues.apache.org/jira/browse/ISIS[contribute back] your improvements.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_i18n.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_i18n.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_i18n.adoc
index 2250553..a5798d9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_i18n.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_i18n.adoc
@@ -32,7 +32,7 @@ The format of the `.pot` and `.po` files is identical; the only difference is th
[IMPORTANT]
====
-Although Isis' implementation is modelled after GNU's API, it does _not_ use any GNU software. This is for two reasons: (a) to simplify the toolchain/developer experience, and (b) because GNU software is usually GPL, which would be incompatible with the Apache license).
+Although Apache Isis' implementation is modelled after GNU's API, it does _not_ use any GNU software. This is for two reasons: (a) to simplify the toolchain/developer experience, and (b) because GNU software is usually GPL, which would be incompatible with the Apache license).
====
This design tackles all the issues of ``ResourceBundle``s:
@@ -43,14 +43,14 @@ This design tackles all the issues of ``ResourceBundle``s:
+
In fact, there are also online communities/platforms of translators to assist with translating files. One such is https://crowdin.com/[crowdin] (nb: this link does not imply endorsement).
-In Isis' implementation, if the translation is missing from the `.po` file then the original message text from the `.pot` file will be returned. In fact, it isn't even necessary for there to be any `.po` files; `.po` translations can be added piecemeal as the need arises.
+In Apache Isis' implementation, if the translation is missing from the `.po` file then the original message text from the `.pot` file will be returned. In fact, it isn't even necessary for there to be any `.po` files; `.po` translations can be added piecemeal as the need arises.
== `TranslationService`
-The cornerstone of Isis' support for i18n is the `TranslationService` service. This is defined in the applib with the following API:
+The cornerstone of Apache Isis' support for i18n is the `TranslationService` service. This is defined in the applib with the following API:
[source,java]
----
@@ -101,14 +101,14 @@ When running in write mode the original text is returned to the caller untransla
== Imperative messages
-The `TranslationService` is used internally by Isis when building up the metamodel; the name and description of every class, property, collection, action and action parameter is automatically translated. Thus the simple act of bootstrapping Isis will cause most of the messages requiring translation (that is: those for the Isis metamodel) to be captured by the `TranslationService`.
+The `TranslationService` is used internally by Apache Isis when building up the metamodel; the name and description of every class, property, collection, action and action parameter is automatically translated. Thus the simple act of bootstrapping Apache Isis will cause most of the messages requiring translation (that is: those for the Apache Isis metamodel) to be captured by the `TranslationService`.
However, for an application to be fully internationalized, any validation messages (from either `disableXxx()` or `validateXxx()` supporting methods) and also possibly an object's title (from the `title()` method) will also require translation. Moreover, these messages must be captured in the `.pot` file such that they can be translated.
=== `TranslatableString`
-The first part of the puzzle is tackled by an extension to Isis' programming model. Whereas previously the `disableXxx()` / `validateXxx()` / `title()` methods could only return a `java.lang.String`, they may now optionally return a `TranslatableString` (defined in Isis applib) instead.
+The first part of the puzzle is tackled by an extension to Apache Isis' programming model. Whereas previously the `disableXxx()` / `validateXxx()` / `title()` methods could only return a `java.lang.String`, they may now optionally return a `TranslatableString` (defined in Isis applib) instead.
Here's a (silly) example from the xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype]:
@@ -247,7 +247,7 @@ public void failsValidation() throws Exception {
Running this test will result in the framework calling the `validateUpdateName(...)` method, and thus to record that a translation is required in the `.pot` file.
-When the integration tests are complete (that is, when Isis is shutdown), the `TranslationServicePo` will write out all captured translations to its log (more on this below). This will include all the translations captured from the Isis metamodel, along with all translations as exercised by the integration tests.
+When the integration tests are complete (that is, when Apache Isis is shutdown), the `TranslationServicePo` will write out all captured translations to its log (more on this below). This will include all the translations captured from the Apache Isis metamodel, along with all translations as exercised by the integration tests.
To ensure your app is fully internationalized app, you must therefore:
@@ -256,9 +256,9 @@ To ensure your app is fully internationalized app, you must therefore:
[NOTE]
====
-We make no apologies for this requirement: one of the reasons that we decided to implement Isis' i18n support in this way is because it encourages/requires the app to be properly tested.
+We make no apologies for this requirement: one of the reasons that we decided to implement Apache Isis' i18n support in this way is because it encourages/requires the app to be properly tested.
-Behind the scenes Isis uses a JUnit rule (`ExceptionRecognizerTranslate`) to intercept any exceptions that are thrown. These are simply passed through to the registered xref:rg.adoc#_rg_services-spi_manpage-ExceptionRecognizer[`ExceptionRecognizer`]s so that any messages are recorded as requiring translation.
+Behind the scenes Apache Isis uses a JUnit rule (`ExceptionRecognizerTranslate`) to intercept any exceptions that are thrown. These are simply passed through to the registered xref:rg.adoc#_rg_services-spi_manpage-ExceptionRecognizer[`ExceptionRecognizer`]s so that any messages are recorded as requiring translation.
====
@@ -314,7 +314,7 @@ The basename for translation files is always `translations`; this cannot be alte
=== Externalized translation files
-Normally Isis configuration files are read from the `WEB-INF` file. However, Isis can be configured to read config files from an xref:ug.adoc#_ug_deployment_externalized-configuration[external directory]; this is also supported for translations.
+Normally Apache Isis configuration files are read from the `WEB-INF` file. However, Apache Isis can be configured to read config files from an xref:ug.adoc#_ug_deployment_externalized-configuration[external directory]; this is also supported for translations.
Thus, if in `web.xml` the external configuration directory has been set:
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_enhance-only.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_enhance-only.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_enhance-only.adoc
index 1854a30..22894ad 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_enhance-only.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_enhance-only.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-From the Isis mailing list is:
+From the Apache Isis mailing list is:
* _Is there a simple way to make a run configuration in IntelliJ for running the datanucleus enhancer before running integration test?_
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_per-user-themes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_per-user-themes.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_per-user-themes.adoc
index 19c950f..a2fc5c8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_per-user-themes.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_per-user-themes.adoc
@@ -4,7 +4,7 @@
:_basedir: ../
:_imagesdir: images/
-From the Isis mailing list is:
+From the Apache Isis mailing list is:
* _Is it possible to have each of our resellers (using our Isis application) use there own theme/branding with their own logo and colors? Would this also be possible for the login page, possibly depending on the used host name?_
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_simulating-collections-of-values.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_simulating-collections-of-values.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_simulating-collections-of-values.adoc
index 09a0d04..9a3efe5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_simulating-collections-of-values.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_tips-n-tricks_simulating-collections-of-values.adoc
@@ -19,5 +19,5 @@ NOTE: TODO
== Persistence Concerns
-IMPORTANT: WIP - easiest to simply store using DataNucleus' support for collections, marked as xref:rg.adoc#_rg_annotations_manpage-Programmatic[`@Programmatic`] so that it is ignored by Isis. Alternatively can store as json/xml in a varchar(4000) or clob and manually unpack.
+IMPORTANT: WIP - easiest to simply store using DataNucleus' support for collections, marked as xref:rg.adoc#_rg_annotations_manpage-Programmatic[`@Programmatic`] so that it is ignored by Apache Isis. Alternatively can store as json/xml in a varchar(4000) or clob and manually unpack.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_transactions-and-errors.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_transactions-and-errors.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_transactions-and-errors.adoc
index c10ffb5..914fe4a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_transactions-and-errors.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_more-advanced_transactions-and-errors.adoc
@@ -4,16 +4,16 @@
:_basedir: ../
:_imagesdir: images/
-In Isis, every action invocation (in fact, every interaction) is automatically wrapped in a transaction, and any repository query automatically does a flush.
+In Apache Isis, every action invocation (in fact, every interaction) is automatically wrapped in a transaction, and any repository query automatically does a flush.
-What that means is that there's no need to explicitly start or commit transactions in Isis; this will be done for you. Indeed, if you do try to manage transactions (eg by reaching into the JDO `PersistenceManager` exposed by the xref:rg.adoc#_rg_services-api_manpage-IsisJdoSupport[IsisJdoSupport] domain service, then you are likely to confuse Isis and get a stack trace for your trouble.
+What that means is that there's no need to explicitly start or commit transactions in Apache Isis; this will be done for you. Indeed, if you do try to manage transactions (eg by reaching into the JDO `PersistenceManager` exposed by the xref:rg.adoc#_rg_services-api_manpage-IsisJdoSupport[IsisJdoSupport] domain service, then you are likely to confuse Isis and get a stack trace for your trouble.
== Aborting Transactions
-If you want to abort Isis' transaction, this can be done by throwing `RecoverableException` (or any subclass, eg `ApplicationException`). The transaction will be aborted, and the exception message will be displayed to the user.
+If you want to abort Apache Isis' transaction, this can be done by throwing `RecoverableException` (or any subclass, eg `ApplicationException`). The transaction will be aborted, and the exception message will be displayed to the user.
If you throw any other exception (ie not a subclass of `RecoverableException`), then the users will see an error page (if Wicket viewer) or a 500 (if Restful Objects viewer).
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties.adoc
index 147238d..95f68af 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties.adoc
@@ -13,7 +13,7 @@ These configuration properties are typically stored in `WEB-INF/viewer_restfulob
====
These configuration settings should be considered beta, and may change in the future in response to emerging requirements.
-Also, be aware enabling these settings makes the representations with respect to the http://restfulobjects.org[Restful Object spec]. (Based on experience in Isis, in the future the spec may be updated to allow such extensions).
+Also, be aware enabling these settings makes the representations with respect to the http://restfulobjects.org[Restful Object spec]. (Based on experience in Apache Isis, in the future the spec may be updated to allow such extensions).
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_honor-ui-hints.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_honor-ui-hints.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_honor-ui-hints.adoc
index c9122cc..c9b447f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_honor-ui-hints.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_honor-ui-hints.adoc
@@ -7,7 +7,7 @@
-By default the representations generated by Restful Objects ignore any Isis metamodel hints referring to the UI.
+By default the representations generated by Restful Objects ignore any Apache Isis metamodel hints referring to the UI.
In particular, if a collection is annotated then `Render(EAGERLY)` then the contents of the collection are _not_
eagerly embedded in the object representation.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_suppressing-elements.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_suppressing-elements.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_suppressing-elements.adoc
index 1942b9b..448d1a4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_suppressing-elements.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_configuration-properties_suppressing-elements.adoc
@@ -33,7 +33,7 @@ The defaults for all of these is false, meaning that the hypermedia/metadata is
In the future we might extend this per-request. Raise/vote on a JIRA ticket if you require this feature.
====
-If an even simpler representations (of objects) are required, see xref:ug.adoc#_ug_restfulobjects-viewer_configuration-properties_simplified-object-representation[simplified object representation], immediately below. And if the above isn't flexible and you need complete control over all representations see the section on xref:ug.adoc#_ug_extending_restfulobjects-viewer[Extending the Restful Objects viewer] in the <<Extending>> chapter.
+If an even simpler representations (of objects) are required, see xref:ug.adoc#_ug_restfulobjects-viewer_configuration-properties_simplified-object-representation[simplified object representation], immediately below. And if the above isn't flexible and you need complete control over all representations see the section on xref:ug.adoc#_ug_extending_restfulobjects-viewer[Extending the Restful Objects viewer] in the xref:ug.adoc#_ug_extending[Extending] chapter.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_features.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_features.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_features.adoc
index 831b0b9..9ad39e2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_features.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_features.adoc
@@ -6,7 +6,7 @@
-The REST API opens up an Isis domain model to a huge variety of applications, from bespoke single-page apps, through integration scenarious, through providing an API for bulk-upload/migration from an existing system.
+The REST API opens up an Apache Isis domain model to a huge variety of applications, from bespoke single-page apps, through integration scenarious, through providing an API for bulk-upload/migration from an existing system.
== Restful Objects Specification
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_hints-and-tips.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_hints-and-tips.adoc
index b42c58a..b321d1a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_restfulobjects-viewer_hints-and-tips.adoc
@@ -22,7 +22,7 @@ video::_-TOvVYWCHc[youtube,width="840px",height="472px"]
== AngularJS Tips
-The hypermedia API exposed by Isis' Restful Objects viewer is intended be support both bespoke custom-written viewers as well as generic viewers. Indeed, we expect most clients consuming the API will be bespoke, not generic.
+The hypermedia API exposed by Apache Isis' Restful Objects viewer is intended be support both bespoke custom-written viewers as well as generic viewers. Indeed, we expect most clients consuming the API will be bespoke, not generic.
This page captures one or two tips on using AngularJS to write such a bespoke client.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime.adoc
index 633f79c..eeef111 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime.adoc
@@ -9,9 +9,9 @@ Isis' own configuration properties are simple key-value pairs, typically held in
[NOTE]
====
-Configuration properties for the viewers can be found in the xref:ug.adoc#_ug_wicket-viewer[Wicket Viewer] chapter and the <<Restful Objects Viewer>> chapter. Likewise[details of configuring security (Apache Shiro) can be found in the xref:ug.adoc#_ug_security[Security] chapter.
+Configuration properties for the viewers can be found in the xref:ug.adoc#_ug_wicket-viewer[Wicket Viewer] chapter and the xref:ug.adoc#_ug_restfulobjects-viewer[RestfulObjects viewer] chapter. Likewise[details of configuring security (Apache Shiro) can be found in the xref:ug.adoc#_ug_security[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 <<Deployment>> 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:ug.adoc#_ug_deployment[Deployment] chapter.
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuration-files.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuration-files.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuration-files.adoc
index e8c45ba..58da346 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuration-files.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuration-files.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-When running an Isis webapp, configuration properties are read from configuration files held in the `WEB-INF` directory.
+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.
@@ -21,7 +21,7 @@ In addition, the following other properties are searched for and if present also
* `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 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`
+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`
+
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-core.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-core.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-core.adoc
index b1d7b8e..d13fc90 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-core.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-core.adoc
@@ -32,7 +32,7 @@ Configuration properties for the JDO/DataNucleus objectstore can be found in the
| `true`,`false` (`false`)
| Disables concurrency checking globally. +
-Only intended for "emergency use" as a workaround while pending fix/patch to Isis itself. (Note that there is no "datanucleus" in the property).
+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.` +
`cssClass.patterns`
@@ -126,7 +126,7 @@ Each entry can be optionally prefixed by "n:" specifying the relative order on t
| `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:_ug_runtime_deployment-types[deployment type]: production mode disables pretty printing, while prototype mode enables it.
+If no configuration property is available, then the defaults is determined by the xref:ug.adoc#_ug_runtime_deployment-types[deployment type]: production mode disables pretty printing, while prototype mode enables it.
@@ -270,4 +270,4 @@ or
isis.viewers.propertyLayout.labelPosition=LEFT
----
-If these are not present then 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.
+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/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus.adoc
index 9b2cb85..f354b02 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus.adoc
@@ -4,9 +4,9 @@
:_basedir: ../
:_imagesdir: images/
-Apache Isis programmatically configures DataNucleus; any 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).
+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 Isis we tend to use annotations instead.
+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:ug.adoc#_ug_more-advanced_overriding-jdo-annotations[Overriding JDO Annotatons] for further discussion.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc
index 06a5722..9edbc79 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_disabling-persistence-by-reachability.adoc
@@ -5,7 +5,7 @@
:_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 Isis' `DomainObjectContainer#persist(.)` or `DomainObjectContainer#persistIfNotAlready(.)` methods.
+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.
@@ -14,7 +14,7 @@ However, convenient though this feature is, you may find that it causes performa
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 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).
+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`:
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_eagerly-registering-entities.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_eagerly-registering-entities.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_eagerly-registering-entities.adoc
index 8cc9744..6822d77 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_eagerly-registering-entities.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_eagerly-registering-entities.adoc
@@ -4,7 +4,7 @@
:_basedir: ../
:_imagesdir: images/
-Both Apache Isis and DataNucleus have their own metamodels of the domain entities. Isis builds its metamodel by walking the graph of types from the services registered using `@DomainService` or explicitly registered in `isis.properties`. The JDO objectstore then takes these types and registers them with DataNucleus.
+Both Apache Isis and DataNucleus have their own metamodels of the domain entities. Apache Isis builds its metamodel by walking the graph of types from the services registered using `@DomainService` or explicitly registered in `isis.properties`. The JDO 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.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_using-jndi-data-source.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_using-jndi-data-source.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_using-jndi-data-source.adoc
index 25649c0..e5ee392 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_using-jndi-data-source.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_configuring-datanucleus_using-jndi-data-source.adoc
@@ -10,7 +10,7 @@ Isis' JDO objectstore can be configured either to connect to the database using
== Application managed
-Using a connection pool managed directly by the application (that is, by Isis' JDO objectstore and ultimately by DataNucleus) requires a single set of configuration properties to be specified.
+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.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_specifying-components.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_specifying-components.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_specifying-components.adoc
index b4e45b6..d8877d2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_specifying-components.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_runtime_specifying-components.adoc
@@ -6,7 +6,7 @@
-The `isis.properties` file has four configuration properties in particular that specify the major components of Isis to use.
+The `isis.properties` file has four configuration properties in particular that specify the major components of Apache Isis to use.
They are:
@@ -52,7 +52,7 @@ The mechanism to discover and load domain services:
[TIP]
====
-The values "datanucleus", "shiro" etc are actually aliases for concrete implementations listed in Isis' `installer-registry.properties` file (in `isis-core-runtime.jar`).
+The values "datanucleus", "shiro" 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 any of these components. This is probably feasible for the two security APIs and the `services-installer` API; but replacing the persistor (JDO/DataNucleus) is much trickier because we rely on the JDO/DN for certain functionality (such as object dirtying and lazy loading) that is not defined within this API.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_security.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_security.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_security.adoc
index 319c1b1..54c1cbd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_security.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_security.adoc
@@ -17,11 +17,11 @@ Isis provides an API for both authentication and authorization, and provides an
Shiro ships with a simple text-based realm -- the `IniRealm` -- which reads users (and password), user roles and role permissions from the `WEB-INF/shiro.ini` file. The xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype] is configured to use this realm.
-Shiro also ships with an implementation of an LDAP-based realm; LDAP is often used to manage user/passwords and corresponding user groups. Isis in turn extends this with its `IsisLdapRealm`, which provides more flexibility for both group/role and role/permissions management.
+Shiro also ships with an implementation of an LDAP-based realm; LDAP is often used to manage user/passwords and corresponding user groups. Apache Isis in turn extends this with its `IsisLdapRealm`, which provides more flexibility for both group/role and role/permissions management.
-In addition, the (non-ASF) link:http://www.isisaddons.org[Isis Addons] provides the http://github.com/isisaddons/isis-module-security[Isis addons' security] module, which also provides an implementation of the Shiro `Realm` API. However, the security module also represents users, roles and permissions as domain objects, allowing them to be administered through Isis itself. Moreover, the security module can optionally delegate password management to a subsidiary (delegate) realm (usually LDAP as discussed above).
+In addition, the (non-ASF) link:http://www.isisaddons.org[Isis Addons] provides the http://github.com/isisaddons/isis-module-security[Isis addons' security] module, which also provides an implementation of the Shiro `Realm` API. However, the security module also represents users, roles and permissions as domain objects, allowing them to be administered through Apache Isis itself. Moreover, the security module can optionally delegate password management to a subsidiary (delegate) realm (usually LDAP as discussed above).
-In addition to Isis' Shiro-based implementation of its authentication and authorization APIs, Isis also provides a "bypass" implementation, useful for quick-n-dirty prototyping when you want to in effect disable (bypass) security completely.
+In addition to Apache Isis' Shiro-based implementation of its authentication and authorization APIs, Isis also provides a "bypass" implementation, useful for quick-n-dirty prototyping when you want to in effect disable (bypass) security completely.
[NOTE]
.What about auditing?
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_security_api-for-applications.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_security_api-for-applications.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_security_api-for-applications.adoc
index 1846f73..2a6260d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_security_api-for-applications.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_security_api-for-applications.adoc
@@ -8,7 +8,7 @@
Generally speaking your domain objects (or more generally your application) should be agnostic of the user/roles that are interacting with them; applying security permissions is the responsibility of the framework.
-Still, on very rare occasion you may have a need, in which case you can either use Isis' `DomainObjectContainer` API or you can reach further down the stack and use the JEE Servlet API.
+Still, on very rare occasion you may have a need, in which case you can either use Apache Isis' `DomainObjectContainer` API or you can reach further down the stack and use the JEE Servlet API.
== `DomainObjectContainer` API
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_security_configuring-isis-to-use-shiro.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_security_configuring-isis-to-use-shiro.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_security_configuring-isis-to-use-shiro.adoc
index 20ecac3..79f0d38 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_security_configuring-isis-to-use-shiro.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_security_configuring-isis-to-use-shiro.adoc
@@ -1,5 +1,5 @@
[[_ug_security_configuring-isis-to-use-shiro]]
-= Configuring Isis to use Shiro
+= Configuring Apache Isis to use Shiro
: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/
@@ -12,7 +12,7 @@ Apache Isis' security mechanism is configurable, specifying an `Authenticator` a
The xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype] is pre-configured to use Apache Shiro, so much of what follows is set up already.
====
-== Telling Isis to use Shiro
+== Telling Apache Isis to use Shiro
To tell Apache Isis to use Shiro, update the `WEB-INF/isis.properties` file:
@@ -26,7 +26,7 @@ This installs the appropriate implementation (the `ShiroAuthenticatorOrAuthorizo
image::{_imagesdir}security/security-apis-impl/configure-isis-to-use-shiro.png[width="600px"]
-The figure above doesn't tell the whole story; we haven't yet seen how Shiro itself is configured to use realms. The `ShiroAuthenticatorOrAuthorizor` is in essence the glue between the Isis runtime and Shiro.
+The figure above doesn't tell the whole story; we haven't yet seen how Shiro itself is configured to use realms. The `ShiroAuthenticatorOrAuthorizor` is in essence the glue between the Apache Isis runtime and Shiro.
== Bootstrapping Shiro
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-ini-realm.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-ini-realm.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-ini-realm.adoc
index f07b324..13b9365 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-ini-realm.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-ini-realm.adoc
@@ -13,7 +13,7 @@ The diagram below shows the Isis and components involved:
image::{_imagesdir}security/security-apis-impl/configure-shiro-to-use-ini-realm.png[width="600px"]
-The realm is responsible for validating the user credentials, and then creates a Shiro link:http://shiro.apache.org/static/latest/apidocs/org/apache/shiro/subject/Subject.html[`Subject`] which represents the user (for the current request). Isis `Authenticator` component then interacts with the `Subject` in order to check permissions.
+The realm is responsible for validating the user credentials, and then creates a Shiro link:http://shiro.apache.org/static/latest/apidocs/org/apache/shiro/subject/Subject.html[`Subject`] which represents the user (for the current request). Apache Isis `Authenticator` component then interacts with the `Subject` in order to check permissions.
@@ -105,7 +105,7 @@ com.mycompany.myapp # ditto
[TIP]
====
-The format of the permissions string is configurable in Shiro, and Isis uses this to provide an extended wildcard format, described xref:ug.adoc#_ug_security_shiro-isis-enhanced-wildcard-permission[here].
+The format of the permissions string is configurable in Shiro, and Apache Isis uses this to provide an extended wildcard format, described xref:ug.adoc#_ug_security_shiro-isis-enhanced-wildcard-permission[here].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-enhanced-wildcard-permission.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-enhanced-wildcard-permission.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-enhanced-wildcard-permission.adoc
index f656dda..31803c4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-enhanced-wildcard-permission.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-enhanced-wildcard-permission.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-If using the text-based xref:ug.adoc#_ug_security_shiro-ini-realm[`IniRealm`] or xref:ug.adoc#_ug_security_shiro-isis-ldap-realm[Isis' LDAP realm], then note that Shiro also allows the string representation of the permissions to be mapped (resolved) to alternative `Permission` instances. Isis provides its own `IsisPermission` which introduces the concept of a "veto".
+If using the text-based xref:ug.adoc#_ug_security_shiro-ini-realm[`IniRealm`] or xref:ug.adoc#_ug_security_shiro-isis-ldap-realm[Isis' LDAP realm], then note that Shiro also allows the string representation of the permissions to be mapped (resolved) to alternative `Permission` instances. Apache Isis provides its own `IsisPermission` which introduces the concept of a "veto".
A vetoing permission is one that prevents access to a feature, rather than grants it. This is useful in some situations where most users have access to most features, and only a small number of features are particularly sensitive. The configuration can therefore be set up to grant fairly broad-brush permissions and then veto permission for the sensitive features for those users that do not have access.
@@ -49,7 +49,7 @@ The net effect is therefore what we would want: that a user with both `admin_rol
-Finally, the Isis permission resolver is specified in `WEB-INF/shiro.ini` file:
+Finally, the Apache Isis permission resolver is specified in `WEB-INF/shiro.ini` file:
[source,ini]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-ldap-realm.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-ldap-realm.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-ldap-realm.adoc
index a7feadc..fe40cd7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-ldap-realm.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_security_shiro-isis-ldap-realm.adoc
@@ -50,7 +50,7 @@ securityManager.realms = $ldapRealm
----
<1> user accounts are searched using a dedicated service account
<2> SASL (CRAM-MD5) authentication is used for this authentication
-<3> Isis' implementation of the LDAP realm.
+<3> Apache Isis' implementation of the LDAP realm.
<4> groups are searched under `ou=groups,o=mojo` (where `mojo` is the company name)
<5> each group has an LDAP objectClass of `groupOfUniqueNames`
<6> each group has a vector attribute of `uniqueMember`
@@ -131,7 +131,7 @@ Create the `ou=groups,o=mojo` hierarchy:
image::{_imagesdir}/configuration/configuring-shiro/ldap/activeds-ldap-mojo-root-dse.png[ActiveDS LDAP Users]
-Configure SASL authentication. This means that the checking of user/password is done implicitly by virtue of Isis connecting to LDAP using these credentials:
+Configure SASL authentication. This means that the checking of user/password is done implicitly by virtue of Apache Isis connecting to LDAP using these credentials:
image::{_imagesdir}/configuration/configuring-shiro/ldap/activeds-ldap-sasl-authentication.png[ActiveDS LDAP Users]
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_security_usage-by-isis-viewers.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_security_usage-by-isis-viewers.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_security_usage-by-isis-viewers.adoc
index c21dbe6..d169f69 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_security_usage-by-isis-viewers.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_security_usage-by-isis-viewers.adoc
@@ -1,5 +1,5 @@
[[_ug_security_usage-by-isis-viewers]]
-= Usage by Isis' Viewers
+= Usage by Apache Isis' Viewers
: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/
@@ -42,14 +42,14 @@ The sign-in page to render is pluggable; see xref:ug.adoc#_ug_extending_wicket-v
In the sign-in page the viewer calls to the Isis Authenticator API, and obtains back a user/role. It also adds in its special reserved role (per the annotation above) and then continues on to whichever page the user was attempting to access (usually the home page).
-And that's really all there is to it. When the viewer renders a domain object it queries the Isis metamodel, and suppresses from the view any object members (properties, actions etc) that are invisible. These may be invisible because the user has no (read ) permission, or they may be invisible because of domain object logic (eg a `hideXxx()` method). The viewer neither knows nor cares.
+And that's really all there is to it. When the viewer renders a domain object it queries the Apache Isis metamodel, and suppresses from the view any object members (properties, actions etc) that are invisible. These may be invisible because the user has no (read ) permission, or they may be invisible because of domain object logic (eg a `hideXxx()` method). The viewer neither knows nor cares.
Similarly, for those object members that _are_ visible, the viewer also checks if they are enabled or disabled. Again, an object member will be disabled if the user does not have (write) permission, or it could be disabled because of domain object logic (eg a `disableXxx()` method).
=== User-registration
-As well as providing a sign-in screen, the Wicket viewer also provides the ability for xref:_user_registration[users to self-register]. By and large this operates outside of Isis' security mechanisms; indeed the various pages (sign-up, sign-up verification, password reset) are all rendered _without_ there being any current user session. These pages all "reach inside" Isis framework using a mechanism similar to <<_headless_access>> in order to actually do their stuff.
+As well as providing a sign-in screen, the Wicket viewer also provides the ability for xref:_user_registration[users to self-register]. By and large this operates outside of Apache Isis' security mechanisms; indeed the various pages (sign-up, sign-up verification, password reset) are all rendered _without_ there being any current user session. These pages all "reach inside" Apache Isis framework using a mechanism similar to xref:ug.adoc#_ug_headless-access[Headless access] in order to actually do their stuff.
[TIP]
====
@@ -58,7 +58,7 @@ The sign-in verification page to render is pluggable; see xref:ug.adoc#_ug_exten
User registration is only available if the xref:_user_registration_service[`UserRegistrationService`] is configured; this is used by the framework to actually create new instances of the user as accessed by the corresponding (Shiro) realm.
-Because Shiro realms are pluggable, the Isis framework does not provide default implementations of this service. However, if you are using the http://github.com/isisaddons/isis-module-security[Isis addons' security] module (non-ASF), then this module _does_ provide an implementation (that, as you might expect, creates new "user" domain entities).
+Because Shiro realms are pluggable, the Apache Isis framework does not provide default implementations of this service. However, if you are using the http://github.com/isisaddons/isis-module-security[Isis addons' security] module (non-ASF), then this module _does_ provide an implementation (that, as you might expect, creates new "user" domain entities).
If you are using an LDAP realm and want to enable user-self registration then you'll need to write your own implementation of this service.
@@ -88,7 +88,7 @@ public interface AuthenticationSessionStrategy {
<1> returns a valid `AuthenticationSession` for the specified request, response
<2> binds (associates the provided `AuthenticationSession`) to the request and response
-Here `AuthenticationSession` is Isis' internal API that represents a signed-on user.
+Here `AuthenticationSession` is Apache Isis' internal API that represents a signed-on user.
The framework provides a number of simple strategies:
@@ -190,7 +190,7 @@ public class CustomRestfulObjectsApplication extends RestfulObjectsApplication {
So far this is just standard javax.rs stuff.
-Next, we need to ensure that a client can hit your new resource *with* the Isis runtime in place, but without there being an Isis session. For that....
+Next, we need to ensure that a client can hit your new resource *with* the Apache Isis runtime in place, but without there being an Apache Isis session. For that....
* create a subclass of the `AuthenticationSessionStrategy` that automatically returns a dummy session if the resource being accessed is "/restful/signup", say. +
+
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_testing_aaa.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_testing_aaa.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_testing_aaa.adoc
index 488686e..0e345d4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_testing_aaa.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_testing_aaa.adoc
@@ -50,7 +50,7 @@ It's up to you whether you use BDD specs for your apps; it will depend on your d
When we talk about integration tests/specs here, we mean tests that exercise the domain object logic, through to the actual database. But we also want the tests to exercise the app from the users's perspective, which means including the user interface.
-For most other frameworks that would require having to test the application in a very heavy weight/fragile fashion using a tool such as link:http://docs.seleniumhq.org/[Selenium], driving a web browser to navigate . In this regard though, Isis has a significant trick up its sleeve. Because Isis implements the naked objects pattern, it means that the UI is generated automatically from the UI. This therefore allows for other implementations of the UI.
+For most other frameworks that would require having to test the application in a very heavy weight/fragile fashion using a tool such as link:http://docs.seleniumhq.org/[Selenium], driving a web browser to navigate . In this regard though, Apache Isis has a significant trick up its sleeve. Because Apache Isis implements the naked objects pattern, it means that the UI is generated automatically from the UI. This therefore allows for other implementations of the UI.
The xref:rg.adoc#_rg_services-api_manpage-WrapperFactory[`WrapperFactory`] domain service allows a test to wrap domain objects and thus to interact with said objects "as if" through the UI:
@@ -125,7 +125,7 @@ In the previous section we discussed using given/when/then as a form of organizi
For integration tests though it can be difficult to keep the "given" short; there could be a lot of prerequisite data that needs to exist before you can actually exercise your system. Moreover, however we do set up that data, but we also want to do so in a way that is resilient to the system changing over time.
-The solution that Isis provides is a domain service called xref:rg.adoc#_rg_classes_super_manpage-FixtureScripts[Fixture Scripts], that defines a pattern and supporting classes to help ensure that the "data setup" for your tests are reusable and maintainable over time.
+The solution that Apache Isis provides is a domain service called xref:rg.adoc#_rg_classes_super_manpage-FixtureScripts[Fixture Scripts], that defines a pattern and supporting classes to help ensure that the "data setup" for your tests are reusable and maintainable over time.
http://git-wip-us.apache.org/repos/asf/isis/blob/fe19dc4b/adocs/documentation/src/main/asciidoc/guides/_ug_testing_bdd-spec-support_key-classes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ug_testing_bdd-spec-support_key-classes.adoc b/adocs/documentation/src/main/asciidoc/guides/_ug_testing_bdd-spec-support_key-classes.adoc
index 3047e00..58b025b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ug_testing_bdd-spec-support_key-classes.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ug_testing_bdd-spec-support_key-classes.adoc
@@ -9,14 +9,14 @@
There are some key framework classes that make up the spec support; these are discussed below.
-NOTE: some of these are also used by Isis' xref:ug.adoc#_ug_testing_integ-test-support[Integration Test support].
+NOTE: some of these are also used by Apache Isis' xref:ug.adoc#_ug_testing_integ-test-support[Integration Test support].
== `IsisSystemForTest`
-The `IsisSystemForTest` class allows a complete running instance of Isis to be bootstrapped (with the JDO objectstore); this is then held on a a `ThreadLocal` from one test to another.
+The `IsisSystemForTest` class allows a complete running instance of Apache Isis to be bootstrapped (with the JDO objectstore); this is then held on a a `ThreadLocal` from one test to another.
Typically bootstrapping code is used to lazily instantiate the `IsisSystemForTest` once and once only. The mechanism for doing this is line-for-line identical in both BDD step defs and integration tests.
@@ -36,7 +36,7 @@ The `ScenarioExecution` also provids access to the configured domain services (u
[NOTE]
====
-This could probably be refactored; Cucumber JVM provides automatic dependency injection into setp definitions, but Isis does not currently leverage or exploit this capability.
+This could probably be refactored; Cucumber JVM provides automatic dependency injection into setp definitions, but Apache Isis does not currently leverage or exploit this capability.
====
Like the `IsisSystemForTest` class, the `ScenarioExecution` class binds an instance of itself onto a `ThreadLocal`. It can then be accessed in BDD step definitions using `ScenarioExecution.current()` static method.