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 2017/11/06 12:07:04 UTC
[isis] branch ISIS-1766-bs3-for-menubars updated: ISIS-1766: adds
support for 'unreferencedActions' menu,
with validation to ensure that there is precisely one such.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-1766-bs3-for-menubars
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/ISIS-1766-bs3-for-menubars by this push:
new affdba6 ISIS-1766: adds support for 'unreferencedActions' menu, with validation to ensure that there is precisely one such.
affdba6 is described below
commit affdba61b7e89fb17970a66a4667d81da1a5114b
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Nov 6 12:06:52 2017 +0000
ISIS-1766: adds support for 'unreferencedActions' menu, with validation to ensure that there is precisely one such.
---
.../applib/layout/menubars/bootstrap3/menubars.xsd | 2 +-
.../layout/component/ServiceActionLayoutData.java | 10 ++-
.../isis/applib/layout/menubars/MenuBars.java | 34 ++------
.../applib/layout/menubars/MenuBarsAbstract.java | 16 ++++
.../layout/menubars/bootstrap3/BS3MenuBars.java | 84 ++++++++++++++++----
.../core/commons/authentication/MessageBroker.java | 4 +
.../services/menubars/menubars.layout.xml | 3 +
.../menubars/bootstrap3/MenuBarsServiceBS3.java | 92 +++++++++++++++++++++-
.../resources/MenuBarsResourceServerside.java | 9 ++-
.../java/domainapp/application/menubars.layout.xml | 3 +
10 files changed, 204 insertions(+), 53 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/applib/layout/menubars/bootstrap3/menubars.xsd b/adocs/documentation/src/main/asciidoc/applib/layout/menubars/bootstrap3/menubars.xsd
index 2dbfe28..e4ad296 100644
--- a/adocs/documentation/src/main/asciidoc/applib/layout/menubars/bootstrap3/menubars.xsd
+++ b/adocs/documentation/src/main/asciidoc/applib/layout/menubars/bootstrap3/menubars.xsd
@@ -36,7 +36,7 @@
<xs:complexType name="menu">
<xs:sequence>
<xs:element name="named" type="xs:string"/>
- <xs:element maxOccurs="unbounded" name="section" type="tns:section"/>
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="section" type="tns:section"/>
</xs:sequence>
<xs:attribute name="cssClassFa" type="xs:string"/>
<xs:attribute name="unreferencedActions" type="xs:boolean"/>
diff --git a/core/applib/src/main/java/org/apache/isis/applib/layout/component/ServiceActionLayoutData.java b/core/applib/src/main/java/org/apache/isis/applib/layout/component/ServiceActionLayoutData.java
index 13f8666..446936b 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/layout/component/ServiceActionLayoutData.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/layout/component/ServiceActionLayoutData.java
@@ -231,10 +231,16 @@ public class ServiceActionLayoutData implements Serializable {
+ @XmlTransient
+ public String getObjectTypeAndId() {
+ return getObjectType() + "#" + getId();
+ }
+
+
@Override
public String toString() {
- return "ActionLayoutData{" +
- "oid='" + objectType + '\'' +
+ return "ServiceActionLayoutData{" +
+ "objectType='" + objectType + '\'' +
", id='" + id + '\'' +
'}';
}
diff --git a/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBars.java b/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBars.java
index 833fa85..54ff094 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBars.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBars.java
@@ -18,6 +18,8 @@
*/
package org.apache.isis.applib.layout.menubars;
+import java.util.LinkedHashMap;
+
import org.apache.isis.applib.annotation.DomainServiceLayout;
import org.apache.isis.applib.annotation.Programmatic;
import org.apache.isis.applib.layout.component.ServiceActionLayoutData;
@@ -34,39 +36,13 @@ public interface MenuBars {
MenuBar menuBarFor(DomainServiceLayout.MenuBar menuBar);
interface Visitor {
- void preVisit(final MenuBar menuBar);
- void visit(final MenuBar menuBar);
- void postVisit(final MenuBar menuBar);
-
- void preVisit(final Menu menu);
- void visit(final Menu menu);
- void postVisit(final Menu menu);
-
- void preVisit(final MenuSection menuSection);
- void visit(final MenuSection section);
- void postVisit(final MenuSection menuSection);
-
void visit(final ServiceActionLayoutData serviceActionLayoutData);
-
- }
-
- class VisitorAdapter implements MenuBars.Visitor {
- @Override public void preVisit(final MenuBar menuBar) { }
- @Override public void visit(final MenuBar menuBar) { }
- @Override public void postVisit(final MenuBar menuBar) { }
-
- @Override public void preVisit(final Menu menu) { }
- @Override public void visit(final Menu menu) { }
- @Override public void postVisit(final Menu menu) { }
-
- @Override public void preVisit(final MenuSection menuSection) { }
- @Override public void visit(final MenuSection section) { }
- @Override public void postVisit(final MenuSection menuSection) { }
-
- @Override public void visit(final ServiceActionLayoutData serviceActionLayoutData) { }
}
@Programmatic
void visit(final MenuBars.Visitor visitor);
+ @Programmatic
+ LinkedHashMap<String, ServiceActionLayoutData> getAllServiceActionsByObjectTypeAndId();
+
}
diff --git a/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBarsAbstract.java b/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBarsAbstract.java
index cd890c6..8fc51aa 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBarsAbstract.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/MenuBarsAbstract.java
@@ -1,10 +1,14 @@
package org.apache.isis.applib.layout.menubars;
import java.io.Serializable;
+import java.util.LinkedHashMap;
import javax.xml.bind.annotation.XmlTransient;
+import com.google.common.collect.Maps;
+
import org.apache.isis.applib.annotation.Programmatic;
+import org.apache.isis.applib.layout.component.ServiceActionLayoutData;
@XmlTransient // ignore this class
public abstract class MenuBarsAbstract implements MenuBars, Serializable {
@@ -22,5 +26,17 @@ public abstract class MenuBarsAbstract implements MenuBars, Serializable {
this.tnsAndSchemaLocation = tnsAndSchemaLocation;
}
+ @Programmatic
+ @XmlTransient
+ public LinkedHashMap<String, ServiceActionLayoutData> getAllServiceActionsByObjectTypeAndId() {
+ final LinkedHashMap<String, ServiceActionLayoutData> serviceActionsByObjectTypeAndId = Maps.newLinkedHashMap();
+ visit(new MenuBars.Visitor() {
+ public void visit(final ServiceActionLayoutData serviceActionLayoutData) {
+ serviceActionsByObjectTypeAndId.put(serviceActionLayoutData.getObjectTypeAndId(), serviceActionLayoutData);
+ }
+ });
+ return serviceActionsByObjectTypeAndId;
+ }
+
}
diff --git a/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/bootstrap3/BS3MenuBars.java b/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/bootstrap3/BS3MenuBars.java
index 6cdbd8b..8529b0b 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/bootstrap3/BS3MenuBars.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/layout/menubars/bootstrap3/BS3MenuBars.java
@@ -26,7 +26,7 @@ import javax.xml.bind.annotation.XmlType;
import org.apache.isis.applib.annotation.DomainServiceLayout;
import org.apache.isis.applib.layout.component.ServiceActionLayoutData;
-import org.apache.isis.applib.layout.menubars.MenuSection;
+import org.apache.isis.applib.layout.menubars.MenuBars;
/**
* Describes the collection of domain services into menubars, broadly corresponding to the aggregation of information within {@link org.apache.isis.applib.annotation.DomainServiceLayout}.
@@ -92,40 +92,96 @@ public class BS3MenuBars extends org.apache.isis.applib.layout.menubars.MenuBars
return null;
}
+ public interface Visitor extends MenuBars.Visitor {
+ void preVisit(final BS3MenuBar menuBar);
+ void visit(final BS3MenuBar menuBar);
+ void postVisit(final BS3MenuBar menuBar);
+
+ void preVisit(final BS3Menu menu);
+ void visit(final BS3Menu menu);
+ void postVisit(final BS3Menu menu);
+
+ void preVisit(final BS3MenuSection menuSection);
+ void visit(final BS3MenuSection section);
+ void postVisit(final BS3MenuSection menuSection);
+ }
+
+ public static class VisitorAdapter implements BS3MenuBars.Visitor {
+ @Override public void preVisit(final BS3MenuBar menuBar) { }
+ @Override public void visit(final BS3MenuBar menuBar) { }
+ @Override public void postVisit(final BS3MenuBar menuBar) { }
+
+ @Override public void preVisit(final BS3Menu menu) { }
+ @Override public void visit(final BS3Menu menu) { }
+ @Override public void postVisit(final BS3Menu menu) { }
+
+ @Override public void preVisit(final BS3MenuSection menuSection) { }
+ @Override public void visit(final BS3MenuSection section) { }
+ @Override public void postVisit(final BS3MenuSection menuSection) { }
+
+ @Override public void visit(final ServiceActionLayoutData serviceActionLayoutData) { }
+ }
+
@Override
- public void visit(final Visitor visitor) {
+ public void visit(final MenuBars.Visitor visitor) {
traverseMenuBar(getPrimary(), visitor);
traverseMenuBar(getSecondary(), visitor);
traverseMenuBar(getTertiary(), visitor);
}
- private void traverseMenuBar(final BS3MenuBar menuBar, final Visitor visitor) {
- visitor.preVisit(menuBar);
- visitor.visit(menuBar);
+ private void traverseMenuBar(final BS3MenuBar menuBar, final MenuBars.Visitor visitor) {
+
+ final Visitor bs3Visitor = visitor instanceof Visitor ? (Visitor) visitor : null;
+
+ if(bs3Visitor != null) {
+ bs3Visitor.preVisit(menuBar);
+ bs3Visitor.visit(menuBar);
+ }
+
for (BS3Menu menu : menuBar.getMenus()) {
traverseMenu(menu, visitor);
}
- visitor.postVisit(menuBar);
+
+ if(bs3Visitor != null) {
+ bs3Visitor.postVisit(menuBar);
+ }
}
- private void traverseMenu(final BS3Menu menu, final Visitor visitor) {
- visitor.preVisit(menu);
- visitor.visit(menu);
+ private void traverseMenu(final BS3Menu menu, final MenuBars.Visitor visitor) {
+
+ final Visitor bs3Visitor = visitor instanceof Visitor ? (Visitor) visitor : null;
+
+ if(bs3Visitor != null) {
+ bs3Visitor.preVisit(menu);
+ bs3Visitor.visit(menu);
+ }
+
final List<BS3MenuSection> sections = menu.getSections();
for (BS3MenuSection section : sections) {
traverseSection(section, visitor);
}
- visitor.postVisit(menu);
+
+ if(bs3Visitor != null) {
+ bs3Visitor.postVisit(menu);
+ }
}
- private void traverseSection(final MenuSection section, final Visitor visitor) {
- visitor.preVisit(section);
- visitor.visit(section);
+ private void traverseSection(final BS3MenuSection section, final MenuBars.Visitor visitor) {
+
+ final Visitor bs3Visitor = visitor instanceof Visitor ? (Visitor) visitor : null;
+ if(bs3Visitor != null) {
+ bs3Visitor.preVisit(section);
+ bs3Visitor.visit(section);
+ }
+
final List<ServiceActionLayoutData> actions = section.getServiceActions();
for (ServiceActionLayoutData action : actions) {
visitor.visit(action);
}
- visitor.postVisit(section);
+
+ if(bs3Visitor != null) {
+ bs3Visitor.postVisit(section);
+ }
}
private String metadataError;
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/commons/authentication/MessageBroker.java b/core/metamodel/src/main/java/org/apache/isis/core/commons/authentication/MessageBroker.java
index 1e23a05..830353e 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/commons/authentication/MessageBroker.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/commons/authentication/MessageBroker.java
@@ -69,6 +69,10 @@ public class MessageBroker implements Serializable {
}
public void addWarning(final String message) {
+ if(warnings.contains(message)) {
+ // just ignore it...
+ return;
+ }
warnings.add(message);
}
diff --git a/core/metamodel/src/test/resources/org/apache/isis/core/metamodel/services/menubars/menubars.layout.xml b/core/metamodel/src/test/resources/org/apache/isis/core/metamodel/services/menubars/menubars.layout.xml
index 7ac2178..e25666c 100644
--- a/core/metamodel/src/test/resources/org/apache/isis/core/metamodel/services/menubars/menubars.layout.xml
+++ b/core/metamodel/src/test/resources/org/apache/isis/core/metamodel/services/menubars/menubars.layout.xml
@@ -15,6 +15,9 @@
</mb3:serviceAction>
</mb3:section>
</mb3:menu>
+ <mb3:menu unreferencedActions="true">
+ <mb3:named>Other</mb3:named>
+ </mb3:menu>
</mb3:primary>
<mb3:secondary>
<mb3:menu>
diff --git a/core/runtime/src/main/java/org/apache/isis/core/runtime/services/menubars/bootstrap3/MenuBarsServiceBS3.java b/core/runtime/src/main/java/org/apache/isis/core/runtime/services/menubars/bootstrap3/MenuBarsServiceBS3.java
index 88989c3..f0871d9 100644
--- a/core/runtime/src/main/java/org/apache/isis/core/runtime/services/menubars/bootstrap3/MenuBarsServiceBS3.java
+++ b/core/runtime/src/main/java/org/apache/isis/core/runtime/services/menubars/bootstrap3/MenuBarsServiceBS3.java
@@ -18,6 +18,7 @@
*/
package org.apache.isis.core.runtime.services.menubars.bootstrap3;
+import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
@@ -32,6 +33,9 @@ import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.DomainServiceLayout;
import org.apache.isis.applib.annotation.NatureOfService;
@@ -42,9 +46,12 @@ import org.apache.isis.applib.layout.menubars.bootstrap3.BS3Menu;
import org.apache.isis.applib.layout.menubars.bootstrap3.BS3MenuBar;
import org.apache.isis.applib.layout.menubars.bootstrap3.BS3MenuBars;
import org.apache.isis.applib.layout.menubars.bootstrap3.BS3MenuSection;
+import org.apache.isis.applib.services.jaxb.JaxbService;
import org.apache.isis.applib.services.menu.MenuBarsLoaderService;
import org.apache.isis.applib.services.menu.MenuBarsService;
+import org.apache.isis.applib.services.message.MessageService;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
+import org.apache.isis.core.metamodel.deployment.DeploymentCategoryProvider;
import org.apache.isis.core.metamodel.facets.actions.notinservicemenu.NotInServiceMenuFacet;
import org.apache.isis.core.metamodel.facets.all.named.NamedFacet;
import org.apache.isis.core.metamodel.facets.members.order.MemberOrderFacet;
@@ -60,6 +67,8 @@ import org.apache.isis.core.runtime.system.session.IsisSessionFactory;
@DomainService(nature = NatureOfService.DOMAIN)
public class MenuBarsServiceBS3 implements MenuBarsService {
+ private static final Logger LOG = LoggerFactory.getLogger(MenuBarsServiceBS3.class);
+
public static final String MB3_TNS = "http://isis.apache.org/applib/layout/menubars/bootstrap3";
public static final String MB3_SCHEMA_LOCATION = "http://isis.apache.org/applib/layout/menubars/bootstrap3/menubars.xsd";
@@ -81,8 +90,10 @@ public class MenuBarsServiceBS3 implements MenuBarsService {
@Programmatic
public BS3MenuBars menuBars(final Type type) {
+ final BS3MenuBars fallbackMenuBars = deriveMenuBarsFromMetaModelFacets();
+
if(type == Type.FALLBACK) {
- return deriveMenuBarsFromMetaModelFacets();
+ return fallbackMenuBars;
}
// else load (and only fallback if nothing could be loaded)...
@@ -90,8 +101,36 @@ public class MenuBarsServiceBS3 implements MenuBarsService {
BS3MenuBars menuBars = menuBarsLoaderService.menuBars();
- if(menuBars == null) {
- menuBars = deriveMenuBarsFromMetaModelFacets();
+ final BS3Menu unreferencedActionsMenu = validate(menuBars);
+
+ if (unreferencedActionsMenu != null) {
+ // add in any missing actions from the fallback
+ final LinkedHashMap<String, ServiceActionLayoutData> referencedActionsByObjectTypeAndId =
+ menuBars.getAllServiceActionsByObjectTypeAndId();
+
+ fallbackMenuBars.visit(new BS3MenuBars.VisitorAdapter(){
+
+ @Override
+ public void visit(final BS3MenuSection menuSection) {
+ BS3MenuSection section = null;
+ for (ServiceActionLayoutData serviceAction : menuSection.getServiceActions()) {
+ final String objectTypeAndId = serviceAction.getObjectTypeAndId();
+ if (!referencedActionsByObjectTypeAndId.containsKey(objectTypeAndId)) {
+ if(section == null) {
+ section = new BS3MenuSection();
+ unreferencedActionsMenu.getSections().add(section);
+ }
+ // detach from fallback, attach to this
+ serviceAction.setOwner(section);
+ section.getServiceActions().add(serviceAction);
+ }
+ }
+ }
+ });
+
+ } else {
+ // just use fallback
+ menuBars = fallbackMenuBars;
}
this.menuBars = menuBars;
@@ -100,6 +139,40 @@ public class MenuBarsServiceBS3 implements MenuBarsService {
return menuBars;
}
+ BS3Menu validate(final BS3MenuBars menuBars) {
+
+ if (menuBars == null) {
+ return null;
+ }
+
+ final List<BS3Menu> menusWithUnreferencedActionsFlagSet = Lists.newArrayList();
+ menuBars.visit(new BS3MenuBars.VisitorAdapter(){
+ @Override public void visit(final BS3Menu menu) {
+ if(isSet(menu.isUnreferencedActions())) {
+ menusWithUnreferencedActionsFlagSet.add(menu);
+ }
+ }
+ private Boolean isSet(final Boolean flag) {
+ return flag != null && flag;
+ }
+
+ });
+
+ final int size = menusWithUnreferencedActionsFlagSet.size();
+ if (size == 1) {
+ return menusWithUnreferencedActionsFlagSet.get(0);
+ }
+
+ menuBars.setMetadataError(
+ "Exactly one menu must have 'unreferencedActions' flag set; found " + size + " such menus");
+ if(!deploymentCategoryProvider.getDeploymentCategory().isProduction()) {
+ messageService.warnUser("Menubars metadata errors; check the error log");
+ }
+ LOG.error("Grid metadata errors:\n\n" + jaxbService.toXml(menuBars) + "\n\n");
+
+ return null;
+ }
+
private BS3MenuBars deriveMenuBarsFromMetaModelFacets() {
final BS3MenuBars menuBars = new BS3MenuBars();
@@ -112,6 +185,11 @@ public class MenuBarsServiceBS3 implements MenuBarsService {
menuBars.setTnsAndSchemaLocation(tnsAndSchemaLocation());
+ final BS3Menu otherMenu = new BS3Menu();
+ otherMenu.setNamed("Other");
+ otherMenu.setUnreferencedActions(true);
+ menuBars.getPrimary().getMenus().add(otherMenu);
+
return menuBars;
}
@@ -297,6 +375,14 @@ public class MenuBarsServiceBS3 implements MenuBarsService {
@Inject
MenuBarsLoaderService menuBarsLoaderService;
+ @javax.inject.Inject
+ DeploymentCategoryProvider deploymentCategoryProvider;
+
+ @javax.inject.Inject
+ MessageService messageService;
+
+ @javax.inject.Inject
+ JaxbService jaxbService;
}
diff --git a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/MenuBarsResourceServerside.java b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/MenuBarsResourceServerside.java
index 273be65..2e0e26d 100644
--- a/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/MenuBarsResourceServerside.java
+++ b/core/viewer-restfulobjects-server/src/main/java/org/apache/isis/viewer/restfulobjects/server/resources/MenuBarsResourceServerside.java
@@ -67,16 +67,17 @@ public class MenuBarsResourceServerside extends ResourceAbstract implements Menu
}
void addLinksForServiceActions(final MenuBars menuBars) {
- menuBars.visit(new MenuBars.VisitorAdapter() {
+ menuBars.visit(new MenuBars.Visitor() {
@Override
public void visit(final ServiceActionLayoutData actionLayoutData) {
final String objectType = actionLayoutData.getObjectType();
+ final String relativeUrl = String.format(
+ "objects/%s/%s/actions/%s",
+ objectType, PersistenceSession.SERVICE_IDENTIFIER, actionLayoutData.getId());
Link link = new Link(
Rel.ACTION.getName(),
RestfulHttpMethod.GET.getJavaxRsMethod(),
- getResourceContext().urlFor(
- "objects/" + objectType + "/" + PersistenceSession.SERVICE_IDENTIFIER + "/actions/" + actionLayoutData.getId()
- ),
+ getResourceContext().urlFor(relativeUrl),
RepresentationType.OBJECT_ACTION.getJsonMediaType().toString());
actionLayoutData.setLink(link);
}
diff --git a/example/application/helloworld/src/main/java/domainapp/application/menubars.layout.xml b/example/application/helloworld/src/main/java/domainapp/application/menubars.layout.xml
index 7ac2178..e25666c 100644
--- a/example/application/helloworld/src/main/java/domainapp/application/menubars.layout.xml
+++ b/example/application/helloworld/src/main/java/domainapp/application/menubars.layout.xml
@@ -15,6 +15,9 @@
</mb3:serviceAction>
</mb3:section>
</mb3:menu>
+ <mb3:menu unreferencedActions="true">
+ <mb3:named>Other</mb3:named>
+ </mb3:menu>
</mb3:primary>
<mb3:secondary>
<mb3:menu>
--
To stop receiving notification emails like this one, please contact
['"commits@isis.apache.org" <co...@isis.apache.org>'].