ISIS-1521: updates to docs/website

Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/d3ef50a5
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/d3ef50a5
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/d3ef50a5

Branch: refs/heads/master
Commit: d3ef50a55efd77746cb3563cf47b0efb9d428b60
Parents: 8f93dd9
Author: Dan Haywood <d...@haywood-associates.co.uk>
Authored: Sun Aug 6 17:46:44 2017 +0100
Committer: Dan Haywood <d...@haywood-associates.co.uk>
Committed: Sun Aug 6 17:46:44 2017 +0100

----------------------------------------------------------------------
 .../rgsvc/_rgsvc_persistence-layer-api.adoc     |  1 +
 ...persistence-layer-api_HsqlDbManagerMenu.adoc | 43 ++++++++++++++++++++
 .../rgsvc/_rgsvc_presentation-layer-spi.adoc    |  1 +
 ...ntation-layer-spi_SessionLoggingService.adoc | 41 +++++++++++++++++++
 .../asciidoc/release-notes/release-notes.adoc   |  6 +--
 5 files changed, 89 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/isis/blob/d3ef50a5/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
----------------------------------------------------------------------
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
index a547573..3b3eb73 100644
--- 
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
+++ 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api.adoc
@@ -84,6 +84,7 @@ Key:
 
 
 
+include::_rgsvc_persistence-layer-api_HsqlDbManagerMenu.adoc[leveloffset=+1]
 include::_rgsvc_persistence-layer-api_IsisJdoSupport.adoc[leveloffset=+1]
 include::_rgsvc_persistence-layer-api_MetricsService.adoc[leveloffset=+1]
 include::_rgsvc_persistence-layer-api_QueryResultsCache.adoc[leveloffset=+1]

http://git-wip-us.apache.org/repos/asf/isis/blob/d3ef50a5/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_HsqlDbManagerMenu.adoc
----------------------------------------------------------------------
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_HsqlDbManagerMenu.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_HsqlDbManagerMenu.adoc
new file mode 100644
index 0000000..948ee4a
--- /dev/null
+++ 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_HsqlDbManagerMenu.adoc
@@ -0,0 +1,43 @@
+[[_rgsvc_persistence-layer-api_HsqlDbManagerMenu]]
+= `HsqlDbManagerMenu`
+: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/
+
+
+
+The `HsqlDbManagerMenu` provides a single menu item to open up the HSQLDB 
manager.
+This is only enabled for prototyping, and if HSQLDB is detected in the 
underlying JDBC URL.
+The menu appears under the "Prototyping" menu.
+
+
+== API & Implementation
+
+The API of the service is:
+
+[source,java]
+----
+public class HsqlDbManagerMenu {
+    public void hsqlDbManager() { ... }
+}
+----
+
+Note that this launches the manager on the same host that the webapp runs, and 
so is only appropriate to use when running on `localhost`.
+
+
+== Disabling/hiding the menu
+
+The menu can be hidden or disabled by subscribing to its domain event, eg:
+
+
+[source,java]
+----
+@DomainService(nature=DOMAIN)
+public void HideHsqlDbManagerMenu extends AbstractSubscriber {
+
+    @EventHandler @Subscribe
+    public void on(HsqlDbManagerMenu.ActionDomainEvent ev) {
+        ev.hide();
+    }
+}
+----

http://git-wip-us.apache.org/repos/asf/isis/blob/d3ef50a5/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
----------------------------------------------------------------------
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
index 3518aff..18219ee 100644
--- 
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
+++ 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi.adoc
@@ -207,6 +207,7 @@ 
include::_rgsvc_presentation-layer-spi_GridSystemService.adoc[leveloffset=+1]
 include::_rgsvc_presentation-layer-spi_HintStore.adoc[leveloffset=+1]
 include::_rgsvc_presentation-layer-spi_LocaleProvider.adoc[leveloffset=+1]
 include::_rgsvc_presentation-layer-spi_RoutingService.adoc[leveloffset=+1]
+include::_rgsvc_presentation-layer-spi_SessionLoggingService.adoc[leveloffset=+1]
 
include::_rgsvc_presentation-layer-spi_TableColumnOrderService.adoc[leveloffset=+1]
 include::_rgsvc_presentation-layer-spi_TranslationService.adoc[leveloffset=+1]
 
include::_rgsvc_presentation-layer-spi_TranslationsResolver.adoc[leveloffset=+1]

http://git-wip-us.apache.org/repos/asf/isis/blob/d3ef50a5/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_SessionLoggingService.adoc
----------------------------------------------------------------------
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_SessionLoggingService.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_SessionLoggingService.adoc
new file mode 100644
index 0000000..a8023e8
--- /dev/null
+++ 
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_SessionLoggingService.adoc
@@ -0,0 +1,41 @@
+[[_rgsvc_presentation-layer-spi_SessionLoggingService]]
+= `SessionLoggingService`
+: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/
+
+
+
+The `SessionLoggingService` defines an SPI to keep track of (typically: to 
log) the current sessions that are using the application.
+
+
+== SPI
+
+The SPI defined by this service is:
+
+[source,java]
+----
+public interface SessionLoggingService {
+    public enum Type { LOGIN, LOGOUT }
+    public enum CausedBy { USER, SESSION_EXPIRATION, RESTART }
+
+    void log(
+        Type type,
+        String username,
+        Date date,
+        CausedBy causedBy,
+        String sessionId);  // <1>
+}
+----
+<1> an internal identifier (the JVM hashCode of the Wicket session).
+
+
+
+
+== Implementations
+
+The framework provides an implementation, `SessionLoggingService.Stderr` that 
just prints out to standard error.
+This is not registered by default, but can be easily registered manually (in 
`1.15.0-SNAPSHOT`) using 
`AppManifestAbstract.Builder#withAdditionalServices(...)`.
+
+The (non-ASF) 
http://github.com/isisaddons/isis-module-sessionlogger[Sessionlogger module] 
provides an implementation that logs each session as a JDO entity.
+

http://git-wip-us.apache.org/repos/asf/isis/blob/d3ef50a5/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
----------------------------------------------------------------------
diff --git 
a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc 
b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
index ee0af8d..d2a340c 100644
--- a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
+++ b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
@@ -24,9 +24,9 @@ This table summarises all releases of Apache Isis to date.
 | xref:r1.15.0[1.15.0]
 | (currently in development)
 | Inline prompts, Wicket 7.x
-|
-|
-|
+| 7
+| 25
+| 34
 |
 
 | xref:r1.14.0[1.14.0]

Reply via email to