http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_LayoutService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_LayoutService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_LayoutService.adoc index c164e0a..785354c 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_LayoutService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_LayoutService.adoc @@ -48,9 +48,9 @@ XML, and how much (if any) will be obtained elsewhere, typically from annotation |=== | Style -|xref:rgant.adoc#_rgant-MemberGroupLayout[`@MemberGroupLayout`] -| xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] -| xref:rgant.adoc#_rgant-ActionLayout[`@ActionLayout`], xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`], xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] +|xref:../rgant/rgant.adoc#_rgant-MemberGroupLayout[`@MemberGroupLayout`] +| xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] +| xref:../rgant/rgant.adoc#_rgant-ActionLayout[`@ActionLayout`], xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`], xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] |`COMPLETE` @@ -88,7 +88,7 @@ As a developer, you therefore have a choice as to how you provide the metadata r The service's functionality is exposed in the UI through a mixin (per object) and a menu action (for all objects): -* the xref:rgant.adoc#_rgcms_classes_mixins_Object[`Object` mixin] provides the ability to download the XML layout for +* the xref:../rgant/rgant.adoc#_rgcms_classes_mixins_Object[`Object` mixin] provides the ability to download the XML layout for any domain object (entity or view model). * the `LayoutServiceMenu` provides the ability to download all XML layouts as a single ZIP file (in any of the @@ -102,6 +102,6 @@ desired. [[__rgsvc_api_LayoutService_related-domain-services]] == Related Domain Services -The xref:rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] is responsible for loading and normalizing layout XML for -a domain class. It in turn uses the xref:rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] and xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] +The xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] is responsible for loading and normalizing layout XML for +a domain class. It in turn uses the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`] and xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`] services. \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MementoService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MementoService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MementoService.adoc index 0facf78..15f5f60 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MementoService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MementoService.adoc @@ -12,9 +12,9 @@ all of their backing state, moreover which is safe for use within a URL. This u The service can also be used to create a memento of arbitrary objects, however this usage is also deprecated. (Prior to `1.13.0` it was used internally by the core implementation of -xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] to capture the state of action invocations so that +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`BackgroundService`] to capture the state of action invocations so that they can be executed by a background process; this is now done using -xref:rgfis.adoc#_rgfis_spi_CommandDtoServiceInternal[`CommandDtoServiceInternal`]). +xref:../rgfis/rgfis.adoc#_rgfis_spi_CommandDtoServiceInternal[`CommandDtoServiceInternal`]). [NOTE] @@ -82,11 +82,11 @@ If using another implementation, the `canSet(...)` method can be used to check i == Usage -As noted in the introduction, a common use case for this service is in the implementation of the xref:rgcms.adoc#_rgcms_classes_super_AbstractViewModel[`ViewModel`] interface. +As noted in the introduction, a common use case for this service is in the implementation of the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractViewModel[`ViewModel`] interface. [TIP] ==== -Rather than implementing `ViewModel`, it's usually easier to annotate your view models with xref:rgant.adoc#_rgant-ViewModel[`@ViewModel`] (or equivalently xref:rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature=EXTERNAL_ENTITY`] or xref:rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature=INMEMORY_ENTITY`]. +Rather than implementing `ViewModel`, it's usually easier to annotate your view models with xref:../rgant/rgant.adoc#_rgant-ViewModel[`@ViewModel`] (or equivalently xref:../rgant/rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature=EXTERNAL_ENTITY`] or xref:../rgant/rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature=INMEMORY_ENTITY`]. ==== For example, suppose you were implementing a view model that represents an external entity in a SOAP web service. To access this service the view model needs to store (say) the hostname, port number and an id to the object. @@ -125,11 +125,11 @@ public class ExternalEntity implements ViewModel { == Related Services -(Prior to `1.13.0`), the memento service was used by the xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] +(Prior to `1.13.0`), the memento service was used by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service and also -xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`]. These both use a memento to capture a +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommandService`]. These both use a memento to capture a representation of an action invocation. This is now done using -xref:rgfis.adoc#_rgfis_spi_CommandDtoServiceInternal[`CommandDtoServiceInternal`]. +xref:../rgfis/rgfis.adoc#_rgfis_spi_CommandDtoServiceInternal[`CommandDtoServiceInternal`]. @@ -137,10 +137,10 @@ xref:rgfis.adoc#_rgfis_spi_CommandDtoServiceInternal[`CommandDtoServiceInternal` == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `MementoService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MessageService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MessageService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MessageService.adoc index eb57549..7cb42ff 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MessageService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MessageService.adoc @@ -9,7 +9,7 @@ The `MessageService` allows domain objects to raise information, warning or erro [NOTE] ==== -The methods in this service replace similar methods (now deprecated) in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +The methods in this service replace similar methods (now deprecated) in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. ==== @@ -66,13 +66,13 @@ The core framework provides a default implementation of this service (`o.a.i.cor == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `MessageService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetamodelService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetamodelService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetamodelService.adoc index 7e5ea83..e493b09 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetamodelService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetamodelService.adoc @@ -52,17 +52,17 @@ The framework provides a default implementation of this service, `o.a.i.c.m.serv == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `MetamodelService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). == Related Services The `MetaModelServiceMenu` provides a method to download all domain members as a CSV. Internally this calls `MetaModelService#export()`. Under the covers this uses the API provided by the -xref:rgsvc.adoc#_rgsvc_api_ApplicationFeatureRepository[`ApplicationFeatureRepository`] domain service. +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ApplicationFeatureRepository[`ApplicationFeatureRepository`] domain service. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetricsService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetricsService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetricsService.adoc index 5ab1992..7161213 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetricsService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_MetricsService.adoc @@ -9,7 +9,7 @@ The `MetricsService` is a request-scoped domain service that hooks into the JDO/DataNucleus ObjectStore to provide a number of counters relating to numbers of object loaded, dirtied etc. -The service is used by the xref:rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] domain service (to populate the DTO held by the `Interaction.Execution`) and also by the (internal) xref:rgfis.adoc#_rgfis_spi_PublishingServiceInternal[`PublishingServiceInternal`] domain service (to populate +The service is used by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] domain service (to populate the DTO held by the `Interaction.Execution`) and also by the (internal) xref:../rgfis/rgfis.adoc#_rgfis_spi_PublishingServiceInternal[`PublishingServiceInternal`] domain service (to populate the `PublishedObjects` class. @@ -28,8 +28,8 @@ public interface MetricsService { ---- <1> The number of objects that have, so far in this request, been loaded from the database. Corresponds to the number of times that `javax.jdo.listener.LoadLifecycleListener#postLoad(InstanceLifecycleEvent)` is fired. <2> The number of objects that have, so far in this request, been dirtied/will need updating in the database); a good measure of the footprint of the interaction. Corresponds to the number of times that `javax.jdo.listener.DirtyLifecycleListener#preDirty(InstanceLifecycleEvent)` callback is fired. -<3> The number of individual properties of objects that were modified; a good measure of the amount of work being done in the interaction. Corresponds to the number of times that the xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`]'s (or -xref:rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`]'s) `audit(...)` method will be called as the transaction +<3> The number of individual properties of objects that were modified; a good measure of the amount of work being done in the interaction. Corresponds to the number of times that the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`]'s (or +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`]'s) `audit(...)` method will be called as the transaction completes. The framework provides a default implementation of this API, namely `o.a.i.c.r.s.metrics.MetricsServiceDefault`. @@ -38,12 +38,12 @@ The framework provides a default implementation of this API, namely `o.a.i.c.r.s == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' default +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' default implementation of `MetricsService` class is automatically registered (it is annotated with `@DomainService`) so no further configuration is required. == Related Services -The xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] also captures the metrics gathered by the +The xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] also captures the metrics gathered by the `MetricsService` and publishes them as part of the `PublishedObjects` class (part of its SPI). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_QueryResultsCache.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_QueryResultsCache.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_QueryResultsCache.adoc index 079a90f..b67c06f 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_QueryResultsCache.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_QueryResultsCache.adoc @@ -111,16 +111,16 @@ This refactoring will be worthwhile provided that enough of the orders being pro == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `QueryResultsCache` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). == Related Services -The xref:rgsvc.adoc#_rgsvc_api_Scratchpad[`Scratchpad`] service is also intended for actions that are called many times, allowing arbitrary information to be shared between them. Those methods could be called from some outer loop in domain code, or by the framework itself if the action invoked has the xref:rgant.adoc#_rgant-Action_invokeOn[`@Action#invokeOn()`] annotation attribute set to `OBJECT_AND_COLLECTION` or `COLLECTION_ONLY`. \ No newline at end of file +The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_Scratchpad[`Scratchpad`] service is also intended for actions that are called many times, allowing arbitrary information to be shared between them. Those methods could be called from some outer loop in domain code, or by the framework itself if the action invoked has the xref:../rgant/rgant.adoc#_rgant-Action_invokeOn[`@Action#invokeOn()`] annotation attribute set to `OBJECT_AND_COLLECTION` or `COLLECTION_ONLY`. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_RepositoryService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_RepositoryService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_RepositoryService.adoc index a6e7def..362cb88 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_RepositoryService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_RepositoryService.adoc @@ -9,12 +9,12 @@ The `RepositoryService` collects together methods for creating, persisting and s You can use it during prototyping to write naive queries (find all rows, then filter using the Guava `Predicate` API, or you can use it to call JDO link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/query.html#named[named queries] using JDOQL. -As an alternative, you could also use link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[JDO typesafe queries] through the xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] service. +As an alternative, you could also use link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[JDO typesafe queries] through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] service. [NOTE] ==== -The methods in this service replace similar methods (now deprecated) in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +The methods in this service replace similar methods (now deprecated) in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. ==== @@ -47,7 +47,7 @@ public interface RepositoryService { } ---- <1> create a new non-persisted domain entity. This is identical to -xref:rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`]'s `instantiate(...)` method, but is provided in the +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`]'s `instantiate(...)` method, but is provided in the ``RepositoryService``'s API too because instantiating and persisting objects are often done together. <2> test whether a particular domain object is persistent or not <3> persist (ie save) an object to the persistent object store (or do nothing if it is already persistent). @@ -83,7 +83,7 @@ repositoryService.persist(cust); You should be aware that by default Apache Isis queues up calls to `#persist()` and `#remove()`. These are then executed either when the request completes (and the transaction commits), or if the queue is flushed. This can be done either implicitly by the framework, or as the result of a direct call to `#flush()`. -By default the framework itself will cause `#flush()` to be called whenever a query is executed by way of `#allMatches(Query)`, as documented xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_generic-repository-api[above]. However, this behaviour can be disabled using the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.container.disableAutoFlush`. +By default the framework itself will cause `#flush()` to be called whenever a query is executed by way of `#allMatches(Query)`, as documented xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_generic-repository-api[above]. However, this behaviour can be disabled using the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.container.disableAutoFlush`. @@ -219,7 +219,7 @@ With respect to the other query APIs, the varargs parameters are optional, but a [TIP] ==== -It is also possible to query using DataNucleus' type-safe query API. For more details, see xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`]. +It is also possible to query using DataNucleus' type-safe query API. For more details, see xref:../rgsvc/rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`]. ==== @@ -255,17 +255,17 @@ This key allows this behaviour to be disabled. == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `RepositoryService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). == Related Services -the xref:rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`] is often used in conjunction with the `RepositoryService`, to instantiate domain objects before persisting. +the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`] is often used in conjunction with the `RepositoryService`, to instantiate domain objects before persisting. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_Scratchpad.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_Scratchpad.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_Scratchpad.adoc index 3c7f3df..d6e09d9 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_Scratchpad.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_Scratchpad.adoc @@ -36,7 +36,7 @@ This class (`o.a.i.applib.services.scratchpad.Scratchpad`) is also the implement == Usage -The most common use-case is for xref:rgant.adoc#_rgant-Action_invokeOn[bulk] actions that act upon multiple objects in a list. The (same) `Scratchpad` service is injected into each of these objects, and so they can use pass information. +The most common use-case is for xref:../rgant/rgant.adoc#_rgant-Action_invokeOn[bulk] actions that act upon multiple objects in a list. The (same) `Scratchpad` service is injected into each of these objects, and so they can use pass information. For example, the Isis addons example https://github.com/isisaddons/isis-app-todoapp/[todoapp] (not ASF) demonstrates how the `Scratchpad` service can be used to calculate the total cost of the selected `ToDoItem`s: @@ -109,13 +109,13 @@ If using the xref:ugvw.adoc#[Wicket viewer], the `ToDoItemBulkUpdate` view model == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `Scratchpad` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). @@ -123,6 +123,6 @@ in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to th == Related Services -The xref:rgsvc.adoc#_rgsvc_api_ActionInteractionContext[`ActionInteractionContext`] service allows xref:rgant.adoc#_rgant-Action_invokeOn[bulk actions] to co-ordinate with each other. +The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ActionInteractionContext[`ActionInteractionContext`] service allows xref:../rgant/rgant.adoc#_rgant-Action_invokeOn[bulk actions] to co-ordinate with each other. -The xref:rgsvc.adoc#_rgsvc_api_QueryResultsCache[`QueryResultsCache`] is useful for caching the results of expensive method calls. +The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_QueryResultsCache[`QueryResultsCache`] is useful for caching the results of expensive method calls. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_ServiceRegistry.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_ServiceRegistry.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_ServiceRegistry.adoc index eebb5d0..63e1e65 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_ServiceRegistry.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_ServiceRegistry.adoc @@ -9,7 +9,7 @@ The `ServiceRegistry2` service collects together methods for accessing other dom [NOTE] ==== -The methods in this service replace similar methods (now deprecated) in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +The methods in this service replace similar methods (now deprecated) in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. ==== @@ -32,7 +32,7 @@ public interface ServiceRegistry2 { <4> returns the list of all domain services that constitute the running application (including internal domain services). Service injection is done automatically if objects are created using the -xref:rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`]. +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`]. @@ -50,7 +50,7 @@ cust.setLastName("Mercury"); repositoryService.persist(cust); ---- -The alternative is to use the xref:rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`] API which performs both steps in a single factory method. +The alternative is to use the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`] API which performs both steps in a single factory method. @@ -64,12 +64,12 @@ The core framework provides a default implementation of this service (`o.a.i.cor == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `ServiceRegistry` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SessionManagementService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SessionManagementService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SessionManagementService.adoc index fc96db5..1bbaa4d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SessionManagementService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SessionManagementService.adoc @@ -47,10 +47,10 @@ The core framework provides a default implementation of this service (`o.a.i.cor == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `SessionManagementService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SudoService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SudoService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SudoService.adoc index f060ce3..d07b8c3 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SudoService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SudoService.adoc @@ -6,7 +6,7 @@ -The `SudoService` allows the current user reported by the xref:rgsvc.adoc#_rgsvc_api_UserService[`UserService`] to be temporarily changed to some other user. +The `SudoService` allows the current user reported by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_UserService[`UserService`] to be temporarily changed to some other user. This is useful both for xref:ugtst.adoc#_ugtst_integ-test-support[integration testing] (eg if testing a workflow system whereby objects are moved from one user to another) and while running xref:ugtst.adoc#_ugtst_fixture-scripts[fixture scripts] (eg setting up objects that would normally require several users to have acted upon the objects). @@ -32,12 +32,12 @@ which will run the provided block of code (a `Runnable` or a `Callable`) in a wa `UserService#getUser()` will return the specified user (and roles, if specified). (If roles are not specified, then the roles of the current user are preserved). -The current user/role reported by the internal xref:rgfis.adoc#_rgfis_spi_AuthenticationSessionProvider[`AuthenticationSessionProvider`] will also return the specified user/roles. +The current user/role reported by the internal xref:../rgfis/rgfis.adoc#_rgfis_spi_AuthenticationSessionProvider[`AuthenticationSessionProvider`] will also return the specified user/roles. [IMPORTANT] ==== Note however that this the "effective user" does not propagate through to the xref:ugsec.adoc#[Shiro security mechanism], which will continue to be evaluated according to the permissions of the current user. -See the xref:rgsvc.adoc#__rgsvc_api_SudoService_ACCESS-ALL-ROLE[`ACCESS-ALL-ROLE`] below for details of how to circumvent this. +See the xref:../rgsvc/rgsvc.adoc#__rgsvc_api_SudoService_ACCESS-ALL-ROLE[`ACCESS-ALL-ROLE`] below for details of how to circumvent this. ==== @@ -70,11 +70,11 @@ protected void execute(final ExecutionContext ec) { [[__rgsvc_api_SudoService_ACCESS-ALL-ROLE]] === ACCESS_ALL_ROLE -When `sudo(...)` is called the "effective user" is reported by both xref:rgsvc.adoc#_rgsvc_api_UserService[`UserService`] and by xref:rgfis.adoc#_rgfis_spi_AuthenticationSessionProvider[`AuthenticationSessionProvider`], but does not propagate through to the xref:ugsec.adoc#[Shiro security mechanism]. +When `sudo(...)` is called the "effective user" is reported by both xref:../rgsvc/rgsvc.adoc#_rgsvc_api_UserService[`UserService`] and by xref:../rgfis/rgfis.adoc#_rgfis_spi_AuthenticationSessionProvider[`AuthenticationSessionProvider`], but does not propagate through to the xref:ugsec.adoc#[Shiro security mechanism]. These continue to be evaluated according to the permissions of the current user. This can be a problem in certain use cases. -For example if running a fixture script (which uses the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`]) from within an implementation of xref:rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`UserRegistrationService`], this is likely to result in ``HiddenException``s being thrown because there is no effective user. +For example if running a fixture script (which uses the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`]) from within an implementation of xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_UserRegistrationService[`UserRegistrationService`], this is likely to result in ``HiddenException``s being thrown because there is no effective user. In such cases, permission checking can simply be disabled by specifying `SudoService.ACCESS_ALL_ROLE` as one of the roles. For example: @@ -105,7 +105,7 @@ In the future this service may be used more deeply, eg to propagate permissions == SPI The `SudoService.Spi` service allows implementations of `SudoService` to notify other services/components that the effective user and roles are different. -The default implementation of xref:rgsvc.adoc#_rgsvc_api_UserService[`UserService`] has been refactored to leverage this SPI. +The default implementation of xref:../rgsvc/rgsvc.adoc#_rgsvc_api_UserService[`UserService`] has been refactored to leverage this SPI. [source,java] ---- @@ -128,10 +128,10 @@ The names of these methods were chosen based on link:href:https://shiro.apache.o == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `SudoService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwaggerService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwaggerService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwaggerService.adoc index ea6f21c..f16f083 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwaggerService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwaggerService.adoc @@ -38,9 +38,9 @@ public interface SwaggerService { } ---- <1> Generate a Swagger spec for use by third-party clients, ie public use. This specification is restricted only to -xref:ugbtb.adoc#_ugbtb_view-models[view model]s and to domain services with a xref:rgant.adoc#_rgant-DomainService_nature[nature] of `VIEW_REST_ONLY`. +xref:ugbtb.adoc#_ugbtb_view-models[view model]s and to domain services with a xref:../rgant/rgant.adoc#_rgant-DomainService_nature[nature] of `VIEW_REST_ONLY`. <2> Generate a Swagger spec for use only by internally-managed clients, ie private internal use. This specification includes domain entities and all menu domain services (as well as any view models). -<3> Generate a Swagger spec that is the same as private case (above), but also including any xref:rgant.adoc#_rgant-Action_restrictTo[prototype] actions. +<3> Generate a Swagger spec that is the same as private case (above), but also including any xref:../rgant/rgant.adoc#_rgant-Action_restrictTo[prototype] actions. <4> Swagger specs can be written either in JSON or YAML format. Isis provides a default implementation of the service, `o.a.i.core.metamodel.services.swagger.SwaggerServiceDefault`. @@ -56,7 +56,7 @@ This service is provided as a convenience for applications, it is not (currently == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `SwaggerService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. @@ -64,6 +64,6 @@ implementation of `SwaggerService` service is automatically registered and injec A `SwaggerServiceMenu` domain service provides a prototype action that enables the swagger spec to be downloaded from the Wicket viewer's UI. -Apache Isis' xref:rgmvn.aod[Maven plugin] also provides a xref:rgmvn.adoc#_rgmvn_swagger[swagger goal] which allows the spec file(s) to be generated at build time. this then allows client-side stubs can then be generated in turn as part of a build pipeline. +Apache Isis' xref:rgmvn.aod[Maven plugin] also provides a xref:../rgmvn/rgmvn.adoc#_rgmvn_swagger[swagger goal] which allows the spec file(s) to be generated at build time. this then allows client-side stubs can then be generated in turn as part of a build pipeline. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwitchUserService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwitchUserService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwitchUserService.adoc index 52de8a7..60d6de6 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwitchUserService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_SwitchUserService.adoc @@ -14,7 +14,7 @@ different users of the system. [NOTE] ==== This service is deprecated; use xref:ugtst.adoc#_ugtst_fixture-scripts[fixture scripts] and the -xref:rgsvc.adoc#_rgsvc_api_SudoService[`SudoService`] instead. +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_SudoService[`SudoService`] instead. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TitleService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TitleService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TitleService.adoc index 6960a88..0919d5b 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TitleService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TitleService.adoc @@ -9,7 +9,7 @@ The `TitleService` provides methods to programmatically obtain the title and ico [NOTE] ==== -The methods in this service replace similar methods (now deprecated) in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +The methods in this service replace similar methods (now deprecated) in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. ==== @@ -63,12 +63,12 @@ The core framework provides a default implementation of this service (`o.a.i.cor == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `TitleService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TransactionService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TransactionService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TransactionService.adoc index 09f03a4..9dca04d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TransactionService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_TransactionService.adoc @@ -9,7 +9,7 @@ The `TransactionService` provides a small number of methods to allow domain obje [NOTE] ==== -The methods in this service replace similar methods (now deprecated) in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +The methods in this service replace similar methods (now deprecated) in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. ==== @@ -31,7 +31,7 @@ and will commit that transaction after the interaction has completed. Under cer perform data migration, say, or for large fixture scripts), it can be helpful to programmatically complete one transaction and start another one. <3> If the user interaction creates/persists an object or deletes an object (eg using the -xref:rgsvc.adoc#_rgsvc_api_RepositoryService[`RepositoryService`]'s `persist()` or `delete()` methods), then the +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_RepositoryService[`RepositoryService`]'s `persist()` or `delete()` methods), then the framework actually queues up the work and only performs the persistence command either at the end of the transaction or immediately prior to the next query. Performing a flush will cause any pending calls to be performed immediately. @@ -51,7 +51,7 @@ public interface Transaction { } ---- <1> is a unique identifier for the interaction/request, as defined by the -xref:rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[`HasTransactionId`] mixin. +xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[`HasTransactionId`] mixin. <2> there can actually be multiple transactions within such a request/interaction; the sequence is a (0-based) is used to distinguish such. <3> as per `TransactionService#flushTransaction()` described above. @@ -88,10 +88,10 @@ The core framework provides a default implementation of this service (`o.a.i.cor == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `TransactionService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_UserService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_UserService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_UserService.adoc index d07f38b..bca048e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_UserService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_UserService.adoc @@ -7,12 +7,12 @@ 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. +If xref:../rgsvc/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] ==== -The methods in this service replace similar methods (now deprecated) in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +The methods in this service replace similar methods (now deprecated) in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. ==== @@ -73,13 +73,13 @@ The core framework provides a default implementation of this service (`o.a.i.cor == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `UserService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_WrapperFactory.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_WrapperFactory.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_WrapperFactory.adoc index 415989e..5eaa6b1 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_WrapperFactory.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_WrapperFactory.adoc @@ -56,8 +56,8 @@ public interface WrapperFactory { <3> whether the supplied object has been wrapped. <4> enumerates how the wrapper interacts with the underlying domain object. <5> validate all business rules and then execute. -<6> skip all business rules and then execute (including creating xref:rgant.adoc#_rgant-Action_command[command]s and firing pre- and post-execute xref:rgant.adoc#_rgant-Action_domainEvent[domain event]s). -<7> validate all business rules (including those from xref:rgant.adoc#_rgant-Action_domainEvent[domain event]s) but do not execute. +<6> skip all business rules and then execute (including creating xref:../rgant/rgant.adoc#_rgant-Action_command[command]s and firing pre- and post-execute xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[domain event]s). +<7> validate all business rules (including those from xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[domain event]s) but do not execute. <8> convenience method to invoke `wrap(...)` with `ExecuteMode#NO_EXECUTE` (make this feature more discoverable) <9> convenience method to invoke `wrap(...)` with `ExecuteMode#SKIP_RULES` (make this feature more discoverable) @@ -74,8 +74,8 @@ Calling any of the above methods may result in a (subclass of) `InteractionExcep In addition, the following methods may also be called: -* the xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and `toString()` methods -* any xref:rgcms.adoc#_rgcms_methods_prefixes_default[`default...()`], xref:rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`] or xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] methods +* the xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and `toString()` methods +* any xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_default[`default...()`], xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`] or xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] methods An exception will be thrown if any other methods are thrown. @@ -114,7 +114,7 @@ public class CustomerAgent { [NOTE] ==== -It ought to be possible to implement an xref:rgsvc.adoc#_rgsvc_spi_ExceptionRecognizer[`ExceptionRecognizer`]s that would allow the above boilerplate to be removed. This recognizer service would recognize the `InteractionException` and convert to a suitable message. +It ought to be possible to implement an xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_ExceptionRecognizer[`ExceptionRecognizer`]s that would allow the above boilerplate to be removed. This recognizer service would recognize the `InteractionException` and convert to a suitable message. At the time of writing Apache Isis does not provide an out-of-the-box implementation of such an `ExceptionRecognizer`; but it should be simple enough to write one⦠==== @@ -153,10 +153,10 @@ The original intent of this API was to enable test transcripts to be captured (i == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `WrapperFactory` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_XmlSnapshotService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_XmlSnapshotService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_XmlSnapshotService.adoc index 250681d..6090bcd 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_XmlSnapshotService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_api_XmlSnapshotService.adoc @@ -194,25 +194,25 @@ public interface XmlSnapshotService { == Registering the Service Assuming that the `configuration-and-annotation` services installer is configured (implicit if using the -`AppManifest` to xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core +`AppManifest` to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app]) then Apache Isis' core implementation of `XmlSnapshotService` service is automatically registered and injected (it is annotated with `@DomainService`) so no further configuration is required. To use an alternative implementation, use -xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained -in the xref:rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] (as explained +in the xref:../rgsvc/rgsvc.adoc#__rgsvc_intro_overriding-the-services[introduction] to this guide). == Related Services -The xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`] provides a mechanism for obtaining a string representations of a single domain object. +The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`] provides a mechanism for obtaining a string representations of a single domain object. -The xref:rgsvc.adoc#_rgsvc_api_MementoService[`MementoService`] also provides a mechanism for generating string representations of domain objects. +The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MementoService[`MementoService`] also provides a mechanism for generating string representations of domain objects. -The xref:rgsvc.adoc#_rgsvc_api_JaxbService[`JaxbService`] is a simple wrapper around +The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_JaxbService[`JaxbService`] is a simple wrapper around standard JAXB functionality for generating both XMLs and XSDs from JAXB-annotated classes. Note that there is built-in support for JAXB classes (ie annotated with -xref:rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]) to be used as view models. +xref:../rgant/rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]) to be used as view models. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc index 3ca4ce6..692cd3e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc @@ -20,7 +20,7 @@ The table below summarizes the application layer APIs defined by Apache Isis. I |Implementation |Notes -|xref:rgsvc.adoc#_rgsvc_api_AcceptHeaderService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_AcceptHeaderService[`o.a.i.applib.` + `services.acceptheader` + `AcceptHeaderService`] |Request-scoped access to HTTP Accept headers. @@ -30,7 +30,7 @@ The table below summarizes the application layer APIs defined by Apache Isis. I |Populated only when the domain objects are accessed using the xref:ugvro.adoc#[Restful Objects viewer]. -|xref:rgsvc.adoc#_rgsvc_api_ActionInvocationContext[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ActionInvocationContext[`o.a.i.applib.` + `services.actinv` + `ActionInvocation-` + `Context`] @@ -42,7 +42,7 @@ The table below summarizes the application layer APIs defined by Apache Isis. I -|xref:rgsvc.adoc#_rgsvc_api_BackgroundService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BackgroundService[`o.a.i.applib.` + `services.background` + `BackgroundService`] |Programmatic persistence of commands to be persisted (so can be executed by a background mechanism, eg scheduler) @@ -50,10 +50,10 @@ The table below summarizes the application layer APIs defined by Apache Isis. I ``o.a.i.core`` + ``isis-core-runtime`` |depends on: + -xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommand-Service`] +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommand-Service`] -|xref:rgsvc.adoc#_rgsvc_api_CommandContext[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`o.a.i.applib.` + `services.command` + `CommandContext`] |Request-scoped access to capture the users's __intention__ to invoke an action or to edit a property. @@ -62,12 +62,12 @@ xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`BackgroundCommand-Service`] ``isis-core-applib`` |API is also a concrete class. + depends on: + -xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] for persistent `Command`, else in-memory impl. used. +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] for persistent `Command`, else in-memory impl. used. -The xref:rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] manages the actual execution of the command. +The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] manages the actual execution of the command. -|xref:rgsvc.adoc#_rgsvc_api_InteractionContext[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[`o.a.i.applib.` + `services.iactn` + `InteractionContext`] |Request-scoped access to the current member execution (action invocation or property edit), @@ -79,7 +79,7 @@ represented as the `Interaction` context. -|xref:rgsvc.adoc#_rgsvc_api_MessageService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MessageService[`o.a.i.applib.` + `services.message` + `MessageService`] |Methods to inform or warn the user, or to raise errors. @@ -87,10 +87,10 @@ represented as the `Interaction` context. ``Default`` + ``o.a.i.core`` + ``isis-core-metamodel`` -|Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +|Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. -|xref:rgsvc.adoc#_rgsvc_api_SessionManagementService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_SessionManagementService[`o.a.i.applib.` + `services.sessmgmt` + `SessionManagementService`] |Methods for batching long-running work (eg data migration) into multiple sessions. @@ -101,7 +101,7 @@ represented as the `Interaction` context. | -|xref:rgsvc.adoc#_rgsvc_api_TitleService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_TitleService[`o.a.i.applib.` + `services.title` + `TitleService`] |Methods to programmatically obtain the title or icon of a domain object. @@ -109,11 +109,11 @@ represented as the `Interaction` context. ``Default`` + ``o.a.i.core`` + ``isis-core-metamodel`` -|Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +|Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. -|xref:rgsvc.adoc#_rgsvc_api_TransactionService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_TransactionService[`o.a.i.applib.` + `services.xactn` + `TransactionService`] |Methods for managing transactions. @@ -121,11 +121,11 @@ represented as the `Interaction` context. ``Default`` + ``o.a.i.core`` + ``isis-core-metamodel`` -|Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +|Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. -|xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`o.a.i.applib.` + `services.wrapper` + `WrapperFactory`] |Interact with another domain object "as if" through the UI (enforcing business rules, firing domain events) http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi.adoc index c49568e..66a9cce 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi.adoc @@ -20,7 +20,7 @@ The table below summarizes the application layer SPIs defined by Apache Isis. I |Notes -|xref:rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_BackgroundCommandService[`o.a.i.applib.` + `services.background` + `BackgroundCommandService`] |Persisted a memento of an action invocation such that it can be executed asynchronously ("in the background") eg by a scheduler. @@ -35,7 +35,7 @@ The table below summarizes the application layer SPIs defined by Apache Isis. I -|xref:rgsvc.adoc#_rgsvc_spi_CommandService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`o.a.i.applib.` + `services.command.spi` + `CommandService`] |Service to act as a factory and repository (create and save) of command instances, ie representations of an action invocation. Used for command/auditing and background services. @@ -49,7 +49,7 @@ The table below summarizes the application layer SPIs defined by Apache Isis. I `JdoRepository` -|xref:rgsvc.adoc#_rgsvc_api_HomePageProviderService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_HomePageProviderService[`o.a.i.applib.` + `services.homepage` + `HomePageProviderService`] |Returns the home page object, if any is defined. @@ -57,7 +57,7 @@ The table below summarizes the application layer SPIs defined by Apache Isis. I `ServiceDefault` + ``o.a.i.core`` + ``isis-core-runtime`` -|Used by the default implementation of xref:rgsvc.adoc#_rgsvc_spi_RoutingService[`RoutingService`]. +|Used by the default implementation of xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_RoutingService[`RoutingService`]. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi.adoc index af2e242..d0f0499 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi.adoc @@ -20,12 +20,12 @@ The table below summarizes the bootstrapping SPI defined by Apache Isis. It als |Notes -|xref:rgsvc.adoc#_rgsvc_spi_ClassDiscoveryService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_ClassDiscoveryService[`o.a.i.applib.` + `services.classdiscovery` + `ClassDiscoveryService`] -|Mechanism to locate (from the classpath) classes with a specific annotation (eg xref:rgant.adoc#_rgant-DomainService[`@DomainService`]) +|Mechanism to locate (from the classpath) classes with a specific annotation (eg xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`]) -Subtypes of a given type (eg xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`]). +Subtypes of a given type (eg xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`]). |`ClassDiscoveryService-` + `UsingReflections` + ``o.a.i.core`` + http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api.adoc index c2ac39f..f06ba8b 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api.adoc @@ -22,7 +22,7 @@ The table below summarizes the core/domain APIs defined by Apache Isis. It also -|xref:rgsvc.adoc#_rgsvc_api_ClockService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ClockService[`o.a.i.applib.` + `services.clock` + `ClockService`] |Access the current time (and for testing, allow the time to be changed) @@ -33,7 +33,7 @@ The table below summarizes the core/domain APIs defined by Apache Isis. It also -|xref:rgsvc.adoc#_rgsvc_api_ConfigurationService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ConfigurationService[`o.a.i.applib.` + `services.config` + `ConfigurationService`] |Access configuration properties (eg from `isis.properties` file) @@ -43,10 +43,10 @@ The table below summarizes the core/domain APIs defined by Apache Isis. It also ``isis-core-runtime`` |The ``ConfigurationServiceMenu`` exposes the ``allConfigurationProperties`` action in the user interface. + + -Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. -|xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`o.a.i.applib` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`o.a.i.applib` + `DomainObjectContainer`] |Miscellaneous functions, eg obtain title of object. |`DomainObjectContainer-` + @@ -56,20 +56,20 @@ Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainOb | -|xref:rgsvc.adoc#_rgsvc_api_EventBusService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`o.a.i.applib.` + `services.eventbus` + `EventBusService`] |Programmatically post events to the internal event bus. Also used by Apache Isis itself to broadcast domain events: -* xref:rgant.adoc#_rgant-Action_domainEvent[`Action#domainEvent()`] -* xref:rgant.adoc#_rgant-Property_domainEvent[`Property#domainEvent()`] -* xref:rgant.adoc#_rgant-Collection_domainEvent[`Collection#domainEvent()`] +* xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[`Action#domainEvent()`] +* xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`Property#domainEvent()`] +* xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[`Collection#domainEvent()`] |`EventBusServiceJdo` + ``o.a.i.core`` + ``isis-core-runtime`` | -|xref:rgsvc.adoc#_rgsvc_api_FactoryService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FactoryService[`o.a.i.applib.` + `services.factory` + `FactoryService`] |Methods to instantiate and initialize domain objects @@ -77,12 +77,12 @@ Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainOb ``Default`` + ``o.a.i.core`` + ``isis-core-metamodel`` -|Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +|Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. -|xref:rgsvc.adoc#_rgsvc_api_Scratchpad[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_Scratchpad[`o.a.i.applib.` + `services.scratchpad` + `Scratchpad`] |Request-scoped service for interchanging information between and aggregating over multiple method calls; in particular for use by "bulk" actions (invoking of an action for all elements of a collection) @@ -94,7 +94,7 @@ Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainOb -|xref:rgsvc.adoc#_rgsvc_api_UserService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_UserService[`o.a.i.applib.` + `services.xactn` + `UserService`] |Methods to access the currently-logged on user. @@ -102,7 +102,7 @@ Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainOb ``Default`` + ``o.a.i.core`` + ``isis-core-metamodel`` -|Supercedes methods in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +|Supercedes methods in xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. @@ -135,7 +135,7 @@ There is also a number of deprecated domain services. |`Bulk.InteractionContext` + ``o.a.i.core`` + ``isis-core-applib`` -|Replaced by xref:rgsvc.adoc#_rgsvc_api_ActionInvocationContext[`ActionInvocationContext`] +|Replaced by xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ActionInvocationContext[`ActionInvocationContext`] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api.adoc index 72c299a..302523f 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api.adoc @@ -22,7 +22,7 @@ The table below summarizes the integration APIs defined by Apache Isis. It also -|xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`o.a.i.applib.` + `services.bookmark` + `BookmarkService2`] |Convert object reference to a serializable "bookmark", and vice versa. @@ -37,7 +37,7 @@ The table below summarizes the integration APIs defined by Apache Isis. It also `Contributions` -|xref:rgsvc.adoc#_rgsvc_api_DeepLinkService[`o.a.i.applib` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DeepLinkService[`o.a.i.applib` + `services.deeplink` + `DeepLinkService`] |Obtain a URL to a domain object (eg for use within an email or report) @@ -47,7 +47,7 @@ The table below summarizes the integration APIs defined by Apache Isis. It also |Implementation only usable within Wicket viewer -|xref:rgsvc.adoc#_rgsvc_api_EmailService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EmailService[`o.a.i.applib.` + `services.email` + `EmailService`] |Send a HTML email, optionally with attachments. @@ -57,7 +57,7 @@ The table below summarizes the integration APIs defined by Apache Isis. It also | -|xref:rgsvc.adoc#_rgsvc_api_GuiceBeanProvider[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_GuiceBeanProvider[`o.a.i.applib.` + `services.guice` + `GuiceBeanProvider`] |Access to internal framework services initialized using Guice DI. @@ -68,7 +68,7 @@ The table below summarizes the integration APIs defined by Apache Isis. It also -|xref:rgsvc.adoc#_rgsvc_api_JaxbService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_JaxbService[`o.a.i.applib.` + `services.jaxb` + `JaxbService`] |Marshal and unmarshal JAXB-annotated view models to/from XML. @@ -78,17 +78,17 @@ The table below summarizes the integration APIs defined by Apache Isis. It also | -|xref:rgsvc.adoc#_rgsvc_api_MementoService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MementoService[`o.a.i.applib.` + `services.memento` + `MementoService`] -|Capture a serializable memento of a set of primitives or xref:rgsvc.adoc#_rgsvc_api_BookmarkService[bookmarks]. Primarily used internally, eg in support of commands/auditing. +|Capture a serializable memento of a set of primitives or xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[bookmarks]. Primarily used internally, eg in support of commands/auditing. |`MementoServiceDefault` + ``o.a.i.core`` + ``isis-core-runtime`` | -|xref:rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`o.a.i.applib.` + +|xref:../rgsvc/rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`o.a.i.applib.` + `services.xmlsnapshot` + `XmlSnapshotService`] |Generate an XML representation of an object and optionally a graph of related objects. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc index c6b2a95..38fbc01 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc @@ -18,11 +18,11 @@ below shows these categories: image::{_imagesdir}reference-services/categories.png[width="600px",link="{_imagesdir}reference-services/categories.png"] -A small number of domain services can be considered both API and SPI; a good example is the xref:rgsvc.adoc#_rgsvc_api_EmailService[`EmailService`] that is of direct use for domain objects wishing to send out emails, +A small number of domain services can be considered both API and SPI; a good example is the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EmailService[`EmailService`] that is of direct use for domain objects wishing to send out emails, but is also used by the framework to support the xref:ugvw.adoc#_ugvw_features_user-registration[user registration] -functionality supported by the xref:ugvw.adoc#[Wicket viewer]. The same is true of the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]; this can be used by domain objects to broadcast arbitrary events, +functionality supported by the xref:ugvw.adoc#[Wicket viewer]. The same is true of the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]; this can be used by domain objects to broadcast arbitrary events, but is also used by the framework to automatically emit events for -xref:rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`] etc. +xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`] etc. For these hybrid services we have categorized the service as an "API" service. This chapter therefore contains only the strictly SPI services. @@ -43,7 +43,7 @@ allowing you to easily mock out these services in your unit tests. The framework also defines a number of "internal" services. These are not part of the framework's formal API, in that they use classes that are outside of the applib. These internal framework services should be thought of as part of the internal design of the framework, and are liable to change from release to release. The internal framework services -are documented in the xref:rgfis.adoc#[Framework Internal Services] guide. +are documented in the xref:../rgfis/rgfis.adoc#[Framework Internal Services] guide. @@ -78,13 +78,13 @@ public class Customer { For objects that are already persisted, the service is automatically injected just after the object is rehydrated by JDO/DataNucleus. -For transient objects (instantiated programmatically), the xref:rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`]'s -``instantiate()`` method (or the deprecated xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s +For transient objects (instantiated programmatically), the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FactoryService[`FactoryService`]'s +``instantiate()`` method (or the deprecated xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s ``newTransientInstance()`` method) will automatically inject the services. Alternatively the object can be instantiated simply using `new`, then services injected using -xref:rgsvc.adoc#_rgsvc_api_ServiceRegistry[`ServiceRegistry`]'s ``injectServicesInto(...)`` method (or the deprecated -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s ``injectServicesInto(...)`` method). +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_ServiceRegistry[`ServiceRegistry`]'s ``injectServicesInto(...)`` method (or the deprecated +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s ``injectServicesInto(...)`` method). @@ -95,20 +95,20 @@ xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s ``in The framework provides default implementations for many of the domain services. This is convenient, but sometimes you will want to replace the default implementation with your own service implementation. -The trick is to use the xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] +The trick is to use the xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] attribute, specifying a low number (typically `"1"`). [NOTE] ==== For a small number of domain services, all implementations are used (following the chain-of-responsibility pattern), not just the first one. The services in question are: -xref:rgsvc.adoc#_rgsvc_spi_ContentMappingService[`ContentMappingService`], -xref:rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`], and -xref:rgsvc.adoc#_rgsvc_spi_RoutingService[`RoutingService`]. +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_ContentMappingService[`ContentMappingService`], +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridSystemService[`GridSystemService`], and +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_RoutingService[`RoutingService`]. ==== For example, suppose you wanted to provide your own implementation of -xref:rgsvc.adoc#_rgsvc_api_LocaleProvider[`LocaleProvider`]. Here's how: +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_LocaleProvider[`LocaleProvider`]. Here's how: [source,java] ---- @@ -176,65 +176,65 @@ image::{_imagesdir}reference-services/commands-and-events.png[width="960px",link To explain: -* the (request-scoped) xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] captures the user's intention to +* the (request-scoped) xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] captures the user's intention to invoke an action or edit a property; this is held by the `Command` object. -* if a xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] has been configured, then this will be used to +* if a xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] has been configured, then this will be used to create the `Command` object implementation, generally so that it can then also be persisted. + + If the action or property is annotated to be invoked in the background (using -xref:rgant.adoc#_rgant-Action_command[`@Action#command...()`] or -xref:rgant.adoc#_rgant-Property_command[`@Property#command...()`]) then no further work is done. But, +xref:../rgant/rgant.adoc#_rgant-Action_command[`@Action#command...()`] or +xref:../rgant/rgant.adoc#_rgant-Property_command[`@Property#command...()`]) then no further work is done. But, if the action/property is to be executed in the foreground, then the interaction continues. -* the (request-scoped) xref:rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] domain service acts as a +* the (request-scoped) xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`] domain service acts as a factory for the ``Interaction`` object, which keeps track of the call-graph of executions (``Interaction.Execution``) of either action invocations or property edits. In the majority of cases there is likely to be just a single top-level -node of this graph, but for applications that use the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] +node of this graph, but for applications that use the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] extensively each successive call results in a new child execution. -* before and after each action invocation/property edit, a xref:rgcms.adoc#_rgcms_classes_domainevent[domain event] is +* before and after each action invocation/property edit, a xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent[domain event] is may be broadcast to all subscribers. Whether this occurs depends on whether the action/property has been annotated -(using xref:rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`] or -xref:rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`]). + +(using xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`] or +xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`]). + + (Note that susbcribers will also receive events for vetoing the action/property; this is not shown on the diagram). * As each execution progresses, and objects that are modified are "enlisted" into the (internal) -xref:rgfis.adoc#_rgfis_spi_ChangedObjectsServiceInternal[`ChangedObjectsServiceInternal`] domain service. Metrics as +xref:../rgfis/rgfis.adoc#_rgfis_spi_ChangedObjectsServiceInternal[`ChangedObjectsServiceInternal`] domain service. Metrics as to which objects are merely loaded into memory are also captured using the -xref:rgsvc.adoc#_rgsvc_api_MetricsService[`MetricsService`] (not shown on the diagram). +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MetricsService[`MetricsService`] (not shown on the diagram). * At the end of each execution, details of that execution are published through the (internal) -xref:rgfis.adoc#_rgfis_spi_PublisherServiceInternal[`PublisherServiceInternal`] domain service. This is only done for -actions/properties annotated appropriate (with xref:rgant.adoc#_rgant-Action_publishing[`@Action#publishing()`] or -xref:rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`]). + +xref:../rgfis/rgfis.adoc#_rgfis_spi_PublisherServiceInternal[`PublisherServiceInternal`] domain service. This is only done for +actions/properties annotated appropriate (with xref:../rgant/rgant.adoc#_rgant-Action_publishing[`@Action#publishing()`] or +xref:../rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`]). + + The internal service delegates in turn to any registered -xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`] (deprecated) and also to any -registered xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]s (there may be more than one). +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`] (deprecated) and also to any +registered xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]s (there may be more than one). * At the end of each transaction, details of all changed objects are published, again through the (internal) -xref:rgfis.adoc#_rgfis_spi_PublisherServiceInternal[`PublisherServiceInternal`] to any registered `PublishingService` +xref:../rgfis/rgfis.adoc#_rgfis_spi_PublisherServiceInternal[`PublisherServiceInternal`] to any registered `PublishingService` or `PublisherService` implementations. Only domain objects specified to be published with -xref:rgant.adoc#_rgant-DomainObject_publishing[`@DomainObject#publishing()`] are published. + +xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[`@DomainObject#publishing()`] are published. + + [NOTE] ==== Note that it's possible for there to be more than one transaction per top-level interaction, by virtue of the -xref:rgsvc.adoc#_rgsvc_api_TransactionService[`TransactionService`]. +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_TransactionService[`TransactionService`]. ==== * Also at the end of each transaction, details of all changed properties are passed to any registered -xref:rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`] or -xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`] (the latter deprecated) by way of the (internal) -xref:rgfis.adoc#_rgfis_spi_AuditingServiceInternal[`AuditingServiceInternal`] domain service. +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`] or +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`] (the latter deprecated) by way of the (internal) +xref:../rgfis/rgfis.adoc#_rgfis_spi_AuditingServiceInternal[`AuditingServiceInternal`] domain service. -Implementations of xref:rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] can use the `Command#getMemento()` -method to obtain a XML equivalent of that `Command`, reified using the xref:rgcms.adoc#_rgcms_schema-cmd[`cmd.xsd`] +Implementations of xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_CommandService[`CommandService`] can use the `Command#getMemento()` +method to obtain a XML equivalent of that `Command`, reified using the xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[`cmd.xsd`] schema. This can be converted back into a `CommandDto` using the `CommandDtoUtils` utility class (part of the applib). -Similarly, implementations of xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] can use the +Similarly, implementations of xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] can use the `InteractionDtoUtils` utility class to obtain a `InteractionDto` representing the interaction, either just for a single execution or for the entire call-graph. This can be converted into XML in a similar fashion. @@ -242,7 +242,7 @@ Likewise, the `PublishedObjects` class passed to the `PublisherService` at the e `PublishedObjects#getDto()` method which returns a `ChangesDto` instance. This can be converted into XML using the `ChangesDtoUtils` utility class. -One final point: multiple xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] implementations are supported +One final point: multiple xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] implementations are supported because different implementations may have different responsibilities. For example, the (non-ASF) http://github.com/isisaddons/isis-module-publishmq[Isis addons' publishmq] module is responsible for publishing messages onto an ActiveMQ event bus, for inter-system communication. However, the SPI can also be used for profiling;
