You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/04/17 13:34:22 UTC

[isis-app-helloworld] 01/01: adds multi-tenancy example

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch jdo-secman-multitenancy
in repository https://gitbox.apache.org/repos/asf/isis-app-helloworld.git

commit 3a2c15df8153c5dbbfed4f63274eb4b4df45dad1
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sat Apr 17 14:34:03 2021 +0100

    adds multi-tenancy example
---
 .../domainapp/modules/hello/HelloWorldModule.java  |  7 ++-
 .../modules/hello/dom/hwo/HelloWorldObject.java    | 16 ++++-
 .../modules/hello/dom/hwo/HelloWorldObjects.java   | 25 +++++++-
 .../modules/hello/fixture/DemoFixture.java         | 39 ++++++++++++
 .../java/domainapp/modules/hello/types/AtPath.java | 26 ++++++++
 .../java/domainapp/security/SeedUsersAndRoles.java |  4 +-
 .../fixturescripts/FixtureScriptSpecProvider.java  | 14 +++++
 .../ApplicationTenancyEvaluatorUsingAtPath.java    | 69 ++++++++++++++++++++++
 .../java/domainapp/security/scripts/Tenancies.java | 39 ++++++++++++
 .../security/scripts/UserToRole__bob_UserRw.java   |  4 +-
 .../security/scripts/UserToRole__dick_UserRo.java  |  4 +-
 .../UserToRole__joe_UserRw_but_NoDelete.java       |  4 +-
 src/main/java/domainapp/webapp/AppManifest.java    |  5 ++
 src/main/resources/config/application.properties   |  3 +
 14 files changed, 250 insertions(+), 9 deletions(-)

diff --git a/src/main/java/domainapp/modules/hello/HelloWorldModule.java b/src/main/java/domainapp/modules/hello/HelloWorldModule.java
index df8f52f..be27bff 100644
--- a/src/main/java/domainapp/modules/hello/HelloWorldModule.java
+++ b/src/main/java/domainapp/modules/hello/HelloWorldModule.java
@@ -4,8 +4,13 @@ import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 
+import domainapp.modules.hello.fixture.DemoFixture;
+
 @Configuration
-@Import({})
+@Import({
+
+        DemoFixture.class
+})
 @ComponentScan
 public class HelloWorldModule {
 
diff --git a/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObject.java b/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObject.java
index 3c9127f..4686968 100644
--- a/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObject.java
+++ b/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObject.java
@@ -19,7 +19,9 @@ import org.apache.isis.applib.annotation.Where;
 import org.apache.isis.applib.services.message.MessageService;
 import org.apache.isis.applib.services.repository.RepositoryService;
 import org.apache.isis.applib.services.title.TitleService;
+import org.apache.isis.extensions.secman.api.tenancy.HasAtPath;
 
+import domainapp.modules.hello.types.AtPath;
 import domainapp.modules.hello.types.Name;
 import domainapp.modules.hello.types.Notes;
 
@@ -37,12 +39,13 @@ import domainapp.modules.hello.types.Notes;
 @javax.jdo.annotations.Unique(name="HelloWorldObject_name_UNQ", members = {"name"})
 @DomainObject(entityChangePublishing = Publishing.ENABLED)
 @DomainObjectLayout()  // causes UI events to be triggered
-public class HelloWorldObject implements Comparable<HelloWorldObject> {
+public class HelloWorldObject implements Comparable<HelloWorldObject>, HasAtPath {
 
     public HelloWorldObject(){}
 
-    public HelloWorldObject(final String name) {
+    public HelloWorldObject(final String name, final String atPath) {
         this.name = name;
+        this.atPath = atPath;
     }
 
     public String title() {
@@ -70,6 +73,15 @@ public class HelloWorldObject implements Comparable<HelloWorldObject> {
         this.notes = notes;
     }
 
+    @AtPath
+    @MemberOrder(name = "metadata", sequence = "3")
+    private String atPath;
+    public String getAtPath() {
+        return atPath;
+    }
+    public void setAtPath(String atPath) {
+        this.atPath = atPath;
+    }
 
     @Action(
             semantics = SemanticsOf.IDEMPOTENT,
diff --git a/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObjects.java b/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObjects.java
index 5d28b08..efcfaa6 100644
--- a/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObjects.java
+++ b/src/main/java/domainapp/modules/hello/dom/hwo/HelloWorldObjects.java
@@ -1,6 +1,9 @@
 package domainapp.modules.hello.dom.hwo;
 
 import java.util.List;
+import java.util.stream.Collectors;
+
+import javax.inject.Inject;
 
 import org.apache.isis.applib.annotation.Action;
 import org.apache.isis.applib.annotation.ActionLayout;
@@ -11,7 +14,11 @@ import org.apache.isis.applib.annotation.RestrictTo;
 import org.apache.isis.applib.annotation.SemanticsOf;
 import org.apache.isis.applib.query.Query;
 import org.apache.isis.applib.services.repository.RepositoryService;
+import org.apache.isis.extensions.secman.api.tenancy.ApplicationTenancy;
+import org.apache.isis.extensions.secman.api.tenancy.ApplicationTenancyRepository;
+import org.apache.isis.extensions.secman.model.dom.user.MeService;
 
+import domainapp.modules.hello.types.AtPath;
 import domainapp.modules.hello.types.Name;
 
 @DomainService(
@@ -30,12 +37,21 @@ public class HelloWorldObjects {
     @Action(semantics = SemanticsOf.NON_IDEMPOTENT)
     @ActionLayout(promptStyle = PromptStyle.DIALOG_MODAL)
     public HelloWorldObject create(
-            @Name final String name) {
-        return repositoryService.persist(new HelloWorldObject(name));
+            @Name final String name,
+            @AtPath final String atPath) {
+        return repositoryService.persist(new HelloWorldObject(name, atPath));
     }
     public String default0Create() {
         return "Hello World!";
     }
+    public String default1Create() {
+        return meService.me().getAtPath();
+    }
+    public List<String> choices1Create() {
+        return applicationTenancyRepository.allTenancies()
+                .stream().map(ApplicationTenancy::getPath)
+                .collect(Collectors.toList());
+    }
 
 
     @Action(semantics = SemanticsOf.SAFE)
@@ -53,5 +69,10 @@ public class HelloWorldObjects {
         return repositoryService.allInstances(HelloWorldObject.class);
     }
 
+    @Inject
+    MeService meService;
+    @Inject
+    ApplicationTenancyRepository<? extends ApplicationTenancy> applicationTenancyRepository;
+
 
 }
diff --git a/src/main/java/domainapp/modules/hello/fixture/DemoFixture.java b/src/main/java/domainapp/modules/hello/fixture/DemoFixture.java
new file mode 100644
index 0000000..534a2dd
--- /dev/null
+++ b/src/main/java/domainapp/modules/hello/fixture/DemoFixture.java
@@ -0,0 +1,39 @@
+package domainapp.modules.hello.fixture;
+
+import javax.inject.Inject;
+
+import org.apache.isis.testing.fixtures.applib.fixturescripts.FixtureScript;
+
+import domainapp.modules.hello.dom.hwo.HelloWorldObjects;
+
+public class DemoFixture extends FixtureScript {
+
+    public DemoFixture() {
+        super();
+    }
+
+    @Override
+    protected void execute(FixtureScript.ExecutionContext ec) {
+        ec.addResult(this, helloWorldObjects.create("Hello, World!", "/"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Great Britain!", "/GBR"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Manchester!", "/GBR/MAN"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Liverpool!", "/GBR/LIV"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Edinburgh!", "/GBR/EDN"));
+
+        ec.addResult(this, helloWorldObjects.create("Hello, Italy!", "/ITA"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Milan!, IT", "/ITA/MIL"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Florence!, IT", "/ITA/FLO"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Rome!, IT", "/ITA/ROM"));
+
+        ec.addResult(this, helloWorldObjects.create("Hello, France!", "/FRA"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Paris!, FR", "/FRA/PAR"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Lyons!, FR", "/FRA/LYN"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Marseilles!, FR", "/FRA/MAR"));
+
+        ec.addResult(this, helloWorldObjects.create("Hello, Belgium!", "/BEL"));
+        ec.addResult(this, helloWorldObjects.create("Hello, Brussels!, BE", "/BEL/BRU"));
+    }
+
+    @Inject
+    HelloWorldObjects helloWorldObjects;
+}
diff --git a/src/main/java/domainapp/modules/hello/types/AtPath.java b/src/main/java/domainapp/modules/hello/types/AtPath.java
new file mode 100644
index 0000000..550678c
--- /dev/null
+++ b/src/main/java/domainapp/modules/hello/types/AtPath.java
@@ -0,0 +1,26 @@
+package domainapp.modules.hello.types;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.apache.isis.applib.annotation.Editing;
+import org.apache.isis.applib.annotation.Optionality;
+import org.apache.isis.applib.annotation.Parameter;
+import org.apache.isis.applib.annotation.ParameterLayout;
+import org.apache.isis.applib.annotation.Property;
+import org.apache.isis.applib.annotation.PropertyLayout;
+
+@javax.jdo.annotations.Column(length = AtPath.MAX_LEN, allowsNull = "false")
+@Property(editing = Editing.DISABLED, maxLength = AtPath.MAX_LEN, optionality = Optionality.MANDATORY)
+@PropertyLayout()
+@Parameter(maxLength = AtPath.MAX_LEN, optionality = Optionality.MANDATORY)
+@ParameterLayout()
+@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface AtPath {
+
+    int MAX_LEN = 50;
+
+}
diff --git a/src/main/java/domainapp/security/SeedUsersAndRoles.java b/src/main/java/domainapp/security/SeedUsersAndRoles.java
index e070c77..0ac898a 100644
--- a/src/main/java/domainapp/security/SeedUsersAndRoles.java
+++ b/src/main/java/domainapp/security/SeedUsersAndRoles.java
@@ -21,6 +21,7 @@ import domainapp.security.isisroles.RoleAndPerms__PersistenceJdo_Allow;
 import domainapp.security.scripts.RoleAndPerms__NoDelete;
 import domainapp.security.scripts.RoleAndPerms__UserRo;
 import domainapp.security.scripts.RoleAndPerms__UserRw;
+import domainapp.security.scripts.Tenancies;
 import domainapp.security.scripts.UserToRole__bob_UserRw;
 import domainapp.security.scripts.UserToRole__dick_UserRo;
 import domainapp.security.scripts.UserToRole__joe_UserRw_but_NoDelete;
@@ -53,7 +54,8 @@ public class SeedUsersAndRoles {
             @Override
             protected void execute(ExecutionContext ec) {
                 ec.executeChildren(this,
-                        new RoleAndPerms__Applib__Allow()
+                        new Tenancies()
+                        , new RoleAndPerms__Applib__Allow()
                         , new RoleAndPerms__ApplibConfiguration__Veto()
                         , new RoleAndPerms__ExtFixtures__Allow()
                         , new RoleAndPerms__ExtH2Console__Allow()
diff --git a/src/main/java/domainapp/security/fixturescripts/FixtureScriptSpecProvider.java b/src/main/java/domainapp/security/fixturescripts/FixtureScriptSpecProvider.java
new file mode 100644
index 0000000..0a70b78
--- /dev/null
+++ b/src/main/java/domainapp/security/fixturescripts/FixtureScriptSpecProvider.java
@@ -0,0 +1,14 @@
+package domainapp.security.fixturescripts;
+
+import org.springframework.stereotype.Service;
+
+import org.apache.isis.testing.fixtures.applib.fixturespec.FixtureScriptsSpecification;
+import org.apache.isis.testing.fixtures.applib.fixturespec.FixtureScriptsSpecificationProvider;
+
+@Service
+public class FixtureScriptSpecProvider implements FixtureScriptsSpecificationProvider {
+    @Override
+    public FixtureScriptsSpecification getSpecification() {
+        return FixtureScriptsSpecification.builder("domainapp").build();
+    }
+}
diff --git a/src/main/java/domainapp/security/multitenancy/ApplicationTenancyEvaluatorUsingAtPath.java b/src/main/java/domainapp/security/multitenancy/ApplicationTenancyEvaluatorUsingAtPath.java
new file mode 100644
index 0000000..6d49a00
--- /dev/null
+++ b/src/main/java/domainapp/security/multitenancy/ApplicationTenancyEvaluatorUsingAtPath.java
@@ -0,0 +1,69 @@
+package domainapp.security.multitenancy;
+
+import org.springframework.stereotype.Service;
+
+import org.apache.isis.extensions.secman.api.tenancy.ApplicationTenancyEvaluator;
+import org.apache.isis.extensions.secman.api.tenancy.HasAtPath;
+import org.apache.isis.extensions.secman.api.user.ApplicationUser;
+
+@Service
+public class ApplicationTenancyEvaluatorUsingAtPath implements ApplicationTenancyEvaluator {
+
+    @Override
+    public boolean handles(Class<?> cls) {
+        return HasAtPath.class.isAssignableFrom(cls);
+    }
+
+    /**
+     * Visible within the user's hierarchy (above or below).
+     *
+     * <p>for example</p>
+     * <ul>
+     *     <li>obj = '/', user = '/ITA'  : visible</li>
+     *     <li>obj = '/ITA', user = '/ITA'  : visible</li>
+     *     <li>obj = '/ITA/MIL', user = '/ITA'  : visible</li>
+     *     <li>obj = '/FRA', user = '/ITA'  : not visible</li>
+     * </ul>
+     */
+    @Override
+    public String hides(Object domainObject, ApplicationUser applicationUser) {
+        final String objAtPath = ((HasAtPath) domainObject).getAtPath();
+        if(objAtPath == null) {
+            return null; // show
+        }
+        final String userAtPath = applicationUser.getAtPath();
+        if(userAtPath == null) {
+            return "user does not have atPath"; // hide
+        }
+        return objAtPath.startsWith(userAtPath) || userAtPath.startsWith(objAtPath)
+                ? null
+                : "object not visible within user's tenancy";
+    }
+
+    /**
+     * Enabled only 'under' the user's hierarchy.
+     *
+     * <p>for example</p>
+     * <ul>
+     *         <li>obj = '/', user = '/ITA'  : not editable</li>
+     *         <li>obj = '/ITA', user = '/ITA'  : editable</li>
+     *         <li>obj = '/ITA/MIL', user = '/ITA'  : editable</li>
+     *         <li>obj = '/FRA', user = '/ITA'  : not editable</li>
+     * </ul>
+     * @return
+     */
+    @Override
+    public String disables(Object domainObject, ApplicationUser applicationUser) {
+        final String objAtPath = ((HasAtPath) domainObject).getAtPath();
+        if(objAtPath == null) {
+            return null; // enable
+        }
+        final String userAtPath = applicationUser.getAtPath();
+        if(userAtPath == null) {
+            return "user does not have atPath"; // disable
+        }
+        return objAtPath.startsWith(userAtPath)
+                ? null
+                : "object not enabled within user's tenancy";
+    }
+}
diff --git a/src/main/java/domainapp/security/scripts/Tenancies.java b/src/main/java/domainapp/security/scripts/Tenancies.java
new file mode 100644
index 0000000..3018af2
--- /dev/null
+++ b/src/main/java/domainapp/security/scripts/Tenancies.java
@@ -0,0 +1,39 @@
+package domainapp.security.scripts;
+
+import org.apache.isis.applib.services.appfeat.ApplicationFeatureId;
+import org.apache.isis.applib.services.appfeat.ApplicationFeatureSort;
+import org.apache.isis.commons.collections.Can;
+import org.apache.isis.extensions.secman.api.permission.ApplicationPermissionMode;
+import org.apache.isis.extensions.secman.api.permission.ApplicationPermissionRule;
+import org.apache.isis.extensions.secman.jdo.seed.scripts.AbstractRoleAndPermissionsFixtureScript;
+import org.apache.isis.extensions.secman.jdo.seed.scripts.AbstractTenancyFixtureScript;
+
+public class Tenancies extends AbstractTenancyFixtureScript {
+
+    public Tenancies() {
+        super();
+    }
+
+    @Override
+    protected void execute(ExecutionContext ec) {
+        create("World", "/", null, ec);
+
+        create("Great Britain", "/GBR","/", ec);
+        create("London, GB", "/GBR/LON","/GBR", ec);
+        create("Liverpool, GB", "/GBR/LIV","/GBR", ec);
+        create("Edinburgh, GB", "/GBR/EDN","/GBR", ec);
+
+        create("Italy", "/ITA","/", ec);
+        create("Milan, IT", "/ITA/MIL", "/ITA", ec);
+        create("Florence, IT", "/ITA/FLO", "/ITA", ec);
+        create("Rome, IT", "/ITA/ROM", "/ITA", ec);
+
+        create("France", "/FRA", "/", ec);
+        create("Paris, FR", "/FRA/PAR", "/FRA", ec);
+        create("Lyons, FR", "/FRA/LYN", "/FRA", ec);
+        create("Marseilles, FR", "/FRA/MAR", "/FRA", ec);
+
+        create("Belgium", "/BEL", "/", ec);
+        create("Brussels, BE", "/BEL/BRU", "/", ec);
+    }
+}
diff --git a/src/main/java/domainapp/security/scripts/UserToRole__bob_UserRw.java b/src/main/java/domainapp/security/scripts/UserToRole__bob_UserRw.java
index 561a189..621a0fc 100644
--- a/src/main/java/domainapp/security/scripts/UserToRole__bob_UserRw.java
+++ b/src/main/java/domainapp/security/scripts/UserToRole__bob_UserRw.java
@@ -14,7 +14,9 @@ import domainapp.security.isisroles.SecmanRoleNames;
 public class UserToRole__bob_UserRw extends AbstractUserAndRolesFixtureScript {
 
     public UserToRole__bob_UserRw() {
-        super("bob", "pass", AccountType.LOCAL,
+        super("bob", "pass", "bob@world.com",
+                "/",
+                AccountType.LOCAL,
                 Can.of(
                         RoleAndPerms__UserRw.ROLE_NAME
                         , SecmanRoleNames.USER
diff --git a/src/main/java/domainapp/security/scripts/UserToRole__dick_UserRo.java b/src/main/java/domainapp/security/scripts/UserToRole__dick_UserRo.java
index 2e62850..653af43 100644
--- a/src/main/java/domainapp/security/scripts/UserToRole__dick_UserRo.java
+++ b/src/main/java/domainapp/security/scripts/UserToRole__dick_UserRo.java
@@ -14,7 +14,9 @@ import domainapp.security.isisroles.SecmanRoleNames;
 public class UserToRole__dick_UserRo extends AbstractUserAndRolesFixtureScript {
 
     public UserToRole__dick_UserRo() {
-        super("dick", "pass", AccountType.LOCAL,
+        super("dick", "pass", "dick@france.com",
+                "/FRA",
+                AccountType.LOCAL,
                 Can.of(
                         RoleAndPerms__UserRo.ROLE_NAME
                         , SecmanRoleNames.USER
diff --git a/src/main/java/domainapp/security/scripts/UserToRole__joe_UserRw_but_NoDelete.java b/src/main/java/domainapp/security/scripts/UserToRole__joe_UserRw_but_NoDelete.java
index 6af2a88..a90a6ba 100644
--- a/src/main/java/domainapp/security/scripts/UserToRole__joe_UserRw_but_NoDelete.java
+++ b/src/main/java/domainapp/security/scripts/UserToRole__joe_UserRw_but_NoDelete.java
@@ -15,7 +15,9 @@ import domainapp.security.isisroles.SecmanRoleNames;
 public class UserToRole__joe_UserRw_but_NoDelete extends AbstractUserAndRolesFixtureScript {
 
     public UserToRole__joe_UserRw_but_NoDelete() {
-        super("joe", "pass", AccountType.LOCAL,
+        super("joe", "pass", "joe@italy.com",
+                "/ITA",
+                AccountType.LOCAL,
                 Can.of(
                         RoleAndPerms__UserRw.ROLE_NAME
                         , RoleAndPerms__NoDelete.ROLE_NAME  // <<< veto application behaviour
diff --git a/src/main/java/domainapp/webapp/AppManifest.java b/src/main/java/domainapp/webapp/AppManifest.java
index d225e45..2b1421b 100644
--- a/src/main/java/domainapp/webapp/AppManifest.java
+++ b/src/main/java/domainapp/webapp/AppManifest.java
@@ -30,7 +30,9 @@ import org.apache.isis.viewer.wicket.viewer.IsisModuleViewerWicketViewer;
 
 import domainapp.modules.hello.HelloWorldModule;
 import domainapp.security.SeedUsersAndRoles;
+import domainapp.security.fixturescripts.FixtureScriptSpecProvider;
 import domainapp.security.isisroles.SecmanRoleNames;
+import domainapp.security.multitenancy.ApplicationTenancyEvaluatorUsingAtPath;
 
 @Configuration
 @Import({
@@ -49,6 +51,9 @@ import domainapp.security.isisroles.SecmanRoleNames;
         IsisModuleTestingFixturesApplib.class,
         SeedUsersAndRoles.class,
 
+        FixtureScriptSpecProvider.class,
+        ApplicationTenancyEvaluatorUsingAtPath.class,
+
         IsisModuleTestingH2ConsoleUi.class,
         HelloWorldModule.class
 })
diff --git a/src/main/resources/config/application.properties b/src/main/resources/config/application.properties
index efbbaf4..986e09d 100644
--- a/src/main/resources/config/application.properties
+++ b/src/main/resources/config/application.properties
@@ -14,3 +14,6 @@ datanucleus.schema.autoCreateAll=true
 
 spring.datasource.platform=h2
 spring.datasource.url=jdbc:h2:mem:helloworld
+
+
+isis.testing.fixtures.initial-script=domainapp.modules.hello.fixture.DemoFixture