Repository: isis Updated Branches: refs/heads/master 1f03e0dc1 -> f057d29d8
ISIS-1503 and ISIS-1548: further documentation updates for these tickets (@Mixin, @DomainObject, UserService, AuthenticationSessionProvider, SudoService) Project: http://git-wip-us.apache.org/repos/asf/isis/repo Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/f057d29d Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/f057d29d Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/f057d29d Branch: refs/heads/master Commit: f057d29d883ea6ca9dd49e9bb8070b8676d81b0f Parents: 1f03e0d Author: Dan Haywood <d...@haywood-associates.co.uk> Authored: Thu Dec 1 10:58:47 2016 +0000 Committer: Dan Haywood <d...@haywood-associates.co.uk> Committed: Thu Dec 1 10:58:47 2016 +0000 ---------------------------------------------------------------------- .../src/main/asciidoc/guides/_rgant-DomainObject.adoc | 1 + .../main/asciidoc/guides/_rgant-DomainObject_mixinMethod.adoc | 6 +++--- adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin.adoc | 5 +++++ .../src/main/asciidoc/guides/_rgant-Mixin_method.adoc | 6 +++--- .../guides/_rgfis_spi_AuthenticationSessionProvider.adoc | 2 ++ .../src/main/asciidoc/guides/_rgsvc_api_UserService.adoc | 2 ++ adocs/documentation/src/main/asciidoc/guides/rgant.adoc | 1 + 7 files changed, 17 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/isis/blob/f057d29d/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject.adoc index 90f90b2..68e357a 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject.adoc @@ -141,6 +141,7 @@ include::_rgant-DomainObject_bounded.adoc[leveloffset=+1] include::_rgant-DomainObject_createdLifecycleEvent.adoc[leveloffset=+1] include::_rgant-DomainObject_editing.adoc[leveloffset=+1] include::_rgant-DomainObject_loadedLifecycleEvent.adoc[leveloffset=+1] +include::_rgant-DomainObject_mixinMethod.adoc[leveloffset=+1] include::_rgant-DomainObject_nature.adoc[leveloffset=+1] include::_rgant-DomainObject_persistedLifecycleEvent.adoc[leveloffset=+1] include::_rgant-DomainObject_persistingLifecycleEvent.adoc[leveloffset=+1] http://git-wip-us.apache.org/repos/asf/isis/blob/f057d29d/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject_mixinMethod.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject_mixinMethod.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject_mixinMethod.adoc index cabce49..8ceab6e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject_mixinMethod.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-DomainObject_mixinMethod.adoc @@ -16,10 +16,10 @@ For example: public class Customer { @DomainObject(nature=Nature.MIXIN, mixinMethod="execute") - public static class _placeOrder { + public static class placeOrder { Customer customer; - public _placeOrder(Customer customer) { this.customer = customer; } + public placeOrder(Customer customer) { this.customer = customer; } public Customer execute(Product p, int quantity) { ... } public String disableExecute() { ... } @@ -35,6 +35,6 @@ When invoked programmatically, the code reads: [source,java] ---- -mixin(Customer._placeOrder.class, someCustomer).execute(someProduct, 3); +mixin(Customer.placeOrder.class, someCustomer).execute(someProduct, 3); ---- http://git-wip-us.apache.org/repos/asf/isis/blob/f057d29d/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin.adoc index b0937e7..3e24e96 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin.adoc @@ -20,6 +20,11 @@ The table below summarizes the annotation's attributes. |=== +| Attribute +| Values (default) +| Description + + |xref:rgant.adoc#_rgant-Mixin_method[`method()`] |Method name within the mixin |(As of `1.13.2-SNAPSHOT`) How to recognize the "reserved" method name, meaning that the mixin's own name will be inferred from the mixin type. http://git-wip-us.apache.org/repos/asf/isis/blob/f057d29d/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin_method.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin_method.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin_method.adoc index db8e70b..1c22ddd 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin_method.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_rgant-Mixin_method.adoc @@ -16,10 +16,10 @@ For example: public class Customer { @Mixin(method="execute") - public static class _placeOrder { + public static class placeOrder { Customer customer; - public _placeOrder(Customer customer) { this.customer = customer; } + public placeOrder(Customer customer) { this.customer = customer; } public Customer execute(Product p, int quantity) { ... } public String disableExecute() { ... } @@ -35,7 +35,7 @@ When invoked programmatically, the code reads: [source,java] ---- -mixin(Customer._placeOrder.class, someCustomer).execute(someProduct, 3); +mixin(Customer.placeOrder.class, someCustomer).execute(someProduct, 3); ---- http://git-wip-us.apache.org/repos/asf/isis/blob/f057d29d/adocs/documentation/src/main/asciidoc/guides/_rgfis_spi_AuthenticationSessionProvider.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgfis_spi_AuthenticationSessionProvider.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgfis_spi_AuthenticationSessionProvider.adoc index 567dc59..1d23104 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_rgfis_spi_AuthenticationSessionProvider.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_rgfis_spi_AuthenticationSessionProvider.adoc @@ -30,3 +30,5 @@ the current `AuthenticationSession` from `IsisSessionFactory` singleton service: isisSessionFactory.getCurrentSession().getAuthenticationSession(); ---- + +(As of `1.13.2-SNAPSHOT`), if xref:rgsvc.adoc#_rgsvc_api_SudoService[`SudoService`] has been used to temporarily override the user and/or roles, then this service will report the overridden values. http://git-wip-us.apache.org/repos/asf/isis/blob/f057d29d/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc index 2744243..78fbe53 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_UserService.adoc @@ -7,6 +7,8 @@ The `UserService` allows the domain object to obtain the identity of the user interacting with said object. +If xref:rgsvc.adoc#_rgsvc_api_SudoService[`SudoService`] has been used to temporarily override the user and/or roles, then this service will report the overridden values instead. + [NOTE] ==== http://git-wip-us.apache.org/repos/asf/isis/blob/f057d29d/adocs/documentation/src/main/asciidoc/guides/rgant.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant.adoc index 85cce1f..bad0833 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant.adoc @@ -80,6 +80,7 @@ include::_rgant-HomePage.adoc[leveloffset=+1] include::_rgant-Inject.adoc[leveloffset=+1] include::_rgant-MemberGroupLayout.adoc[leveloffset=+1] include::_rgant-MemberOrder.adoc[leveloffset=+1] +include::_rgant-Mixin.adoc[leveloffset=+1] include::_rgant-Nullable.adoc[leveloffset=+1] include::_rgant-NotPersistent.adoc[leveloffset=+1] include::_rgant-MinLength.adoc[leveloffset=+1]
