You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2021/02/02 21:20:24 UTC
[isis] branch ISIS-2516 created (now 5b229f5)
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a change to branch ISIS-2516
in repository https://gitbox.apache.org/repos/asf/isis.git.
at 5b229f5 ISIS-2516: regen docs (experimental)
This branch includes the following new commits:
new 5b229f5 ISIS-2516: regen docs (experimental)
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[isis] 01/01: ISIS-2516: regen docs (experimental)
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch ISIS-2516
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 5b229f547c4fbb36008dd18bf2ce0af83d07d6c5
Author: Andi Huber <ah...@apache.org>
AuthorDate: Tue Feb 2 22:20:02 2021 +0100
ISIS-2516: regen docs (experimental)
---
.../pages/index/applib/AbstractViewModel.adoc | 2 -
.../IsisModuleApplib.adoc} | 6 +-
.../index/applib/RecreatableDomainObject.adoc | 2 +-
.../pages/index/applib/annotation/Action.adoc | 6 +-
.../index/applib/annotation/ActionLayout.adoc | 2 +-
.../pages/index/applib/annotation/Collection.adoc | 2 +-
.../pages/index/applib/annotation/Defaulted.adoc | 2 +
.../index/applib/annotation/DomainObject.adoc | 16 +-
.../applib/annotation/DomainObjectLayout.adoc | 4 +-
.../index/applib/annotation/EqualByContent.adoc | 4 +-
.../pages/index/applib/annotation/Module.adoc | 4 +-
.../pages/index/applib/annotation/Nature.adoc | 2 +-
.../pages/index/applib/annotation/Parameter.adoc | 2 +-
.../pages/index/applib/annotation/Property.adoc | 4 +-
.../client/RepresentationTypeSimplifiedV2.adoc | 74 ++
.../ui/IconUiEvent.adoc} | 28 +-
.../applib/exceptions/TranslatableException.adoc | 4 +-
.../unrecoverable/DomainModelException.adoc} | 22 +-
.../unrecoverable/MetaModelException.adoc} | 10 +-
.../unrecoverable/NoAuthenticatorException.adoc} | 22 +-
.../unrecoverable/ObjectNotFoundException.adoc} | 16 +-
.../unrecoverable/ObjectPersistenceException.adoc} | 16 +-
.../unrecoverable/ReflectiveActionException.adoc} | 16 +-
.../unrecoverable/UnexpectedCallException.adoc} | 8 +-
.../unrecoverable/UnknownTypeException.adoc} | 8 +-
.../tree/LazyTreeNode.adoc} | 22 +-
.../jaxb/DataTypeFactory.adoc} | 6 +-
.../JavaSqlXMLGregorianCalendarMarshalling.adoc} | 16 +-
.../JavaTimeXMLGregorianCalendarMarshalling.adoc | 34 +
.../jaxb/JodaTimeJaxbAdapters.adoc} | 6 +-
.../JodaTimeXMLGregorianCalendarMarshalling.adoc} | 22 +-
.../jaxb/PrimitiveJaxbAdapters.adoc} | 6 +-
.../applib/layout/component/ActionLayoutData.adoc | 4 +-
.../layout/component/ActionLayoutDataOwner.adoc} | 8 +-
...onLayoutData.adoc => CollectionLayoutData.adoc} | 57 +-
.../component/CollectionLayoutDataOwner.adoc} | 6 +-
.../layout/component/CssClassFaPosition.adoc} | 10 +-
...LayoutData.adoc => DomainObjectLayoutData.adoc} | 57 +-
.../component/DomainObjectLayoutDataOwner.adoc} | 8 +-
.../index/applib/layout/component/FieldSet.adoc | 87 ++
.../layout/component/FieldSetOwner.adoc} | 6 +-
.../layout/component/HasNamed.adoc} | 12 +-
.../component/MemberRegion.adoc} | 24 +-
.../layout/component/MemberRegionOwner.adoc} | 6 +-
.../layout/component/Owned.adoc} | 6 +-
.../layout/component/Owner.adoc} | 6 +-
...tionLayoutData.adoc => PropertyLayoutData.adoc} | 64 +-
...ayoutData.adoc => ServiceActionLayoutData.adoc} | 42 +-
.../component/ServiceActionLayoutDataOwner.adoc} | 8 +-
.../grid/Grid.adoc} | 39 +-
.../grid/GridAbstract.adoc} | 39 +-
.../layout/grid/bootstrap3/BS3ClearFix.adoc} | 6 +-
.../layout/grid/bootstrap3/BS3ClearFixHidden.adoc} | 10 +-
.../grid/bootstrap3/BS3ClearFixVisible.adoc} | 20 +-
.../applib/layout/grid/bootstrap3/BS3Col.adoc | 98 ++
.../grid/bootstrap3/BS3Element.adoc} | 12 +-
.../grid/bootstrap3/BS3ElementAbstract.adoc} | 19 +-
.../grid/bootstrap3/BS3Grid.adoc} | 37 +-
.../applib/layout/grid/bootstrap3/BS3Row.adoc | 52 +
.../layout/grid/bootstrap3/BS3RowContent.adoc | 37 +
.../grid/bootstrap3/BS3RowContentOwner.adoc} | 6 +-
.../layout/grid/bootstrap3/BS3RowOwner.adoc} | 6 +-
.../grid/bootstrap3/BS3Tab.adoc} | 35 +-
.../applib/layout/grid/bootstrap3/BS3TabGroup.adoc | 59 +
.../layout/grid/bootstrap3/BS3TabGroupOwner.adoc} | 6 +-
.../layout/grid/bootstrap3/BS3TabOwner.adoc} | 6 +-
.../layout/grid/bootstrap3/Size.adoc} | 16 +-
.../grid/bootstrap3/SizeSpan.adoc} | 26 +-
.../layout/grid/bootstrap3/WithinGrid.adoc} | 6 +-
.../layout/links/Link.adoc} | 18 +-
.../layout/menubars/HasNamed.adoc} | 6 +-
.../layout/menubars/Menu.adoc} | 6 +-
.../layout/menubars/MenuBar.adoc} | 6 +-
.../menubars/MenuBars.adoc} | 22 +-
.../menubars/MenuBarsAbstract.adoc} | 16 +-
.../layout/menubars/MenuSection.adoc} | 6 +-
.../menubars/bootstrap3/BS3Menu.adoc} | 35 +-
.../menubars/bootstrap3/BS3MenuBar.adoc} | 22 +-
.../menubars/bootstrap3/BS3MenuBars.adoc} | 37 +-
.../menubars/bootstrap3/BS3MenuSection.adoc} | 22 +-
.../mixins/MixinConstants.adoc} | 10 +-
.../mixins/dto/Dto.adoc} | 6 +-
.../mixins/dto/Dto_downloadXml.adoc} | 11 +-
.../dto/Dto_downloadXsd.adoc} | 22 +-
.../layout/Object_downloadLayoutXml.adoc} | 19 +-
.../mixins/layout/Object_openRestApi.adoc} | 12 +-
.../mixins/layout/Object_rebuildMetamodel.adoc} | 9 +-
.../metamodel/Object_downloadMetamodelXml.adoc} | 23 +-
.../mixins/metamodel/Object_objectIdentifier.adoc} | 6 +-
.../mixins/metamodel/Object_objectType.adoc} | 6 +-
.../services/bookmark/BookmarkHolder_lookup.adoc} | 6 +-
.../services/bookmark/BookmarkHolder_object.adoc} | 6 +-
.../CommandDtoProcessorForActionAbstract.adoc} | 8 +-
.../CommandDtoProcessorForPropertyAbstract.adoc} | 8 +-
.../services/confview/ConfigurationMenu.adoc} | 8 +-
.../index/applib/services/error/SimpleTicket.adoc | 47 +
.../exceprecog/ExceptionRecognizerAbstract.adoc | 24 +
.../applib/services/grid/GridLoaderService.adoc | 8 +-
.../index/applib/services/grid/GridService.adoc | 20 +-
.../applib/services/grid/GridSystemService.adoc | 2 +-
.../applib/services/i18n/TranslatableString.adoc | 2 +-
.../services/menu/MenuBarsLoaderService.adoc | 4 +-
.../applib/services/menu/MenuBarsService.adoc | 2 +-
.../applib/services/repository/EntityState.adoc | 2 -
...TableColumnOrderForCollectionTypeAbstract.adoc} | 22 +-
...lEncodingServiceUsingBaseEncodingAbstract.adoc} | 8 +-
.../index/applib/services/user/UserService.adoc | 2 +-
.../events/EmailEventAbstract.adoc} | 22 +-
.../applib/services/wrapper/WrappingObject.adoc | 2 +-
.../wrapper/control/ExceptionHandlerAbstract.adoc} | 6 +-
.../wrapper/events/AccessEvent.adoc} | 12 +-
.../wrapper/events/ActionInvocationEvent.adoc | 2 +-
.../wrapper/events/ActionVisibilityEvent.adoc | 2 +-
.../services/wrapper/events/InteractionEvent.adoc | 2 +-
.../services/wrapper/events/VisibilityEvent.adoc | 2 +-
.../services/xactn/TransactionalProcessor.adoc | 59 +
.../services/xmlsnapshot/XmlSnapshotService.adoc | 2 +-
.../XmlSnapshotService~Snapshot~Builder.adoc | 2 +-
.../types/DescriptionType.adoc} | 6 +-
.../types/MemberIdentifierType.adoc} | 8 +-
.../types/TargetActionType.adoc} | 8 +-
.../types/TargetClassType.adoc} | 8 +-
.../pages/index/applib/util/ObjectContracts.adoc | 64 ++
.../pages/index/applib/util/ReasonBuffer.adoc | 40 +
.../pages/index/applib/util/ReasonBuffer2.adoc | 69 ++
.../util/Reasons.adoc} | 8 +-
.../pages/index/applib/util/TitleBuffer.adoc | 187 ++++
.../TitleBufferException.adoc} | 20 +-
.../applib/util/schema/InteractionDtoUtils.adoc | 72 ++
.../schema/MemberExecutionDtoUtils.adoc} | 22 +-
.../commons/resource/ResourceCoordinates.adoc | 2 +
.../DataSourceIntrospectionService.adoc} | 16 +-
.../commandlog/impl/CommandSubscriberForJdo.adoc} | 9 +-
.../impl/IsisModuleExtCommandLogImpl.adoc} | 12 +-
.../impl/mixins/HasUniqueId_command.adoc} | 25 +-
.../mixins/HasUsername_recentCommandsByUser.adoc} | 19 +-
.../commandlog/impl/ui/CommandServiceMenu.adoc} | 28 +-
.../IsisModuleExtCommandReplayPrimary.adoc} | 6 +-
.../primary/config/PrimaryConfig.adoc} | 11 +-
.../primary/mixins/Object_openOnSecondary.adoc} | 16 +-
.../primary/restapi/CommandRetrievalService.adoc} | 20 +-
.../primary/ui/CommandReplayOnPrimaryService.adoc | 55 +
.../IsisModuleExtCommandReplaySecondary.adoc} | 24 +-
.../commandreplay/secondary/SecondaryStatus.adoc} | 16 +-
.../secondary/analyser/CommandReplayAnalyser.adoc} | 8 +-
.../analyser/CommandReplayAnalyserException.adoc} | 8 +-
.../analyser/CommandReplayAnalyserResult.adoc} | 8 +-
.../analysis/CommandReplayAnalysisService.adoc} | 18 +-
.../secondary/clock/TickingClockService.adoc | 41 +
.../secondary/config/SecondaryConfig.adoc} | 31 +-
.../executor/CommandExecutorServiceWithTime.adoc | 28 +
.../secondary/fetch/CommandFetcher.adoc} | 15 +-
.../secondary/job/ReplicateAndReplayJob.adoc} | 11 +-
.../secondary/job/SecondaryStatusData.adoc} | 22 +-
.../jobcallables/ReplicateAndRunCommands.adoc} | 30 +-
.../secondary/mixins/CommandJdo_exclude.adoc} | 15 +-
.../secondary/mixins/CommandJdo_replayQueue.adoc} | 22 +-
.../secondary/mixins/Object_openOnPrimary.adoc} | 16 +-
.../spi/ReplayCommandExecutionController.adoc} | 21 +-
.../ui/CommandReplayOnSecondaryService.adoc} | 20 +-
.../cors/impl/IsisModuleExtCorsImpl.adoc} | 6 +-
.../fullcalendar/applib/CalendarEventable.adoc} | 21 +-
.../fullcalendar/applib/Calendarable.adoc | 29 +
.../applib/IsisModuleExtFullCalendarApplib.adoc} | 6 +-
.../spi/CalendarableDereferencingService.adoc | 16 +
.../fullcalendar/applib/value/CalendarEvent.adoc} | 48 +-
.../ui/component/IsisModuleExtFullCalendarUi.adoc} | 6 +-
.../hsqldbmgr/dom/IsisModuleExtHsqldbMgr.adoc} | 6 +-
.../hsqldbmgr/dom/services/HsqlDbManagerMenu.adoc} | 10 +-
.../applib/IsisModuleExtJaxRsClientApplib.adoc} | 6 +-
.../jaxrsclient/applib/client/JaxRsClient.adoc} | 14 +-
.../jaxrsclient/applib/client/JaxRsResponse.adoc} | 8 +-
.../applib/IsisModuleIncModelApplib.adoc} | 6 +-
.../modelannotation/applib/annotation/Model.adoc} | 23 +-
.../metamodel/IsisModuleExtModelAnnotation.adoc} | 6 +-
.../SupportingMethodValidatorRefinerFactory.adoc} | 16 +-
.../services/IncubatorMetaModelPlugin.adoc} | 6 +-
.../quartz/IsisModuleExtQuartzImpl.adoc} | 6 +-
.../quartz/context/JobExecutionData.adoc} | 18 +-
.../spring/AutowiringSpringBeanJobFactory.adoc} | 6 +-
.../restclient/ActionParameterListBuilder.adoc | 28 +
.../restclient/IsisModuleExtRestClient.adoc} | 6 +-
.../extensions/restclient/ResponseDigest.adoc | 53 +
.../index/extensions/restclient/RestfulClient.adoc | 95 ++
.../restclient/RestfulClientConfig.adoc} | 6 +-
.../restclient/RestfulClientException.adoc} | 18 +-
.../restclient/auth/BasicAuthFilter.adoc} | 18 +-
.../restclient/log/ClientConversationFilter.adoc} | 22 +-
.../restclient/log/ClientConversationLogger.adoc} | 14 +-
.../secman/api/IsisModuleExtSecmanApi.adoc} | 6 +-
.../extensions/secman/api/SecmanConfiguration.adoc | 67 ++
.../secman/api/SecurityRealm.adoc} | 6 +-
.../secman/api/SecurityRealmCharacteristic.adoc} | 6 +-
.../secman/api/SecurityRealmService.adoc} | 6 +-
.../api/encryption/PasswordEncryptionService.adoc} | 8 +-
.../encryption/PasswordEncryptionServiceNone.adoc} | 8 +-
.../secman/api/events/UserCreatedEvent.adoc} | 35 +-
.../api/permission/ApplicationPermission.adoc | 49 +
.../api/permission/ApplicationPermissionMode.adoc | 37 +
.../ApplicationPermissionRepository.adoc | 30 +
.../api/permission/ApplicationPermissionRule.adoc | 33 +
.../api/permission/ApplicationPermissionValue.adoc | 34 +
.../permission/ApplicationPermissionValueSet.adoc} | 24 +-
.../permission/PermissionsEvaluationService.adoc | 18 +
.../PermissionsEvaluationServiceAbstract.adoc} | 6 +-
...ermissionsEvaluationServiceAllowBeatsVeto.adoc} | 8 +-
...ermissionsEvaluationServiceVetoBeatsAllow.adoc} | 8 +-
.../secman/api/role/ApplicationRole.adoc} | 29 +-
.../api/role/ApplicationRoleRepository.adoc} | 40 +-
.../secman/api/tenancy/ApplicationTenancy.adoc} | 22 +-
.../api/tenancy/ApplicationTenancyEvaluator.adoc | 26 +
.../api/tenancy/ApplicationTenancyRepository.adoc} | 36 +-
.../extensions/secman/api/tenancy/HasAtPath.adoc | 20 +
.../secman/api/user/AccountType.adoc} | 22 +-
.../secman/api/user/ApplicationUser.adoc | 84 ++
.../secman/api/user/ApplicationUserRepository.adoc | 51 +
.../secman/api/user/ApplicationUserStatus.adoc} | 22 +-
.../IsisModuleExtSecmanEncryptionJbcrypt.adoc} | 6 +-
.../PasswordEncryptionServiceUsingJBcrypt.adoc} | 8 +-
.../jdo/IsisModuleExtSecmanPersistenceJdo.adoc} | 6 +-
.../jdo/seed/SeedSecurityModuleService.adoc} | 8 +-
.../jdo/seed/SeedUsersAndRolesFixtureScript.adoc} | 10 +-
.../secman/jdo/seed/scripts/GlobalTenancy.adoc} | 8 +-
...tFixturesFixtureResultsRoleAndPermissions.adoc} | 8 +-
.../IsisExtSecmanAdminRoleAndPermissions.adoc} | 6 +-
.../jdo/seed/scripts/IsisExtSecmanAdminUser.adoc} | 6 +-
.../IsisExtSecmanFixtureRoleAndPermissions.adoc} | 16 +-
...sisExtSecmanRegularUserRoleAndPermissions.adoc} | 12 +-
.../jpa/IsisModuleExtSecmanPersistenceJpa.adoc} | 6 +-
.../jpa/seed/SeedSecurityModuleService.adoc} | 8 +-
.../jpa/seed/SeedUsersAndRolesFixtureScript.adoc} | 10 +-
.../secman/jpa/seed/scripts/GlobalTenancy.adoc} | 8 +-
...tFixturesFixtureResultsRoleAndPermissions.adoc} | 8 +-
.../IsisExtSecmanAdminRoleAndPermissions.adoc} | 6 +-
.../jpa/seed/scripts/IsisExtSecmanAdminUser.adoc} | 6 +-
.../IsisExtSecmanFixtureRoleAndPermissions.adoc} | 16 +-
...sisExtSecmanRegularUserRoleAndPermissions.adoc} | 12 +-
...yModuleAppUserRegistrationServiceAbstract.adoc} | 22 +-
.../secman/model/IsisModuleExtSecmanModel.adoc} | 6 +-
.../secman/model/app/user/MeService.adoc} | 8 +-
.../shiro/IsisModuleExtSecmanRealmShiro.adoc} | 6 +-
.../shiro/IsisModuleExtSecmanShiroRealm.adoc} | 21 +-
.../services/SecurityRealmServiceUsingShiro.adoc} | 6 +-
.../secman/shiro/util/ShiroUtils.adoc} | 10 +-
.../realm/impl/IsisLdapContextFactory.adoc} | 24 +-
.../shirorealmldap/realm/impl/IsisLdapRealm.adoc | 147 +++
.../impl/IsisModuleExtShiroRealmLdapImpl.adoc} | 6 +-
.../ui/IsisModuleExtExcelDownloadUi.adoc} | 6 +-
.../ui/components/CollectionContentsAsExcel.adoc} | 22 +-
.../CollectionContentsAsExcelFactory.adoc} | 22 +-
.../pdfjs/applib/annotations/PdfJsViewer.adoc} | 22 +-
.../wicket/pdfjs/applib/config/PdfJsConfig.adoc} | 34 +-
.../viewer/wicket/pdfjs/applib/config/Scale.adoc} | 40 +-
.../pdfjs/applib/spi/PdfJsViewerAdvisor.adoc} | 22 +-
.../wicket/pdfjs/ui/IsisModuleExtPdfjsUi.adoc} | 6 +-
.../applib/IsisModulePersistenceJdoApplib.adoc} | 6 +-
.../jdo/applib/integration/JdoSupportService.adoc | 2 +-
.../jdo/datanucleus/IsisModuleJdoDatanucleus.adoc | 24 +
.../changetracking/JdoLifecycleListener.adoc | 56 +
.../mixins/Persistable_datanucleusIdLong.adoc} | 8 +-
.../Persistable_datanucleusVersionLong.adoc} | 8 +-
.../Persistable_datanucleusVersionTimestamp.adoc} | 8 +-
.../mixins/Persistable_downloadJdoMetadata.adoc} | 11 +-
.../applib/IsisBookmarkConverter.adoc} | 8 +-
.../applib/IsisLocalResourcePathConverter.adoc} | 8 +-
.../applib/IsisMarkupConverter.adoc} | 8 +-
.../applib/IsisPasswordConverter.adoc} | 8 +-
.../JavaAwtBufferedImageByteArrayConverter.adoc} | 8 +-
.../schema/v2/IsisChangesDtoConverter.adoc} | 8 +-
.../schema/v2/IsisCommandDtoConverter.adoc} | 8 +-
.../schema/v2/IsisInteractionDtoConverter.adoc} | 8 +-
.../schema/v2/IsisOidDtoConverter.adoc} | 8 +-
.../time/IsoOffsetTimeConverter.adoc} | 8 +-
.../time/IsoZonedDateTimeConverter.adoc} | 8 +-
.../applib/ByteArrayBlobRdbmsMapping.adoc} | 8 +-
.../valuetypes/applib/IsisBlobMapping.adoc} | 22 +-
.../valuetypes/applib/IsisClobMapping.adoc} | 22 +-
.../JpaEntityInjectionPointResolver.adoc} | 10 +-
.../jpa/eclipselink/IsisModuleJpaEclipselink.adoc} | 24 +-
.../IsisModuleSchema.adoc} | 6 +-
.../bypass/IsisModuleSecurityBypass.adoc} | 8 +-
.../authentication/AuthenticatorBypass.adoc} | 16 +-
.../bypass/authorization/AuthorizorBypass.adoc} | 22 +-
.../keycloak/IsisModuleSecurityKeycloak.adoc} | 8 +-
.../authentication/AuthenticatorKeycloak.adoc} | 22 +-
.../authorization/AuthorizorKeycloak.adoc} | 18 +-
.../keycloak/webmodule/KeycloakFilter.adoc} | 16 +-
.../keycloak/webmodule/WebModuleKeycloak.adoc} | 10 +-
.../shiro/IsisModuleSecurityShiro.adoc} | 8 +-
.../shiro/authentication/AuthenticatorShiro.adoc} | 24 +-
.../shiro/authorization/AuthorizorShiro.adoc | 33 +
.../shiro/authorization/IsisPermission.adoc} | 22 +-
.../authorization/IsisPermissionResolver.adoc} | 8 +-
.../shiro/webmodule/WebModuleShiro.adoc} | 24 +-
.../index/subdomains/base/applib/Chained.adoc | 29 +
.../base/applib/Dflt.adoc} | 6 +-
.../applib/IsisModuleSubdomainsBaseApplib.adoc} | 6 +-
.../base/applib/PowerType.adoc} | 8 +-
.../base/applib/Titled.adoc} | 6 +-
.../base/applib/TitledEnum.adoc} | 8 +-
.../base/applib/services/BaseServicesModule.adoc} | 6 +-
.../applib/services/calendar/CalendarService.adoc} | 32 +-
.../base/applib/types/DescriptionType.adoc} | 6 +-
.../base/applib/types/FqcnType.adoc} | 6 +-
.../base/applib/types/MoneyType.adoc} | 6 +-
.../base/applib/types/NameType.adoc} | 6 +-
.../base/applib/types/NotesType.adoc} | 6 +-
.../base/applib/types/ObjectIdentifierType.adoc} | 6 +-
.../base/applib/types/PercentageType.adoc} | 6 +-
.../base/applib/types/ProperNameType.adoc} | 6 +-
.../base/applib/types/ReferenceType.adoc} | 6 +-
.../base/applib/types/TitleType.adoc} | 6 +-
.../base/applib/types/UrlTemplateType.adoc} | 6 +-
.../base/applib/types/UserNameType.adoc} | 6 +-
.../base/applib/types/XxxType.adoc} | 6 +-
.../base/applib/utils/ClassUtils.adoc} | 6 +-
.../base/applib/utils/JodaPeriodUtils.adoc} | 18 +-
.../base/applib/utils/MathUtils.adoc} | 22 +-
.../base/applib/utils/MessageUtils.adoc} | 6 +-
.../base/applib/utils/StringUtils.adoc} | 20 +-
.../base/applib/utils/TitleBuilder.adoc} | 38 +-
.../base/applib/valuetypes/AbstractInterval.adoc | 79 ++
.../base/applib/valuetypes/LocalDateInterval.adoc | 45 +
.../subdomains/base/applib/valuetypes/VT.adoc | 74 ++
.../base/applib/with/WithCodeComparable.adoc} | 6 +-
.../base/applib/with/WithCodeGetter.adoc} | 8 +-
.../base/applib/with/WithCodeUnique.adoc} | 6 +-
.../applib/with/WithDescriptionComparable.adoc} | 6 +-
.../base/applib/with/WithDescriptionGetter.adoc} | 8 +-
.../base/applib/with/WithDescriptionUnique.adoc} | 6 +-
.../base/applib/with/WithInterval.adoc} | 32 +-
.../base/applib/with/WithIntervalContiguous.adoc | 42 +
.../base/applib/with/WithIntervalMutable.adoc} | 18 +-
.../base/applib/with/WithNameComparable.adoc} | 6 +-
.../base/applib/with/WithNameGetter.adoc} | 8 +-
.../base/applib/with/WithNameUnique.adoc} | 6 +-
.../base/applib/with/WithReferenceComparable.adoc} | 6 +-
.../base/applib/with/WithReferenceGetter.adoc} | 8 +-
.../base/applib/with/WithReferenceUnique.adoc} | 6 +-
.../base/applib/with/WithSequence.adoc} | 8 +-
.../base/applib/with/WithStartDate.adoc} | 8 +-
.../base/applib/with/WithTitleComparable.adoc} | 6 +-
.../base/applib/with/WithTitleGetter.adoc} | 8 +-
.../base/applib/with/WithTitleUnique.adoc} | 6 +-
.../applib/IsisModuleSubdomainsExcelApplib.adoc} | 6 +-
.../excel/applib/dom/AggregationType.adoc} | 8 +-
.../excel/applib/dom/ExcelMetaDataEnabled.adoc} | 8 +-
.../subdomains/excel/applib/dom/ExcelService.adoc | 63 ++
.../excel/applib/dom/HyperLink.adoc} | 6 +-
.../excel/applib/dom/PivotColumn.adoc} | 6 +-
.../excel/applib/dom/PivotDecoration.adoc} | 6 +-
.../excel/applib/dom/PivotRow.adoc} | 6 +-
.../excel/applib/dom/PivotValue.adoc} | 8 +-
.../excel/applib/dom/RowHandler.adoc} | 6 +-
.../excel/applib/dom/WorksheetContent.adoc} | 10 +-
.../excel/applib/dom/WorksheetSpec.adoc} | 28 +-
.../excel/applib/dom/util/AnnotationList.adoc} | 10 +-
.../excel/applib/dom/util/AnnotationTriplet.adoc} | 18 +-
.../applib/dom/util/ExcelFileBlobConverter.adoc} | 8 +-
.../excel/applib/dom/util/ExcelServiceImpl.adoc | 109 ++
.../excel/applib/dom/util/Mode.adoc} | 17 +-
.../excel/applib/dom/util/PivotUtils.adoc} | 22 +-
.../excel/applib/dom/util/SheetPivoter.adoc | 40 +
.../excel/testing/ExcelFixture.adoc} | 23 +-
.../excel/testing/ExcelFixture2.adoc} | 29 +-
.../excel/testing/ExcelFixtureRowHandler.adoc} | 6 +-
.../testing/ExcelFixtureWorkbookHandler.adoc} | 6 +-
.../excel/testing/FixtureAwareRowHandler.adoc} | 8 +-
.../testing/IsisModuleSubdomainsExcelTesting.adoc} | 6 +-
.../applib/IsisModuleSubdomainsSpringApplib.adoc} | 6 +-
.../spring/applib/service/BeanDescriptor.adoc} | 8 +-
.../spring/applib/service/ContextBeans.adoc} | 6 +-
.../spring/applib/service/SpringBeansService.adoc} | 10 +-
.../IsisModuleSubdomainsXDocReportApplib.adoc} | 6 +-
.../xdocreport/applib/service/OutputType.adoc} | 8 +-
.../applib/service/XDocReportModel.adoc} | 6 +-
.../applib/service/XDocReportService.adoc} | 10 +-
.../applib/IsisModuleTestingFakeDataApplib.adoc} | 6 +-
.../services/AbstractRandomValueGenerator.adoc} | 8 +-
.../fakedata/applib/services/Addresses.adoc} | 36 +-
.../fakedata/applib/services/BigDecimals.adoc} | 10 +-
.../fakedata/applib/services/BigIntegers.adoc} | 8 +-
.../fakedata/applib/services/Books.adoc} | 12 +-
.../fakedata/applib/services/Booleans.adoc} | 23 +-
.../fakedata/applib/services/Bytes.adoc} | 12 +-
.../fakedata/applib/services/Chars.adoc} | 14 +-
.../fakedata/applib/services/Collections.adoc | 91 ++
.../fakedata/applib/services/Comms.adoc} | 22 +-
.../fakedata/applib/services/CreditCards.adoc} | 18 +-
.../fakedata/applib/services/Doubles.adoc} | 10 +-
.../fakedata/applib/services/Enums.adoc} | 8 +-
.../fakedata/applib/services/FakeDataService.adoc | 106 ++
.../fakedata/applib/services/Floats.adoc} | 8 +-
.../fakedata/applib/services/Integers.adoc} | 12 +-
.../fakedata/applib/services/IsisBlobs.adoc} | 12 +-
.../fakedata/applib/services/IsisClobs.adoc} | 12 +-
.../fakedata/applib/services/IsisPasswords.adoc} | 8 +-
.../fakedata/applib/services/J8DateTimes.adoc} | 20 +-
.../fakedata/applib/services/J8LocalDates.adoc} | 20 +-
.../fakedata/applib/services/J8Periods.adoc} | 22 +-
.../fakedata/applib/services/JavaSqlDates.adoc} | 8 +-
.../applib/services/JavaSqlTimestamps.adoc} | 8 +-
.../fakedata/applib/services/JavaUtilDates.adoc} | 8 +-
.../fakedata/applib/services/JodaDateTimes.adoc} | 20 +-
.../fakedata/applib/services/JodaLocalDates.adoc} | 20 +-
.../fakedata/applib/services/JodaPeriods.adoc} | 22 +-
.../fakedata/applib/services/Longs.adoc} | 8 +-
.../fakedata/applib/services/Lorem.adoc} | 24 +-
.../fakedata/applib/services/Names.adoc} | 18 +-
.../fakedata/applib/services/Shorts.adoc} | 12 +-
.../fakedata/applib/services/Strings.adoc} | 12 +-
.../fakedata/applib/services/Urls.adoc} | 8 +-
.../fakedata/applib/services/Uuids.adoc} | 8 +-
.../ui/IsisModuleTestingH2ConsoleUi.adoc} | 6 +-
.../h2console/ui/services/H2ManagerMenu.adoc} | 10 +-
.../ui/webmodule/WebModuleH2Console.adoc} | 22 +-
.../applib/ExceptionRecognizerTranslate.adoc} | 6 +-
.../applib/IsisIntegrationTestAbstract.adoc} | 8 +-
.../applib/IsisInteractionHandler.adoc} | 8 +-
.../applib/ThrowableMatchers.adoc} | 12 +-
.../applib/swagger/SwaggerExporter.adoc} | 22 +-
.../applib/validate/DomainModelValidator.adoc | 42 +
.../IsisModuleTestingSpecSupportApplib.adoc} | 6 +-
.../integration/ObjectFactoryForIntegration.adoc} | 12 +-
.../specsupport/applib/specs/V.adoc} | 8 +-
.../IsisModuleTestingUnitTestSupportApplib.adoc} | 6 +-
.../applib/bean/AbstractBeanPropertiesTest.adoc} | 7 +-
.../bean/FixtureDatumFactoriesForAnyPojo.adoc} | 14 +-
.../bean/FixtureDatumFactoriesForApplib.adoc} | 8 +-
.../applib/bean/FixtureDatumFactoriesForJoda.adoc} | 16 +-
.../applib/bean/FixtureDatumFactoriesForTime.adoc} | 22 +-
.../unittestsupport/applib/bean/PojoTester.adoc} | 22 +-
.../core/AbstractApplyToAllContractTest.adoc} | 22 +-
...rectionalRelationshipContractTestAbstract.adoc} | 6 +-
.../applib/core/bidir/Instantiator.adoc} | 8 +-
.../applib/core/bidir/InstantiatorSimple.adoc} | 10 +-
.../applib/core/bidir/Instantiators.adoc} | 6 +-
.../ComparableContractTest_compareTo.adoc} | 8 +-
.../core/comparable/ComparableContractTester.adoc} | 18 +-
.../unittestsupport/applib/core/files/Files.adoc | 32 +
.../applib/core/jaxb/JaxbMatchers.adoc} | 12 +-
.../applib/core/jmocking/Imposterisers.adoc} | 8 +-
.../core/jmocking/InjectIntoJMockAction.adoc} | 14 +-
.../applib/core/jmocking/IsisActions.adoc} | 12 +-
.../applib/core/jmocking/JMockActions.adoc} | 8 +-
.../applib/core/jmocking/JUnitRuleMockery2.adoc | 75 ++
.../applib/core/jmocking/PostponedAction.adoc} | 8 +-
.../core/soap/SoapEndpointPublishingRule.adoc} | 30 +-
.../applib/core/soap/SoapEndpointSpec.adoc} | 33 +-
.../SortedSetsContractTestAbstract.adoc} | 6 +-
.../applib/core/streams/NullPrintStream.adoc} | 24 +-
.../applib/core/utils/CollectUtils.adoc} | 6 +-
.../applib/core/utils/IndentPrinter.adoc | 86 ++
.../applib/core/utils/ReflectUtils.adoc} | 22 +-
.../applib/core/utils/StringUtils.adoc} | 8 +-
.../core/value/ValueTypeContractTestAbstract.adoc} | 22 +-
.../applib/dom/assertions/Asserting.adoc} | 6 +-
.../applib/dom/matchers/IsisMatchers.adoc | 46 +
.../dom/privatecons/PrivateConstructorTester.adoc} | 8 +-
.../applib/dom/reflect/ReflectUtils.adoc} | 8 +-
.../applib/dom/repo/FinderInteraction.adoc} | 22 +-
.../applib/IsisModuleValAsciidocApplib.adoc} | 6 +-
.../asciidoc/applib/jaxb/AsciiDocJaxbAdapter.adoc} | 8 +-
.../asciidoc/applib/value/AsciiDoc.adoc} | 26 +-
.../metamodel/IsisModuleValAsciidocMetaModel.adoc} | 6 +-
.../IsisModuleValAsciidocPersistenceJdoDn5.adoc} | 6 +-
.../jdo/dn5/converters/IsisAsciiDocConverter.adoc} | 8 +-
.../ui/wkt/IsisModuleValAsciidocUiWkt.adoc} | 6 +-
.../applib/IsisModuleValMarkdownApplib.adoc} | 6 +-
.../markdown/applib/jaxb/MarkdownJaxbAdapter.adoc} | 8 +-
.../markdown/applib/value/Converter.adoc} | 44 +-
.../metamodel/IsisModuleValMarkdownMetaModel.adoc} | 6 +-
.../IsisModuleValMarkdownPersistenceJdoDn5.adoc} | 6 +-
.../jdo/dn5/converters/IsisMarkdownConverter.adoc} | 8 +-
.../ui/wkt/IsisModuleValMarkdownUiWkt.adoc} | 6 +-
.../sse/applib/IsisModuleValSseApplib.adoc} | 6 +-
.../sse/applib/annotations/ServerSentEvents.adoc} | 6 +-
.../sse/applib/annotations/SseSource.adoc} | 12 +-
.../sse/applib/service/SseChannel.adoc} | 24 +-
.../sse/applib/service/SseService.adoc} | 10 +-
.../sse/ui/wkt/IsisModuleValSseUiWkt.adoc} | 6 +-
.../sse/ui/wkt/services/SseServiceDefault.adoc} | 10 +-
.../wkt/webmodule/WebModuleServerSentEvents.adoc} | 16 +-
.../IsisModuleViewerRestfulObjectsApplib.adoc} | 6 +-
.../restfulobjects/applib/JsonRepresentation.adoc | 481 ++++++++
.../restfulobjects/applib/LinkRepresentation.adoc | 52 +
.../index/viewer/restfulobjects/applib/Rel.adoc | 104 ++
.../restfulobjects/applib/RelDefinition.adoc} | 29 +-
.../restfulobjects/applib/RepresentationType.adoc | 118 ++
.../restfulobjects/applib/RestfulHttpMethod.adoc} | 12 +-
.../restfulobjects/applib/RestfulMediaType.adoc | 76 ++
.../restfulobjects/applib/RestfulRequest.adoc} | 14 +-
.../restfulobjects/applib/RestfulResponse.adoc} | 31 +-
.../applib/boot/BootstrapResource.adoc} | 6 +-
.../AbstractObjectMemberRepresentation.adoc} | 20 +-
.../domainobjects/ActionResultRepresentation.adoc} | 10 +-
.../DomainObjectMemberRepresentation.adoc | 42 +
.../domainobjects/DomainObjectRepresentation.adoc | 64 ++
.../applib/domainobjects/DomainObjectResource.adoc | 56 +
.../domainobjects/DomainRepresentation.adoc} | 22 +-
.../domainobjects/DomainServiceResource.adoc | 50 +
.../applib/domainobjects/ListRepresentation.adoc} | 10 +-
.../domainobjects/ObjectActionRepresentation.adoc} | 8 +-
.../ObjectCollectionRepresentation.adoc} | 8 +-
.../ObjectPropertyRepresentation.adoc} | 6 +-
.../domainobjects/ScalarValueRepresentation.adoc} | 8 +-
.../AbstractTypeMemberRepresentation.adoc} | 6 +-
.../ActionDescriptionRepresentation.adoc} | 8 +-
.../ActionParameterDescriptionRepresentation.adoc} | 6 +-
.../CollectionDescriptionRepresentation.adoc} | 6 +-
.../domaintypes/DomainTypeRepresentation.adoc} | 6 +-
.../applib/domaintypes/DomainTypeResource.adoc} | 24 +-
.../PropertyDescriptionRepresentation.adoc} | 6 +-
.../TypeActionResultRepresentation.adoc} | 6 +-
.../domaintypes/TypeListRepresentation.adoc} | 6 +-
.../applib/dtos/ScalarValueDtoV2.adoc} | 18 +-
.../applib/errors/ErrorRepresentation.adoc} | 6 +-
.../applib/health/HealthRepresentation.adoc} | 8 +-
.../applib/health/HealthResource.adoc} | 12 +-
.../applib/homepage/HomePageRepresentation.adoc} | 12 +-
.../applib/homepage/HomePageResource.adoc} | 23 +-
.../applib/menubars/MenuBarsResource.adoc} | 31 +-
.../applib/user/UserRepresentation.adoc} | 22 +-
.../restfulobjects/applib/user/UserResource.adoc} | 18 +-
.../restfulobjects/applib/util/JsonMapper.adoc} | 27 +-
.../restfulobjects/applib/util/JsonNodeUtils.adoc} | 33 +-
.../restfulobjects/applib/util/MediaTypes.adoc} | 12 +-
.../restfulobjects/applib/util/Parser.adoc} | 36 +-
.../restfulobjects/applib/util/PathNode.adoc} | 30 +-
.../applib/util/UrlEncodingUtils.adoc} | 22 +-
.../applib/version/VersionRepresentation.adoc} | 10 +-
.../applib/version/VersionResource.adoc} | 12 +-
...sModuleViewerRestfulObjectsJaxrsResteasy4.adoc} | 6 +-
.../conneg/RestfulObjectsJaxbWriterForXml.adoc} | 6 +-
.../webmodule/WebModuleJaxrsResteasy4.adoc} | 22 +-
.../IsisModuleRestfulObjectsRendering.adoc} | 6 +-
.../rendering/service/RepresentationService.adoc} | 24 +-
.../RepresentationServiceContentNegotiator.adoc | 32 +
.../acceptheader/AcceptHeaderServiceForRest.adoc} | 6 +-
.../service/conneg/ContentNegotiationService.adoc} | 22 +-
.../conneg/ContentNegotiationServiceAbstract.adoc} | 22 +-
...entNegotiationServiceForRestfulObjectsV1_0.adoc | 44 +
.../ContentNegotiationServiceOrgApacheIsisV1.adoc} | 22 +-
.../ContentNegotiationServiceOrgApacheIsisV2.adoc | 59 +
.../ContentNegotiationServiceXRoDomainType.adoc | 33 +
.../service/swagger/SwaggerServiceMenu.adoc} | 24 +-
.../IsisModuleViewerRestfulObjectsViewer.adoc} | 6 +-
.../wicket/model/IsisModuleViewerWicketModel.adoc} | 6 +-
.../wicket/ui/IsisModuleViewerWicketUi.adoc} | 6 +-
.../viewer/IsisModuleViewerWicketViewer.adoc} | 6 +-
.../modules/generated/pages/system-overview.adoc | 1153 +++++++++++++-------
551 files changed, 8083 insertions(+), 3471 deletions(-)
diff --git a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc b/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
index 7747117..7c6675c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
@@ -5,8 +5,6 @@ Convenience super class for view models that wish to interact with the container
Subclassing is NOT mandatory; the methods in this superclass can be pushed down into domain objects and another superclass used if required.
-As an alternative, consider simply annotating the view model class with _org.apache.isis.applib.annotation.ViewModel_ .
-
.Java Sources
[source,java]
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/IsisModuleApplib.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/IsisModuleApplib.adoc
index 78f204d..2b5fef2 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/IsisModuleApplib.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleApplib : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleApplib {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc b/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc
index 8349ea1..8709d95 100644
--- a/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc
@@ -3,7 +3,7 @@
Indicates that the domain object can be recreated from a string.
-Objects that are view models (logically belonging to the UI/application layer) should instead implement _org.apache.isis.applib.ViewModel_ .
+Objects that are view models (logically belonging to the UI/application layer) should instead implement xref:system:generated:index/applib/ViewModel.adoc[ViewModel] .
.Java Sources
[source,java]
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc
index 5e30591..ade6d4a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc
@@ -67,7 +67,7 @@ Whether action invocations, captured as xref:system:generated:index/applib/servi
<.> `[teal]#*_domainEvent_*#` : `Class<? extends ActionDomainEvent<?>>`
+
--
-Indicates that an invocation of the action should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.domain.ActionDomainEvent_ .
+Indicates that an invocation of the action should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/domain/ActionDomainEvent.adoc[ActionDomainEvent] .
For example:
@@ -96,7 +96,7 @@ Indicates where (in the UI) the action is not visible to the user.
It is also possible to suppress an action's visibility using _ActionLayout#hidden()_ .
-For _DomainService domain service_ actions, the action's visibility is dependent upon its _DomainService#nature() nature_ and for contributed actions on how it is _ActionLayout#contributed()_ .
+For xref:system:generated:index/applib/annotation/DomainService.adoc[DomainService] actions, the action's visibility is dependent upon its _DomainService#nature() nature_ and for contributed actions on how it is _ActionLayout#contributed()_ .
--
<.> `[teal]#*_restrictTo_*#` : `xref:system:generated:index/applib/annotation/RestrictTo.adoc[RestrictTo]`
+
@@ -118,7 +118,7 @@ The type-of the elements returned by the action.
<.> `[teal]#*_fileAccept_*#` : `String`
+
--
-For downloading xref:system:generated:index/applib/value/Blob.adoc[Blob] or xref:system:generated:index/applib/value/Clob.adoc[Clob] , optionally restrict the files accepted (eg `.xslx` ).
+For downloading _Blob_ or _Clob_ , optionally restrict the files accepted (eg `.xslx` ).
The value should be of the form "file_extension|audio/*|video/*|image/*|media_type".
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc
index 7fe77b5..b92755d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc
@@ -49,7 +49,7 @@ For the Wicket viewer, this can be a bootstrap class such asbtn-info.
--
Indicates theFont AwesomeCSS class to decorate an action (button or menu item).
--
-<.> `[teal]#*_cssClassFaPosition_*#` : `CssClassFaPosition`
+<.> `[teal]#*_cssClassFaPosition_*#` : `xref:system:generated:index/applib/layout/component/CssClassFaPosition.adoc[CssClassFaPosition]`
+
--
Indicates the position of theFont Awesomeicon. The icon could be rendered on the left or the right of the action button
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc
index eb8fbca..61b2041 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc
@@ -21,7 +21,7 @@ Domain semantics for domain object collection.
<.> `[teal]#*_domainEvent_*#` : `Class<? extends CollectionDomainEvent<?,?>>`
+
--
-Indicates that changes to the collection that should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.domain.CollectionDomainEvent_ .
+Indicates that changes to the collection that should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/domain/CollectionDomainEvent.adoc[CollectionDomainEvent] .
For example:
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc
index 0905995..ebb9e39 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc
@@ -5,6 +5,8 @@ Indicates that the class should have a default, by providing a link to a xref:sy
This possibly seems a little tortuous. The more obvious means to provide a default would seem to be a simple `@DefaultsTo(new SomeObject())` . However, Java only allows primitives, strings and class literals to be used in annotations. We therefore need delegate to an external implementation. (This more complex design is also more flexible of course; the implementation of xref:system:generated:index/applib/adapters/DefaultsProvider.adoc[DefaultsProvider] could adjust the default it provid [...]
+Note: This annotation is only incompletely recognized by the framework, and may be deprecated in the future.
+
.Java Sources
[source,java]
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc
index 30d4d8f..83e0caf 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc
@@ -1,7 +1,7 @@
= DomainObject : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Domain semantics for domain objects (entities and view models; for services see _org.apache.isis.applib.annotation.DomainService_ ).
+Domain semantics for domain objects (entities and view models; for services see xref:system:generated:index/applib/annotation/DomainService.adoc[DomainService] ).
.Java Sources
[source,java]
@@ -110,49 +110,49 @@ This value, if specified, is used in the serialized form of the object's OID. An
<.> `[teal]#*_createdLifecycleEvent_*#` : `Class<? extends ObjectCreatedEvent<?>>`
+
--
-Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent_ .
+Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/lifecycle/ObjectCreatedEvent.adoc[ObjectCreatedEvent] .
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
<.> `[teal]#*_persistingLifecycleEvent_*#` : `Class<? extends ObjectPersistingEvent<?>>`
+
--
-Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent_ .
+Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/lifecycle/ObjectPersistingEvent.adoc[ObjectPersistingEvent] .
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
<.> `[teal]#*_persistedLifecycleEvent_*#` : `Class<? extends ObjectPersistedEvent<?>>`
+
--
-Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent_ .
+Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/lifecycle/ObjectPersistedEvent.adoc[ObjectPersistedEvent] .
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
<.> `[teal]#*_loadedLifecycleEvent_*#` : `Class<? extends ObjectLoadedEvent<?>>`
+
--
-Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent_ .
+Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/lifecycle/ObjectLoadedEvent.adoc[ObjectLoadedEvent] .
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
<.> `[teal]#*_updatingLifecycleEvent_*#` : `Class<? extends ObjectUpdatingEvent<?>>`
+
--
-Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent_ .
+Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/lifecycle/ObjectUpdatingEvent.adoc[ObjectUpdatingEvent] .
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
<.> `[teal]#*_updatedLifecycleEvent_*#` : `Class<? extends ObjectUpdatedEvent<?>>`
+
--
-Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent_ .
+Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/lifecycle/ObjectUpdatedEvent.adoc[ObjectUpdatedEvent] .
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
<.> `[teal]#*_removingLifecycleEvent_*#` : `Class<? extends ObjectRemovingEvent<?>>`
+
--
-Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent_ .
+Indicates that the loading of the domain object should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/lifecycle/ObjectRemovingEvent.adoc[ObjectRemovingEvent] .
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc
index 9f306e8..886b7b1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc
@@ -49,7 +49,7 @@ Indicates the css class that a domain class (type) should have.
--
Indicates theFont AwesomeCSS class to decorate an domain object.
--
-<.> `[teal]#*_cssClassFaPosition_*#` : `CssClassFaPosition`
+<.> `[teal]#*_cssClassFaPosition_*#` : `xref:system:generated:index/applib/layout/component/CssClassFaPosition.adoc[CssClassFaPosition]`
+
--
Indicates the position of theFont Awesomeicon. The icon could be rendered on the left or the right of the object's title.
@@ -90,7 +90,7 @@ This subclass must provide a no-arg constructor; the fields are set reflectively
<.> `[teal]#*_iconUiEvent_*#` : `Class<? extends IconUiEvent<?>>`
+
--
-Which subclass of _IconUiEvent_ should be used to obtain an icon.
+Which subclass of xref:system:generated:index/applib/events/ui/IconUiEvent.adoc[IconUiEvent] should be used to obtain an icon.
This subclass must provide a no-arg constructor; the fields are set reflectively.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc
index c47db6a..f4eda37 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc
@@ -1,13 +1,13 @@
= EqualByContent : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Indicates that the class follows the equal-by-content contract, usually associated with _Value value_ types.
+Indicates that the class follows the equal-by-content contract, usually associated with xref:system:generated:index/applib/annotation/Value.adoc[Value] types.
If a class claims to be equal-by-content then its _#equals(Object)_ should return `true` if its content (as opposed to identity) is the same. For example, _String_ , _BigDecimal_ and _Date_ follow this contract.
Note also that the Java Language Specification requires that two objects that are _#equals(Object) equal_ must return the same value from _#hashCode()_ . Failure to do this means that that the object will not behave correctly when used as a key into a hashing structure (eg a _HashMap_ ).
-By default any _Value value_ types are assumed to follow the equal-by-content rule, though this can be overridden if required. Value types are usually also immutable (though there are some classic exceptions to this, such as _Date_ ).
+By default any xref:system:generated:index/applib/annotation/Value.adoc[Value] types are assumed to follow the equal-by-content rule, though this can be overridden if required. Value types are usually also immutable (though there are some classic exceptions to this, such as _Date_ ).
.Java Sources
[source,java]
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc
index dd04b8c..e8a6312 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc
@@ -3,9 +3,9 @@
Intended to be annotated on the root marker class of a (Maven) module which contains a single coherent set of functionality, possibly including domain services.
-A _Module @Module_ (because it's a meta-annotation) is also a Spring _Configuration @Configuration_ , which means that the functionality can be depended upon transitively using Spring's _Import @Import_ annotation. Normally the import graph mirrors the dependencies in Maven.
+A xref:system:generated:index/applib/annotation/Module.adoc[Module] (because it's a meta-annotation) is also a Spring _Configuration @Configuration_ , which means that the functionality can be depended upon transitively using Spring's _Import @Import_ annotation. Normally the import graph mirrors the dependencies in Maven.
-Also, a _Module @Module_ also declares the Spring _ComponentScan @ComponentScan_ (with no parameters), which means that any domain services in the same package or subpackages are automatically found and registered.
+Also, a xref:system:generated:index/applib/annotation/Module.adoc[Module] also declares the Spring _ComponentScan @ComponentScan_ (with no parameters), which means that any domain services in the same package or subpackages are automatically found and registered.
.Java Sources
[source,java]
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc
index 1f323b4..53bb1b3 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc
@@ -27,7 +27,7 @@ enum Nature {
<.> `[teal]#*_NOT_SPECIFIED_*#`
+
--
-The default; allows the programmer to combine `@DomainObject` annotation with the xref:system:generated:index/applib/ViewModel.adoc[ViewModel] annotation, or the _XmlRootElement_ annotation, or by implementing the _org.apache.isis.applib.ViewModel_ interface.
+The default; allows the programmer to combine `@DomainObject` annotation with the xref:system:generated:index/applib/ViewModel.adoc[ViewModel] annotation, or the _XmlRootElement_ annotation, or by implementing the xref:system:generated:index/applib/ViewModel.adoc[ViewModel] interface.
--
<.> `[teal]#*_ENTITY_*#`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc
index fe98ee4..7e422aa 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc
@@ -41,7 +41,7 @@ The default value (-1) indicates that no maxLength has been specified.
<.> `[teal]#*_mustSatisfy_*#` : `Class<? extends Specification>[]`
+
--
-The _org.apache.isis.applib.spec.Specification_ (s) to be satisfied by this parameter.
+The xref:system:generated:index/applib/spec/Specification.adoc[Specification] (s) to be satisfied by this parameter.
If more than one is provided, then all must be satisfied (in effect "AND"ed together).
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc
index b665998..fe09900 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc
@@ -57,7 +57,7 @@ Whether property edits, captured as xref:system:generated:index/applib/services/
<.> `[teal]#*_domainEvent_*#` : `Class<? extends PropertyDomainEvent<?,?>>`
+
--
-Indicates that changes to the property that should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) _org.apache.isis.applib.events.domain.PropertyDomainEvent_ .
+Indicates that changes to the property that should be posted to the _org.apache.isis.applib.services.eventbus.EventBusService event bus_ using a custom (subclass of) xref:system:generated:index/applib/events/domain/PropertyDomainEvent.adoc[PropertyDomainEvent] .
For example:
@@ -117,7 +117,7 @@ To ensure that the property is actually not persisted in the objectstore, also a
<.> `[teal]#*_mustSatisfy_*#` : `Class<? extends Specification>[]`
+
--
-The _org.apache.isis.applib.spec.Specification_ (s) to be satisfied by this property.
+The xref:system:generated:index/applib/spec/Specification.adoc[Specification] (s) to be satisfied by this property.
If more than one is provided, then all must be satisfied (in effect "AND"ed together).
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/client/RepresentationTypeSimplifiedV2.adoc b/antora/components/system/modules/generated/pages/index/applib/client/RepresentationTypeSimplifiedV2.adoc
new file mode 100644
index 0000000..dc19908
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/client/RepresentationTypeSimplifiedV2.adoc
@@ -0,0 +1,74 @@
+= RepresentationTypeSimplifiedV2 : _enum_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+enum RepresentationTypeSimplifiedV2 {
+
+ OBJECT // <.>
+
+ OBJECT_COLLECTION // <.>
+
+ LIST // <.>
+
+ VALUE // <.>
+
+ VALUES // <.>
+
+ VOID // <.>
+
+ @Getter
+final String typeLiteral;
+
+ boolean isObject()
+
+ boolean isObjectCollection()
+
+ boolean isList()
+
+ boolean isValue()
+
+ boolean isValues()
+
+ boolean isVoid()
+
+ String getContentTypeHeaderValue(final String profileName)
+
+ Optional<RepresentationTypeSimplifiedV2> parse(final String typeLiteral)
+
+ Optional<RepresentationTypeSimplifiedV2> parseContentTypeHeaderString(final String contentTypeHeaderString)
+}
+----
+
+<.> `[teal]#*_OBJECT_*#`
++
+--
+The media type used as content-Type header when a domain object is rendered.
+--
+<.> `[teal]#*_OBJECT_COLLECTION_*#`
++
+--
+The media type used as content-Type header when a parented collection is rendered.
+--
+<.> `[teal]#*_LIST_*#`
++
+--
+The media type used as content-Type header when a standalone collection is rendered.
+--
+<.> `[teal]#*_VALUE_*#`
++
+--
+The media type used as content-Type header when a single (nullable) value is rendered.
+--
+<.> `[teal]#*_VALUES_*#`
++
+--
+The media type used as content-Type header when a list of values is rendered.
+--
+<.> `[teal]#*_VOID_*#`
++
+--
+The media type used as content-Type header when a void action result is rendered.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService~Snapshot~Builder.adoc b/antora/components/system/modules/generated/pages/index/applib/events/ui/IconUiEvent.adoc
similarity index 54%
copy from antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService~Snapshot~Builder.adoc
copy to antora/components/system/modules/generated/pages/index/applib/events/ui/IconUiEvent.adoc
index 82b3d91..a5e7d2c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService~Snapshot~Builder.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/ui/IconUiEvent.adoc
@@ -1,32 +1,38 @@
-= XmlSnapshotService.Snapshot.Builder : _interface_
+= IconUiEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Emitted for subscribers to obtain a cssClass hint (equivalent to the `iconName()` supporting method).
+
.Java Sources
[source,java]
----
-interface Builder {
+class IconUiEvent {
+
+ IconUiEvent() // <.>
- void includePath(final String path) // <.>
+ IconUiEvent(final S source)
- void includePathAndAnnotation(final String path, final String annotation) // <.>
+ String getIconName() // <.>
- XmlSnapshotService.Snapshot build() // <.>
+ void setIconName(final String iconName) // <.>
}
----
-<.> `[teal]#*includePath*#(String path)` : `void`
+<.> `[teal]#*IconUiEvent*#()`
+
--
-Enrich the snapshot to include the state of these referenced objects
+If used then the framework will set state via (non-API) setters.
+
+Because the _EventObject_ superclass prohibits a null source, a dummy value is temporarily used.
--
-<.> `[teal]#*includePathAndAnnotation*#(String path, String annotation)` : `void`
+<.> `[teal]#*getIconName*#()` : `String`
+
--
-Ditto, but add an XML annotation attribute to the included element(s).
+The icon name as provided by a subscriber using _#setIconName(String)_ .
--
-<.> `[teal]#*build*#()` : `xref:system:generated:index/applib/annotation/Snapshot.adoc[Snapshot]`
+<.> `[teal]#*setIconName*#(String iconName)` : `void`
+
--
-Builds the Snapshot.
+For subscribers to call to provide an icon name for this object.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc
index 82d5bd1..616a0e4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc
@@ -19,9 +19,9 @@ interface TranslatableException {
<.> `[teal]#*getTranslatableMessage*#()` : `xref:system:generated:index/applib/services/i18n/TranslatableString.adoc[TranslatableString]`
+
--
-In the spirit of _Exception#getLocalizedMessage()_ , but using _org.apache.isis.applib.services.i18n.TranslatableString_ instead.
+In the spirit of _Exception#getLocalizedMessage()_ , but using xref:system:generated:index/applib/services/i18n/TranslatableString.adoc[TranslatableString] instead.
-If returnsnull, then _Exception#getMessage()_ will be used as a fallback. This design allows the Isis-provided _org.apache.isis.applib.exceptions.RecoverableException_ and _org.apache.isis.applib.exceptions.UnrecoverableException_ to provide constructors that accept a _org.apache.isis.applib.services.i18n.TranslatableString_ , but can be left as null for any existing code.
+If returnsnull, then _Exception#getMessage()_ will be used as a fallback. This design allows the Isis-provided xref:system:generated:index/applib/exceptions/RecoverableException.adoc[RecoverableException] and xref:system:generated:index/applib/exceptions/UnrecoverableException.adoc[UnrecoverableException] to provide constructors that accept a xref:system:generated:index/applib/services/i18n/TranslatableString.adoc[TranslatableString] , but can be left as null for any existing code.
--
<.> `[teal]#*getTranslationContext*#()` : `String`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/DomainModelException.adoc
similarity index 72%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/DomainModelException.adoc
index dcdaf9a..96e065b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/DomainModelException.adoc
@@ -1,28 +1,18 @@
-= EntityState : _enum_
+= DomainModelException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+Thrown when a problem is found with the domain model, and Isis cannot proceed.
.Java Sources
[source,java]
----
-enum EntityState {
+class DomainModelException {
- NOT_PERSISTABLE
+ DomainModelException(final String message)
- PERSISTABLE_ATTACHED
+ DomainModelException(final Throwable cause)
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ DomainModelException(final String message, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/MetaModelException.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/MetaModelException.adoc
index 78f204d..ed63d06 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/MetaModelException.adoc
@@ -1,12 +1,16 @@
-= ResourceCoordinates : _class_
+= MetaModelException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class MetaModelException {
- int compareTo(final ResourceCoordinates other)
+ MetaModelException(final String message)
+
+ MetaModelException(final Throwable cause)
+
+ MetaModelException(final String message, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/NoAuthenticatorException.adoc
similarity index 70%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/NoAuthenticatorException.adoc
index dcdaf9a..d9df14e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/NoAuthenticatorException.adoc
@@ -1,28 +1,18 @@
-= EntityState : _enum_
+= NoAuthenticatorException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+Indicates that there is no Authenticator available to authenticate a user based on this request.
.Java Sources
[source,java]
----
-enum EntityState {
+class NoAuthenticatorException {
- NOT_PERSISTABLE
+ NoAuthenticatorException(final String msg)
- PERSISTABLE_ATTACHED
+ NoAuthenticatorException(final String msg, final Throwable cause)
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ NoAuthenticatorException(final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectNotFoundException.adoc
similarity index 73%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectNotFoundException.adoc
index ba495fc..2370806 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectNotFoundException.adoc
@@ -1,20 +1,16 @@
-= MenuBarsService : _interface_
+= ObjectNotFoundException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Indicates that the persistence context was unable to get an instantiate for the specified object identifier.
+
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class ObjectNotFoundException {
- MenuBars menuBars() // <.>
+ ObjectNotFoundException(final String oid)
- MenuBars menuBars(final Type type)
+ ObjectNotFoundException(final String oid, final Throwable cause)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectPersistenceException.adoc
similarity index 76%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectPersistenceException.adoc
index ba495fc..a1440ad 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectPersistenceException.adoc
@@ -1,20 +1,16 @@
-= MenuBarsService : _interface_
+= ObjectPersistenceException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class ObjectPersistenceException {
- MenuBars menuBars() // <.>
+ ObjectPersistenceException(final String message)
- MenuBars menuBars(final Type type)
+ ObjectPersistenceException(final String message, final Throwable cause)
+
+ ObjectPersistenceException(final Throwable cause)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ReflectiveActionException.adoc
similarity index 77%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ReflectiveActionException.adoc
index ba495fc..ff7f3b4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ReflectiveActionException.adoc
@@ -1,20 +1,16 @@
-= MenuBarsService : _interface_
+= ReflectiveActionException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class ReflectiveActionException {
- MenuBars menuBars() // <.>
+ ReflectiveActionException(final String msg)
- MenuBars menuBars(final Type type)
+ ReflectiveActionException(final Throwable cause)
+
+ ReflectiveActionException(final String msg, final Throwable cause)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnexpectedCallException.adoc
similarity index 78%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnexpectedCallException.adoc
index 78f204d..710b0b1 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnexpectedCallException.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= UnexpectedCallException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Indicates that a call was made to a method (normally an overridden one) that was not expected, and hence not coded for.
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class UnexpectedCallException {
- int compareTo(final ResourceCoordinates other)
+ UnexpectedCallException()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnknownTypeException.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnknownTypeException.adoc
index 78f204d..4d74df1 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnknownTypeException.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= UnknownTypeException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class UnknownTypeException {
- int compareTo(final ResourceCoordinates other)
+ UnknownTypeException(final String message)
+
+ UnknownTypeException(final Object object)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/tree/LazyTreeNode.adoc
similarity index 68%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/graph/tree/LazyTreeNode.adoc
index dcdaf9a..d88f4ac 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/tree/LazyTreeNode.adoc
@@ -1,28 +1,26 @@
-= EntityState : _enum_
+= LazyTreeNode : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+class LazyTreeNode {
- NOT_PERSISTABLE
+ TreeNode<T> of(T value, Class<? extends TreeAdapter<T>> treeAdapterClass, TreeState sharedState)
- PERSISTABLE_ATTACHED
+ T getValue()
- PERSISTABLE_DETACHED
+ TreeNode<T> getParentIfAny()
- PERSISTABLE_DESTROYED
+ int getChildCount()
- boolean isPersistable()
+ Stream<TreeNode<T>> streamChildren()
- boolean isAttached()
+ Class<? extends TreeAdapter<T>> getTreeAdapterClass()
- boolean isDetached()
+ TreePath getPositionAsPath()
- boolean isDestroyed()
+ TreeState getTreeState()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/DataTypeFactory.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/jaxb/DataTypeFactory.adoc
index 78f204d..397b841 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/DataTypeFactory.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= DataTypeFactory : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class DataTypeFactory {
- int compareTo(final ResourceCoordinates other)
+ XMLGregorianCalendar withTypeFactoryDo(Function<DatatypeFactory, XMLGregorianCalendar> factory)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlXMLGregorianCalendarMarshalling.adoc
similarity index 74%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlXMLGregorianCalendarMarshalling.adoc
index ba495fc..d72a8d4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlXMLGregorianCalendarMarshalling.adoc
@@ -1,20 +1,16 @@
-= MenuBarsService : _interface_
+= JavaSqlXMLGregorianCalendarMarshalling : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class JavaSqlXMLGregorianCalendarMarshalling {
- MenuBars menuBars() // <.>
+ static DatatypeFactory datatypeFactory;
- MenuBars menuBars(final Type type)
+ Timestamp toTimestamp(final XMLGregorianCalendar calendar)
+
+ XMLGregorianCalendar toXMLGregorianCalendar(final Timestamp timestamp)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeXMLGregorianCalendarMarshalling.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeXMLGregorianCalendarMarshalling.adoc
new file mode 100644
index 0000000..9bd8487
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeXMLGregorianCalendarMarshalling.adoc
@@ -0,0 +1,34 @@
+= JavaTimeXMLGregorianCalendarMarshalling : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+class JavaTimeXMLGregorianCalendarMarshalling {
+
+ LocalDate toLocalDate(XMLGregorianCalendar cal)
+
+ LocalTime toLocalTime(XMLGregorianCalendar cal)
+
+ LocalDateTime toLocalDateTime(XMLGregorianCalendar cal)
+
+ OffsetDateTime toOffsetDateTime(XMLGregorianCalendar cal)
+
+ OffsetTime toOffsetTime(XMLGregorianCalendar cal)
+
+ ZonedDateTime toZonedDateTime(XMLGregorianCalendar cal)
+
+ XMLGregorianCalendar toXMLGregorianCalendar2(LocalDate localDate)
+
+ XMLGregorianCalendar toXMLGregorianCalendar2(LocalTime localTime)
+
+ XMLGregorianCalendar toXMLGregorianCalendar2(LocalDateTime localDateTime)
+
+ XMLGregorianCalendar toXMLGregorianCalendar2(OffsetTime offsetTime)
+
+ XMLGregorianCalendar toXMLGregorianCalendar2(OffsetDateTime offsetDateTime)
+
+ XMLGregorianCalendar toXMLGregorianCalendar2(ZonedDateTime zonedDateTime)
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeJaxbAdapters.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeJaxbAdapters.adoc
index 78f204d..e4214a2 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeJaxbAdapters.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= JodaTimeJaxbAdapters : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class JodaTimeJaxbAdapters {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeXMLGregorianCalendarMarshalling.adoc
similarity index 56%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeXMLGregorianCalendarMarshalling.adoc
index dcdaf9a..5b57426 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeXMLGregorianCalendarMarshalling.adoc
@@ -1,28 +1,26 @@
-= EntityState : _enum_
+= JodaTimeXMLGregorianCalendarMarshalling : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+class JodaTimeXMLGregorianCalendarMarshalling {
- NOT_PERSISTABLE
+ DateTime toDateTime(final XMLGregorianCalendar xgc)
- PERSISTABLE_ATTACHED
+ LocalDate toLocalDate(final XMLGregorianCalendar xgc)
- PERSISTABLE_DETACHED
+ LocalDateTime toLocalDateTime(final XMLGregorianCalendar xgc)
- PERSISTABLE_DESTROYED
+ LocalTime toLocalTime(final XMLGregorianCalendar xgc)
- boolean isPersistable()
+ XMLGregorianCalendar toXMLGregorianCalendar(DateTime dateTime)
- boolean isAttached()
+ XMLGregorianCalendar toXMLGregorianCalendar(final LocalDateTime localDateTime)
- boolean isDetached()
+ XMLGregorianCalendar toXMLGregorianCalendar(final LocalDate localDate)
- boolean isDestroyed()
+ XMLGregorianCalendar toXMLGregorianCalendar(final LocalTime localTime)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/PrimitiveJaxbAdapters.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/jaxb/PrimitiveJaxbAdapters.adoc
index 78f204d..6f1f079 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/PrimitiveJaxbAdapters.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= PrimitiveJaxbAdapters : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class PrimitiveJaxbAdapters {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
index 6255761..d87d67f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
@@ -85,7 +85,7 @@ Method name.
Overloaded methods are not supported.
--
-<.> `[teal]#*getOwner*#()` : `ActionLayoutDataOwner`
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/component/ActionLayoutDataOwner.adoc[ActionLayoutDataOwner]`
+
--
Owner.
@@ -97,7 +97,7 @@ Set programmatically by framework after reading in from XML.
--
For diagnostics; populated by the framework if and only if a metadata error.
--
-<.> `[teal]#*getLink*#()` : `Link`
+<.> `[teal]#*getLink*#()` : `xref:system:generated:index/applib/layout/links/Link.adoc[Link]`
+
--
The link to access this resource from the REST API (Restful Objects viewer).
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutDataOwner.adoc
similarity index 83%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutDataOwner.adoc
index 78f204d..26db570 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutDataOwner.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= ActionLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface ActionLayoutDataOwner {
- int compareTo(final ResourceCoordinates other)
+ List<ActionLayoutData> getActions()
+
+ void setActions(List<ActionLayoutData> actions)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutData.adoc
similarity index 57%
copy from antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutData.adoc
index 6255761..dd805ed 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutData.adoc
@@ -1,43 +1,35 @@
-= ActionLayoutData : _class_
+= CollectionLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Describes the layout of a single action, broadly corresponding to _org.apache.isis.applib.annotation.ActionLayout_ .
+Describes the layout of a single collection, broadly corresponds to the _org.apache.isis.applib.annotation.CollectionLayout_ annotation.
-Note that _org.apache.isis.applib.annotation.ActionLayout#contributed()_ is omitted because this only applies to domain services.
+Note that _org.apache.isis.applib.annotation.CollectionLayout#render()_ is omitted because _#defaultView_ is its replacement.
.Java Sources
[source,java]
----
-class ActionLayoutData {
+class CollectionLayoutData {
- ActionLayoutData()
+ CollectionLayoutData()
- ActionLayoutData(final String id)
+ CollectionLayoutData(final String id)
String getId() // <.>
void setId(String id)
- BookmarkPolicy getBookmarking()
-
- void setBookmarking(BookmarkPolicy bookmarking)
-
String getCssClass()
void setCssClass(String cssClass)
- String getCssClassFa()
-
- void setCssClassFa(String cssClassFa)
-
- CssClassFaPosition getCssClassFaPosition()
-
- void setCssClassFaPosition(CssClassFaPosition cssClassFaPosition)
-
String getDescribedAs()
void setDescribedAs(String describedAs)
+ String getDefaultView() // <.>
+
+ void setDefaultView(String defaultView)
+
Where getHidden()
void setHidden(Where hidden)
@@ -50,21 +42,21 @@ class ActionLayoutData {
void setNamedEscaped(Boolean namedEscaped)
- org.apache.isis.applib.annotation.ActionLayout.Position getPosition()
+ Integer getPaged()
- void setPosition(org.apache.isis.applib.annotation.ActionLayout.Position position)
+ void setPaged(Integer paged)
- PromptStyle getPromptStyle()
+ String getSortedBy()
- void setPromptStyle(PromptStyle promptStyle)
+ void setSortedBy(String sortedBy)
- Redirect getRedirect()
+ List<ActionLayoutData> getActions()
- void setRedirect(Redirect redirect)
+ void setActions(List<ActionLayoutData> actionLayoutDatas)
- ActionLayoutDataOwner getOwner() // <.>
+ CollectionLayoutDataOwner getOwner() // <.>
- void setOwner(final ActionLayoutDataOwner owner)
+ void setOwner(final CollectionLayoutDataOwner owner)
String getMetadataError() // <.>
@@ -81,11 +73,14 @@ class ActionLayoutData {
<.> `[teal]#*getId*#()` : `String`
+
--
-Method name.
-
-Overloaded methods are not supported.
+Collection identifier, being the getter method without "get" prefix, first letter lower cased.
+--
+<.> `[teal]#*getDefaultView*#()` : `String`
++
+--
+Typicallytableorhidden, but could be any other named view that is configured and appropriate, eggmap3orfullcalendar2.
--
-<.> `[teal]#*getOwner*#()` : `ActionLayoutDataOwner`
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/component/CollectionLayoutDataOwner.adoc[CollectionLayoutDataOwner]`
+
--
Owner.
@@ -97,7 +92,7 @@ Set programmatically by framework after reading in from XML.
--
For diagnostics; populated by the framework if and only if a metadata error.
--
-<.> `[teal]#*getLink*#()` : `Link`
+<.> `[teal]#*getLink*#()` : `xref:system:generated:index/applib/layout/links/Link.adoc[Link]`
+
--
The link to access this resource from the REST API (Restful Objects viewer).
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutDataOwner.adoc
similarity index 86%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutDataOwner.adoc
index 78f204d..4a48090 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutDataOwner.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= CollectionLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface CollectionLayoutDataOwner {
- int compareTo(final ResourceCoordinates other)
+ List<CollectionLayoutData> getCollections()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/CssClassFaPosition.adoc
similarity index 85%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/CssClassFaPosition.adoc
index 78f204d..a6be340 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/CssClassFaPosition.adoc
@@ -1,12 +1,16 @@
-= ResourceCoordinates : _class_
+= CssClassFaPosition : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+enum CssClassFaPosition {
- int compareTo(final ResourceCoordinates other)
+ LEFT
+
+ RIGHT
+
+ boolean isLeftOrUnspecified(final CssClassFaPosition posistion)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutData.adoc
similarity index 63%
copy from antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutData.adoc
index 6255761..65628ca 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutData.adoc
@@ -1,22 +1,14 @@
-= ActionLayoutData : _class_
+= DomainObjectLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Describes the layout of a single action, broadly corresponding to _org.apache.isis.applib.annotation.ActionLayout_ .
-
-Note that _org.apache.isis.applib.annotation.ActionLayout#contributed()_ is omitted because this only applies to domain services.
+Describes the layout of the title and icon of a domain object, broadly corresponding to _org.apache.isis.applib.annotation.DomainObjectLayout_ .
.Java Sources
[source,java]
----
-class ActionLayoutData {
-
- ActionLayoutData()
-
- ActionLayoutData(final String id)
+class DomainObjectLayoutData {
- String getId() // <.>
-
- void setId(String id)
+ DomainObjectLayoutData()
BookmarkPolicy getBookmarking()
@@ -38,10 +30,6 @@ class ActionLayoutData {
void setDescribedAs(String describedAs)
- Where getHidden()
-
- void setHidden(Where hidden)
-
String getNamed()
void setNamed(String named)
@@ -50,54 +38,37 @@ class ActionLayoutData {
void setNamedEscaped(Boolean namedEscaped)
- org.apache.isis.applib.annotation.ActionLayout.Position getPosition()
-
- void setPosition(org.apache.isis.applib.annotation.ActionLayout.Position position)
-
- PromptStyle getPromptStyle()
-
- void setPromptStyle(PromptStyle promptStyle)
-
- Redirect getRedirect()
-
- void setRedirect(Redirect redirect)
-
- ActionLayoutDataOwner getOwner() // <.>
+ String getPlural()
- void setOwner(final ActionLayoutDataOwner owner)
+ void setPlural(String plural)
String getMetadataError() // <.>
void setMetadataError(final String metadataError)
+ DomainObjectLayoutDataOwner getOwner() // <.>
+
+ void setOwner(final DomainObjectLayoutDataOwner owner)
+
Link getLink() // <.>
void setLink(final Link link)
-
- String toString()
}
----
-<.> `[teal]#*getId*#()` : `String`
+<.> `[teal]#*getMetadataError*#()` : `String`
+
--
-Method name.
-
-Overloaded methods are not supported.
+For diagnostics; populated by the framework if and only if a metadata error.
--
-<.> `[teal]#*getOwner*#()` : `ActionLayoutDataOwner`
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/component/DomainObjectLayoutDataOwner.adoc[DomainObjectLayoutDataOwner]`
+
--
Owner.
Set programmatically by framework after reading in from XML.
--
-<.> `[teal]#*getMetadataError*#()` : `String`
-+
---
-For diagnostics; populated by the framework if and only if a metadata error.
---
-<.> `[teal]#*getLink*#()` : `Link`
+<.> `[teal]#*getLink*#()` : `xref:system:generated:index/applib/layout/links/Link.adoc[Link]`
+
--
The link to access this resource from the REST API (Restful Objects viewer).
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutDataOwner.adoc
similarity index 80%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutDataOwner.adoc
index 78f204d..8100efc 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutDataOwner.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= DomainObjectLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface DomainObjectLayoutDataOwner {
- int compareTo(final ResourceCoordinates other)
+ DomainObjectLayoutData getDomainObject()
+
+ void setDomainObject(DomainObjectLayoutData domainObjectLayoutData)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSet.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSet.adoc
new file mode 100644
index 0000000..d9d208e
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSet.adoc
@@ -0,0 +1,87 @@
+= FieldSet : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+A xref:system:generated:index/applib/layout/component/MemberRegion.adoc[MemberRegion] of the page containing a set of related xref:system:generated:index/applib/layout/component/PropertyLayoutData.adoc[PropertyLayoutData] and associated xref:system:generated:index/applib/layout/component/ActionLayoutData.adoc[ActionLayoutData] .
+
+.Java Sources
+[source,java]
+----
+class FieldSet {
+
+ FieldSet()
+
+ FieldSet(final String name)
+
+ String getId() // <.>
+
+ void setId(final String id)
+
+ Boolean isUnreferencedActions() // <.>
+
+ void setUnreferencedActions(final Boolean unreferencedActions)
+
+ Boolean isUnreferencedProperties() // <.>
+
+ void setUnreferencedProperties(final Boolean unreferencedProperties)
+
+ String getName() // <.>
+
+ void setName(String name)
+
+ List<ActionLayoutData> getActions()
+
+ void setActions(List<ActionLayoutData> actionLayoutDatas)
+
+ List<PropertyLayoutData> getProperties()
+
+ void setProperties(List<PropertyLayoutData> properties)
+
+ FieldSetOwner getOwner() // <.>
+
+ void setOwner(final FieldSetOwner owner)
+
+ String getMetadataError() // <.>
+
+ void setMetadataError(final String metadataError)
+
+ String toString()
+}
+----
+
+<.> `[teal]#*getId*#()` : `String`
++
+--
+As per <div id="...">...</div> : must be unique across entire page.
+--
+<.> `[teal]#*isUnreferencedActions*#()` : `Boolean`
++
+--
+Whether this fieldset should be used to hold any unreferenced actions (contributed or "native").
+
+Any layout must have precisely one fieldset or xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Col.adoc[BS3Col] that has this attribute set.
+--
+<.> `[teal]#*isUnreferencedProperties*#()` : `Boolean`
++
+--
+Whether this fieldset should be used to hold any unreferenced properties (contributed or "native").
+
+Any grid layout must have precisely one fieldset that has this attribute set.
+--
+<.> `[teal]#*getName*#()` : `String`
++
+--
+Corresponds to the _MemberOrder#name()_ (when applied to properties).
+--
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/component/FieldSetOwner.adoc[FieldSetOwner]`
++
+--
+Owner.
+
+Set programmatically by framework after reading in from XML.
+--
+<.> `[teal]#*getMetadataError*#()` : `String`
++
+--
+For diagnostics; populated by the framework if and only if a metadata error.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSetOwner.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSetOwner.adoc
index 78f204d..d831081 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSetOwner.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= FieldSetOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface FieldSetOwner {
- int compareTo(final ResourceCoordinates other)
+ List<FieldSet> getFieldSets()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasNamed.adoc
similarity index 82%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/HasNamed.adoc
index 78f204d..6cdadfe 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasNamed.adoc
@@ -1,12 +1,18 @@
-= ResourceCoordinates : _class_
+= HasNamed : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface HasNamed {
- int compareTo(final ResourceCoordinates other)
+ String getNamed()
+
+ void setNamed(String named)
+
+ Boolean getNamedEscaped()
+
+ void setNamedEscaped(Boolean namedEscaped)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegion.adoc
similarity index 73%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegion.adoc
index dcdaf9a..75579ea 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegion.adoc
@@ -1,28 +1,14 @@
-= EntityState : _enum_
+= MemberRegion : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+Represents an area on the page containing one or several related members.
+
+Implementations include aFieldSet(containing a number of properties and their actions), and aCollectionLayoutData(containing a single collection and associated actions)
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+interface MemberRegion {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegionOwner.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegionOwner.adoc
index 78f204d..5b67df8 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegionOwner.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= MemberRegionOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+interface MemberRegionOwner {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owned.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/Owned.adoc
index 78f204d..e876c60 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owned.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= Owned : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface Owned {
- int compareTo(final ResourceCoordinates other)
+ T getOwner()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owner.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/Owner.adoc
index 78f204d..57ac280 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owner.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= Owner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+interface Owner {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/PropertyLayoutData.adoc
similarity index 62%
copy from antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/PropertyLayoutData.adoc
index 6255761..9430fd1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/PropertyLayoutData.adoc
@@ -1,39 +1,25 @@
-= ActionLayoutData : _class_
+= PropertyLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Describes the layout of a single action, broadly corresponding to _org.apache.isis.applib.annotation.ActionLayout_ .
-
-Note that _org.apache.isis.applib.annotation.ActionLayout#contributed()_ is omitted because this only applies to domain services.
+Describes the layout of a single property, broadly corresponds to the _org.apache.isis.applib.annotation.PropertyLayout_ annotation.
.Java Sources
[source,java]
----
-class ActionLayoutData {
+class PropertyLayoutData {
- ActionLayoutData()
+ PropertyLayoutData()
- ActionLayoutData(final String id)
+ PropertyLayoutData(final String id)
String getId() // <.>
void setId(String id)
- BookmarkPolicy getBookmarking()
-
- void setBookmarking(BookmarkPolicy bookmarking)
-
String getCssClass()
void setCssClass(String cssClass)
- String getCssClassFa()
-
- void setCssClassFa(String cssClassFa)
-
- CssClassFaPosition getCssClassFaPosition()
-
- void setCssClassFaPosition(CssClassFaPosition cssClassFaPosition)
-
String getDescribedAs()
void setDescribedAs(String describedAs)
@@ -42,6 +28,14 @@ class ActionLayoutData {
void setHidden(Where hidden)
+ LabelPosition getLabelPosition()
+
+ void setLabelPosition(LabelPosition labelPosition)
+
+ Integer getMultiLine()
+
+ void setMultiLine(Integer multiLine)
+
String getNamed()
void setNamed(String named)
@@ -50,21 +44,29 @@ class ActionLayoutData {
void setNamedEscaped(Boolean namedEscaped)
- org.apache.isis.applib.annotation.ActionLayout.Position getPosition()
-
- void setPosition(org.apache.isis.applib.annotation.ActionLayout.Position position)
-
PromptStyle getPromptStyle()
void setPromptStyle(PromptStyle promptStyle)
- Redirect getRedirect()
+ RenderDay getRenderDay()
+
+ void setRenderDay(final RenderDay renderDay)
+
+ Integer getTypicalLength()
- void setRedirect(Redirect redirect)
+ void setTypicalLength(Integer typicalLength)
- ActionLayoutDataOwner getOwner() // <.>
+ Repainting getRepainting()
- void setOwner(final ActionLayoutDataOwner owner)
+ void setRepainting(final Repainting repainting)
+
+ List<ActionLayoutData> getActions()
+
+ void setActions(List<ActionLayoutData> actionLayoutDatas)
+
+ FieldSet getOwner() // <.>
+
+ void setOwner(final FieldSet owner)
String getMetadataError() // <.>
@@ -81,11 +83,9 @@ class ActionLayoutData {
<.> `[teal]#*getId*#()` : `String`
+
--
-Method name.
-
-Overloaded methods are not supported.
+Property identifier, being the getter method without "get" or "is" prefix, first letter lower cased.
--
-<.> `[teal]#*getOwner*#()` : `ActionLayoutDataOwner`
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/component/FieldSet.adoc[FieldSet]`
+
--
Owner.
@@ -97,7 +97,7 @@ Set programmatically by framework after reading in from XML.
--
For diagnostics; populated by the framework if and only if a metadata error.
--
-<.> `[teal]#*getLink*#()` : `Link`
+<.> `[teal]#*getLink*#()` : `xref:system:generated:index/applib/layout/links/Link.adoc[Link]`
+
--
The link to access this resource from the REST API (Restful Objects viewer).
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutData.adoc
similarity index 73%
copy from antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutData.adoc
index 6255761..9be2883 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutData.adoc
@@ -1,4 +1,4 @@
-= ActionLayoutData : _class_
+= ServiceActionLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the layout of a single action, broadly corresponding to _org.apache.isis.applib.annotation.ActionLayout_ .
@@ -8,11 +8,15 @@ Note that _org.apache.isis.applib.annotation.ActionLayout#contributed()_ is omit
.Java Sources
[source,java]
----
-class ActionLayoutData {
+class ServiceActionLayoutData {
- ActionLayoutData()
+ ServiceActionLayoutData()
- ActionLayoutData(final String id)
+ ServiceActionLayoutData(final String objectType, final String id)
+
+ String getObjectType()
+
+ void setObjectType(final String objectType)
String getId() // <.>
@@ -30,18 +34,10 @@ class ActionLayoutData {
void setCssClassFa(String cssClassFa)
- CssClassFaPosition getCssClassFaPosition()
-
- void setCssClassFaPosition(CssClassFaPosition cssClassFaPosition)
-
String getDescribedAs()
void setDescribedAs(String describedAs)
- Where getHidden()
-
- void setHidden(Where hidden)
-
String getNamed()
void setNamed(String named)
@@ -50,21 +46,9 @@ class ActionLayoutData {
void setNamedEscaped(Boolean namedEscaped)
- org.apache.isis.applib.annotation.ActionLayout.Position getPosition()
-
- void setPosition(org.apache.isis.applib.annotation.ActionLayout.Position position)
+ ServiceActionLayoutDataOwner getOwner() // <.>
- PromptStyle getPromptStyle()
-
- void setPromptStyle(PromptStyle promptStyle)
-
- Redirect getRedirect()
-
- void setRedirect(Redirect redirect)
-
- ActionLayoutDataOwner getOwner() // <.>
-
- void setOwner(final ActionLayoutDataOwner owner)
+ void setOwner(final ServiceActionLayoutDataOwner owner)
String getMetadataError() // <.>
@@ -74,6 +58,8 @@ class ActionLayoutData {
void setLink(final Link link)
+ String getObjectTypeAndId()
+
String toString()
}
----
@@ -85,7 +71,7 @@ Method name.
Overloaded methods are not supported.
--
-<.> `[teal]#*getOwner*#()` : `ActionLayoutDataOwner`
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/component/ServiceActionLayoutDataOwner.adoc[ServiceActionLayoutDataOwner]`
+
--
Owner.
@@ -97,7 +83,7 @@ Set programmatically by framework after reading in from XML.
--
For diagnostics; populated by the framework if and only if a metadata error.
--
-<.> `[teal]#*getLink*#()` : `Link`
+<.> `[teal]#*getLink*#()` : `xref:system:generated:index/applib/layout/links/Link.adoc[Link]`
+
--
The link to access this resource from the REST API (Restful Objects viewer).
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutDataOwner.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutDataOwner.adoc
index 78f204d..7861793 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutDataOwner.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= ServiceActionLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface ServiceActionLayoutDataOwner {
- int compareTo(final ResourceCoordinates other)
+ List<ServiceActionLayoutData> getServiceActions()
+
+ void setServiceActions(List<ServiceActionLayoutData> actions)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/Grid.adoc
similarity index 51%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/Grid.adoc
index f147e5c..bc48d11 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/Grid.adoc
@@ -1,37 +1,34 @@
-= GridSystemService : _interface_
+= Grid : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+All top-level page layout classes should implement this interface.
+
+It is used by the xref:system:generated:index/applib/services/layout/LayoutService.adoc[LayoutService] as a common based type for any layouts read in from XML.
.Java Sources
[source,java]
----
-interface GridSystemService {
+interface Grid {
+
+ Class<?> getDomainClass()
+
+ void setDomainClass(final Class<?> domainClass)
- Class<G> gridImplementation() // <.>
+ String getTnsAndSchemaLocation()
- String tns()
+ void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
- String schemaLocation()
+ boolean isNormalized()
- G defaultGrid(Class<?> domainClass)
+ void setNormalized(final boolean normalized)
- void normalize(G grid, Class<?> domainClass) // <.>
+ LinkedHashMap<String, PropertyLayoutData> getAllPropertiesById()
- void complete(G grid, Class<?> domainClass)
+ LinkedHashMap<String, CollectionLayoutData> getAllCollectionsById()
- void minimal(G grid, Class<?> domainClass)
+ LinkedHashMap<String, ActionLayoutData> getAllActionsById()
+
+ void visit(final Grid.Visitor visitor)
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
-+
---
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/GridAbstract.adoc
similarity index 50%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/GridAbstract.adoc
index f147e5c..a05459d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/GridAbstract.adoc
@@ -1,37 +1,34 @@
-= GridSystemService : _interface_
+= GridAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+All top-level page layout classes should implement this interface.
+
+It is used by the xref:system:generated:index/applib/services/layout/LayoutService.adoc[LayoutService] as a common based type for any layouts read in from XML.
.Java Sources
[source,java]
----
-interface GridSystemService {
+class GridAbstract {
+
+ Class<?> getDomainClass()
+
+ void setDomainClass(final Class<?> domainClass)
- Class<G> gridImplementation() // <.>
+ String getTnsAndSchemaLocation()
- String tns()
+ void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
- String schemaLocation()
+ boolean isNormalized()
- G defaultGrid(Class<?> domainClass)
+ void setNormalized(final boolean normalized)
- void normalize(G grid, Class<?> domainClass) // <.>
+ LinkedHashMap<String, PropertyLayoutData> getAllPropertiesById()
- void complete(G grid, Class<?> domainClass)
+ LinkedHashMap<String, CollectionLayoutData> getAllCollectionsById()
- void minimal(G grid, Class<?> domainClass)
+ LinkedHashMap<String, ActionLayoutData> getAllActionsById()
+
+ LinkedHashMap<String, FieldSet> getAllFieldSetsByName()
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
-+
---
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc
index 78f204d..4f54214 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= BS3ClearFix : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class BS3ClearFix {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixHidden.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixHidden.adoc
index 78f204d..025aefe 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixHidden.adoc
@@ -1,12 +1,16 @@
-= ResourceCoordinates : _class_
+= BS3ClearFixHidden : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+One of theResponsive utility classes.
+
+It is rendered as a (eg) <div class="clearfix hidden-xs ...">
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class BS3ClearFixHidden {
- int compareTo(final ResourceCoordinates other)
+ String toCssClass()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixVisible.adoc
similarity index 75%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixVisible.adoc
index ba495fc..ae99ae6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixVisible.adoc
@@ -1,20 +1,20 @@
-= MenuBarsService : _interface_
+= BS3ClearFixVisible : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+One of theResponsive utility classes.
+
+It is rendered as a (eg) <div class="clearfix visible-xs-block ...">
+
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class BS3ClearFixVisible {
- MenuBars menuBars() // <.>
+ CssDisplay getCssDisplay()
- MenuBars menuBars(final Type type)
+ void setCssDisplay(final CssDisplay cssDisplay)
+
+ String toCssClass()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Col.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Col.adoc
new file mode 100644
index 0000000..e63d09b
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Col.adoc
@@ -0,0 +1,98 @@
+= BS3Col : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+A column within a row which, depending on its _#getSpan()_ , could be as narrow as 1/12th of the page's width, all the way up to spanning the entire page.
+
+Pretty much other content can be contained within a column, though most commonly it will be xref:system:generated:index/applib/layout/component/FieldSet.adoc[FieldSet] s (a group of properties) or xref:system:generated:index/applib/layout/component/CollectionLayoutData.adoc[CollectionLayoutData] s. However, columns can also be used to contain further xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Row.adoc[BS3Row] s (creating a nested grid of rows/cols/rows/cols) and xref:sy [...]
+
+It is rendered as a (eg) <div class="col-md-4 ...">
+
+.Java Sources
+[source,java]
+----
+class BS3Col {
+
+ String getId() // <.>
+
+ void setId(final String id)
+
+ int getSpan()
+
+ void setSpan(final int span)
+
+ Boolean isUnreferencedActions() // <.>
+
+ void setUnreferencedActions(final Boolean unreferencedActions)
+
+ Boolean isUnreferencedCollections() // <.>
+
+ void setUnreferencedCollections(final Boolean unreferencedCollections)
+
+ DomainObjectLayoutData getDomainObject() // <.>
+
+ void setDomainObject(final DomainObjectLayoutData domainObjectLayoutData)
+
+ List<SizeSpan> getSizeSpans()
+
+ void setSizeSpans(final List<SizeSpan> sizeSpans)
+
+ List<ActionLayoutData> getActions()
+
+ void setActions(final List<ActionLayoutData> actions)
+
+ List<BS3Row> getRows()
+
+ void setRows(final List<BS3Row> rows)
+
+ List<BS3TabGroup> getTabGroups()
+
+ void setTabGroups(final List<BS3TabGroup> tabGroups)
+
+ List<FieldSet> getFieldSets()
+
+ void setFieldSets(final List<FieldSet> fieldSets)
+
+ List<CollectionLayoutData> getCollections()
+
+ void setCollections(final List<CollectionLayoutData> collections)
+
+ String getMetadataError() // <.>
+
+ void setMetadataError(final String metadataError)
+
+ String toCssClass()
+
+ String toString()
+}
+----
+
+<.> `[teal]#*getId*#()` : `String`
++
+--
+As per <div id="...">...</div> : must be unique across entire page.
+--
+<.> `[teal]#*isUnreferencedActions*#()` : `Boolean`
++
+--
+Whether this column should be used to hold any unreferenced actions (contributed or "native").
+
+Any layout must have precisely one column or xref:system:generated:index/applib/layout/component/FieldSet.adoc[FieldSet] that has this attribute set.
+--
+<.> `[teal]#*isUnreferencedCollections*#()` : `Boolean`
++
+--
+Whether this column should be used to hold any unreferenced collections (contributed or "native").
+
+Any layout must have precisely one column or xref:system:generated:index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc[BS3TabGroup] that has this attribute set.
+--
+<.> `[teal]#*getDomainObject*#()` : `xref:system:generated:index/applib/layout/component/DomainObjectLayoutData.adoc[DomainObjectLayoutData]`
++
+--
+Whether to show the object's icon and title.
+--
+<.> `[teal]#*getMetadataError*#()` : `String`
++
+--
+For diagnostics; populated by the framework if and only if a metadata error.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Element.adoc
similarity index 72%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Element.adoc
index ba495fc..b585b68 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Element.adoc
@@ -1,20 +1,20 @@
-= MenuBarsService : _interface_
+= BS3Element : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+interface BS3Element {
- MenuBars menuBars() // <.>
+ String getCssClass() // <.>
- MenuBars menuBars(final Type type)
+ void setCssClass(final String cssClass)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
+<.> `[teal]#*getCssClass*#()` : `String`
+
--
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
+Any additional CSS classes to render on the page element corresponding to this object, eg as per theBootstrap mixinsor just for custom styling.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ElementAbstract.adoc
similarity index 66%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ElementAbstract.adoc
index 505d2bc..ca5302a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ElementAbstract.adoc
@@ -1,25 +1,22 @@
-= MenuBarsLoaderService : _interface_
+= BS3ElementAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Superclass for all layout classes, factoring out the common _#getCssClass()_ attribute.
+
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
+class BS3ElementAbstract {
- boolean supportsReloading() // <.>
+ String getCssClass() // <.>
- BS3MenuBars menuBars() // <.>
+ void setCssClass(final String cssClass)
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
-+
---
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
+<.> `[teal]#*getCssClass*#()` : `String`
+
--
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+Any additional CSS classes to render on the page element corresponding to this object, eg as per theBootstrap mixinsor just for custom styling.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Grid.adoc
similarity index 52%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Grid.adoc
index f147e5c..30188f3 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Grid.adoc
@@ -1,37 +1,40 @@
-= GridSystemService : _interface_
+= BS3Grid : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+This is the top-level for rendering the domain object's properties, collections and actions. It simply consists of a number of rows.
+
+The element is rendered as a <div class="...">
.Java Sources
[source,java]
----
-interface GridSystemService {
+class BS3Grid {
+
+ String getCssClass()
+
+ void setCssClass(final String cssClass)
+
+ List<BS3Row> getRows()
- Class<G> gridImplementation() // <.>
+ void setRows(final List<BS3Row> rows)
- String tns()
+ List<String> getMetadataErrors() // <.>
- String schemaLocation()
+ void setMetadataErrors(final List<String> metadataErrors)
- G defaultGrid(Class<?> domainClass)
+ void visit(final Grid.Visitor visitor)
- void normalize(G grid, Class<?> domainClass) // <.>
+ LinkedHashMap<String, BS3Tab> getAllTabsByName()
- void complete(G grid, Class<?> domainClass)
+ LinkedHashMap<String, HasCssId> getAllCssId()
- void minimal(G grid, Class<?> domainClass)
+ BS3Grid getGrid()
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
+<.> `[teal]#*getMetadataErrors*#()` : `List<String>`
+
--
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
+For diagnostics; populated by the framework if and only if a metadata error.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Row.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Row.adoc
new file mode 100644
index 0000000..10bb685
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Row.adoc
@@ -0,0 +1,52 @@
+= BS3Row : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Contains a row of content, either on the top-level xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Grid.adoc[BS3Grid] or at any other lower-level element that can contain rows, eg xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Tab.adoc[BS3Tab] .
+
+It is rendered as a <div class="row ...">
+
+.Java Sources
+[source,java]
+----
+class BS3Row {
+
+ String getId() // <.>
+
+ void setId(final String id)
+
+ List<BS3RowContent> getCols()
+
+ void setCols(final List<BS3RowContent> cols)
+
+ String getMetadataError() // <.>
+
+ void setMetadataError(final String metadataError)
+
+ BS3RowOwner getOwner() // <.>
+
+ void setOwner(final BS3RowOwner owner)
+
+ BS3Grid getGrid()
+
+ String toString()
+}
+----
+
+<.> `[teal]#*getId*#()` : `String`
++
+--
+As per <div id="...">...</div> : must be unique across entire page.
+--
+<.> `[teal]#*getMetadataError*#()` : `String`
++
+--
+For diagnostics; populated by the framework if and only if a metadata error.
+--
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc[BS3RowOwner]`
++
+--
+Owner.
+
+Set programmatically by framework after reading in from XML.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContent.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContent.adoc
new file mode 100644
index 0000000..2c01dbc
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContent.adoc
@@ -0,0 +1,37 @@
+= BS3RowContent : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Common superclass for any content of a row.
+
+Most commonly the content of a row is xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Col.adoc[BS3Col] umns, but it may be either of the xref:system:generated:index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc[BS3ClearFix] classes.
+
+.Java Sources
+[source,java]
+----
+class BS3RowContent {
+
+ Size getSize() // <.>
+
+ void setSize(final Size size)
+
+ BS3RowContentOwner getOwner() // <.>
+
+ void setOwner(final BS3RowContentOwner owner)
+
+ BS3Grid getGrid()
+}
+----
+
+<.> `[teal]#*getSize*#()` : `xref:system:generated:index/applib/layout/grid/bootstrap3/Size.adoc[Size]`
++
+--
+Default if not specified is _Size#MD_ .
+--
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc[BS3RowContentOwner]`
++
+--
+Owner.
+
+Set programmatically by framework after reading in from XML.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc
index 78f204d..6f27e5d 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= BS3RowContentOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+interface BS3RowContentOwner {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc
index 78f204d..d4ccdb0 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= BS3RowOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface BS3RowOwner {
- int compareTo(final ResourceCoordinates other)
+ List<BS3Row> getRows()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Tab.adoc
similarity index 54%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Tab.adoc
index f147e5c..7b8afd0 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Tab.adoc
@@ -1,37 +1,38 @@
-= GridSystemService : _interface_
+= BS3Tab : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+Represents a tab within a xref:system:generated:index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc[BS3TabGroup] .
+
+They simply contain one or more xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Row.adoc[BS3Row] s.
.Java Sources
[source,java]
----
-interface GridSystemService {
+class BS3Tab {
+
+ String getName()
- Class<G> gridImplementation() // <.>
+ void setName(final String name)
- String tns()
+ List<BS3Row> getRows()
- String schemaLocation()
+ void setRows(final List<BS3Row> rows)
- G defaultGrid(Class<?> domainClass)
+ BS3TabOwner getOwner() // <.>
- void normalize(G grid, Class<?> domainClass) // <.>
+ void setOwner(final BS3TabOwner owner)
- void complete(G grid, Class<?> domainClass)
+ BS3Grid getGrid()
- void minimal(G grid, Class<?> domainClass)
+ String toString()
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc[BS3TabOwner]`
+
--
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
+Owner.
+
+Set programmatically by framework after reading in from XML.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc
new file mode 100644
index 0000000..1b1e76e
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc
@@ -0,0 +1,59 @@
+= BS3TabGroup : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Represents a tab group containing one or more xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Tab.adoc[BS3Tab] s.
+
+.Java Sources
+[source,java]
+----
+class BS3TabGroup {
+
+ Boolean isUnreferencedCollections() // <.>
+
+ void setUnreferencedCollections(final Boolean unreferencedCollections)
+
+ Boolean isCollapseIfOne() // <.>
+
+ void setCollapseIfOne(final Boolean collapseIfOne)
+
+ List<BS3Tab> getTabs()
+
+ void setTabs(final List<BS3Tab> tabs)
+
+ BS3TabGroupOwner getOwner() // <.>
+
+ void setOwner(final BS3TabGroupOwner owner)
+
+ String getMetadataError() // <.>
+
+ void setMetadataError(final String metadataError)
+
+ BS3Grid getGrid()
+}
+----
+
+<.> `[teal]#*isUnreferencedCollections*#()` : `Boolean`
++
+--
+Whether this tab group should be used to hold any unreferenced collections (contributed or "native").
+
+Any layout must have precisely one tab group or xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Col.adoc[BS3Col] that has this attribute set.
+--
+<.> `[teal]#*isCollapseIfOne*#()` : `Boolean`
++
+--
+If there is a single tab in the tabgroup, then whether to collapse and render without the outer tab.
+--
+<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc[BS3TabGroupOwner]`
++
+--
+Owner.
+
+Set programmatically by framework after reading in from XML.
+--
+<.> `[teal]#*getMetadataError*#()` : `String`
++
+--
+For diagnostics; populated by the framework if and only if a metadata error.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc
index 78f204d..7289758 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= BS3TabGroupOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface BS3TabGroupOwner {
- int compareTo(final ResourceCoordinates other)
+ List<BS3TabGroup> getTabGroups()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc
index 78f204d..0dc816c 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= BS3TabOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface BS3TabOwner {
- int compareTo(final ResourceCoordinates other)
+ List<BS3Tab> getTabs()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/Size.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/Size.adoc
index 78f204d..6370e12 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/Size.adoc
@@ -1,12 +1,22 @@
-= ResourceCoordinates : _class_
+= Size : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+As pergrid options, also used inresponsive utilityclasses.
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+enum Size {
+
+ XS
+
+ SM
+
+ MD
+
+ LG
- int compareTo(final ResourceCoordinates other)
+ String toCssClassFragment()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/SizeSpan.adoc
similarity index 67%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/SizeSpan.adoc
index dcdaf9a..bf6195ae 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/SizeSpan.adoc
@@ -1,28 +1,30 @@
-= EntityState : _enum_
+= SizeSpan : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+class SizeSpan {
+
+ SizeSpan with(final Size size, final int span)
+
+ SizeSpan offset(final Size size, final int span)
- NOT_PERSISTABLE
+ Size getSize()
- PERSISTABLE_ATTACHED
+ void setSize(final Size size)
- PERSISTABLE_DETACHED
+ int getSpan()
- PERSISTABLE_DESTROYED
+ void setSpan(final int span)
- boolean isPersistable()
+ Boolean isOffset()
- boolean isAttached()
+ void setOffset(final Boolean offset)
- boolean isDetached()
+ String toCssClassFragment()
- boolean isDestroyed()
+ StringBuilder appendCssClassFragment(final StringBuilder buf)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/WithinGrid.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/WithinGrid.adoc
index 78f204d..d54c6f5 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/WithinGrid.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= WithinGrid : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface WithinGrid {
- int compareTo(final ResourceCoordinates other)
+ BS3Grid getGrid()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/links/Link.adoc
similarity index 78%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/links/Link.adoc
index 78f204d..2c1780f 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/links/Link.adoc
@@ -1,12 +1,24 @@
-= ResourceCoordinates : _class_
+= Link : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Link {
- int compareTo(final ResourceCoordinates other)
+ Link()
+
+ Link(final String rel, final String method, final String href, final String type)
+
+ String getRel()
+
+ String getMethod()
+
+ String getHref()
+
+ String getType()
+
+ String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/HasNamed.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/HasNamed.adoc
index 78f204d..9ddc7d8 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/HasNamed.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= HasNamed : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface HasNamed {
- int compareTo(final ResourceCoordinates other)
+ String getNamed()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/Menu.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/Menu.adoc
index 78f204d..abcfce2 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/Menu.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= Menu : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+interface Menu {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBar.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBar.adoc
index 78f204d..4093673 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBar.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= MenuBar : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+interface MenuBar {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBars.adoc
similarity index 71%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBars.adoc
index dcdaf9a..0fa49ef 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBars.adoc
@@ -1,28 +1,20 @@
-= EntityState : _enum_
+= MenuBars : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
+interface MenuBars {
- PERSISTABLE_DESTROYED
+ String getTnsAndSchemaLocation()
- boolean isPersistable()
+ void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
- boolean isAttached()
+ MenuBar menuBarFor(DomainServiceLayout.MenuBar menuBar)
- boolean isDetached()
+ void visit(Visitor visitor)
- boolean isDestroyed()
+ Map<String, ServiceActionLayoutData> getAllServiceActionsByObjectTypeAndId()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBarsAbstract.adoc
similarity index 76%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBarsAbstract.adoc
index ba495fc..0b26941 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBarsAbstract.adoc
@@ -1,20 +1,16 @@
-= MenuBarsService : _interface_
+= MenuBarsAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class MenuBarsAbstract {
- MenuBars menuBars() // <.>
+ String getTnsAndSchemaLocation()
- MenuBars menuBars(final Type type)
+ void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
+
+ LinkedHashMap<String, ServiceActionLayoutData> getAllServiceActionsByObjectTypeAndId()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuSection.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuSection.adoc
index 78f204d..39b5ac1 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuSection.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= MenuSection : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface MenuSection {
- int compareTo(final ResourceCoordinates other)
+ List<ServiceActionLayoutData> getServiceActions()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3Menu.adoc
similarity index 50%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3Menu.adoc
index f147e5c..9953dca 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3Menu.adoc
@@ -1,37 +1,38 @@
-= GridSystemService : _interface_
+= BS3Menu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+Describes the collection of domain services into menubars, broadly corresponding to the aggregation of information of xref:system:generated:index/applib/annotation/DomainServiceLayout.adoc[DomainServiceLayout] that have the same value of _DomainServiceLayout#named()_ .
.Java Sources
[source,java]
----
-interface GridSystemService {
+class BS3Menu {
- Class<G> gridImplementation() // <.>
+ BS3Menu()
- String tns()
+ BS3Menu(String named)
- String schemaLocation()
+ String getNamed()
- G defaultGrid(Class<?> domainClass)
+ void setNamed(String named)
- void normalize(G grid, Class<?> domainClass) // <.>
+ String getCssClassFa()
- void complete(G grid, Class<?> domainClass)
+ void setCssClassFa(final String cssClassFa)
- void minimal(G grid, Class<?> domainClass)
+ List<BS3MenuSection> getSections()
+
+ Boolean isUnreferencedActions() // <.>
+
+ void setUnreferencedActions(final Boolean unreferencedActions)
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
+<.> `[teal]#*isUnreferencedActions*#()` : `Boolean`
+
--
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
+Whether this menu should be used to hold any unreferenced actions.
+
+Any menubars layout must have precisely one menu that has this attribute set.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc
similarity index 67%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc
index dcdaf9a..2f3fa53 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc
@@ -1,28 +1,18 @@
-= EntityState : _enum_
+= BS3MenuBar : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+Describes the collection of domain services into menubars, broadly corresponding to the aggregation of information of xref:system:generated:index/applib/annotation/DomainServiceLayout.adoc[DomainServiceLayout] that have the same value of _DomainServiceLayout#named()_ .
.Java Sources
[source,java]
----
-enum EntityState {
+class BS3MenuBar {
- NOT_PERSISTABLE
+ BS3MenuBar()
- PERSISTABLE_ATTACHED
+ List<BS3Menu> getMenus()
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ void setMenus(List<BS3Menu> menus)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc
similarity index 50%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc
index f147e5c..84adb3c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc
@@ -1,37 +1,40 @@
-= GridSystemService : _interface_
+= BS3MenuBars : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+Describes the collection of domain services into menubars, broadly corresponding to the aggregation of information within xref:system:generated:index/applib/annotation/DomainServiceLayout.adoc[DomainServiceLayout] .
.Java Sources
[source,java]
----
-interface GridSystemService {
+class BS3MenuBars {
- Class<G> gridImplementation() // <.>
+ BS3MenuBars()
- String tns()
+ BS3MenuBar getPrimary()
- String schemaLocation()
+ void setPrimary(final BS3MenuBar primary)
- G defaultGrid(Class<?> domainClass)
+ BS3MenuBar getSecondary()
- void normalize(G grid, Class<?> domainClass) // <.>
+ void setSecondary(final BS3MenuBar secondary)
- void complete(G grid, Class<?> domainClass)
+ BS3MenuBar getTertiary()
- void minimal(G grid, Class<?> domainClass)
+ void setTertiary(final BS3MenuBar tertiary)
+
+ BS3MenuBar menuBarFor(final DomainServiceLayout.MenuBar menuBar)
+
+ void visit(final MenuBars.Visitor visitor)
+
+ String getMetadataError() // <.>
+
+ void setMetadataError(final String metadataError)
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
+<.> `[teal]#*getMetadataError*#()` : `String`
+
--
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
+For diagnostics; populated by the framework if and only if a metadata error.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuSection.adoc
similarity index 65%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuSection.adoc
index dcdaf9a..d9600d9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuSection.adoc
@@ -1,28 +1,22 @@
-= EntityState : _enum_
+= BS3MenuSection : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+Corresponds to a domain service that contributes its serviceActions under a particular xref:system:generated:index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc[BS3MenuBar] .
.Java Sources
[source,java]
----
-enum EntityState {
+class BS3MenuSection {
- NOT_PERSISTABLE
+ BS3MenuSection()
- PERSISTABLE_ATTACHED
+ String getNamed()
- PERSISTABLE_DETACHED
+ void setNamed(String named)
- PERSISTABLE_DESTROYED
+ List<ServiceActionLayoutData> getServiceActions()
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ void setServiceActions(List<ServiceActionLayoutData> actionLayoutDatas)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/MixinConstants.adoc
similarity index 78%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/MixinConstants.adoc
index 78f204d..5b163f9 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/MixinConstants.adoc
@@ -1,12 +1,16 @@
-= ResourceCoordinates : _class_
+= MixinConstants : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class MixinConstants {
- int compareTo(final ResourceCoordinates other)
+ public static final String METADATA_LAYOUT_GROUPNAME;
+
+ public static final String FILENAME_PROPERTY_NAME;
+
+ public static final String FILENAME_PROPERTY_DESCRIPTION;
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto.adoc
index 78f204d..1b6a383 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= Dto : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+interface Dto {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXml.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXml.adoc
index 78f204d..b5d3c5c 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXml.adoc
@@ -1,12 +1,17 @@
-= ResourceCoordinates : _class_
+= Dto_downloadXml : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Dto_downloadXml {
- int compareTo(final ResourceCoordinates other)
+ @Inject
+JaxbService jaxbService;
+
+ Object act(final String fileName)
+
+ String default0Act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXsd.adoc
similarity index 74%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXsd.adoc
index ba495fc..5d803d1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXsd.adoc
@@ -1,20 +1,22 @@
-= MenuBarsService : _interface_
+= Dto_downloadXsd : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class Dto_downloadXsd {
- MenuBars menuBars() // <.>
+ @Inject
+MessageService messageService;
- MenuBars menuBars(final Type type)
+ @Inject
+JaxbService jaxbService;
+
+ Object act(final String fileName, final JaxbService.IsisSchemas isisSchemas)
+
+ String default0Act()
+
+ JaxbService.IsisSchemas default1Act()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_downloadLayoutXml.adoc
similarity index 77%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_downloadLayoutXml.adoc
index ba495fc..f57ab4c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_downloadLayoutXml.adoc
@@ -1,20 +1,19 @@
-= MenuBarsService : _interface_
+= Object_downloadLayoutXml : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class Object_downloadLayoutXml {
- MenuBars menuBars() // <.>
+ @Inject
+LayoutService layoutService;
- MenuBars menuBars(final Type type)
+ Object act(final String fileName, final LayoutService.Style style)
+
+ String default0Act()
+
+ LayoutService.Style default1Act()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_openRestApi.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_openRestApi.adoc
index 78f204d..5535433 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_openRestApi.adoc
@@ -1,12 +1,18 @@
-= ResourceCoordinates : _class_
+= Object_openRestApi : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Object_openRestApi {
- int compareTo(final ResourceCoordinates other)
+ @Inject
+BookmarkService bookmarkService;
+
+ @Inject
+RestfulPathProvider restfulPathProvider;
+
+ LocalResourcePath act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_rebuildMetamodel.adoc
similarity index 86%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_rebuildMetamodel.adoc
index 78f204d..7f66f5c 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_rebuildMetamodel.adoc
@@ -1,12 +1,15 @@
-= ResourceCoordinates : _class_
+= Object_rebuildMetamodel : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Object_rebuildMetamodel {
- int compareTo(final ResourceCoordinates other)
+ @Inject
+MetaModelService metaModelService;
+
+ Object act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_downloadMetamodelXml.adoc
similarity index 74%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_downloadMetamodelXml.adoc
index ba495fc..c6834a5 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_downloadMetamodelXml.adoc
@@ -1,20 +1,23 @@
-= MenuBarsService : _interface_
+= Object_downloadMetamodelXml : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class Object_downloadMetamodelXml {
- MenuBars menuBars() // <.>
+ @Inject
+MetaModelService metaModelService;
- MenuBars menuBars(final Type type)
+ @Inject
+JaxbService jaxbService;
+
+ @Inject
+MetaModelServiceMenu metaModelServiceMenu;
+
+ Object act(final String fileName)
+
+ String default0Act()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectIdentifier.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectIdentifier.adoc
index 78f204d..cb0681c 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectIdentifier.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= Object_objectIdentifier : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Object_objectIdentifier {
- int compareTo(final ResourceCoordinates other)
+ String prop()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectType.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectType.adoc
index 78f204d..b01c134 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectType.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= Object_objectType : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Object_objectType {
- int compareTo(final ResourceCoordinates other)
+ String prop()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_lookup.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_lookup.adoc
index 78f204d..07df383 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_lookup.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= BookmarkHolder_lookup : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class BookmarkHolder_lookup {
- int compareTo(final ResourceCoordinates other)
+ Object act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_object.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_object.adoc
index 78f204d..78a10b7 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_object.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= BookmarkHolder_object : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class BookmarkHolder_object {
- int compareTo(final ResourceCoordinates other)
+ Object prop()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForActionAbstract.adoc
similarity index 83%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForActionAbstract.adoc
index 78f204d..cc5c9c4 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForActionAbstract.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= CommandDtoProcessorForActionAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Convenience adapter for command processors for action invocations.
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class CommandDtoProcessorForActionAbstract {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForPropertyAbstract.adoc
similarity index 83%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForPropertyAbstract.adoc
index 78f204d..1bec0cb 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForPropertyAbstract.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= CommandDtoProcessorForPropertyAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Convenience adapter for command processors for property edits.
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class CommandDtoProcessorForPropertyAbstract {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationMenu.adoc
similarity index 82%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationMenu.adoc
index 78f204d..5a1326b 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationMenu.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= ConfigurationMenu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class ConfigurationMenu {
- int compareTo(final ResourceCoordinates other)
+ ConfigurationMenu(ConfigurationViewService configurationService)
+
+ Set<ConfigurationProperty> configuration()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/error/SimpleTicket.adoc b/antora/components/system/modules/generated/pages/index/applib/services/error/SimpleTicket.adoc
new file mode 100644
index 0000000..a9867dc
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/services/error/SimpleTicket.adoc
@@ -0,0 +1,47 @@
+= SimpleTicket : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Response from the xref:system:generated:index/applib/services/error/ErrorReportingService.adoc[ErrorReportingService] , containing information to show to the end-user.
+
+Implementation notes:
+
+* a class has been used here so that additional fields might be added in the future.
+* the class is _Serializable_
+
+so that it can be stored by the Wicket viewer as a Wicket model.
+
+.Java Sources
+[source,java]
+----
+class SimpleTicket {
+
+ SimpleTicket(final String reference, final String userMessage, final String details)
+
+ SimpleTicket(final String reference, final String userMessage, final String details, final StackTracePolicy stackTracePolicy)
+
+ SimpleTicket(final String reference, final String userMessage, final String details, final String kittenUrl)
+
+ SimpleTicket(final String reference, final String userMessage, final String details, final StackTracePolicy stackTracePolicy, final String kittenUrl)
+
+ String getReference()
+
+ String getUserMessage()
+
+ String getDetails()
+
+ StackTracePolicy getStackTracePolicy()
+
+ String getKittenUrl() // <.>
+
+ String getMarkup()
+}
+----
+
+<.> `[teal]#*getKittenUrl*#()` : `String`
++
+--
+If specified, is the external URL of an image to display to the end user.
+
+Not necessarily of a kitten, but something by way of an apology.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerAbstract.adoc
new file mode 100644
index 0000000..4ebf6c0
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerAbstract.adoc
@@ -0,0 +1,24 @@
+= ExceptionRecognizerAbstract : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Abstract implementation of xref:system:generated:index/applib/services/exceprecog/ExceptionRecognizer.adoc[ExceptionRecognizer] that looks exceptions meeting the _Predicate_ supplied in the constructor and, if found anywhere in the causal chain, then returns a non-null message indicating that the exception has been recognized.
+
+If a messaging-parsing _Function_ is provided through the constructor, then the message can be altered. Otherwise the exception's _Throwable#getMessage() message_ is returned as-is.
+
+.Java Sources
+[source,java]
+----
+class ExceptionRecognizerAbstract {
+
+ ExceptionRecognizerAbstract(final Category category, Predicate<Throwable> predicate, final Function<String, String> messageParser)
+
+ ExceptionRecognizerAbstract(Predicate<Throwable> predicate, final Function<String, String> messageParser)
+
+ ExceptionRecognizerAbstract(Category category, Predicate<Throwable> predicate)
+
+ ExceptionRecognizerAbstract(Predicate<Throwable> predicate)
+
+ Optional<Recognition> recognize(Throwable ex)
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc
index 66e314b..d5224f2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc
@@ -33,14 +33,14 @@ To support metamodel invalidation/rebuilding of spec.
--
Whether any persisted layout metadata (eg a.layout.xmlfile) exists for this domain class.
--
-<.> `[teal]#*load*#(Class<?> domainClass)` : `Grid`
+<.> `[teal]#*load*#(Class<?> domainClass)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a _Grid_ for the specified domain class, eg from alayout.xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from alayout.xmlfile, elsenull.
--
-<.> `[teal]#*load*#(Class<?> domainClass, String layout)` : `Grid`
+<.> `[teal]#*load*#(Class<?> domainClass, String layout)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a _Grid_ for the specified domain class, eg from alayout.xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from alayout.xmlfile, elsenull.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc
index 2da9b24..4fc353f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc
@@ -41,39 +41,39 @@ To support metamodel invalidation/rebuilding of spec.
--
Whether any persisted layout metadata (eg a.layout.xmlfile) exists for this domain class.
--
-<.> `[teal]#*load*#(Class<?> domainClass)` : `Grid`
+<.> `[teal]#*load*#(Class<?> domainClass)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a _Grid_ for the specified domain class, eg from alayout.xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from alayout.xmlfile, elsenull.
--
-<.> `[teal]#*load*#(Class<?> domainClass, String layout)` : `Grid`
+<.> `[teal]#*load*#(Class<?> domainClass, String layout)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a _Grid_ for the specified domain class, eg from a[domainClass].layout.[layout].xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from a[domainClass].layout.[layout].xmlfile, elsenull.
--
-<.> `[teal]#*defaultGridFor*#(Class<?> domainClass)` : `Grid`
+<.> `[teal]#*defaultGridFor*#(Class<?> domainClass)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
Returns a default grid; eg where none can be loaded using _#load(Class)_ .
--
-<.> `[teal]#*normalize*#(Grid grid)` : `Grid`
+<.> `[teal]#*normalize*#(xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] grid)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
Returns a normalized grid for the domain class obtained previously using _#load(Class)_ .
If a "normalized" grid is persisted as thelayout.xml, then the expectation is that the xref:system:generated:index/applib/annotation/MemberOrder.adoc[MemberOrder] annotation can be removed from the domain class because the binding of properties/collections/actions will be within the XML. However, the layout annotations ( xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] [...]
--
-<.> `[teal]#*complete*#(Grid grid)` : `Grid`
+<.> `[teal]#*complete*#(xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] grid)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Modifies the provided _Grid_ with additional metadata, broadly speaking corresponding to the xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] , xref:system:generated:index/applib/annotation/PropertyLayout.adoc[PropertyLayout] and xref:system:generated:index/applib/annotation/CollectionLayout.adoc[CollectionLayout] .
+Modifies the provided xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] with additional metadata, broadly speaking corresponding to the xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] , xref:system:generated:index/applib/annotation/PropertyLayout.adoc[PropertyLayout] and xref:system:generated:index/applib/annotation/CollectionLayout.adoc[CollectionLayout] .
If a "completed" grid is persisted as thelayout.xml, then there should be no need for any of the layout annotations, nor the xref:system:generated:index/applib/annotation/MemberOrder.adoc[MemberOrder] annotations, to be required in the domain class itself.
--
-<.> `[teal]#*minimal*#(Grid grid)` : `Grid`
+<.> `[teal]#*minimal*#(xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] grid)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Modifies the provided _Grid_ , removing all metadata except the basic grid structure.
+Modifies the provided xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] , removing all metadata except the basic grid structure.
If a "minimal" grid is persisted as thelayout.xml, then the expectation is that most of the layout annotations ( xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] , xref:system:generated:index/applib/annotation/PropertyLayout.adoc[PropertyLayout] , xref:system:generated:index/applib/annotation/CollectionLayout.adoc[CollectionLayout] , but also xref:system:generated:inde [...]
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
index f147e5c..c5ac8d6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
@@ -1,7 +1,7 @@
= GridSystemService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+Provides an implementation of xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] .
.Java Sources
[source,java]
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc
index 705d42b..91564f6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc
@@ -62,7 +62,7 @@ The arguments; excluded from _#equals(Object)_ comparison.
<.> `[teal]#*translate*#(xref:system:generated:index/applib/services/i18n/TranslationService.adoc[TranslationService] translationService, String context)` : `String`
+
--
-Translates this string using the provided _org.apache.isis.applib.services.i18n.TranslationService_ , selecting either the single or plural form as per _#getPattern()_ .
+Translates this string using the provided xref:system:generated:index/applib/services/i18n/TranslationService.adoc[TranslationService] , selecting either the single or plural form as per _#getPattern()_ .
--
<.> `[teal]#*getPattern*#()` : `String`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
index 505d2bc..9c179ab 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
@@ -17,9 +17,9 @@ interface MenuBarsLoaderService {
--
Whether dynamic reloading of layouts is enabled.
--
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
+<.> `[teal]#*menuBars*#()` : `xref:system:generated:index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc[BS3MenuBars]`
+
--
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+Returns a new instance of a xref:system:generated:index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc[BS3MenuBars] , else `null` .
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
index ba495fc..0e6f0f6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
@@ -12,7 +12,7 @@ interface MenuBarsService {
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
+<.> `[teal]#*menuBars*#()` : `xref:system:generated:index/applib/layout/menubars/MenuBars.adoc[MenuBars]`
+
--
Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
index dcdaf9a..7d5acf9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
@@ -1,8 +1,6 @@
= EntityState : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderForCollectionTypeAbstract.adoc
similarity index 70%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderForCollectionTypeAbstract.adoc
index dcdaf9a..78a8791 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderForCollectionTypeAbstract.adoc
@@ -1,28 +1,14 @@
-= EntityState : _enum_
+= TableColumnOrderForCollectionTypeAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
+class TableColumnOrderForCollectionTypeAbstract {
- boolean isDetached()
+ List<String> orderParented(final Object parent, final String collectionId, final Class<?> collectionType, final List<String> propertyIds)
- boolean isDestroyed()
+ List<String> orderStandalone(final Class<?> collectionType, final List<String> propertyIds)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingServiceUsingBaseEncodingAbstract.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingServiceUsingBaseEncodingAbstract.adoc
index 78f204d..6d447d7 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingServiceUsingBaseEncodingAbstract.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= UrlEncodingServiceUsingBaseEncodingAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class UrlEncodingServiceUsingBaseEncodingAbstract {
- int compareTo(final ResourceCoordinates other)
+ String encode(final byte[] bytes)
+
+ byte[] decode(final String str)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc
index b4f2b89..d4884b4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc
@@ -3,7 +3,7 @@
The xref:system:generated:index/applib/services/user/UserService.adoc[UserService] allows the domain object to obtain the identity of the user interacting with said object.
-If xref:system:generated:index/applib/services/sudo/SudoService.adoc[SudoService] has been used to temporarily override the user and/or roles, then this service will report the overridden values instead.
+If _SudoService_ has been used to temporarily override the user and/or roles, then this service will report the overridden values instead.
.Java Sources
[source,java]
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailEventAbstract.adoc
similarity index 72%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailEventAbstract.adoc
index dcdaf9a..3e5f9fb 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailEventAbstract.adoc
@@ -1,28 +1,20 @@
-= EntityState : _enum_
+= EmailEventAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+An event sent to all services interested in user registration
.Java Sources
[source,java]
----
-enum EntityState {
+class EmailEventAbstract {
- NOT_PERSISTABLE
+ EmailEventAbstract(final String email, final String confirmationUrl, final String applicationName)
- PERSISTABLE_ATTACHED
+ String getEmail()
- PERSISTABLE_DETACHED
+ String getConfirmationUrl()
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ String getApplicationName()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/WrappingObject.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/WrappingObject.adoc
index a719fc8..00a88b5 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/WrappingObject.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/WrappingObject.adoc
@@ -37,7 +37,7 @@ NOTE: domain classes may not have a method with this name. The `__isis_` prefix
<.> `[teal]#*__isis_executionModes*#()` : `ImmutableEnumSet<xref:system:generated:index/applib/services/wrapper/control/ExecutionMode.adoc[ExecutionMode]>`
+
--
-The _EnumSetexecution modes_ inferred from the xref:system:generated:index/applib/services/wrapper/control/SyncControl.adoc[SyncControl] with which this wrapper was _WrapperFactory#wrap(Object, SyncControl) created_ .
+The _EnumSetexecution modes_ inferred from the _SyncControl_ with which this wrapper was _WrapperFactory#wrap(Object, SyncControl) created_ .
NOTE: domain classes may not have a method with this name. The `__isis_` prefix is intended to reduce the risk of a collision.
--
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/control/ExceptionHandlerAbstract.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/wrapper/control/ExceptionHandlerAbstract.adoc
index 78f204d..e69bd69 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/control/ExceptionHandlerAbstract.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= ExceptionHandlerAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class ExceptionHandlerAbstract {
- int compareTo(final ResourceCoordinates other)
+ Logger getLog()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/AccessEvent.adoc
similarity index 55%
copy from antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
copy to antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/AccessEvent.adoc
index 7747117..4bd7a23 100644
--- a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/AccessEvent.adoc
@@ -1,16 +1,16 @@
-= AbstractViewModel : _class_
+= AccessEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Convenience super class for view models that wish to interact with the container.
+ _Supported only by _org.apache.isis.applib.services.wrapper.WrapperFactory_ service,_ represents an access (reading) of a property, collection or title.
-Subclassing is NOT mandatory; the methods in this superclass can be pushed down into domain objects and another superclass used if required.
-
-As an alternative, consider simply annotating the view model class with _org.apache.isis.applib.annotation.ViewModel_ .
+Analogous to xref:system:generated:index/applib/services/wrapper/events/ValidityEvent.adoc[ValidityEvent] (which corresponds to modifying a property or collection etc), however the _#getReason()_ will always be `null` . (If access is not allowed then a vetoing xref:system:generated:index/applib/services/wrapper/events/VisibilityEvent.adoc[VisibilityEvent] would have been fired).
.Java Sources
[source,java]
----
-class AbstractViewModel {
+class AccessEvent {
+
+ AccessEvent(final Object source, final Identifier identifier)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionInvocationEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionInvocationEvent.adoc
index 618b488..885c2cb 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionInvocationEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionInvocationEvent.adoc
@@ -1,7 +1,7 @@
= ActionInvocationEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
- _Supported only by xref:system:generated:index/applib/services/wrapper/WrapperFactory.adoc[WrapperFactory] service,_ represents a check as to whether a particular argument for an action is valid or not.
+ _Supported only by _WrapperFactory_ service,_ represents a check as to whether a particular argument for an action is valid or not.
If _#getReason()_ is not `null` then provides the reason why the set of arguments are invalid; otherwise the arguments are valid.
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionVisibilityEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionVisibilityEvent.adoc
index d7db002..17aa569 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionVisibilityEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionVisibilityEvent.adoc
@@ -1,7 +1,7 @@
= ActionVisibilityEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
- _Supported only by xref:system:generated:index/applib/services/wrapper/WrapperFactory.adoc[WrapperFactory] service,_ represents a check as to whether an action is visible or has been hidden.
+ _Supported only by _WrapperFactory_ service,_ represents a check as to whether an action is visible or has been hidden.
If _#getReason()_ is not `null` then provides the reason why the action is invisible; otherwise action is visible.
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/InteractionEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/InteractionEvent.adoc
index 4207e9b..94ae75d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/InteractionEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/InteractionEvent.adoc
@@ -3,7 +3,7 @@
_Supported only by _org.apache.isis.applib.services.wrapper.WrapperFactory_ service,_ represents an interaction with a domain object or a particular feature (property, collection, action) of a domain object.
-Many of the interactions are checks for _VisibilityEvent visibility_ , _UsabilityEvent usability_ and _ValidityEvent validity_ .
+Many of the interactions are checks for xref:system:generated:index/applib/services/wrapper/events/VisibilityEvent.adoc[VisibilityEvent] , xref:system:generated:index/applib/services/wrapper/events/UsabilityEvent.adoc[UsabilityEvent] and xref:system:generated:index/applib/services/wrapper/events/ValidityEvent.adoc[ValidityEvent] .
.Java Sources
[source,java]
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/VisibilityEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/VisibilityEvent.adoc
index b89c99d..9a352fd 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/VisibilityEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/VisibilityEvent.adoc
@@ -1,7 +1,7 @@
= VisibilityEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
- _Supported only by xref:system:generated:index/applib/services/wrapper/WrapperFactory.adoc[WrapperFactory] service,_ represents a check to determine whether a member of an object is visible or has been hidden.
+ _Supported only by _WrapperFactory_ service,_ represents a check to determine whether a member of an object is visible or has been hidden.
If _#getReason()_ is `null` , then is usable; otherwise is invisible.
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/xactn/TransactionalProcessor.adoc b/antora/components/system/modules/generated/pages/index/applib/services/xactn/TransactionalProcessor.adoc
new file mode 100644
index 0000000..103bbbd
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/services/xactn/TransactionalProcessor.adoc
@@ -0,0 +1,59 @@
+= TransactionalProcessor : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+interface TransactionalProcessor {
+
+ Result<T> callTransactional(TransactionDefinition def, Callable<T> callable) // <.>
+
+ Result<Void> runTransactional(TransactionDefinition def, ThrowingRunnable runnable) // <.>
+
+ Result<T> callTransactional(Propagation propagation, Callable<T> callable) // <.>
+
+ Result<Void> runTransactional(Propagation propagation, ThrowingRunnable runnable) // <.>
+
+ Result<T> callWithinCurrentTransactionElseCreateNew(Callable<T> callable) // <.>
+
+ Result<Void> runWithinCurrentTransactionElseCreateNew(ThrowingRunnable runnable) // <.>
+}
+----
+
+<.> `[teal]#*callTransactional*#<T>(TransactionDefinition def, Callable<T> callable)` : `xref:system:generated:index/commons/functional/Result.adoc[Result]<T>`
++
+--
+Runs given _callable_ with a transactional boundary, where the detailed transactional behavior is governed by given _TransactionDefinition_ _def_ .
+--
+<.> `[teal]#*runTransactional*#(TransactionDefinition def, ThrowingRunnable runnable)` : `xref:system:generated:index/commons/functional/Result.adoc[Result]<Void>`
++
+--
+Runs given _runnable_ with a transactional boundary, where the detailed transactional behavior is governed by given _TransactionDefinition_ _def_ .
+--
+<.> `[teal]#*callTransactional*#<T>(Propagation propagation, Callable<T> callable)` : `xref:system:generated:index/commons/functional/Result.adoc[Result]<T>`
++
+--
+Runs given _callable_ with a transactional boundary, where the detailed transactional behavior is governed by given _Propagation_ _propagation_ .
+
+More fine grained control is given via _#callTransactional(TransactionDefinition, Callable)_
+--
+<.> `[teal]#*runTransactional*#(Propagation propagation, ThrowingRunnable runnable)` : `xref:system:generated:index/commons/functional/Result.adoc[Result]<Void>`
++
+--
+Runs given _runnable_ with a transactional boundary, where the detailed transactional behavior is governed by given _Propagation_ _propagation_ .
+
+More fine grained control is given via _#runTransactional(TransactionDefinition, Callable)_
+--
+<.> `[teal]#*callWithinCurrentTransactionElseCreateNew*#<T>(Callable<T> callable)` : `xref:system:generated:index/commons/functional/Result.adoc[Result]<T>`
++
+--
+Runs given _callable_ within an existing transactional boundary, or in the absence of such a boundary, creates a new one.
+
+In other words, support a current transaction, create a new one if none exists.
+--
+<.> `[teal]#*runWithinCurrentTransactionElseCreateNew*#(ThrowingRunnable runnable)` : `xref:system:generated:index/commons/functional/Result.adoc[Result]<Void>`
++
+--
+Runs given _runnable_ within an existing transactional boundary, or in the absence of such a boundary creates a new one.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService.adoc
index 44a0da9..f87d136 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService.adoc
@@ -18,7 +18,7 @@ interface XmlSnapshotService {
}
----
-<.> `[teal]#*snapshotFor*#(Object domainObject)` : `xref:system:generated:index/applib/annotation/Snapshot.adoc[Snapshot]`
+<.> `[teal]#*snapshotFor*#(Object domainObject)` : `Snapshot`
+
--
Exports the state of a domain object into a Snapshot (which can then be converted into XML, for example).
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService~Snapshot~Builder.adoc b/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService~Snapshot~Builder.adoc
index 82b3d91..e72a561 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService~Snapshot~Builder.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/xmlsnapshot/XmlSnapshotService~Snapshot~Builder.adoc
@@ -24,7 +24,7 @@ Enrich the snapshot to include the state of these referenced objects
--
Ditto, but add an XML annotation attribute to the included element(s).
--
-<.> `[teal]#*build*#()` : `xref:system:generated:index/applib/annotation/Snapshot.adoc[Snapshot]`
+<.> `[teal]#*build*#()` : `Snapshot`
+
--
Builds the Snapshot.
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/types/DescriptionType.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/types/DescriptionType.adoc
index 78f204d..33e5923 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/types/DescriptionType.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= DescriptionType : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class DescriptionType {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/types/MemberIdentifierType.adoc
similarity index 74%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/types/MemberIdentifierType.adoc
index 78f204d..508c9ee 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/types/MemberIdentifierType.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= MemberIdentifierType : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+As per _Command#getMemberIdentifier()_ and _org.apache.isis.applib.services.publishing.spi.EntityPropertyChangeSubscriber#audit(UUID, int, String, Bookmark, String, String, String, String, String, Timestamp)_ .
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class MemberIdentifierType {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/types/TargetActionType.adoc
similarity index 73%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/types/TargetActionType.adoc
index 78f204d..a65026b 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/types/TargetActionType.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= TargetActionType : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+A user-friendly name of an action, as per _Command#getTargetAction()_ , _org.apache.isis.applib.services.publishing.spi.EntityPropertyChangeSubscriber#audit(UUID, int, String, Bookmark, String, String, String, String, String, Timestamp)_ .
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class TargetActionType {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/types/TargetClassType.adoc
similarity index 73%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/types/TargetClassType.adoc
index 78f204d..a123704 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/types/TargetClassType.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= TargetClassType : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+A user-friendly name of a class, as per _Command#getTargetClass()_ , _org.apache.isis.applib.services.publishing.spi.EntityPropertyChangeSubscriber#audit(UUID, int, String, Bookmark, String, String, String, String, String, Timestamp)_ .
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class TargetClassType {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/util/ObjectContracts.adoc b/antora/components/system/modules/generated/pages/index/applib/util/ObjectContracts.adoc
new file mode 100644
index 0000000..3ffacca
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/util/ObjectContracts.adoc
@@ -0,0 +1,64 @@
+= ObjectContracts : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Provides fluent composition for Objects' equals, hashCode and toString. Sample usage by composing getters ...For 'compareTo' use JDK's comparator composition ...
+
+----
+
+private static final Equality equality =
+ ObjectContracts.checkEquals(ApplicationFeature::getFeatureId);
+
+private static final Hashing hashing =
+ ObjectContracts.hashing(ApplicationFeature::getFeatureId);
+
+private static final ToString toString =
+ ObjectContracts.toString("featureId", ApplicationFeature::getFeatureId);
+
+public boolean equals(final Object obj) {
+ return equality.equals(this, obj);
+}
+
+public int hashCode() {
+ return hashing.hashCode(this);
+}
+
+public String toString() {
+ return toString.toString(this);
+}
+----
+
+----
+
+private static final Comparator comparator =
+ Comparator.comparing(ApplicationFeature::getFeatureId);
+
+public int compareTo(final ApplicationFeature other) {
+ return comparator.compare(this, other);
+}
+----
+
+.Java Sources
+[source,java]
+----
+class ObjectContracts {
+
+ ToString<T> toString(String name, Function<T, ?> getter)
+
+ Equality<T> checkEquals(Function<T, ?> getter)
+
+ Hashing<T> hashing(Function<T, ?> getter)
+
+ ObjectContract<T> contract(Class<T> objectClass)
+
+ ObjectContract<T> parse(Class<T> target, String propertyNames)
+
+ String toString(T obj, String propertyNames)
+
+ boolean equals(T obj, Object other, String propertyNames)
+
+ int hashCode(Object obj, String propertyNames)
+
+ int compare(T obj, T other, String propertyNames)
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/util/ReasonBuffer.adoc b/antora/components/system/modules/generated/pages/index/applib/util/ReasonBuffer.adoc
new file mode 100644
index 0000000..9be809c
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/util/ReasonBuffer.adoc
@@ -0,0 +1,40 @@
+= ReasonBuffer : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Helper class to create properly concatenated reason string for use in method that return _String_ s with reasons.
+
+If no reasons are specified _#getReason()_ will returnnull, otherwise it will return a _String_ with all the valid reasons concatenated with a semi-colon separating each one.
+
+An alternative is to use the xref:system:generated:index/applib/util/Reasons.adoc[Reasons] class.
+
+.Java Sources
+[source,java]
+----
+class ReasonBuffer {
+
+ StringBuffer reasonBuffer;
+
+ void append(final String reason) // <.>
+
+ void appendOnCondition(final boolean condition, final String reason) // <.>
+
+ String getReason() // <.>
+}
+----
+
+<.> `[teal]#*append*#(String reason)` : `void`
++
+--
+Append a reason to the list of existing reasons.
+--
+<.> `[teal]#*appendOnCondition*#(boolean condition, String reason)` : `void`
++
+--
+Append a reason to the list of existing reasons if the condition flag is true.
+--
+<.> `[teal]#*getReason*#()` : `String`
++
+--
+Return the combined set of reasons, ornullif there are none.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/util/ReasonBuffer2.adoc b/antora/components/system/modules/generated/pages/index/applib/util/ReasonBuffer2.adoc
new file mode 100644
index 0000000..fbd5d2f
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/util/ReasonBuffer2.adoc
@@ -0,0 +1,69 @@
+= ReasonBuffer2 : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Extension to applib's xref:system:generated:index/applib/util/ReasonBuffer.adoc[ReasonBuffer] .
+
+.Java Sources
+[source,java]
+----
+class ReasonBuffer2 {
+
+ ReasonBuffer2Builder builder()
+
+ ReasonBuffer2 forAll()
+
+ ReasonBuffer2 forSingle()
+
+ ReasonBuffer2 forAll(final String prefix)
+
+ ReasonBuffer2 forSingle(final String prefix)
+
+ ReasonBuffer2 append(final LazyReason lazyReason)
+
+ void appendIfNotPresent(final Optional<?> optional, final String reason)
+
+ ReasonBuffer2 append(final String reason) // <.>
+
+ ReasonBuffer2 append(final boolean condition, final String reason) // <.>
+
+ ReasonBuffer2 append(final Condition condition, final String reason) // <.>
+
+ String getReason() // <.>
+
+ String appendReason(final StringBuilder buf) // <.>
+
+ ReasonBuffer2 plus(final ReasonBuffer2 other) // <.>
+}
+----
+
+<.> `[teal]#*append*#(String reason)` : `xref:system:generated:index/applib/util/ReasonBuffer2.adoc[ReasonBuffer2]`
++
+--
+Append a reason to the list of existing reasons.
+--
+<.> `[teal]#*append*#(boolean condition, String reason)` : `xref:system:generated:index/applib/util/ReasonBuffer2.adoc[ReasonBuffer2]`
++
+--
+Append a reason to the list of existing reasons if the condition flag is true.
+--
+<.> `[teal]#*append*#(Condition condition, String reason)` : `xref:system:generated:index/applib/util/ReasonBuffer2.adoc[ReasonBuffer2]`
++
+--
+Append a reason to the list of existing reasons if the condition flag is true.
+--
+<.> `[teal]#*getReason*#()` : `String`
++
+--
+Return the combined set of reasons, ornullif there are none.
+--
+<.> `[teal]#*appendReason*#(StringBuilder buf)` : `String`
++
+--
+Appends reasons.
+--
+<.> `[teal]#*plus*#(xref:system:generated:index/applib/util/ReasonBuffer2.adoc[ReasonBuffer2] other)` : `xref:system:generated:index/applib/util/ReasonBuffer2.adoc[ReasonBuffer2]`
++
+--
+Combines sets of reasons from another.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/applib/util/Reasons.adoc
similarity index 82%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/applib/util/Reasons.adoc
index 78f204d..e0dc024 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/util/Reasons.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= Reasons : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+An alternative to xref:system:generated:index/applib/util/ReasonBuffer.adoc[ReasonBuffer] .
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Reasons {
- int compareTo(final ResourceCoordinates other)
+ String coalesce(final String... reasons)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/util/TitleBuffer.adoc b/antora/components/system/modules/generated/pages/index/applib/util/TitleBuffer.adoc
new file mode 100644
index 0000000..4accdee
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/util/TitleBuffer.adoc
@@ -0,0 +1,187 @@
+= TitleBuffer : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Title buffer is a utility class to help produce titles for objects without having to add lots of guard code.
+
+It provides two basic method: one to concatenate a title to the buffer; another to append a title with a joiner string, taking care adding in necessary spaces.
+
+The benefits of using this class is that null references are safely ignored (rather than appearing as 'null'), and joiners (a space by default) are only added when needed.
+
+.Java Sources
+[source,java]
+----
+class TitleBuffer {
+
+ TitleBuffer() // <.>
+
+ TitleBuffer(final Object object) // <.>
+
+ TitleBuffer(final Object object, final String defaultTitle) // <.>
+
+ TitleBuffer(final String text) // <.>
+
+ boolean isEmpty(final Object object) // <.>
+
+ boolean isEmpty(final String text) // <.>
+
+ TitleBuffer append(final int number) // <.>
+
+ TitleBuffer append(final Object object) // <.>
+
+ TitleBuffer append(final Object object, final String defaultValue) // <.>
+
+ TitleBuffer append(final String text) // <.>
+
+ TitleBuffer append(final String joiner, final Object object) // <.>
+
+ TitleBuffer append(final String joiner, final Object object, final String defaultTitle) // <.>
+
+ TitleBuffer append(final String joiner, final String text) // <.>
+
+ TitleBuffer appendSpace() // <.>
+
+ TitleBuffer concat(final Object object) // <.>
+
+ TitleBuffer concat(final Object object, final String defaultValue) // <.>
+
+ TitleBuffer concat(final String text) // <.>
+
+ TitleBuffer concat(final String joiner, final String text) // <.>
+
+ TitleBuffer concat(final String joiner, final Object object) // <.>
+
+ TitleBuffer concat(final String joiner, final Object object, final String defaultValue) // <.>
+
+ String toString() // <.>
+
+ TitleBuffer truncate(final int noWords) // <.>
+}
+----
+
+<.> `[teal]#*TitleBuffer*#()`
++
+--
+Creates a new, empty, xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] .
+--
+<.> `[teal]#*TitleBuffer*#(Object object)`
++
+--
+Creates a new xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] , containing the title of the specified object.
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*TitleBuffer*#(Object object, String defaultTitle)`
++
+--
+Creates a new title object, containing the title of the specified object.
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*TitleBuffer*#(String text)`
++
+--
+Creates a new title object, containing the specified text.
+--
+<.> `[teal]#*_isEmpty_*#(Object object)` : `boolean`
++
+--
+Determines if the specified object's title is empty (or null).
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*_isEmpty_*#(String text)` : `boolean`
++
+--
+Determines if the specified text is empty. Will return true if either: the specified reference is null; or if the reference is an empty string.
+--
+<.> `[teal]#*append*#(int number)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
+<.> `[teal]#*append*#(Object object)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Append the title of the specified object to this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] .
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*append*#(Object object, String defaultValue)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Appends the title of the specified object, or the specified text if the objects title is null or empty. Prepends a space if there is already some text in this title object.
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*append*#(String text)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Appends a space (if there is already some text in this title object) and then the specified text.
+--
+<.> `[teal]#*append*#(String joiner, Object object)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Appends the joining string and the title of the specified object. If the object is empty then nothing will be appended.
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*append*#(String joiner, Object object, String defaultTitle)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Append thejoinertext, a space, and the title of the specified object to the text of this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] . If the title of the specified object is null then use thedefaultValuetext. If both the objects title and the default value are null or equate to a zero-length string then no text will be appended ; not even the joiner text.
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*append*#(String joiner, String text)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Appends the joiner text, a space, and the text to the text of this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] . If no text yet exists in the object then the joiner text and space are omitted.
+--
+<.> `[teal]#*appendSpace*#()` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Append a space to the text of this TitleString object if, and only if, there is some existing text i.e., a space is only added to existing text and will not create a text entry consisting of only one space.
+--
+<.> `[teal]#*concat*#(Object object)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Concatenate the the title value (the result of calling an objects label() method) to this TitleString object. If the value is null the no text is added.
+--
+<.> `[teal]#*concat*#(Object object, String defaultValue)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Concatenate the title of the object value or the specified default value if the title is equal to null or is empty, to this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] .
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*concat*#(String text)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Concatenate the specified text on to the end of the text of this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] .
+--
+<.> `[teal]#*concat*#(String joiner, String text)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Concatenate the joiner text and the text to the text of this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] object. If no text yet exists in the object then the joiner text is omitted.
+--
+<.> `[teal]#*concat*#(String joiner, Object object)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Concatenate the joiner text and the title of the object to the text of this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] . If no object yet exists in the object then the joiner text is omitted.
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*concat*#(String joiner, Object object, String defaultValue)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Concatenate the joiner text and the title of the object to the text of this xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer] object. If no object yet exists in the object then defaultValue is used instead.
+
+Note: this method only obtains the title using either `title()` or `toString()` ; it doesn't honour other mechanisms for specifying the title, such as _org.apache.isis.applib.annotation.Title_ annotation. If that functionality is required, first call _org.apache.isis.applib.DomainObjectContainer#titleOf(Object)_ on the object and pass in the resultant string.
+--
+<.> `[teal]#*toString*#()` : `String`
++
+--
+Returns a String that represents the value of this object.
+--
+<.> `[teal]#*truncate*#(int noWords)` : `xref:system:generated:index/applib/util/TitleBuffer.adoc[TitleBuffer]`
++
+--
+Truncates this title so it has a maximum number of words. Spaces are used to determine words, thus two spaces in a title will cause two words to be mistakenly identified.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/util/TitleBufferException.adoc
similarity index 75%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/applib/util/TitleBufferException.adoc
index ba495fc..415af34 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/util/TitleBufferException.adoc
@@ -1,20 +1,20 @@
-= MenuBarsService : _interface_
+= TitleBufferException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class TitleBufferException {
- MenuBars menuBars() // <.>
+ TitleBufferException()
- MenuBars menuBars(final Type type)
+ TitleBufferException(final String msg)
+
+ TitleBufferException(final Throwable cause)
+
+ TitleBufferException(final String msg, final Throwable cause)
+
+ Throwable getCause()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/util/schema/InteractionDtoUtils.adoc b/antora/components/system/modules/generated/pages/index/applib/util/schema/InteractionDtoUtils.adoc
new file mode 100644
index 0000000..b31e896
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/applib/util/schema/InteractionDtoUtils.adoc
@@ -0,0 +1,72 @@
+= InteractionDtoUtils : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+class InteractionDtoUtils {
+
+ static JAXBContext jaxbContext;
+
+ void init()
+
+ JAXBContext getJaxbContext()
+
+ InteractionDto fromXml(final Reader reader)
+
+ InteractionDto fromXml(final String xml)
+
+ InteractionDto fromXml(final Class<?> contextClass, final String resourceName, final Charset charset)
+
+ String toXml(final InteractionDto interactionDto)
+
+ void toXml(final InteractionDto interactionDto, final Writer writer)
+
+ InteractionDto newInteractionDto(final Interaction.Execution<?, ?> execution) // <.>
+
+ InteractionDto newInteractionDto(final Interaction.Execution<?, ?> execution, final Strategy strategy) // <.>
+
+ ActionInvocationDto newActionInvocation(final int sequence, final Bookmark targetBookmark, final String targetTitle, final String actionIdentifier, final List<ParamDto> parameterDtos, final String user)
+
+ PropertyEditDto newPropertyEdit(final int sequence, final Bookmark targetBookmark, final String targetTitle, final String propertyIdentifier, final ValueWithTypeDto newValueDto, final String user)
+
+ String deriveLogicalMemberId(final Bookmark bookmark, final String memberId)
+
+ void addParamArg(final InteractionDto interactionDto, final String parameterName, final Class<?> parameterType, final Object arg, final BookmarkService bookmarkService)
+
+ void addReturn(final ActionInvocationDto invocationDto, final Class<?> returnType, final Object result, final BookmarkService bookmarkService) // <.>
+
+ List<ParamDto> getParameters(final ActionInvocationDto ai)
+
+ List<String> getParameterNames(final ActionInvocationDto ai)
+
+ List<ValueType> getParameterTypes(final ActionInvocationDto ai)
+
+ ParamDto getParameter(final ActionInvocationDto ai, final int paramNum)
+
+ ValueDto getParameterArgument(final ActionInvocationDto ai, final int paramNum)
+
+ String getParameterName(final ActionInvocationDto ai, final int paramNum)
+
+ ValueType getParameterType(final ActionInvocationDto ai, final int paramNum)
+
+ boolean isNull(final ActionInvocationDto ai, int paramNum)
+
+ T getParameterArgValue(final ActionInvocationDto ai, int paramNum)
+
+ void dump(final InteractionDto ixnDto, final PrintStream out)
+}
+----
+
+<.> `[teal]#*_newInteractionDto_*#(Execution<?, ?> execution)` : `InteractionDto`
++
+--
+Creates a _InteractionDto_ (serializable to XML) for the provided _Interaction.Execution_ (the applib object).
+--
+<.> `[teal]#*_newInteractionDto_*#(Execution<?, ?> execution, Strategy strategy)` : `InteractionDto`
++
+--
+Creates a _InteractionDto_ (serializable to XML) for the provided _Interaction.Execution_ (the applib object).
+--
+<.> `[teal]#*_addReturn_*#(ActionInvocationDto invocationDto, Class<?> returnType, Object result, xref:system:generated:index/applib/services/bookmark/BookmarkService.adoc[BookmarkService] bookmarkService)` : `void`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/util/schema/MemberExecutionDtoUtils.adoc
similarity index 61%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/applib/util/schema/MemberExecutionDtoUtils.adoc
index dcdaf9a..b5231a0 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/util/schema/MemberExecutionDtoUtils.adoc
@@ -1,28 +1,26 @@
-= EntityState : _enum_
+= MemberExecutionDtoUtils : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+class MemberExecutionDtoUtils {
- NOT_PERSISTABLE
+ T clone(final T dto)
- PERSISTABLE_ATTACHED
+ MetricsDto metricsFor(final MemberExecutionDto executionDto)
- PERSISTABLE_DETACHED
+ PeriodDto timingsFor(final MetricsDto metricsDto)
- PERSISTABLE_DESTROYED
+ ObjectCountsDto objectCountsFor(final MetricsDto metricsDto)
- boolean isPersistable()
+ DifferenceDto numberObjectsLoadedFor(final ObjectCountsDto objectCountsDto)
- boolean isAttached()
+ DifferenceDto numberObjectsDirtiedFor(final ObjectCountsDto objectCountsDto)
- boolean isDetached()
+ String toXml(final T dto)
- boolean isDestroyed()
+ void toXml(final T dto, final Writer writer)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
index 78f204d..fcd118c 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
@@ -6,6 +6,8 @@
----
class ResourceCoordinates {
+ ResourceCoordinates fromFile(final File file)
+
int compareTo(final ResourceCoordinates other)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/core/config/datasources/DataSourceIntrospectionService.adoc
similarity index 77%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/core/config/datasources/DataSourceIntrospectionService.adoc
index ba495fc..f117617 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/core/config/datasources/DataSourceIntrospectionService.adoc
@@ -1,20 +1,14 @@
-= MenuBarsService : _interface_
+= DataSourceIntrospectionService : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+For a given _Spring_ context, provides utilities to introspect the list of configured data-sources.
+
.Java Sources
[source,java]
----
-interface MenuBarsService {
-
- MenuBars menuBars() // <.>
+class DataSourceIntrospectionService {
- MenuBars menuBars(final Type type)
+ Stream<DataSourceInfo> streamDataSourceInfos()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/CommandSubscriberForJdo.adoc
similarity index 83%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/CommandSubscriberForJdo.adoc
index 78f204d..37ba3a3 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/CommandSubscriberForJdo.adoc
@@ -1,12 +1,15 @@
-= ResourceCoordinates : _class_
+= CommandSubscriberForJdo : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class CommandSubscriberForJdo {
- int compareTo(final ResourceCoordinates other)
+ @Inject
+final CommandJdoRepository commandJdoRepository;
+
+ void onCompleted(Command command)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/IsisModuleExtCommandLogImpl.adoc
similarity index 71%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/IsisModuleExtCommandLogImpl.adoc
index ba495fc..f654046 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/IsisModuleExtCommandLogImpl.adoc
@@ -1,20 +1,20 @@
-= MenuBarsService : _interface_
+= IsisModuleExtCommandLogImpl : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class IsisModuleExtCommandLogImpl {
- MenuBars menuBars() // <.>
+ FixtureScript getTeardownFixture()
- MenuBars menuBars(final Type type)
+ FixtureScript getTeardownFixtureWillDelete() // <.>
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
+<.> `[teal]#*getTeardownFixtureWillDelete*#()` : `FixtureScript`
+
--
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
+For tests that need to delete the command table first. Should be run in the @Before of the test.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionInvocationEvent.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/mixins/HasUniqueId_command.adoc
similarity index 50%
copy from antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionInvocationEvent.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/mixins/HasUniqueId_command.adoc
index 618b488..a8e032c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/events/ActionInvocationEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/mixins/HasUniqueId_command.adoc
@@ -1,30 +1,29 @@
-= ActionInvocationEvent : _class_
+= HasUniqueId_command : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
- _Supported only by xref:system:generated:index/applib/services/wrapper/WrapperFactory.adoc[WrapperFactory] service,_ represents a check as to whether a particular argument for an action is valid or not.
-
-If _#getReason()_ is not `null` then provides the reason why the set of arguments are invalid; otherwise the arguments are valid.
-
-Called after each of the xref:system:generated:index/applib/services/wrapper/events/ActionArgumentEvent.adoc[ActionArgumentEvent] s.
+This mixin contributes a `command` action to any (non-command) implementation of xref:system:generated:index/commons/having/HasUniqueId.adoc[HasUniqueId] ; that is: audit entries, and published events. Thus, it is possible to navigate from the effect back to the cause.
.Java Sources
[source,java]
----
-class ActionInvocationEvent {
+class HasUniqueId_command {
+
+ @Inject
+CommandJdoRepository commandServiceRepository;
- ActionInvocationEvent(final Object source, final Identifier actionIdentifier, final Object[] args)
+ HasUniqueId_command(final HasUniqueId hasUniqueId)
- Object[] getArgs()
+ CommandJdo act()
- void setArgs(final Object[] args)
+ boolean hideAct() // <.>
- Object getProposed() // <.>
+ String disableAct()
}
----
-<.> `[teal]#*getProposed*#()` : `Object`
+<.> `[teal]#*hideAct*#()` : `boolean`
+
--
-Does not apply
+Hide if the contributee is a xref:system:generated:index/applib/services/command/Command.adoc[Command] , because xref:system:generated:index/applib/services/command/Command.adoc[Command] s already have a _Command#getParent() parent_ property.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/mixins/HasUsername_recentCommandsByUser.adoc
similarity index 75%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/mixins/HasUsername_recentCommandsByUser.adoc
index ba495fc..4de9cac 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/mixins/HasUsername_recentCommandsByUser.adoc
@@ -1,20 +1,19 @@
-= MenuBarsService : _interface_
+= HasUsername_recentCommandsByUser : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class HasUsername_recentCommandsByUser {
- MenuBars menuBars() // <.>
+ @Inject
+CommandJdoRepository commandServiceRepository;
- MenuBars menuBars(final Type type)
+ HasUsername_recentCommandsByUser(final HasUsername hasUsername)
+
+ List<CommandJdo> coll()
+
+ boolean hideColl()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/ui/CommandServiceMenu.adoc
similarity index 61%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/ui/CommandServiceMenu.adoc
index dcdaf9a..433ddad 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandlog/impl/ui/CommandServiceMenu.adoc
@@ -1,28 +1,32 @@
-= EntityState : _enum_
+= CommandServiceMenu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+class CommandServiceMenu {
+
+ final CommandJdoRepository commandServiceRepository;
+
+ final ClockService clockService;
+
+ List<CommandJdo> activeCommands()
- NOT_PERSISTABLE
+ boolean hideActiveCommands()
- PERSISTABLE_ATTACHED
+ List<CommandJdo> findCommands(final LocalDate from, final LocalDate to)
- PERSISTABLE_DETACHED
+ boolean hideFindCommands()
- PERSISTABLE_DESTROYED
+ LocalDate default0FindCommands()
- boolean isPersistable()
+ LocalDate default1FindCommands()
- boolean isAttached()
+ CommandJdo findCommandById(final UUID transactionId)
- boolean isDetached()
+ boolean hideFindCommandById()
- boolean isDestroyed()
+ void truncateLog()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/IsisModuleExtCommandReplayPrimary.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/IsisModuleExtCommandReplayPrimary.adoc
index 78f204d..d4d60a0 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/IsisModuleExtCommandReplayPrimary.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtCommandReplayPrimary : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtCommandReplayPrimary {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/config/PrimaryConfig.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/config/PrimaryConfig.adoc
index 78f204d..4023fc5 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/config/PrimaryConfig.adoc
@@ -1,12 +1,17 @@
-= ResourceCoordinates : _class_
+= PrimaryConfig : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class PrimaryConfig {
- int compareTo(final ResourceCoordinates other)
+ @Getter
+final String secondaryBaseUrlWicket;
+
+ PrimaryConfig(final IsisConfiguration isisConfiguration)
+
+ boolean isConfigured()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/mixins/Object_openOnSecondary.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/mixins/Object_openOnSecondary.adoc
index 78f204d..488f8dc 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/mixins/Object_openOnSecondary.adoc
@@ -1,12 +1,22 @@
-= ResourceCoordinates : _class_
+= Object_openOnSecondary : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Object_openOnSecondary {
- int compareTo(final ResourceCoordinates other)
+ final Object object;
+
+ @Inject
+PrimaryConfig primaryConfig;
+
+ @Inject
+BookmarkService bookmarkService;
+
+ URL act()
+
+ boolean hideAct()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/restapi/CommandRetrievalService.adoc
similarity index 59%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/restapi/CommandRetrievalService.adoc
index 505d2bc..084651c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/restapi/CommandRetrievalService.adoc
@@ -1,25 +1,23 @@
-= MenuBarsLoaderService : _interface_
+= CommandRetrievalService : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
+class CommandRetrievalService {
- boolean supportsReloading() // <.>
+ @Inject
+CommandJdoRepository commandServiceRepository;
- BS3MenuBars menuBars() // <.>
+ List<CommandJdo> findCommandsOnPrimaryFrom(final UUID uniqueId, final Integer batchSize) // <.>
+
+ Integer default1FindCommandsOnPrimaryFrom()
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
-+
---
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
+<.> `[teal]#*findCommandsOnPrimaryFrom*#(UUID uniqueId, Integer batchSize)` : `List<CommandJdo>`
+
--
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+These actions should be called with HTTP Accept Header set to:application/xml;profile="urn:org.restfulobjects:repr-types/action-result";x-ro-domain-type="org.apache.isis.schema.cmd.v1.CommandsDto"
--
diff --git a/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/ui/CommandReplayOnPrimaryService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/ui/CommandReplayOnPrimaryService.adoc
new file mode 100644
index 0000000..b52f29e
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/primary/ui/CommandReplayOnPrimaryService.adoc
@@ -0,0 +1,55 @@
+= CommandReplayOnPrimaryService : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+class CommandReplayOnPrimaryService {
+
+ @Inject
+final CommandJdoRepository commandServiceRepository;
+
+ @Inject
+final JaxbService jaxbService;
+
+ @Inject
+final MessageService messageService;
+
+ @Inject
+final ContentMappingServiceForCommandsDto contentMappingServiceForCommandsDto;
+
+ @Inject
+final CommandRetrievalService commandRetrievalService;
+
+ List<CommandJdo> findCommands(final UUID uniqueId, final Integer batchSize) // <.>
+
+ Integer default1FindCommandsOnPrimaryFrom()
+
+ Clob downloadCommands(final UUID uniqueId, final Integer batchSize, final String filenamePrefix) // <.>
+
+ Integer default1DownloadCommands()
+
+ String default2DownloadCommands()
+
+ Clob downloadCommandById(final UUID uniqueId, final String filenamePrefix) // <.>
+
+ String default1DownloadCommandById()
+}
+----
+
+<.> `[teal]#*findCommands*#(UUID uniqueId, Integer batchSize)` : `List<CommandJdo>`
++
+--
+These actions should be called with HTTP Accept Header set to:application/xml;profile="urn:org.restfulobjects:repr-types/action-result";x-ro-domain-type="org.apache.isis.schema.cmd.v1.CommandsDto"
+--
+<.> `[teal]#*downloadCommands*#(UUID uniqueId, Integer batchSize, String filenamePrefix)` : `xref:system:generated:index/applib/value/Clob.adoc[Clob]`
++
+--
+These actions should be called with HTTP Accept Header set to:application/xml;profile="urn:org.restfulobjects:repr-types/action-result";x-ro-domain-type="org.apache.isis.schema.cmd.v1.CommandsDto"
+--
+<.> `[teal]#*downloadCommandById*#(UUID uniqueId, String filenamePrefix)` : `xref:system:generated:index/applib/value/Clob.adoc[Clob]`
++
+--
+This action should be called with HTTP Accept Header set to:application/xml;profile="urn:org.restfulobjects:repr-types/action-result";x-ro-domain-type="org.apache.isis.schema.cmd.v1.CommandDto"
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/IsisModuleExtCommandReplaySecondary.adoc
similarity index 57%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/IsisModuleExtCommandReplaySecondary.adoc
index dcdaf9a..5ab89f7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/IsisModuleExtCommandReplaySecondary.adoc
@@ -1,28 +1,26 @@
-= EntityState : _enum_
+= IsisModuleExtCommandReplaySecondary : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
+class IsisModuleExtCommandReplaySecondary {
- PERSISTABLE_ATTACHED
+ @Inject
+ApplicationContext applicationContext;
- PERSISTABLE_DETACHED
+ @Inject
+IsisConfiguration isisConfiguration;
- PERSISTABLE_DESTROYED
+ JobDetailFactoryBean replicateAndReplayJobDetailFactory()
- boolean isPersistable()
+ SimpleTriggerFactoryBean replicateAndReplayTriggerFactory(JobDetail job)
- boolean isAttached()
+ SpringBeanJobFactory springBeanJobFactory()
- boolean isDetached()
+ SchedulerFactoryBean scheduler(final Trigger trigger, final JobDetail jobDetail, final SpringBeanJobFactory sbjf)
- boolean isDestroyed()
+ Scheduler scheduler(final Trigger trigger, final JobDetail job, final SchedulerFactoryBean factory)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/SecondaryStatus.adoc
similarity index 80%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/SecondaryStatus.adoc
index 78f204d..be43d1f 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/SecondaryStatus.adoc
@@ -1,12 +1,22 @@
-= ResourceCoordinates : _class_
+= SecondaryStatus : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+enum SecondaryStatus {
- int compareTo(final ResourceCoordinates other)
+ TICKING_CLOCK_STATUS_UNKNOWN
+
+ TICKING_CLOCK_NOT_YET_INITIALIZED
+
+ OK
+
+ REST_CALL_FAILING
+
+ FAILED_TO_UNMARSHALL_RESPONSE
+
+ UNKNOWN_STATE
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyser.adoc
similarity index 80%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyser.adoc
index 78f204d..cf76012 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyser.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= CommandReplayAnalyser : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface CommandReplayAnalyser {
- int compareTo(final ResourceCoordinates other)
+ String analyzeReplay(final CommandJdo commandJdo) // <.>
}
----
+<.> `[teal]#*analyzeReplay*#(CommandJdo commandJdo)` : `String`
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyserException.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyserException.adoc
index 78f204d..4b271c8 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyserException.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= CommandReplayAnalyserException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class CommandReplayAnalyserException {
- int compareTo(final ResourceCoordinates other)
+ void init()
+
+ String analyzeReplay(final CommandJdo commandJdo)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyserResult.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyserResult.adoc
index 78f204d..a910422 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analyser/CommandReplayAnalyserResult.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= CommandReplayAnalyserResult : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class CommandReplayAnalyserResult {
- int compareTo(final ResourceCoordinates other)
+ void init()
+
+ String analyzeReplay(final CommandJdo commandJdo)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analysis/CommandReplayAnalysisService.adoc
similarity index 65%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analysis/CommandReplayAnalysisService.adoc
index 505d2bc..247ac51 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/analysis/CommandReplayAnalysisService.adoc
@@ -1,25 +1,21 @@
-= MenuBarsLoaderService : _interface_
+= CommandReplayAnalysisService : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
+class CommandReplayAnalysisService {
- boolean supportsReloading() // <.>
+ @Inject
+List<CommandReplayAnalyser> analysers;
- BS3MenuBars menuBars() // <.>
+ void analyse(final CommandJdo commandJdo) // <.>
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
+<.> `[teal]#*analyse*#(CommandJdo commandJdo)` : `void`
+
--
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
-+
---
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+if hit an issue with the command having been replayed, then mark this as in error. This will effectively block the running of any further commands until the adminstrator fixes the issue.
--
diff --git a/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/clock/TickingClockService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/clock/TickingClockService.adoc
new file mode 100644
index 0000000..bc91bee
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/clock/TickingClockService.adoc
@@ -0,0 +1,41 @@
+= TickingClockService : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Only enabled for the `secondary` profile, where it sets up the framework to use _TickingFixtureClock_ so that time can be changed dynamically when running.
+
+As an additional safeguard, if the configuration keys to access the primary are not provided, then the service will not initialize.
+
+IMPORTANT: the methods provided by this service are not thread-safe, because the clock is a globally-scoped singleton rather than a thread-local. These methods should therefore only be used in single-user systems, eg a replay secondary.
+
+.Java Sources
+[source,java]
+----
+class TickingClockService {
+
+ final IsisConfiguration isisConfiguration;
+
+ void init()
+
+ boolean isInitialized()
+
+ void at(Timestamp timestamp, Runnable runnable) // <.>
+
+ T at(Timestamp timestamp, Supplier<T> supplier) // <.>
+}
+----
+
+<.> `[teal]#*at*#(Timestamp timestamp, Runnable runnable)` : `void`
++
+--
+Executes the runnable, setting the clock to be the specified time beforehand (and reinstating it to its original time afterwards).
+
+IMPORTANT: this method is not thread-safe, because the clock is a globally-scoped singleton rather than a thread-local. This method should therefore only be used in single-user systems, eg a replay secondary.
+--
+<.> `[teal]#*at*#<T>(Timestamp timestamp, Supplier<T> supplier)` : `T`
++
+--
+Executes the callable, setting the clock to be the specified time beforehand (and reinstating it to its original time afterwards).
+
+IMPORTANT: this method is not thread-safe, because the clock is a globally-scoped singleton rather than a thread-local. This method should therefore only be used in single-user systems, eg a replay secondary.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/config/SecondaryConfig.adoc
similarity index 66%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/config/SecondaryConfig.adoc
index dcdaf9a..45fcc25 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/config/SecondaryConfig.adoc
@@ -1,28 +1,35 @@
-= EntityState : _enum_
+= SecondaryConfig : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+class SecondaryConfig {
+
+ @Getter
+final String primaryUser;
- NOT_PERSISTABLE
+ @Getter
+final String primaryPassword;
- PERSISTABLE_ATTACHED
+ @Getter
+final String primaryBaseUrlRestful;
- PERSISTABLE_DETACHED
+ @Getter
+final String primaryBaseUrlWicket;
- PERSISTABLE_DESTROYED
+ @Getter
+final int batchSize;
- boolean isPersistable()
+ @Getter
+final String quartzUser;
- boolean isAttached()
+ @Getter
+final List<String> quartzRoles;
- boolean isDetached()
+ SecondaryConfig(final IsisConfiguration isisConfiguration)
- boolean isDestroyed()
+ boolean isConfigured()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/executor/CommandExecutorServiceWithTime.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/executor/CommandExecutorServiceWithTime.adoc
new file mode 100644
index 0000000..b4f0367
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/executor/CommandExecutorServiceWithTime.adoc
@@ -0,0 +1,28 @@
+= CommandExecutorServiceWithTime : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Override of xref:system:generated:index/applib/services/command/CommandExecutorService.adoc[CommandExecutorService] that also sets the time (using the xref:system:generated:index/extensions/commandreplay/secondary/clock/TickingClockService.adoc[TickingClockService] ) to that of the xref:system:generated:index/applib/services/command/Command.adoc[Command] 's _Command#getTimestamp() timestamp_ before executing the command.
+
+It then delegates down to the default implementation.
+
+.Java Sources
+[source,java]
+----
+class CommandExecutorServiceWithTime {
+
+ final CommandExecutorService delegate;
+
+ final TickingClockService tickingClockService;
+
+ CommandExecutorServiceWithTime(final CommandExecutorService delegate, final TickingClockService tickingClockService)
+
+ Bookmark executeCommand(final Command command)
+
+ Bookmark executeCommand(final SudoPolicy sudoPolicy, final Command command)
+
+ Bookmark executeCommand(final CommandDto dto, final CommandOutcomeHandler outcomeHandler)
+
+ Bookmark executeCommand(final SudoPolicy sudoPolicy, final CommandDto dto, final CommandOutcomeHandler outcomeHandler)
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/fetch/CommandFetcher.adoc
similarity index 72%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/fetch/CommandFetcher.adoc
index ba495fc..dfc35e4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/fetch/CommandFetcher.adoc
@@ -1,20 +1,23 @@
-= MenuBarsService : _interface_
+= CommandFetcher : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class CommandFetcher {
- MenuBars menuBars() // <.>
+ static final String URL_SUFFIX;
- MenuBars menuBars(final Type type)
+ @Inject
+SecondaryConfig secondaryConfig;
+
+ List<CommandDto> fetchCommand(final CommandJdo previousHwmIfAny) // <.>
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
+<.> `[teal]#*fetchCommand*#(CommandJdo previousHwmIfAny)` : `List<CommandDto>`
+
--
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
+Replicates a single command.
--
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/job/ReplicateAndReplayJob.adoc
similarity index 80%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/job/ReplicateAndReplayJob.adoc
index 78f204d..3c853e5 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/job/ReplicateAndReplayJob.adoc
@@ -1,12 +1,17 @@
-= ResourceCoordinates : _class_
+= ReplicateAndReplayJob : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class ReplicateAndReplayJob {
- int compareTo(final ResourceCoordinates other)
+ @Inject
+SecondaryConfig secondaryConfig;
+
+ Authentication authentication;
+
+ void execute(final JobExecutionContext quartzContext)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/job/SecondaryStatusData.adoc
similarity index 73%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/job/SecondaryStatusData.adoc
index dcdaf9a..9bfdd16 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/job/SecondaryStatusData.adoc
@@ -1,28 +1,18 @@
-= EntityState : _enum_
+= SecondaryStatusData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
+class SecondaryStatusData {
- boolean isPersistable()
+ SecondaryStatusData(final JobExecutionContext jobExecutionContext)
- boolean isAttached()
+ SecondaryStatus getSecondaryStatus()
- boolean isDetached()
+ SecondaryStatus getSecondaryStatus(final SecondaryStatus defaultStatus)
- boolean isDestroyed()
+ void setSecondaryStatus(final SecondaryStatus mode)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/jobcallables/ReplicateAndRunCommands.adoc
similarity index 55%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/jobcallables/ReplicateAndRunCommands.adoc
index dcdaf9a..3d93849 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/jobcallables/ReplicateAndRunCommands.adoc
@@ -1,28 +1,34 @@
-= EntityState : _enum_
+= ReplicateAndRunCommands : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+Encodes the algorithm for fetching commands from the primary, and replaying on the secondary.
+
+This class is instantiated each time the Quartz job (_org.apache.isis.extensions.commandreplay.secondary.job.ReplicateAndReplayJob_) files.
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
+class ReplicateAndRunCommands {
- PERSISTABLE_ATTACHED
+ @Inject
+CommandExecutorService commandExecutorService;
- PERSISTABLE_DETACHED
+ @Inject
+TransactionService transactionService;
- PERSISTABLE_DESTROYED
+ @Inject
+CommandFetcher commandFetcher;
- boolean isPersistable()
+ @Inject
+CommandJdoRepository commandJdoRepository;
- boolean isAttached()
+ @Inject
+CommandReplayAnalysisService analysisService;
- boolean isDetached()
+ @Inject
+Optional<ReplayCommandExecutionController> controller;
- boolean isDestroyed()
+ SecondaryStatus call()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/CommandJdo_exclude.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/CommandJdo_exclude.adoc
index 78f204d..db3b544 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/CommandJdo_exclude.adoc
@@ -1,12 +1,21 @@
-= ResourceCoordinates : _class_
+= CommandJdo_exclude : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class CommandJdo_exclude {
- int compareTo(final ResourceCoordinates other)
+ final CommandJdo commandJdo;
+
+ @Inject
+Optional<SecondaryConfig> secondaryConfig;
+
+ CommandJdo act()
+
+ boolean hideAct()
+
+ String disableAct()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/CommandJdo_replayQueue.adoc
similarity index 76%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/CommandJdo_replayQueue.adoc
index ba495fc..d7798e0 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/CommandJdo_replayQueue.adoc
@@ -1,20 +1,22 @@
-= MenuBarsService : _interface_
+= CommandJdo_replayQueue : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class CommandJdo_replayQueue {
- MenuBars menuBars() // <.>
+ final CommandJdo commandJdo;
- MenuBars menuBars(final Type type)
+ @Inject
+SecondaryConfig secondaryConfig;
+
+ @Inject
+CommandJdoRepository commandJdoRepository;
+
+ List<CommandJdo> coll()
+
+ boolean hideColl()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/Object_openOnPrimary.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/Object_openOnPrimary.adoc
index 78f204d..8802dd9 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/mixins/Object_openOnPrimary.adoc
@@ -1,12 +1,22 @@
-= ResourceCoordinates : _class_
+= Object_openOnPrimary : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Object_openOnPrimary {
- int compareTo(final ResourceCoordinates other)
+ final Object object;
+
+ @Inject
+SecondaryConfig secondaryConfig;
+
+ @Inject
+BookmarkService bookmarkService;
+
+ URL act()
+
+ boolean hideAct()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/spi/ReplayCommandExecutionController.adoc
similarity index 65%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/spi/ReplayCommandExecutionController.adoc
index 505d2bc..85d455e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/spi/ReplayCommandExecutionController.adoc
@@ -1,25 +1,22 @@
-= MenuBarsLoaderService : _interface_
+= ReplayCommandExecutionController : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Optional SPI that allows the replicate and replay job to be paused if required.
+
+If no implementation is configured, then replication/replay will continue without interruption.
+
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
-
- boolean supportsReloading() // <.>
+interface ReplayCommandExecutionController {
- BS3MenuBars menuBars() // <.>
+ State getState() // <.>
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
-+
---
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
+<.> `[teal]#*getState*#()` : `State`
+
--
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+The current state, or `null` if the service implementing this SPI has not yet been initialized.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/ui/CommandReplayOnSecondaryService.adoc
similarity index 74%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/ui/CommandReplayOnSecondaryService.adoc
index ba495fc..8e8c93c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/commandreplay/secondary/ui/CommandReplayOnSecondaryService.adoc
@@ -1,20 +1,20 @@
-= MenuBarsService : _interface_
+= CommandReplayOnSecondaryService : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class CommandReplayOnSecondaryService {
- MenuBars menuBars() // <.>
+ @Inject
+final CommandJdoRepository commandJdoRepository;
- MenuBars menuBars(final Type type)
+ @Inject
+final JaxbService jaxbService;
+
+ CommandJdo findMostRecentReplayed()
+
+ void uploadCommands(final Clob commandsDtoAsXml)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/cors/impl/IsisModuleExtCorsImpl.adoc
similarity index 83%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/cors/impl/IsisModuleExtCorsImpl.adoc
index 78f204d..e050c15 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/cors/impl/IsisModuleExtCorsImpl.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtCorsImpl : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IsisModuleExtCorsImpl {
- int compareTo(final ResourceCoordinates other)
+ FilterRegistrationBean<Filter> createCorsFilterRegistration(IsisConfiguration configuration)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/CalendarEventable.adoc
similarity index 61%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/CalendarEventable.adoc
index 505d2bc..f90d53e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/CalendarEventable.adoc
@@ -1,25 +1,24 @@
-= MenuBarsLoaderService : _interface_
+= CalendarEventable : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
+interface CalendarEventable {
- boolean supportsReloading() // <.>
+ String getCalendarName() // <.>
- BS3MenuBars menuBars() // <.>
+ CalendarEvent toCalendarEvent()
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
+<.> `[teal]#*getCalendarName*#()` : `String`
+
--
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
-+
---
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+The name of the calendar to which this event belongs.
+
+For example, anEmployeemight provide have aemployedOn, so the calendar name would be "employedOn"
+
+If there is possibly more than one date associated with the entity, then use xref:system:generated:index/extensions/fullcalendar/applib/Calendarable.adoc[Calendarable] instead.
--
diff --git a/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/Calendarable.adoc b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/Calendarable.adoc
new file mode 100644
index 0000000..33238ca
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/Calendarable.adoc
@@ -0,0 +1,29 @@
+= Calendarable : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+interface Calendarable {
+
+ Set<String> getCalendarNames() // <.>
+
+ Map<String, CalendarEventable> getCalendarEvents() // <.>
+}
+----
+
+<.> `[teal]#*getCalendarNames*#()` : `Set<String>`
++
+--
+The names of unique "calendar"s provided by this object.
+
+The "calendar" is a string identifier that indicates the nature of this event.
+
+For example, an event of a lease'sFixedBreakOptionhas three dates: the _break date_ , the _exercise date_ and the _reminder date_ . These therefore correspond to three different calendar names, respectively _Fixed break_ , _Fixed break exercise_ and _Fixed break exercise reminder_ .
+--
+<.> `[teal]#*getCalendarEvents*#()` : `Map<String, xref:system:generated:index/extensions/fullcalendar/applib/CalendarEventable.adoc[CalendarEventable]>`
++
+--
+The events associated with this object, keyed by their corresponding _#getCalendarNames() calendar name_ .
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/IsisModuleExtFullCalendarApplib.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/IsisModuleExtFullCalendarApplib.adoc
index 78f204d..7121ca4 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/IsisModuleExtFullCalendarApplib.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtFullCalendarApplib : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtFullCalendarApplib {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/spi/CalendarableDereferencingService.adoc b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/spi/CalendarableDereferencingService.adoc
new file mode 100644
index 0000000..00c47a8
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/spi/CalendarableDereferencingService.adoc
@@ -0,0 +1,16 @@
+= CalendarableDereferencingService : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Optional SPI service that allows a xref:system:generated:index/extensions/fullcalendar/applib/Calendarable.adoc[Calendarable] or xref:system:generated:index/extensions/fullcalendar/applib/CalendarEventable.adoc[CalendarEventable] object to be translated/dereferenced to some other object, typically its owner. The markers on the calendar then open up the dereferenced object, rather than the original xref:system:generated:index/extensions/fullcalendar/applib/Calendarable.adoc[Calendarable] [...]
+
+For example, the `incode-module-commchannel` 's `Note` implements `CalendarEventable` , but this service allows the _owner_ of the `Note` (ie the `Notable` ) sto be shown instead.
+
+.Java Sources
+[source,java]
+----
+interface CalendarableDereferencingService {
+
+ Object dereference(final Object calendarableOrCalendarEventable)
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/value/CalendarEvent.adoc
similarity index 52%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/value/CalendarEvent.adoc
index f147e5c..9ebefe6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/applib/value/CalendarEvent.adoc
@@ -1,37 +1,43 @@
-= GridSystemService : _interface_
+= CalendarEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
+Value type representing an event on a calendar.
.Java Sources
[source,java]
----
-interface GridSystemService {
+class CalendarEvent {
- Class<G> gridImplementation() // <.>
+ // no default
+static final CalendarEvent DEFAULT_VALUE;
- String tns()
+ CalendarEvent(final DateTime dateTime, final String calendarName, final String title)
- String schemaLocation()
+ CalendarEvent(final DateTime dateTime, final String calendarName, final String title, final String notes)
- G defaultGrid(Class<?> domainClass)
+ DateTime getDateTime()
- void normalize(G grid, Class<?> domainClass) // <.>
+ String getCalendarName()
- void complete(G grid, Class<?> domainClass)
+ String getTitle()
- void minimal(G grid, Class<?> domainClass)
+ String getNotes()
+
+ CalendarEvent withDateTime(final DateTime date)
+
+ CalendarEvent withCalendarName(final String calendarName)
+
+ CalendarEvent withTitle(final String title)
+
+ CalendarEvent withNotes(final String notes)
+
+ int hashCode()
+
+ boolean equals(Object obj)
+
+ String toString()
+
+ int typicalLength()
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
-+
---
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/ui/component/IsisModuleExtFullCalendarUi.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/fullcalendar/ui/component/IsisModuleExtFullCalendarUi.adoc
index 78f204d..d245fd9 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/fullcalendar/ui/component/IsisModuleExtFullCalendarUi.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtFullCalendarUi : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtFullCalendarUi {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/hsqldbmgr/dom/IsisModuleExtHsqldbMgr.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/hsqldbmgr/dom/IsisModuleExtHsqldbMgr.adoc
index 78f204d..4326add 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/hsqldbmgr/dom/IsisModuleExtHsqldbMgr.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtHsqldbMgr : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtHsqldbMgr {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/hsqldbmgr/dom/services/HsqlDbManagerMenu.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/hsqldbmgr/dom/services/HsqlDbManagerMenu.adoc
index 78f204d..29badc6 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/hsqldbmgr/dom/services/HsqlDbManagerMenu.adoc
@@ -1,12 +1,16 @@
-= ResourceCoordinates : _class_
+= HsqlDbManagerMenu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class HsqlDbManagerMenu {
- int compareTo(final ResourceCoordinates other)
+ HsqlDbManagerMenu(DataSourceIntrospectionService datasourceIntrospector)
+
+ void hsqlDbManager()
+
+ boolean hideHsqlDbManager()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/IsisModuleExtJaxRsClientApplib.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/IsisModuleExtJaxRsClientApplib.adoc
index 78f204d..b6f9982 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/IsisModuleExtJaxRsClientApplib.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtJaxRsClientApplib : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtJaxRsClientApplib {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/client/JaxRsClient.adoc
similarity index 77%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/client/JaxRsClient.adoc
index ba495fc..7f7b70f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/client/JaxRsClient.adoc
@@ -1,20 +1,14 @@
-= MenuBarsService : _interface_
+= JaxRsClient : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+interface JaxRsClient {
- MenuBars menuBars() // <.>
+ JaxRsResponse get(URI uri, Class<?> dtoClass, ReprType reprType, String username, String password)
- MenuBars menuBars(final Type type)
+ JaxRsResponse post(URI uri, String bodyJson, String username, String password)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/client/JaxRsResponse.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/client/JaxRsResponse.adoc
index 78f204d..c213587 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/jaxrsclient/applib/client/JaxRsResponse.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= JaxRsResponse : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface JaxRsResponse {
- int compareTo(final ResourceCoordinates other)
+ int getStatus()
+
+ T readEntity(final Class<T> entityType)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/applib/IsisModuleIncModelApplib.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/modelannotation/applib/IsisModuleIncModelApplib.adoc
index 78f204d..57e7530 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/applib/IsisModuleIncModelApplib.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleIncModelApplib : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleIncModelApplib {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/applib/annotation/Model.adoc
similarity index 67%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/modelannotation/applib/annotation/Model.adoc
index 505d2bc..aefcba6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/applib/annotation/Model.adoc
@@ -1,25 +1,14 @@
-= MenuBarsLoaderService : _interface_
+= Model : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Indicates that a method is a supporting-method, one that contributes (hide, validate, ...) to an *Action* .
+
+By placing the xref:system:generated:index/extensions/modelannotation/applib/annotation/Model.adoc[Model] annotation on a method, a contract with the meta-model is enforced, such that this method must be recognized and cannot be ignored.
+
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
-
- boolean supportsReloading() // <.>
-
- BS3MenuBars menuBars() // <.>
+@interface Model {
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
-+
---
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
-+
---
-Returns a new instance of a _BS3MenuBars_ , else `null` .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/IsisModuleExtModelAnnotation.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/IsisModuleExtModelAnnotation.adoc
index 78f204d..a0b21ce 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/IsisModuleExtModelAnnotation.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtModelAnnotation : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtModelAnnotation {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/facets/SupportingMethodValidatorRefinerFactory.adoc
similarity index 75%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/facets/SupportingMethodValidatorRefinerFactory.adoc
index ba495fc..76c48ab 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/facets/SupportingMethodValidatorRefinerFactory.adoc
@@ -1,20 +1,16 @@
-= MenuBarsService : _interface_
+= SupportingMethodValidatorRefinerFactory : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class SupportingMethodValidatorRefinerFactory {
- MenuBars menuBars() // <.>
+ SupportingMethodValidatorRefinerFactory()
- MenuBars menuBars(final Type type)
+ void process(ProcessMethodContext processMethodContext)
+
+ void refineProgrammingModel(ProgrammingModel programmingModel)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/services/IncubatorMetaModelPlugin.adoc
similarity index 85%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/services/IncubatorMetaModelPlugin.adoc
index 78f204d..317f25e 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/modelannotation/metamodel/services/IncubatorMetaModelPlugin.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= IncubatorMetaModelPlugin : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IncubatorMetaModelPlugin {
- int compareTo(final ResourceCoordinates other)
+ void refineProgrammingModel(ProgrammingModel programmingModel)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/quartz/IsisModuleExtQuartzImpl.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/quartz/IsisModuleExtQuartzImpl.adoc
index 78f204d..af53926 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/quartz/IsisModuleExtQuartzImpl.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtQuartzImpl : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtQuartzImpl {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/quartz/context/JobExecutionData.adoc
similarity index 62%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/quartz/context/JobExecutionData.adoc
index 505d2bc..8986648 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/quartz/context/JobExecutionData.adoc
@@ -1,25 +1,27 @@
-= MenuBarsLoaderService : _interface_
+= JobExecutionData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Requires that the job is annotated with the _org.quartz.PersistJobDataAfterExecution_ annotation.
+
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
+class JobExecutionData {
- boolean supportsReloading() // <.>
+ String getString(String key, final String defaultValue) // <.>
- BS3MenuBars menuBars() // <.>
+ void setString(String key, String value) // <.>
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
+<.> `[teal]#*getString*#(String key, String defaultValue)` : `String`
+
--
-Whether dynamic reloading of layouts is enabled.
+Lookup property from the job detail.
--
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
+<.> `[teal]#*setString*#(String key, String value)` : `void`
+
--
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+Save key into the job detail obtained from context.
--
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/quartz/spring/AutowiringSpringBeanJobFactory.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/quartz/spring/AutowiringSpringBeanJobFactory.adoc
index 78f204d..1b5cd59 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/quartz/spring/AutowiringSpringBeanJobFactory.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= AutowiringSpringBeanJobFactory : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class AutowiringSpringBeanJobFactory {
- int compareTo(final ResourceCoordinates other)
+ void setApplicationContext(final ApplicationContext context)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/restclient/ActionParameterListBuilder.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/ActionParameterListBuilder.adoc
new file mode 100644
index 0000000..de0d5e1
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/ActionParameterListBuilder.adoc
@@ -0,0 +1,28 @@
+= ActionParameterListBuilder : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+class ActionParameterListBuilder {
+
+ ActionParameterListBuilder addActionParameter(String parameterName, String parameterValue)
+
+ ActionParameterListBuilder addActionParameter(String parameterName, int parameterValue)
+
+ ActionParameterListBuilder addActionParameter(String parameterName, long parameterValue)
+
+ ActionParameterListBuilder addActionParameter(String parameterName, byte parameterValue)
+
+ ActionParameterListBuilder addActionParameter(String parameterName, short parameterValue)
+
+ ActionParameterListBuilder addActionParameter(String parameterName, double parameterValue)
+
+ ActionParameterListBuilder addActionParameter(String parameterName, float parameterValue)
+
+ ActionParameterListBuilder addActionParameter(String parameterName, boolean parameterValue)
+
+ Entity<String> build()
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/IsisModuleExtRestClient.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/restclient/IsisModuleExtRestClient.adoc
index 78f204d..b827b4e 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/IsisModuleExtRestClient.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtRestClient : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtRestClient {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/restclient/ResponseDigest.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/ResponseDigest.adoc
new file mode 100644
index 0000000..37c5aeb
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/ResponseDigest.adoc
@@ -0,0 +1,53 @@
+= ResponseDigest : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+class ResponseDigest {
+
+ ResponseDigest<T> of(final Response response, final Class<T> entityType) // <.>
+
+ ResponseDigest<T> ofList(final Response response, final Class<T> entityType, final GenericType<List<T>> genericType) // <.>
+
+ ResponseDigest<T> ofAsyncFailure(final Future<Response> asyncResponse, final Class<T> entityType, final Exception failure) // <.>
+
+ boolean isSuccess() // <.>
+
+ boolean isFailure() // <.>
+
+ Optional<T> getEntity() // <.>
+
+ Can<T> getEntities() // <.>
+
+ Exception getFailureCause() // <.>
+
+ T singletonOrElseMapFailure(Function<Exception, T> failureMapper) // <.>
+
+ Can<T> multipleOrElseMapFailure(Function<Exception, Can<T>> failureMapper) // <.>
+}
+----
+
+<.> `[teal]#*_of_*#<T>(Response response, Class<T> entityType)` : `xref:system:generated:index/extensions/restclient/ResponseDigest.adoc[ResponseDigest]<T>`
++
+--
+synchronous response processing (single entity)
+--
+<.> `[teal]#*_ofList_*#<T>(Response response, Class<T> entityType, GenericType<List<T>> genericType)` : `xref:system:generated:index/extensions/restclient/ResponseDigest.adoc[ResponseDigest]<T>`
++
+--
+synchronous response processing (list of entities)
+--
+<.> `[teal]#*_ofAsyncFailure_*#<T>(Future<Response> asyncResponse, Class<T> entityType, Exception failure)` : `xref:system:generated:index/extensions/restclient/ResponseDigest.adoc[ResponseDigest]<T>`
++
+--
+a-synchronous response failure processing
+--
+<.> `[teal]#*isSuccess*#()` : `boolean`
+<.> `[teal]#*isFailure*#()` : `boolean`
+<.> `[teal]#*getEntity*#()` : `Optional<T>`
+<.> `[teal]#*getEntities*#()` : `Can<T>`
+<.> `[teal]#*getFailureCause*#()` : `Exception`
+<.> `[teal]#*singletonOrElseMapFailure*#(Function<Exception, T> failureMapper)` : `T`
+<.> `[teal]#*multipleOrElseMapFailure*#(Function<Exception, Can<T>> failureMapper)` : `Can<T>`
+
diff --git a/antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClient.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClient.adoc
new file mode 100644
index 0000000..1368dde
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClient.adoc
@@ -0,0 +1,95 @@
+= RestfulClient : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Setup the Restful Client with Basic-Auth:Synchronous example:Asynchronous example:Maven Setup:
+
+----
+
+RestfulClientConfig clientConfig = new RestfulClientConfig();
+clientConfig.setRestfulBase("http://localhost:8080/helloworld/restful/");
+clientConfig.setUseBasicAuth(true); // default = false
+clientConfig.setRestfulAuthUser("sven");
+clientConfig.setRestfulAuthPassword("pass");
+clientConfig.setUseRequestDebugLogging(true); // default = false
+
+RestfulClient client = RestfulClient.ofConfig(clientConfig);
+----
+
+----
+ _Builder request = client.request(
+ "services/myService/actions/lookupMyObjectById/invoke",
+ SuppressionType.RO);
+
+Entity args = client.arguments()
+ .addActionParameter("id", "12345")
+ .build();
+
+Response response = request.post(args);
+
+ResponseDigest digest = client.digest(response, MyObject.class);_
+
+if(digest.isSuccess()) {
+ System.out.println("result: "+ digest.getEntities().getSingletonOrFail().get$$instanceId());
+} else {
+ digest.getFailureCause().printStackTrace();
+}
+----
+
+----
+ _Builder request = client.request(
+ "services/myService/actions/lookupMyObjectById/invoke",
+ SuppressionType.RO);
+
+Entity args = client.arguments()
+ .addActionParameter("id", "12345")
+ .build();
+
+Future asyncResponse = request
+ .async()
+ .post(args);
+
+CompletableFuture> digestFuture =
+ client.digest(asyncResponse, MyObject.class);
+
+ResponseDigest digest = digestFuture.get(); // blocking_
+
+if(digest.isSuccess()) {
+ System.out.println("result: "+ digest.getEntities().getSingletonOrFail().get$$instanceId());
+} else {
+ digest.getFailureCause().printStackTrace();
+}
+----
+
+----
+ _org.apache.isis.coreisis-core-applib2.0.0-M2-SNAPSHOTorg.glassfish.jersey.extjersey-spring52.29.1org.glassfishjavax.json1.1.4org.eclipse.persistenceorg.eclipse.persistence.moxy2.7.5_
+----
+
+.Java Sources
+[source,java]
+----
+class RestfulClient {
+
+ RestfulClient ofConfig(RestfulClientConfig clientConfig)
+
+ void init(RestfulClientConfig clientConfig)
+
+ RestfulClientConfig getConfig()
+
+ Client getJaxRsClient()
+
+ Builder request(String path, SuppressionType... suppressionTypes)
+
+ Builder request(String path, EnumSet<SuppressionType> suppressionTypes)
+
+ ActionParameterListBuilder arguments()
+
+ ResponseDigest<T> digest(Response response, Class<T> entityType)
+
+ ResponseDigest<T> digestList(Response response, Class<T> entityType, GenericType<List<T>> genericType)
+
+ CompletableFuture<ResponseDigest<T>> digest(final Future<Response> asyncResponse, final Class<T> entityType)
+
+ CompletableFuture<ResponseDigest<T>> digestList(final Future<Response> asyncResponse, final Class<T> entityType, GenericType<List<T>> genericType)
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClientConfig.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClientConfig.adoc
index 78f204d..393c55c 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClientConfig.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= RestfulClientConfig : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class RestfulClientConfig {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClientException.adoc
similarity index 75%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClientException.adoc
index ba495fc..5645290 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/RestfulClientException.adoc
@@ -1,20 +1,18 @@
-= MenuBarsService : _interface_
+= RestfulClientException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class RestfulClientException {
- MenuBars menuBars() // <.>
+ RestfulClientException()
- MenuBars menuBars(final Type type)
+ RestfulClientException(final String message)
+
+ RestfulClientException(final Throwable cause)
+
+ RestfulClientException(final String message, final Throwable cause)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/auth/BasicAuthFilter.adoc
similarity index 77%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/restclient/auth/BasicAuthFilter.adoc
index ba495fc..9f9c81d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/auth/BasicAuthFilter.adoc
@@ -1,20 +1,18 @@
-= MenuBarsService : _interface_
+= BasicAuthFilter : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class BasicAuthFilter {
- MenuBars menuBars() // <.>
+ BasicAuthFilter of(Credentials credentials)
- MenuBars menuBars(final Type type)
+ Credentials getCredentials()
+
+ void setCredentials(Credentials credentials)
+
+ void filter(ClientRequestContext requestContext)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/log/ClientConversationFilter.adoc
similarity index 65%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/restclient/log/ClientConversationFilter.adoc
index dcdaf9a..8c7c303 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/log/ClientConversationFilter.adoc
@@ -1,28 +1,18 @@
-= EntityState : _enum_
+= ClientConversationFilter : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
+interface ClientConversationFilter {
- boolean isPersistable()
+ void onRequest(String endpoint, String method, String acceptHeaderParsing, Map<String, List<String>> headers, String body)
- boolean isAttached()
+ void onResponse(int httpReturnCode, Map<String, List<String>> headers, String body)
- boolean isDetached()
+ void filter(ClientRequestContext requestContext)
- boolean isDestroyed()
+ void filter(ClientRequestContext requestContext, ClientResponseContext responseContext)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/restclient/log/ClientConversationLogger.adoc
similarity index 74%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/restclient/log/ClientConversationLogger.adoc
index ba495fc..9a0a333 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/restclient/log/ClientConversationLogger.adoc
@@ -1,20 +1,14 @@
-= MenuBarsService : _interface_
+= ClientConversationLogger : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+class ClientConversationLogger {
- MenuBars menuBars() // <.>
+ void onRequest(String endpoint, String method, String acceptHeaderParsing, Map<String, List<String>> headers, String body)
- MenuBars menuBars(final Type type)
+ void onResponse(int httpReturnCode, Map<String, List<String>> headers, String body)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/IsisModuleExtSecmanApi.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/IsisModuleExtSecmanApi.adoc
index 78f204d..487a0a1 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/IsisModuleExtSecmanApi.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtSecmanApi : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtSecmanApi {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecmanConfiguration.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecmanConfiguration.adoc
new file mode 100644
index 0000000..851af43
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecmanConfiguration.adoc
@@ -0,0 +1,67 @@
+= SecmanConfiguration : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+class SecmanConfiguration {
+
+ @Getter
+@Builder.Default
+@NonNull
+final String regularUserRoleName;
+
+ @Getter
+@Builder.Default
+@NonNull
+final String fixtureRoleName;
+
+ @Getter
+@Builder.Default
+@NonNull
+final String adminRoleName;
+
+ @Getter
+@Builder.Default
+@NonNull
+final String adminUserName;
+
+ @Getter
+@Builder.Default
+@NonNull
+final String adminPassword;
+
+ @Getter
+@Builder.Default
+@NonNull
+final String[] adminStickyNamespacePermissions; // <.>
+
+ @Getter
+@Singular
+final Set<String> adminAdditionalNamespacePermissions;
+
+ @Getter
+@Builder.Default
+final boolean autoEnableIfDelegatedAndAuthenticated; // <.>
+
+ Stream<String> streamAdminNamespacePermissions()
+
+ boolean isStickyAdminNamespace(String featureFqn)
+}
+----
+
+<.> `[teal]#*adminStickyNamespacePermissions*#` : `String[]`
++
+--
+cannot be removed via user interface
+--
+<.> `[teal]#*autoEnableIfDelegatedAndAuthenticated*#` : `boolean`
++
+--
+Delegated users, on first successful logon, are auto-created but disabled (by default).
+
+This option allows to override this behavior, such that authenticated users are also auto-enabled.
+
+default: false
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealm.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealm.adoc
index 78f204d..904265d 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealm.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= SecurityRealm : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface SecurityRealm {
- int compareTo(final ResourceCoordinates other)
+ EnumSet<SecurityRealmCharacteristic> getCharacteristics()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealmCharacteristic.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealmCharacteristic.adoc
index 78f204d..1f29d96 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealmCharacteristic.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= SecurityRealmCharacteristic : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+enum SecurityRealmCharacteristic {
- int compareTo(final ResourceCoordinates other)
+ DELEGATING
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealmService.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealmService.adoc
index 78f204d..94ce001 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/SecurityRealmService.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= SecurityRealmService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface SecurityRealmService {
- int compareTo(final ResourceCoordinates other)
+ SecurityRealm getCurrentRealm()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/encryption/PasswordEncryptionService.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/encryption/PasswordEncryptionService.adoc
index 78f204d..c183e63 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/encryption/PasswordEncryptionService.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= PasswordEncryptionService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+interface PasswordEncryptionService {
- int compareTo(final ResourceCoordinates other)
+ String encrypt(final String password)
+
+ boolean matches(final String candidate, final String encrypted)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/encryption/PasswordEncryptionServiceNone.adoc
similarity index 82%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/encryption/PasswordEncryptionServiceNone.adoc
index 78f204d..78214a1 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/encryption/PasswordEncryptionServiceNone.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= PasswordEncryptionServiceNone : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class PasswordEncryptionServiceNone {
- int compareTo(final ResourceCoordinates other)
+ String encrypt(String password)
+
+ boolean matches(String candidate, String encrypted)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/events/UserCreatedEvent.adoc
similarity index 62%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/events/UserCreatedEvent.adoc
index dcdaf9a..96214de 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/events/UserCreatedEvent.adoc
@@ -1,28 +1,31 @@
-= EntityState : _enum_
+= UserCreatedEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+SecMan fires this event when a new user entity just got persisted.
-.Java Sources
-[source,java]
-----
-enum EntityState {
+Users may subscribe to this event in order to apply business logic to the newly created user. eg. add default roles
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
+----
- PERSISTABLE_DESTROYED
+@Component
+public class Listener {
+ @EventListener(UserCreatedEvent.class)
+ public void listenOn(UserCreatedEvent event) {
+ // business logic ...
+ }
+}
+----
- boolean isPersistable()
+.Java Sources
+[source,java]
+----
+class UserCreatedEvent {
- boolean isAttached()
+ AccountType getAccountType()
- boolean isDetached()
+ String getUserName()
- boolean isDestroyed()
+ boolean isDelegated()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermission.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermission.adoc
new file mode 100644
index 0000000..af6517d
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermission.adoc
@@ -0,0 +1,49 @@
+= ApplicationPermission : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Specifies how a particular _#getRole() application role_ may interact with a specific _#getFeature() application feature_ .
+
+Each permission has a _#getRule() rule_ and a _#getMode() mode_ . The xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionRule.adoc[ApplicationPermissionRule] determines whether the permission _ApplicationPermissionRule#ALLOW grants_ access to the feature or _ApplicationPermissionRule#VETO veto_ es access to it. The xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionMode.adoc[ApplicationPermissionMode] indicates whether the rol [...]
+
+For a given permission, there is an interaction between the xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionRule.adoc[ApplicationPermissionRule] and the xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionMode.adoc[ApplicationPermissionMode] :
+
+* for an _ApplicationPermissionRule#ALLOW allow_ , a _ApplicationPermissionMode#CHANGING usability_ allow implies _ApplicationPermissionMode#VIEWING visibility_ allow.
+* conversely, for a _ApplicationPermissionRule#VETO veto_ , a _ApplicationPermissionMode#VIEWING visibility_ veto implies a _ApplicationPermissionMode#CHANGING usability_ veto.
+
+.Java Sources
+[source,java]
+----
+interface ApplicationPermission {
+
+ String title() // <.>
+
+ ApplicationFeatureType getFeatureType()
+
+ ApplicationRole getRole()
+
+ void setRole(ApplicationRole applicationRole)
+
+ ApplicationPermissionRule getRule()
+
+ void setRule(ApplicationPermissionRule rule)
+
+ ApplicationPermissionMode getMode()
+
+ void setMode(ApplicationPermissionMode changing)
+
+ String getType()
+
+ String getFeatureFqn()
+
+ void setFeatureFqn(String featureFqn)
+
+ Optional<ApplicationFeatureId> createFeatureId()
+}
+----
+
+<.> `[teal]#*title*#()` : `String`
++
+--
+having a title() method (rather than using @Title annotation) is necessary as a workaround to be able to use wrapperFactory#unwrap(...) method, which is otherwise broken in Isis 1.6.0
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionMode.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionMode.adoc
new file mode 100644
index 0000000..2f2b432
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionMode.adoc
@@ -0,0 +1,37 @@
+= ApplicationPermissionMode : _enum_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Named after UNIX modes (chmodetc), determines that nature of access (of denial of access if vetoed) to an _ApplicationFeature_ .
+
+.Java Sources
+[source,java]
+----
+enum ApplicationPermissionMode {
+
+ VIEWING // <.>
+
+ CHANGING // <.>
+
+ String toString()
+}
+----
+
+<.> `[teal]#*_VIEWING_*#`
++
+--
+Whether the user/role can view (or is prevented from viewing) the application feature (class member).
+
+The xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionRule.adoc[ApplicationPermissionRule] of the xref:system:generated:index/extensions/secman/api/permission/ApplicationPermission.adoc[ApplicationPermission] indicates whether access is being granted or denied.
+--
+<.> `[teal]#*_CHANGING_*#`
++
+--
+Whether can user/role can change (or is prevented from changing) the state of the system using the application feature (class member).
+
+In other words, whether they can execute (if an action, modify/clear (if a property), addTo/removeFrom (if a collection).
+
+The xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionRule.adoc[ApplicationPermissionRule] of the xref:system:generated:index/extensions/secman/api/permission/ApplicationPermission.adoc[ApplicationPermission] indicates whether access is being granted or denied.
+
+Note that the Wicket viewer does not at the time of writing (Isis 1.6.0) support the notion of mutable collections. The RO viewer does, however.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionRepository.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionRepository.adoc
new file mode 100644
index 0000000..2f112db
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionRepository.adoc
@@ -0,0 +1,30 @@
+= ApplicationPermissionRepository : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+interface ApplicationPermissionRepository {
+
+ Optional<P> findByUserAndPermissionValue(String username, ApplicationPermissionValue changingPermissionValue)
+
+ Optional<P> findByRoleAndRuleAndFeature(ApplicationRole holder, ApplicationPermissionRule rule, ApplicationFeatureType type, String featureFqn)
+
+ Collection<P> allPermissions()
+
+ Collection<P> findOrphaned()
+
+ Collection<P> findByFeatureCached(ApplicationFeatureId featureId)
+
+ Collection<P> findByRoleAndRuleAndFeatureTypeCached(ApplicationRole holder, ApplicationPermissionRule rule, ApplicationFeatureType type)
+
+ P newApplicationPermission() // <.>
+
+ P newPermission(ApplicationRole role, ApplicationPermissionRule rule, ApplicationPermissionMode mode, String packageFqn, String className, String memberName)
+
+ P newPermission(ApplicationRole holder, ApplicationPermissionRule rule, ApplicationPermissionMode mode, ApplicationFeatureType featureType, String featureFqn)
+}
+----
+
+<.> `[teal]#*newApplicationPermission*#()` : `P`
+
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionRule.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionRule.adoc
new file mode 100644
index 0000000..ac1366a
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionRule.adoc
@@ -0,0 +1,33 @@
+= ApplicationPermissionRule : _enum_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Whether the permission _#ALLOW grants_ or _#VETO denies_ access to an _ApplicationFeature_ .
+
+.Java Sources
+[source,java]
+----
+enum ApplicationPermissionRule {
+
+ ALLOW // <.>
+
+ VETO // <.>
+
+ String toString()
+}
+----
+
+<.> `[teal]#*_ALLOW_*#`
++
+--
+The permission grants the ability to view/use the _ApplicationFeature_ .
+
+The xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionMode.adoc[ApplicationPermissionMode] determines whether the permission is to only view or also to use the _ApplicationFeature_ .
+--
+<.> `[teal]#*_VETO_*#`
++
+--
+The permission prevents the ability to view/use the _ApplicationFeature_ .
+
+The xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionMode.adoc[ApplicationPermissionMode] determines whether the permission is to only view or also to use the _ApplicationFeature_ .
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionValue.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionValue.adoc
new file mode 100644
index 0000000..0c05a9e
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionValue.adoc
@@ -0,0 +1,34 @@
+= ApplicationPermissionValue : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+A serializable value object representing an (anonymized) xref:system:generated:index/extensions/secman/api/permission/ApplicationPermission.adoc[ApplicationPermission] .
+
+Intended for value type arithmetic and also for caching. No user/role information is held because that information is not required to perform the arithmetic.
+
+.Java Sources
+[source,java]
+----
+class ApplicationPermissionValue {
+
+ ApplicationPermissionValue(final ApplicationFeatureId featureId, final ApplicationPermissionRule rule, final ApplicationPermissionMode mode)
+
+ ApplicationFeatureId getFeatureId()
+
+ ApplicationPermissionRule getRule()
+
+ ApplicationPermissionMode getMode()
+
+ boolean implies(final ApplicationFeatureId featureId, final ApplicationPermissionMode mode)
+
+ boolean refutes(final ApplicationFeatureId featureId, final ApplicationPermissionMode mode)
+
+ int compareTo(final ApplicationPermissionValue o)
+
+ boolean equals(final Object o)
+
+ int hashCode()
+
+ String toString()
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionValueSet.adoc
similarity index 52%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionValueSet.adoc
index dcdaf9a..b750cdf 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/ApplicationPermissionValueSet.adoc
@@ -1,28 +1,26 @@
-= EntityState : _enum_
+= ApplicationPermissionValueSet : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+A serializable value object representing a set of (anonymized) xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionValue.adoc[ApplicationPermissionValue] s.
+
+Intended for value type arithmetic and also for caching.
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
+class ApplicationPermissionValueSet {
- PERSISTABLE_DETACHED
+ ApplicationPermissionValueSet(final List<ApplicationPermissionValue> permissionValues, final PermissionsEvaluationService permissionsEvaluationService)
- PERSISTABLE_DESTROYED
+ boolean grants(final ApplicationFeatureId featureId, final ApplicationPermissionMode mode)
- boolean isPersistable()
+ Evaluation evaluate(final ApplicationFeatureId featureId, final ApplicationPermissionMode mode)
- boolean isAttached()
+ boolean equals(final Object o)
- boolean isDetached()
+ int hashCode()
- boolean isDestroyed()
+ String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationService.adoc
new file mode 100644
index 0000000..cdeaaec4
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationService.adoc
@@ -0,0 +1,18 @@
+= PermissionsEvaluationService : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Strategy for determining which permission should apply when there are multiple that apply for a particular target feature Id, and which may conflict with each other.
+
+All implementations of this interface must be _java.io.Serializable_ , because an instance is serialized into xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionValueSet.adoc[ApplicationPermissionValueSet] .
+
+.Java Sources
+[source,java]
+----
+interface PermissionsEvaluationService {
+
+ ApplicationPermissionValueSet.Evaluation evaluate(final ApplicationFeatureId targetMemberId, final ApplicationPermissionMode mode, final Collection<ApplicationPermissionValue> permissionValues) // <.>
+}
+----
+
+<.> `[teal]#*evaluate*#(ApplicationFeatureId targetMemberId, xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionMode.adoc[ApplicationPermissionMode] mode, Collection<xref:system:generated:index/extensions/secman/api/permission/ApplicationPermissionValue.adoc[ApplicationPermissionValue]> permissionValues)` : `Evaluation`
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceAbstract.adoc
similarity index 73%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceAbstract.adoc
index 78f204d..e63af6f 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceAbstract.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= PermissionsEvaluationServiceAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class PermissionsEvaluationServiceAbstract {
- int compareTo(final ResourceCoordinates other)
+ ApplicationPermissionValueSet.Evaluation evaluate(final ApplicationFeatureId targetMemberId, final ApplicationPermissionMode mode, final Collection<ApplicationPermissionValue> permissionValues)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceAllowBeatsVeto.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceAllowBeatsVeto.adoc
index 78f204d..1c6ec0e 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceAllowBeatsVeto.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= PermissionsEvaluationServiceAllowBeatsVeto : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+An implementation whereby a VETO permission for a feature overrides an ALLOW (for same scope).
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class PermissionsEvaluationServiceAllowBeatsVeto {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceVetoBeatsAllow.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceVetoBeatsAllow.adoc
index 78f204d..069b990 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/permission/PermissionsEvaluationServiceVetoBeatsAllow.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= PermissionsEvaluationServiceVetoBeatsAllow : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+An implementation whereby a VETO permission for a feature overrides an ALLOW (for same scope).
+
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class PermissionsEvaluationServiceVetoBeatsAllow {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/role/ApplicationRole.adoc
similarity index 58%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/role/ApplicationRole.adoc
index 505d2bc..ef2e629 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/role/ApplicationRole.adoc
@@ -1,25 +1,32 @@
-= MenuBarsLoaderService : _interface_
+= ApplicationRole : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
+interface ApplicationRole {
- boolean supportsReloading() // <.>
+ public static final int MAX_LENGTH_NAME;
- BS3MenuBars menuBars() // <.>
+ public static final int TYPICAL_LENGTH_NAME;
+
+ public static final int TYPICAL_LENGTH_DESCRIPTION;
+
+ String title() // <.>
+
+ String getName()
+
+ void setName(String name)
+
+ String getDescription()
+
+ void setDescription(String description)
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
-+
---
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
+<.> `[teal]#*title*#()` : `String`
+
--
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+having a title() method (rather than using @Title annotation) is necessary as a workaround to be able to use wrapperFactory#unwrap(...) method, which is otherwise broken in Isis 1.6.0
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/role/ApplicationRoleRepository.adoc
similarity index 51%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/role/ApplicationRoleRepository.adoc
index f147e5c..079df6b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/role/ApplicationRoleRepository.adoc
@@ -1,37 +1,41 @@
-= GridSystemService : _interface_
+= ApplicationRoleRepository : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
-
.Java Sources
[source,java]
----
-interface GridSystemService {
+interface ApplicationRoleRepository {
+
+ R newApplicationRole() // <.>
+
+ Collection<R> allRoles()
+
+ R newRole(String name, String description)
+
+ Collection<R> findNameContaining(String search)
- Class<G> gridImplementation() // <.>
+ Collection<R> getRoles(ApplicationUser user)
- String tns()
+ Collection<R> findMatching(String search) // <.>
- String schemaLocation()
+ Optional<R> findByName(String roleName)
- G defaultGrid(Class<?> domainClass)
+ Optional<R> findByNameCached(String roleName)
- void normalize(G grid, Class<?> domainClass) // <.>
+ void addRoleToUser(ApplicationRole role, ApplicationUser user)
- void complete(G grid, Class<?> domainClass)
+ void removeRoleFromUser(ApplicationRole role, ApplicationUser user)
- void minimal(G grid, Class<?> domainClass)
+ boolean isAdminRole(ApplicationRole role)
+
+ void deleteRole(ApplicationRole holder)
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
+<.> `[teal]#*newApplicationRole*#()` : `R`
+<.> `[teal]#*findMatching*#(String search)` : `Collection<R>`
+
--
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
+auto-complete support
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancy.adoc
similarity index 72%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancy.adoc
index dcdaf9a..39b8d80 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancy.adoc
@@ -1,28 +1,26 @@
-= EntityState : _enum_
+= ApplicationTenancy : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+interface ApplicationTenancy {
- NOT_PERSISTABLE
+ public static final int MAX_LENGTH_PATH;
- PERSISTABLE_ATTACHED
+ public static final int MAX_LENGTH_NAME;
- PERSISTABLE_DETACHED
+ public static final int TYPICAL_LENGTH_NAME;
- PERSISTABLE_DESTROYED
+ String title()
- boolean isPersistable()
+ String getPath()
- boolean isAttached()
+ String getName()
- boolean isDetached()
+ void setName(String name)
- boolean isDestroyed()
+ ApplicationTenancy getParent()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancyEvaluator.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancyEvaluator.adoc
new file mode 100644
index 0000000..3d10d32
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancyEvaluator.adoc
@@ -0,0 +1,26 @@
+= ApplicationTenancyEvaluator : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Optional SPI interface to be implemented by a domain service, providing an alternative mechanism for evaluating the application tenancy of the object being interacted with (the "what") and optionally also the tenancy of the user making the call (the "who").
+
+.Java Sources
+[source,java]
+----
+interface ApplicationTenancyEvaluator {
+
+ boolean handles(Class<?> cls) // <.>
+
+ String hides(Object domainObject, ApplicationUser applicationUser)
+
+ String disables(Object domainObject, ApplicationUser applicationUser)
+}
+----
+
+<.> `[teal]#*handles*#(Class<?> cls)` : `boolean`
++
+--
+Whether this evaluator can determine the tenancy of the specified domain entity (such as `ToDoItem` ) being interacted with (the "what").
+
+This method is also called to determine if the evaluator is also able to determine the tenancy of the security module's own xref:system:generated:index/extensions/secman/api/user/ApplicationUser.adoc[ApplicationUser] , ie the "who" is doing the interacting. If the evaluator does not handle the class, then the fallback behaviour is to invoke _ApplicationUser#getAtPath()_ } on the xref:system:generated:index/extensions/secman/api/user/ApplicationUser.adoc[ApplicationUser] and use the path [...]
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancyRepository.adoc
similarity index 50%
copy from antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancyRepository.adoc
index f147e5c..de11ea2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/ApplicationTenancyRepository.adoc
@@ -1,37 +1,37 @@
-= GridSystemService : _interface_
+= ApplicationTenancyRepository : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Provides an implementation of _Grid_ .
-
.Java Sources
[source,java]
----
-interface GridSystemService {
+interface ApplicationTenancyRepository {
+
+ T newApplicationTenancy() // <.>
+
+ Collection<T> allTenancies()
+
+ Collection<T> getChildren(ApplicationTenancy tenancy)
- Class<G> gridImplementation() // <.>
+ Collection<T> findByNameOrPathMatchingCached(String partialNameOrPath)
- String tns()
+ Collection<T> findMatching(String search) // <.>
- String schemaLocation()
+ T newTenancy(String name, String path, ApplicationTenancy parent)
- G defaultGrid(Class<?> domainClass)
+ void setTenancyOnUser(ApplicationTenancy tenancy, ApplicationUser user)
- void normalize(G grid, Class<?> domainClass) // <.>
+ void clearTenancyOnUser(ApplicationUser user)
- void complete(G grid, Class<?> domainClass)
+ void setParentOnTenancy(ApplicationTenancy tenancy, ApplicationTenancy parent)
- void minimal(G grid, Class<?> domainClass)
+ void clearParentOnTenancy(ApplicationTenancy tenancy)
}
----
-<.> `[teal]#*gridImplementation*#()` : `Class<G>`
-+
---
-Which grid (implementation) is defined by this service.
---
-<.> `[teal]#*normalize*#(G grid, Class<?> domainClass)` : `void`
+<.> `[teal]#*newApplicationTenancy*#()` : `T`
+<.> `[teal]#*findMatching*#(String search)` : `Collection<T>`
+
--
-Validate the grid, derive any missing object members, and overwrite any facets in the metamodel based on the layout.
+auto-complete support
--
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/HasAtPath.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/HasAtPath.adoc
new file mode 100644
index 0000000..3d714dc
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/tenancy/HasAtPath.adoc
@@ -0,0 +1,20 @@
+= HasAtPath : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Role interface for domain objects to implement, indicating that these are characteristics of the entity that can be used to determine its visibility/editability.object's tenancyuser's tenancyaccessnullnulleditablenullnon-nulleditable//editable//itvisible//it/carvisible//it/iglvisible//frvisible/nullnot visible/it/editable/it/iteditable/it/it/carvisible/it/it/iglvisible/it/frnot visible/itnullnot visible/it/car/editable/it/car/iteditable/it/car/it/careditable/it/car/it/iglnot visible/it/c [...]
+
+Previously theatPathwould have corresponded to the unique path of some particular xref:system:generated:index/extensions/secman/api/tenancy/ApplicationTenancy.adoc[ApplicationTenancy] instance. However, this has now been generalized; the atPath is simply a string whose interpretation is application-specific (in particular by the xref:system:generated:index/extensions/secman/api/tenancy/ApplicationTenancyEvaluator.adoc[ApplicationTenancyEvaluator] SPI).
+
+For applications that still wish to follow the original more specific design (that theatPathcorresponds to a single xref:system:generated:index/extensions/secman/api/tenancy/ApplicationTenancy.adoc[ApplicationTenancy] ), then the path can be interpreted according to the following table:
+
+any object that is not tenanted (that is, its class does not implement xref:system:generated:index/extensions/secman/api/tenancy/HasAtPath.adoc[HasAtPath] is accessible by any user (usual permission rules apply).
+
+.Java Sources
+[source,java]
+----
+interface HasAtPath {
+
+ String getAtPath()
+}
+----
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/AccountType.adoc
similarity index 71%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/user/AccountType.adoc
index dcdaf9a..2e5f355 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/AccountType.adoc
@@ -1,28 +1,22 @@
-= EntityState : _enum_
+= AccountType : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+Whether the user's account is local enabled (user/password) or delegated (eg LDAP), as per _IsisModuleSecurityRealm#setDelegateAuthenticationRealm(org.apache.shiro.realm.AuthenticatingRealm)_ .
.Java Sources
[source,java]
----
-enum EntityState {
+enum AccountType {
- NOT_PERSISTABLE
+ LOCAL
- PERSISTABLE_ATTACHED
+ DELEGATED
- PERSISTABLE_DETACHED
+ boolean isLocal()
- PERSISTABLE_DESTROYED
+ boolean isDelegated()
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUser.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUser.adoc
new file mode 100644
index 0000000..111740c
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUser.adoc
@@ -0,0 +1,84 @@
+= ApplicationUser : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+interface ApplicationUser {
+
+ public static final int MAX_LENGTH_USERNAME;
+
+ public static final int MAX_LENGTH_FAMILY_NAME;
+
+ public static final int MAX_LENGTH_GIVEN_NAME;
+
+ public static final int MAX_LENGTH_KNOWN_AS;
+
+ public static final int MAX_LENGTH_EMAIL_ADDRESS;
+
+ public static final int MAX_LENGTH_PHONE_NUMBER;
+
+ String title() // <.>
+
+ String iconName()
+
+ String getName()
+
+ String getEncryptedPassword()
+
+ AccountType getAccountType()
+
+ void setAccountType(AccountType accountType)
+
+ ApplicationPermissionValueSet getPermissionSet()
+
+ SortedSet<? extends ApplicationRole> getRoles()
+
+ ApplicationUserStatus getStatus()
+
+ void setStatus(ApplicationUserStatus disabled)
+
+ void setAtPath(String atPath)
+
+ String getEmailAddress()
+
+ void setEmailAddress(String emailAddress)
+
+ String getFaxNumber()
+
+ void setFaxNumber(String faxNumber)
+
+ String getFamilyName()
+
+ void setFamilyName(String familyName)
+
+ String getGivenName()
+
+ void setGivenName(String givenName)
+
+ String getKnownAs()
+
+ void setKnownAs(String knownAs)
+
+ String getPhoneNumber()
+
+ void setPhoneNumber(String phoneNumber)
+
+ void setUsername(String username)
+
+ void setEncryptedPassword(String encryptedPassword)
+
+ boolean isForSelfOrRunAsAdministrator()
+
+ boolean isHasPassword()
+
+ boolean isLocalAccount()
+}
+----
+
+<.> `[teal]#*title*#()` : `String`
++
+--
+having a title() method (rather than using @Title annotation) is necessary as a workaround to be able to use wrapperFactory#unwrap(...) method, which is otherwise broken in Isis 1.6.0
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUserRepository.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUserRepository.adoc
new file mode 100644
index 0000000..2f255af
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUserRepository.adoc
@@ -0,0 +1,51 @@
+= ApplicationUserRepository : _interface_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+interface ApplicationUserRepository {
+
+ U newApplicationUser() // <.>
+
+ Optional<U> findByUsername(String username)
+
+ U findOrCreateUserByUsername(String username)
+
+ Collection<U> allUsers()
+
+ Collection<U> find(String search)
+
+ Collection<U> findByAtPath(String atPath)
+
+ Collection<U> findByRole(ApplicationRole role)
+
+ Collection<U> findByTenancy(ApplicationTenancy tenancy)
+
+ Collection<U> findMatching(String search) // <.>
+
+ void enable(ApplicationUser user)
+
+ void disable(ApplicationUser user)
+
+ boolean isAdminUser(ApplicationUser user)
+
+ boolean isPasswordFeatureEnabled(ApplicationUser holder)
+
+ boolean updatePassword(ApplicationUser user, String password)
+
+ U newUser(String username, AccountType accountType, Consumer<U> beforePersist)
+
+ U newLocalUser(String username, Password password, ApplicationUserStatus status)
+
+ U newDelegateUser(String username, ApplicationUserStatus status)
+}
+----
+
+<.> `[teal]#*newApplicationUser*#()` : `U`
+<.> `[teal]#*findMatching*#(String search)` : `Collection<U>`
++
+--
+auto-complete support
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUserStatus.adoc
similarity index 77%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUserStatus.adoc
index ba495fc..be6cc7f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/api/user/ApplicationUserStatus.adoc
@@ -1,20 +1,22 @@
-= MenuBarsService : _interface_
+= ApplicationUserStatus : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Whether the user's account is enabled or disabled.
+
.Java Sources
[source,java]
----
-interface MenuBarsService {
+enum ApplicationUserStatus {
+
+ ENABLED
+
+ DISABLED
- MenuBars menuBars() // <.>
+ ApplicationUserStatus parse(final Boolean enabled)
- MenuBars menuBars(final Type type)
+ String toString()
+
+ boolean isEnabled()
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/encryption/jbcrypt/IsisModuleExtSecmanEncryptionJbcrypt.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/encryption/jbcrypt/IsisModuleExtSecmanEncryptionJbcrypt.adoc
index 78f204d..f3e437c 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/encryption/jbcrypt/IsisModuleExtSecmanEncryptionJbcrypt.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtSecmanEncryptionJbcrypt : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtSecmanEncryptionJbcrypt {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/encryption/jbcrypt/services/PasswordEncryptionServiceUsingJBcrypt.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/encryption/jbcrypt/services/PasswordEncryptionServiceUsingJBcrypt.adoc
index 78f204d..899ab00 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/encryption/jbcrypt/services/PasswordEncryptionServiceUsingJBcrypt.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= PasswordEncryptionServiceUsingJBcrypt : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class PasswordEncryptionServiceUsingJBcrypt {
- int compareTo(final ResourceCoordinates other)
+ String encrypt(String password)
+
+ boolean matches(String candidate, String encrypted)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/IsisModuleExtSecmanPersistenceJdo.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/IsisModuleExtSecmanPersistenceJdo.adoc
index 78f204d..0d87a3a 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/IsisModuleExtSecmanPersistenceJdo.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtSecmanPersistenceJdo : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtSecmanPersistenceJdo {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/SeedSecurityModuleService.adoc
similarity index 80%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/SeedSecurityModuleService.adoc
index 78f204d..4f32d36 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/SeedSecurityModuleService.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= SeedSecurityModuleService : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class SeedSecurityModuleService {
- int compareTo(final ResourceCoordinates other)
+ SeedSecurityModuleService(final FixtureScripts fixtureScripts)
+
+ void onMetamodelEvent(final MetamodelEvent event)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/SeedUsersAndRolesFixtureScript.adoc
similarity index 61%
copy from antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/SeedUsersAndRolesFixtureScript.adoc
index 7747117..6d7e512 100644
--- a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/SeedUsersAndRolesFixtureScript.adoc
@@ -1,16 +1,12 @@
-= AbstractViewModel : _class_
+= SeedUsersAndRolesFixtureScript : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Convenience super class for view models that wish to interact with the container.
-
-Subclassing is NOT mandatory; the methods in this superclass can be pushed down into domain objects and another superclass used if required.
-
-As an alternative, consider simply annotating the view model class with _org.apache.isis.applib.annotation.ViewModel_ .
+This fixture script will be run automatically on start-up by virtue of the fact that the xref:system:generated:index/extensions/secman/jdo/seed/SeedSecurityModuleService.adoc[SeedSecurityModuleService] is a _org.apache.isis.applib.annotation.DomainService_ and calls the setup during its _org.apache.isis.extensions.secman.jdo.seed.SeedSecurityModuleService#init() init_ ( _javax.annotation.PostConstruct_ ) method.
.Java Sources
[source,java]
----
-class AbstractViewModel {
+class SeedUsersAndRolesFixtureScript {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/GlobalTenancy.adoc
similarity index 85%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/GlobalTenancy.adoc
index 78f204d..efb2984 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/GlobalTenancy.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= GlobalTenancy : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class GlobalTenancy {
- int compareTo(final ResourceCoordinates other)
+ public static final String TENANCY_NAME;
+
+ public static final String TENANCY_PATH;
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtFixturesFixtureResultsRoleAndPermissions.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtFixturesFixtureResultsRoleAndPermissions.adoc
index 78f204d..d239e70 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtFixturesFixtureResultsRoleAndPermissions.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= IsisExtFixturesFixtureResultsRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IsisExtFixturesFixtureResultsRoleAndPermissions {
- int compareTo(final ResourceCoordinates other)
+ public static final String ROLE_NAME;
+
+ IsisExtFixturesFixtureResultsRoleAndPermissions()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanAdminRoleAndPermissions.adoc
similarity index 82%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanAdminRoleAndPermissions.adoc
index 78f204d..f4683e9 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanAdminRoleAndPermissions.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= IsisExtSecmanAdminRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IsisExtSecmanAdminRoleAndPermissions {
- int compareTo(final ResourceCoordinates other)
+ IsisExtSecmanAdminRoleAndPermissions(SecmanConfiguration configBean)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanAdminUser.adoc
similarity index 86%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanAdminUser.adoc
index 78f204d..16f1e85 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanAdminUser.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= IsisExtSecmanAdminUser : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IsisExtSecmanAdminUser {
- int compareTo(final ResourceCoordinates other)
+ IsisExtSecmanAdminUser(SecmanConfiguration configBean)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanFixtureRoleAndPermissions.adoc
similarity index 75%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanFixtureRoleAndPermissions.adoc
index ba495fc..42c845b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanFixtureRoleAndPermissions.adoc
@@ -1,20 +1,14 @@
-= MenuBarsService : _interface_
+= IsisExtSecmanFixtureRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Role to run in the prototype fixture scripts for the example webapp for the security module.
+
.Java Sources
[source,java]
----
-interface MenuBarsService {
-
- MenuBars menuBars() // <.>
+class IsisExtSecmanFixtureRoleAndPermissions {
- MenuBars menuBars(final Type type)
+ IsisExtSecmanFixtureRoleAndPermissions(SecmanConfiguration configBean)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanRegularUserRoleAndPermissions.adoc
similarity index 65%
copy from antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanRegularUserRoleAndPermissions.adoc
index 7747117..5a86e22 100644
--- a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jdo/seed/scripts/IsisExtSecmanRegularUserRoleAndPermissions.adoc
@@ -1,16 +1,14 @@
-= AbstractViewModel : _class_
+= IsisExtSecmanRegularUserRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Convenience super class for view models that wish to interact with the container.
-
-Subclassing is NOT mandatory; the methods in this superclass can be pushed down into domain objects and another superclass used if required.
-
-As an alternative, consider simply annotating the view model class with _org.apache.isis.applib.annotation.ViewModel_ .
+Role for regular users of the security module, providing the ability to lookup their user account using the xref:system:generated:index/extensions/secman/model/app/user/MeService.adoc[MeService] , and for viewing and maintaining their user details.
.Java Sources
[source,java]
----
-class AbstractViewModel {
+class IsisExtSecmanRegularUserRoleAndPermissions {
+
+ IsisExtSecmanRegularUserRoleAndPermissions(SecmanConfiguration configBean)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/IsisModuleExtSecmanPersistenceJpa.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/IsisModuleExtSecmanPersistenceJpa.adoc
index 78f204d..91f9261 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/IsisModuleExtSecmanPersistenceJpa.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtSecmanPersistenceJpa : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtSecmanPersistenceJpa {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/SeedSecurityModuleService.adoc
similarity index 80%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/SeedSecurityModuleService.adoc
index 78f204d..4f32d36 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/SeedSecurityModuleService.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= SeedSecurityModuleService : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class SeedSecurityModuleService {
- int compareTo(final ResourceCoordinates other)
+ SeedSecurityModuleService(final FixtureScripts fixtureScripts)
+
+ void onMetamodelEvent(final MetamodelEvent event)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/SeedUsersAndRolesFixtureScript.adoc
similarity index 61%
copy from antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/SeedUsersAndRolesFixtureScript.adoc
index 7747117..19ed831 100644
--- a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/SeedUsersAndRolesFixtureScript.adoc
@@ -1,16 +1,12 @@
-= AbstractViewModel : _class_
+= SeedUsersAndRolesFixtureScript : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Convenience super class for view models that wish to interact with the container.
-
-Subclassing is NOT mandatory; the methods in this superclass can be pushed down into domain objects and another superclass used if required.
-
-As an alternative, consider simply annotating the view model class with _org.apache.isis.applib.annotation.ViewModel_ .
+This fixture script will be run automatically on start-up by virtue of the fact that the xref:system:generated:index/extensions/secman/jpa/seed/SeedSecurityModuleService.adoc[SeedSecurityModuleService] is a _org.apache.isis.applib.annotation.DomainService_ and calls the setup during its _org.apache.isis.extensions.secman.jpa.seed.SeedSecurityModuleService#init() init_ ( _javax.annotation.PostConstruct_ ) method.
.Java Sources
[source,java]
----
-class AbstractViewModel {
+class SeedUsersAndRolesFixtureScript {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/GlobalTenancy.adoc
similarity index 85%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/GlobalTenancy.adoc
index 78f204d..efb2984 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/GlobalTenancy.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= GlobalTenancy : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class GlobalTenancy {
- int compareTo(final ResourceCoordinates other)
+ public static final String TENANCY_NAME;
+
+ public static final String TENANCY_PATH;
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtFixturesFixtureResultsRoleAndPermissions.adoc
similarity index 79%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtFixturesFixtureResultsRoleAndPermissions.adoc
index 78f204d..d239e70 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtFixturesFixtureResultsRoleAndPermissions.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= IsisExtFixturesFixtureResultsRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IsisExtFixturesFixtureResultsRoleAndPermissions {
- int compareTo(final ResourceCoordinates other)
+ public static final String ROLE_NAME;
+
+ IsisExtFixturesFixtureResultsRoleAndPermissions()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanAdminRoleAndPermissions.adoc
similarity index 82%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanAdminRoleAndPermissions.adoc
index 78f204d..f4683e9 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanAdminRoleAndPermissions.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= IsisExtSecmanAdminRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IsisExtSecmanAdminRoleAndPermissions {
- int compareTo(final ResourceCoordinates other)
+ IsisExtSecmanAdminRoleAndPermissions(SecmanConfiguration configBean)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanAdminUser.adoc
similarity index 86%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanAdminUser.adoc
index 78f204d..16f1e85 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanAdminUser.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= IsisExtSecmanAdminUser : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class IsisExtSecmanAdminUser {
- int compareTo(final ResourceCoordinates other)
+ IsisExtSecmanAdminUser(SecmanConfiguration configBean)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanFixtureRoleAndPermissions.adoc
similarity index 75%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanFixtureRoleAndPermissions.adoc
index ba495fc..42c845b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanFixtureRoleAndPermissions.adoc
@@ -1,20 +1,14 @@
-= MenuBarsService : _interface_
+= IsisExtSecmanFixtureRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+Role to run in the prototype fixture scripts for the example webapp for the security module.
+
.Java Sources
[source,java]
----
-interface MenuBarsService {
-
- MenuBars menuBars() // <.>
+class IsisExtSecmanFixtureRoleAndPermissions {
- MenuBars menuBars(final Type type)
+ IsisExtSecmanFixtureRoleAndPermissions(SecmanConfiguration configBean)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanRegularUserRoleAndPermissions.adoc
similarity index 65%
copy from antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanRegularUserRoleAndPermissions.adoc
index 7747117..5a86e22 100644
--- a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/seed/scripts/IsisExtSecmanRegularUserRoleAndPermissions.adoc
@@ -1,16 +1,14 @@
-= AbstractViewModel : _class_
+= IsisExtSecmanRegularUserRoleAndPermissions : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Convenience super class for view models that wish to interact with the container.
-
-Subclassing is NOT mandatory; the methods in this superclass can be pushed down into domain objects and another superclass used if required.
-
-As an alternative, consider simply annotating the view model class with _org.apache.isis.applib.annotation.ViewModel_ .
+Role for regular users of the security module, providing the ability to lookup their user account using the xref:system:generated:index/extensions/secman/model/app/user/MeService.adoc[MeService] , and for viewing and maintaining their user details.
.Java Sources
[source,java]
----
-class AbstractViewModel {
+class IsisExtSecmanRegularUserRoleAndPermissions {
+
+ IsisExtSecmanRegularUserRoleAndPermissions(SecmanConfiguration configBean)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/userreg/SecurityModuleAppUserRegistrationServiceAbstract.adoc
similarity index 58%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/jpa/userreg/SecurityModuleAppUserRegistrationServiceAbstract.adoc
index dcdaf9a..3a59eed 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/jpa/userreg/SecurityModuleAppUserRegistrationServiceAbstract.adoc
@@ -1,28 +1,20 @@
-= EntityState : _enum_
+= SecurityModuleAppUserRegistrationServiceAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+An abstract implementation of xref:system:generated:index/applib/services/userreg/UserRegistrationService.adoc[UserRegistrationService] with a single abstract method for the initial role of newly created local users
.Java Sources
[source,java]
----
-enum EntityState {
+class SecurityModuleAppUserRegistrationServiceAbstract {
- NOT_PERSISTABLE
+ boolean usernameExists(final String username)
- PERSISTABLE_ATTACHED
+ void registerUser(final UserDetails userDetails)
- PERSISTABLE_DETACHED
+ boolean emailExists(final String emailAddress)
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ boolean updatePasswordByEmail(final String emailAddress, final String password)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/model/IsisModuleExtSecmanModel.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/model/IsisModuleExtSecmanModel.adoc
index 78f204d..848d74e 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/model/IsisModuleExtSecmanModel.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtSecmanModel : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtSecmanModel {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/model/app/user/MeService.adoc
similarity index 88%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/model/app/user/MeService.adoc
index 78f204d..cfe265e 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/model/app/user/MeService.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= MeService : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class MeService {
- int compareTo(final ResourceCoordinates other)
+ String iconName()
+
+ ApplicationUser me()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/IsisModuleExtSecmanRealmShiro.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/shiro/IsisModuleExtSecmanRealmShiro.adoc
index 78f204d..31dd469 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/IsisModuleExtSecmanRealmShiro.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtSecmanRealmShiro : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtSecmanRealmShiro {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/IsisModuleExtSecmanShiroRealm.adoc
similarity index 62%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/shiro/IsisModuleExtSecmanShiroRealm.adoc
index 505d2bc..f4c0eac 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/IsisModuleExtSecmanShiroRealm.adoc
@@ -1,25 +1,24 @@
-= MenuBarsLoaderService : _interface_
+= IsisModuleExtSecmanShiroRealm : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsLoaderService {
+class IsisModuleExtSecmanShiroRealm {
- boolean supportsReloading() // <.>
+ IsisModuleExtSecmanShiroRealm() // <.>
- BS3MenuBars menuBars() // <.>
+ EnumSet<SecurityRealmCharacteristic> getCharacteristics()
+
+ V execute(final Supplier<V> closure)
+
+ V doExecute(final Supplier<V> closure)
}
----
-<.> `[teal]#*supportsReloading*#()` : `boolean`
-+
---
-Whether dynamic reloading of layouts is enabled.
---
-<.> `[teal]#*menuBars*#()` : `BS3MenuBars`
+<.> `[teal]#*IsisModuleExtSecmanShiroRealm*#()`
+
--
-Returns a new instance of a _BS3MenuBars_ , else `null` .
+Configures a _org.apache.shiro.authz.permission.PermissionResolver_ that knows how to process the permission strings that are provided by Isis' _Authorizor_ for Shiro.
--
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/services/SecurityRealmServiceUsingShiro.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/shiro/services/SecurityRealmServiceUsingShiro.adoc
index 78f204d..09239e8 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/services/SecurityRealmServiceUsingShiro.adoc
@@ -1,12 +1,12 @@
-= ResourceCoordinates : _class_
+= SecurityRealmServiceUsingShiro : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class SecurityRealmServiceUsingShiro {
- int compareTo(final ResourceCoordinates other)
+ SecurityRealm getCurrentRealm()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/util/ShiroUtils.adoc
similarity index 82%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/secman/shiro/util/ShiroUtils.adoc
index 78f204d..7cb97fe 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/secman/shiro/util/ShiroUtils.adoc
@@ -1,12 +1,16 @@
-= ResourceCoordinates : _class_
+= ShiroUtils : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class ShiroUtils {
- int compareTo(final ResourceCoordinates other)
+ RealmSecurityManager getSecurityManager()
+
+ IsisModuleExtSecmanShiroRealm getIsisModuleSecurityRealm()
+
+ boolean isSingleRealm()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisLdapContextFactory.adoc
similarity index 59%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisLdapContextFactory.adoc
index dcdaf9a..f3ac6fe 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisLdapContextFactory.adoc
@@ -1,28 +1,18 @@
-= EntityState : _enum_
+= IsisLdapContextFactory : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+An extension of _JndiLdapContextFactory_ that allows a different authentication mechanism for system-level authentications (as used by authorization lookups, for example) compared to regular authentication.
+
+See xref:system:generated:index/extensions/shirorealmldap/realm/impl/IsisLdapRealm.adoc[IsisLdapRealm] for typical configuration within `shiro.ini` .
.Java Sources
[source,java]
----
-enum EntityState {
-
- NOT_PERSISTABLE
-
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
+class IsisLdapContextFactory {
- boolean isDetached()
+ String getSystemAuthenticationMechanism()
- boolean isDestroyed()
+ void setSystemAuthenticationMechanism(String systemAuthenticationMechanism)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisLdapRealm.adoc b/antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisLdapRealm.adoc
new file mode 100644
index 0000000..24788ce
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisLdapRealm.adoc
@@ -0,0 +1,147 @@
+= IsisLdapRealm : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+Implementation of _org.apache.shiro.realm.ldap.JndiLdapRealm_ that also returns each user's groups.
+
+Sample config for `shiro.ini` :
+
+----
+
+contextFactory = org.apache.isis.extensions.shirorealmldap.realm.impl.IsisLdapContextFactory
+contextFactory.url = ldap://localhost:10389
+contextFactory.authenticationMechanism = CRAM-MD5
+contextFactory.systemAuthenticationMechanism = simple
+contextFactory.systemUsername = uid=admin,ou=system
+contextFactory.systemPassword = secret
+
+ldapRealm = org.apache.isis.extensions.shirorealmldap.realm.impl.IsisLdapRealm
+ldapRealm.contextFactory = $contextFactory
+
+ldapRealm.searchBase = ou=groups,o=mojo
+ldapRealm.groupObjectClass = groupOfUniqueNames
+ldapRealm.uniqueMemberAttribute = uniqueMember
+ldapRealm.uniqueMemberAttributeValueTemplate = uid={0}
+
+ldapRealm.searchUserBase = ou=users,o=mojo
+ldapRealm.userObjectClass=inetOrgPerson
+ldapRealm.groupExtractedAttribute=street,country
+ldapRealm.userExtractedAttribute=street,country
+ldapRealm.permissionByGroupAttribute=attribute:Folder.{street}:Read,attribute:Portfolio.{country}
+ldapRealm.permissionByUserAttribute=attribute:Folder.{street}:Read,attribute:Portfolio.{country}
+
+# optional mapping from physical groups to logical application roles
+ldapRealm.rolesByGroup = \
+ LDN_USERS: user_role,\
+ NYK_USERS: user_role,\
+ HKG_USERS: user_role,\
+ GLOBAL_ADMIN: admin_role,\
+ DEMOS: self-install_role
+
+securityManager.realms = $ldapRealm
+----
+
+The permissions for each role can be specified using the _#setResourcePath(String)_ to an 'ini' file with a [roles] section, eg:
+
+----
+
+ldapRealm.resourcePath=classpath:webapp/myroles.ini
+----
+
+where `myroles.ini` is in `src/main/resources/webapp` , and takes the form:
+
+----
+
+[roles]
+user_role = *:ToDoItemsJdo:*:*,\
+ *:ToDoItem:*:*
+self-install_role = *:ToDoItemsFixturesService:install:*
+admin_role = *
+----
+
+This 'ini' file can then be referenced by other realms (if multiple realm are configured with the Shiro security manager).
+
+Alternatively, permissions can be set directly using _#setPermissionsByRole(String)_ , where the string is the same information, formatted thus:
+
+----
+
+ldapRealm.permissionsByRole=\
+ user_role = *:ToDoItemsJdo:*:*,\
+ *:ToDoItem:*:*; \
+ self-install_role = *:ToDoItemsFixturesService:install:* ; \
+ admin_role = *
+----
+
+Alternatively, permissions can be extracted from the base itself with the parameter searchUserBase, the attribute list as userExtractedAttribute and the permission url as permissionByUserAttribute. The idea is to extract attribute from the user or the group of the user and map directly to permission rule in replacing the string {attribute} by the extracted attribute (can me multiple). See the sample for group and user attribute and mapping.
+
+.Java Sources
+[source,java]
+----
+class IsisLdapRealm {
+
+ IsisLdapRealm()
+
+ void setSearchBase(String searchBase)
+
+ void setGroupObjectClass(String groupObjectClassAttribute)
+
+ void setUniqueMemberAttribute(String uniqueMemberAttribute)
+
+ void setUniqueMemberAttributeValueTemplate(String template)
+
+ void setRolesByGroup(Map<String, String> rolesByGroup)
+
+ void setResourcePath(String resourcePath) // <.>
+
+ void setPermissionsByRole(String permissionsByRoleStr) // <.>
+
+ void setPermissionByUserAttribute(String permissionByUserAttr)
+
+ void setPermissionByGroupAttribute(String permissionByGroupAttribute)
+
+ void setUserExtractedAttribute(String userExtractedAttribute)
+
+ void setGroupExtractedAttribute(String groupExtractedAttribute)
+
+ void setSearchUserBase(String searchUserBase)
+
+ void setUserObjectClass(String userObjectClass)
+
+ void setCnAttribute(String cnAttribute)
+}
+----
+
+<.> `[teal]#*setResourcePath*#(String resourcePath)` : `void`
++
+--
+----
+
+ldapRealm.resourcePath=classpath:webapp/myroles.ini
+----
+
+where `myroles.ini` is in `src/main/resources/webapp` , and takes the form:This 'ini' file can then be referenced by other realms (if multiple realm are configured with the Shiro security manager).
+
+----
+
+[roles]
+user_role = *:ToDoItemsJdo:*:*,\
+ *:ToDoItem:*:*
+self-install_role = *:ToDoItemsFixturesService:install:*
+admin_role = *
+----
+
+--
+<.> `[line-through gray]#*setPermissionsByRole*#(String permissionsByRoleStr)` : `void`
++
+--
+Specify permissions for each role using a formatted string.
+
+----
+
+ldapRealm.permissionsByRole=\
+ user_role = *:ToDoItemsJdo:*:*,\
+ *:ToDoItem:*:*; \
+ self-install_role = *:ToDoItemsFixturesService:install:* ; \
+ admin_role = *
+----
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisModuleExtShiroRealmLdapImpl.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisModuleExtShiroRealmLdapImpl.adoc
index 78f204d..2acfe38 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/shirorealmldap/realm/impl/IsisModuleExtShiroRealmLdapImpl.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtShiroRealmLdapImpl : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtShiroRealmLdapImpl {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/IsisModuleExtExcelDownloadUi.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/IsisModuleExtExcelDownloadUi.adoc
index 78f204d..e48db38 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/IsisModuleExtExcelDownloadUi.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtExcelDownloadUi : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtExcelDownloadUi {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/components/CollectionContentsAsExcel.adoc
similarity index 70%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/components/CollectionContentsAsExcel.adoc
index dcdaf9a..6449949 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/components/CollectionContentsAsExcel.adoc
@@ -1,28 +1,16 @@
-= EntityState : _enum_
+= CollectionContentsAsExcel : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+_PanelAbstract Panel_ that represents a _EntityCollectionModel collection of entity_ s rendered using _AjaxFallbackDefaultDataTable_ .
.Java Sources
[source,java]
----
-enum EntityState {
+class CollectionContentsAsExcel {
- NOT_PERSISTABLE
+ CollectionContentsAsExcel(final String id, final EntityCollectionModel model)
- PERSISTABLE_ATTACHED
-
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ void renderHead(IHeaderResponse response)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/components/CollectionContentsAsExcelFactory.adoc
similarity index 63%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/components/CollectionContentsAsExcelFactory.adoc
index dcdaf9a..16e815e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/exceldownload/ui/components/CollectionContentsAsExcelFactory.adoc
@@ -1,28 +1,22 @@
-= EntityState : _enum_
+= CollectionContentsAsExcelFactory : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+_ComponentFactory_ for xref:system:generated:index/extensions/viewer/wicket/exceldownload/ui/components/CollectionContentsAsExcel.adoc[CollectionContentsAsExcel] .
.Java Sources
[source,java]
----
-enum EntityState {
+class CollectionContentsAsExcelFactory {
- NOT_PERSISTABLE
+ CollectionContentsAsExcelFactory()
- PERSISTABLE_ATTACHED
+ ApplicationAdvice appliesTo(final IModel<?> model)
- PERSISTABLE_DETACHED
+ Component createComponent(final String id, final IModel<?> model)
- PERSISTABLE_DESTROYED
+ IModel<String> getTitleLabel()
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ IModel<String> getCssClass()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/annotations/PdfJsViewer.adoc
similarity index 70%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/annotations/PdfJsViewer.adoc
index dcdaf9a..605d5df 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/annotations/PdfJsViewer.adoc
@@ -1,28 +1,18 @@
-= EntityState : _enum_
+= PdfJsViewer : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+An annotation that could be applied on a property or parameter of type _org.apache.isis.applib.value.Blob_ . Such property/parameter will be visualized withPDF.jsviewer.
.Java Sources
[source,java]
----
-enum EntityState {
+@interface PdfJsViewer {
- NOT_PERSISTABLE
+ int initialPageNum() default 1;
- PERSISTABLE_ATTACHED
+ Scale initialScale() default Scale._1_00;
- PERSISTABLE_DETACHED
-
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ int initialHeight() default 800;
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/config/PdfJsConfig.adoc
similarity index 57%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/config/PdfJsConfig.adoc
index dcdaf9a..6245abc 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/config/PdfJsConfig.adoc
@@ -1,28 +1,38 @@
-= EntityState : _enum_
+= PdfJsConfig : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
-
.Java Sources
[source,java]
----
-enum EntityState {
+class PdfJsConfig {
+
+ PdfJsConfig withInitialPage(int initialPage)
+
+ int getInitialPage()
+
+ PdfJsConfig withInitialHeight(final int initialHeight)
+
+ int getInitialHeight()
+
+ PdfJsConfig withInitialScale(final Scale initialScale)
+
+ String getInitialScale()
- NOT_PERSISTABLE
+ PdfJsConfig disableWorker(final boolean disable)
- PERSISTABLE_ATTACHED
+ boolean isWorkerDisabled()
- PERSISTABLE_DETACHED
+ PdfJsConfig withDocumentUrl(final CharSequence url)
- PERSISTABLE_DESTROYED
+ CharSequence getDocumentUrl()
- boolean isPersistable()
+ PdfJsConfig withWorkerUrl(final String url)
- boolean isAttached()
+ CharSequence getWorkerUrl()
- boolean isDetached()
+ PdfJsConfig withCanvasId(final String url)
- boolean isDestroyed()
+ CharSequence getCanvasId()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/config/Scale.adoc
similarity index 76%
copy from antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/config/Scale.adoc
index ba495fc..baee614 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/config/Scale.adoc
@@ -1,20 +1,40 @@
-= MenuBarsService : _interface_
+= Scale : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-interface MenuBarsService {
+enum Scale {
- MenuBars menuBars() // <.>
+ AUTOMATIC
- MenuBars menuBars(final Type type)
+ ACTUAL_SIZE
+
+ PAGE_FIT
+
+ PAGE_WIDTH
+
+ _0_50
+
+ _0_75
+
+ _1_00
+
+ _1_25
+
+ _1_50
+
+ _2_00
+
+ _3_00
+
+ _4_00
+
+ Scale(final String value)
+
+ String getValue()
+
+ Scale forValue(final String scaleValue)
}
----
-<.> `[teal]#*menuBars*#()` : `MenuBars`
-+
---
-Returns _#menuBars()_ with a type of _Type#DEFAULT_ .
---
-
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/spi/PdfJsViewerAdvisor.adoc
similarity index 69%
copy from antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/spi/PdfJsViewerAdvisor.adoc
index dcdaf9a..362dab2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/applib/spi/PdfJsViewerAdvisor.adoc
@@ -1,28 +1,20 @@
-= EntityState : _enum_
+= PdfJsViewerAdvisor : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-TODO lower case enums not up to standard, is this an issue?
+SPI service interface.
.Java Sources
[source,java]
----
-enum EntityState {
+interface PdfJsViewerAdvisor {
- NOT_PERSISTABLE
+ Advice advise(final InstanceKey instanceKey)
- PERSISTABLE_ATTACHED
+ void pageNumChangedTo(final InstanceKey instanceKey, final int pageNum)
- PERSISTABLE_DETACHED
+ void scaleChangedTo(final InstanceKey instanceKey, final Scale scale)
- PERSISTABLE_DESTROYED
-
- boolean isPersistable()
-
- boolean isAttached()
-
- boolean isDetached()
-
- boolean isDestroyed()
+ void heightChangedTo(final InstanceKey instanceKey, final int height)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/ui/IsisModuleExtPdfjsUi.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/ui/IsisModuleExtPdfjsUi.adoc
index 78f204d..eab6f5e 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/extensions/viewer/wicket/pdfjs/ui/IsisModuleExtPdfjsUi.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModuleExtPdfjsUi : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModuleExtPdfjsUi {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/applib/IsisModulePersistenceJdoApplib.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/persistence/jdo/applib/IsisModulePersistenceJdoApplib.adoc
index 78f204d..91ab0d4 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/applib/IsisModulePersistenceJdoApplib.adoc
@@ -1,12 +1,10 @@
-= ResourceCoordinates : _class_
+= IsisModulePersistenceJdoApplib : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
-
- int compareTo(final ResourceCoordinates other)
+class IsisModulePersistenceJdoApplib {
}
----
diff --git a/antora/components/system/modules/generated/pages/index/persistence/jdo/applib/integration/JdoSupportService.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/applib/integration/JdoSupportService.adoc
index cdf2637..e7b0c10 100644
--- a/antora/components/system/modules/generated/pages/index/persistence/jdo/applib/integration/JdoSupportService.adoc
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/applib/integration/JdoSupportService.adoc
@@ -108,7 +108,7 @@ FromDN-5.2...
For RDBMS any single-valued member will be fetched in the original SQL query, but with multiple-valued members this is not supported. However what will happen is that any collection/array field will be retrieved in a single SQL query for all candidate objects (by default using an EXISTS subquery); this avoids the "N+1" problem, resulting in 1 original SQL query plus 1 SQL query per collection member. Note that you can disable this by either not putting multi-valued fields in the FetchPla [...]
--
-<.> `[teal]#*disableMultivaluedFetch*#(xref:system:generated:index/applib/query/Query.adoc[Query]<?> query)` : `void`
+<.> `[teal]#*disableMultivaluedFetch*#(Query<?> query)` : `void`
+
--
Fetch Optimization
diff --git a/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/IsisModuleJdoDatanucleus.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/IsisModuleJdoDatanucleus.adoc
new file mode 100644
index 0000000..22219e4
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/IsisModuleJdoDatanucleus.adoc
@@ -0,0 +1,24 @@
+= IsisModuleJdoDatanucleus : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+.Java Sources
+[source,java]
+----
+class IsisModuleJdoDatanucleus {
+
+ Map<String, String> getAsMap()
+
+ TransactionAwarePersistenceManagerFactoryProxy getTransactionAwarePersistenceManagerFactoryProxy(final LocalPersistenceManagerFactoryBean localPmfBean) // <.>
+
+ LocalPersistenceManagerFactoryBean getLocalPersistenceManagerFactoryBean(final MetaModelContext metaModelContext, final EventBusService eventBusService, final Provider<EntityChangeTracker> entityChangeTrackerProvider, final DnSettings dnSettings)
+
+ JdoTransactionManager getTransactionManager(LocalPersistenceManagerFactoryBean localPmfBean)
+}
+----
+
+<.> `[teal]#*getTransactionAwarePersistenceManagerFactoryProxy*#(LocalPersistenceManagerFactoryBean localPmfBean)` : `TransactionAwarePersistenceManagerFactoryProxy`
++
+--
+_TransactionAwarePersistenceManagerFactoryProxy_ was retired by the Spring Framework, recommended usage is still online [1]. Sources have been recovered from [2].
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/changetracking/JdoLifecycleListener.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/changetracking/JdoLifecycleListener.adoc
new file mode 100644
index 0000000..6dfba97
--- /dev/null
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/changetracking/JdoLifecycleListener.adoc
@@ -0,0 +1,56 @@
+= JdoLifecycleListener : _class_
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+
+* enlistCreated <-> postStore (when NEW)
+* enlistDeleting <-> preDelete
+* enlistUpdating <-> preDirty
+* recognizeLoaded <-> postLoad
+* recognizePersisting <-> preStore (when NEW)
+* recognizeUpdating <-> postStore (when NOT NEW)
+
+.Java Sources
+[source,java]
+----
+class JdoLifecycleListener {
+
+ void postCreate(final InstanceLifecycleEvent event)
+
+ void preAttach(final InstanceLifecycleEvent event)
+
+ void postAttach(final InstanceLifecycleEvent event)
+
+ void postLoad(final InstanceLifecycleEvent event)
+
+ void preStore(InstanceLifecycleEvent event)
+
+ void postStore(InstanceLifecycleEvent event)
+
+ void preDirty(InstanceLifecycleEvent event)
+
+ void postDirty(InstanceLifecycleEvent event)
+
+ void preDelete(InstanceLifecycleEvent event)
+
+ void postDelete(InstanceLifecycleEvent event)
+
+ void preClear(InstanceLifecycleEvent event) // <.>
+
+ void postClear(InstanceLifecycleEvent event) // <.>
+
+ void preDetach(InstanceLifecycleEvent event)
+
+ void postDetach(InstanceLifecycleEvent event)
+}
+----
+
+<.> `[teal]#*preClear*#(InstanceLifecycleEvent event)` : `void`
++
+--
+Does nothing, not important event for Isis to track.
+--
+<.> `[teal]#*postClear*#(InstanceLifecycleEvent event)` : `void`
++
+--
+Does nothing, not important event for Isis to track.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusIdLong.adoc
similarity index 87%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusIdLong.adoc
index 78f204d..0676e99 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusIdLong.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= Persistable_datanucleusIdLong : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Persistable_datanucleusIdLong {
- int compareTo(final ResourceCoordinates other)
+ Long prop()
+
+ boolean hideProp()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusVersionLong.adoc
similarity index 86%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusVersionLong.adoc
index 78f204d..248421f 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusVersionLong.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= Persistable_datanucleusVersionLong : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Persistable_datanucleusVersionLong {
- int compareTo(final ResourceCoordinates other)
+ Long prop()
+
+ boolean hideProp()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusVersionTimestamp.adoc
similarity index 84%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusVersionTimestamp.adoc
index 78f204d..4a3d35d 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_datanucleusVersionTimestamp.adoc
@@ -1,12 +1,14 @@
-= ResourceCoordinates : _class_
+= Persistable_datanucleusVersionTimestamp : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
.Java Sources
[source,java]
----
-class ResourceCoordinates {
+class Persistable_datanucleusVersionTimestamp {
- int compareTo(final ResourceCoordinates other)
+ java.sql.Timestamp prop()
+
+ boolean hideProp()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_downloadJdoMetadata.adoc
similarity index 81%
copy from antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
copy to antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_downloadJdoMetadata.adoc
index 78f204d..a2e148b 100644
--- a/antora/components/system/modules/generated/pages/index/commons/resource/ResourceCoordinates.adoc
+++ b/antora/components/system/modules/generated/pages/index/persistence/jdo/datanucleus/mixins/Persistable_downloadJdoMetadata.adoc
@@ -1,12 +1,17 @@
-= ResourceCoordinates : _class_
... 12071 lines suppressed ...