").append(m.parseHTML(a)).find(d):a)}).complete(c&&function(a,b){g.each(c,e||[a.responseText,b,a])}),this},m.expr.filters.animated=function(a){return m.grep(m.timers,function(b){return a===b.elem}).length};var cd=a.document.documentElement;function dd(a){return m.isWindow(a)?a:9===a.nodeType?a.defaultView||a.parentWindow:!1}m.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=m.css(a,"position"),l=m(a),n={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=m.css(a,"top"),i=m.css(a,"left"),j=("absolute"===k||"fixed"===k)&&m.inArray("auto",[f,i])>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),m.isFunction(b)&&(b=b.call(a,c,h)),null!=b.top&&(n.top=b.top-h.top+g),null!=b.left&&(n.left=b.left-h.left+e),"using"in b?b.using.call(a,n):l.css(n)}},m.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){m.offset.setOffset(this,a,b)});var b,c,d={top:0,left:0},e=this[0],f=e&&e.ownerDocument;if(f)return b=f.documentElement,m.contains(b,e)?(typeof e.getBoundingClientRect!==K&&(d=e.getBoundingClientRect()),c=dd(f),{top:d.top+(c.pageYOffset||b.scrollTop)-(b.clientTop||0),left:d.left+(c.pageXOffset||b.scrollLeft)-(b.clientLeft||0)}):d},position:function(){if(this[0]){var a,b,c={top:0,left:0},d=this[0];return"fixed"===m.css(d,"position")?b=d.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),m.nodeName(a[0],"html")||(c=a.offset()),c.top+=m.css(a[0],"borderTopWidth",!0),c.left+=m.css(a[0],"borderLeftWidth",!0)),{top:b.top-c.top-m.css(d,"marginTop",!0),left:b.left-c.left-m.css(d,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||cd;while(a&&!m.nodeName(a,"html")&&"static"===m.css(a,"position"))a=a.offsetParent;return a||cd})}}),m.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c=/Y/.test(b);m.fn[a]=function(d){return V(this,function(a,d,e){var f=dd(a);return void 0===e?f?b in f?f[b]:f.document.documentElement[d]:a[d]:void(f?f.scrollTo(c?m(f).scrollLeft():e,c?e:m(f).scrollTop()):a[d]=e)},a,d,arguments.length,null)}}),m.each(["top","left"],function(a,b){m.cssHooks[b]=Lb(k.pixelPosition,function(a,c){return c?(c=Jb(a,b),Hb.test(c)?m(a).position()[b]+"px":c):void 0})}),m.each({Height:"height",Width:"width"},function(a,b){m.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){m.fn[d]=function(d,e){var f=arguments.length&&(c||"boolean"!=typeof d),g=c||(d===!0||e===!0?"margin":"border");return V(this,function(b,c,d){var e;return m.isWindow(b)?b.document.documentElement["client"+a]:9===b.nodeType?(e=b.documentElement,Math.max(b.body["scroll"+a],e["scroll"+a],b.body["offset"+a],e["offset"+a],e["client"+a])):void 0===d?m.css(b,c,g):m.style(b,c,d,g)},b,f?d:void 0,f,null)}})}),m.fn.size=function(){return this.length},m.fn.andSelf=m.fn.addBack,"function"==typeof define&&define.amd&&define("jquery",[],function(){return m});var ed=a.jQuery,fd=a.$;return m.noConflict=function(b){return a.$===m&&(a.$=fd),b&&a.jQuery===m&&(a.jQuery=ed),m},typeof b===K&&(a.jQuery=a.$=m),m});
diff --git a/modules/portal-ui-oauth/src/test/resources/META-INF/resources/javascript/spec/ssoSpec.js b/modules/portal-ui-oauth/src/test/resources/META-INF/resources/javascript/spec/ssoSpec.js
new file mode 100644
index 0000000..8755e0d
--- /dev/null
+++ b/modules/portal-ui-oauth/src/test/resources/META-INF/resources/javascript/spec/ssoSpec.js
@@ -0,0 +1,13 @@
+describe("SSO", function() {
+ var reloadTokenFormWasCalled = false;
+ it("should not call 'reloadTokenForm' immediate", function() {
+ expect(reloadTokenFormWasCalled).toEqual(false);
+ });
+ it("should trigger ajax and call 'reloadTokenForm'", function() {
+ setTimeout(function(){expect(reloadTokenFormWasCalled).toEqual(true);}, 11000);
+ });
+ it("should stop the timer when idle", function() {
+ stopRenew();
+ setTimeout(function(){expect(reloadTokenFormWasCalled).toEqual(true);}, 11000);
+ });
+});
diff --git a/modules/portal-ui-runtime/eclipse/templates/portal_templates.xml b/modules/portal-ui-runtime/eclipse/templates/portal_templates.xml
new file mode 100644
index 0000000..8af8f8e
--- /dev/null
+++ b/modules/portal-ui-runtime/eclipse/templates/portal_templates.xml
@@ -0,0 +1,18 @@
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:f="http://xmlns.jcp.org/jsf/core"
+ xmlns:h="http://xmlns.jcp.org/jsf/html"
+ xmlns:ui="http://xmlns.jcp.org/jsf/facelets"
+ xmlns:cui="https://cuioss.de/jsf/core">
+ xmlns:boot="https://cuioss.de/jsf/bootstrap">
+
+<ui:composition template="/templates/master_centered.xhtml">
+
+ <ui:define name="title">#{msgs['portal.title']}</ui:define>
+
+ <ui:define name="content">
+ ${cursor}
+ </ui:define>
+</ui:composition>
+</html>
+
\ No newline at end of file
diff --git a/modules/portal-ui-runtime/pom.xml b/modules/portal-ui-runtime/pom.xml
new file mode 100644
index 0000000..e08db90
--- /dev/null
+++ b/modules/portal-ui-runtime/pom.xml
@@ -0,0 +1,77 @@
+
+ 4.0.0
+
+ de.cuioss.portal.ui
+ modules
+ 1.0.0-SNAPSHOT
+
+ portal-ui-runtime
+ Portal UI Runtime
+ Provides the runtime implementations for portal-ui-api
+
+
+ de.cuioss.portal.ui
+ portal-ui-api
+
+
+ de.cuioss.jsf
+ cui-jsf-core-components
+
+
+
+ org.apache.deltaspike.core
+ deltaspike-core-api
+
+
+ org.apache.deltaspike.core
+ deltaspike-core-impl
+
+
+ org.apache.deltaspike.modules
+ deltaspike-jsf-module-api
+
+
+ org.apache.deltaspike.modules
+ deltaspike-jsf-module-impl
+
+
+
+
+ de.cuioss.portal.ui
+ portal-ui-unit-testing
+
+
+ de.cuioss.portal.authentication
+ portal-authentication-mock
+
+
+
+
+
+ maven-resources-plugin
+
+
+ copy-modified-microprofile-config.yaml
+ process-resources
+
+ resources
+
+
+ ${basedir}/target/classes/META-INF
+ true
+
+
+ src/main/resources/META-INF
+ microprofile-config.yaml
+ true
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/MessageProducerBean.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/MessageProducerBean.java
new file mode 100644
index 0000000..18e28d0
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/MessageProducerBean.java
@@ -0,0 +1,135 @@
+package de.cuioss.portal.ui.runtime.application;
+
+import java.text.MessageFormat;
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.faces.application.FacesMessage;
+import javax.faces.application.FacesMessage.Severity;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.application.message.MessageProducer;
+import de.cuioss.jsf.api.application.message.MessageProducerImpl;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.core.bundle.PortalResourceBundle;
+import de.cuioss.portal.ui.api.message.PortalMessageProducer;
+import de.cuioss.tools.collect.MoreCollections;
+import de.cuioss.tools.string.TextSplitter;
+import lombok.EqualsAndHashCode;
+import lombok.NonNull;
+import lombok.ToString;
+
+/**
+ * Portal version of MessageProducer.
+ *
Implementation Note
+ *
+ * All message-strings will be post-processed using {@link TextSplitter} prior
+ * to displaying. This will smoothen possible ui glitches on the growl display
+ * element, but may be problematic regarding unit-tests that will check the
+ * result using {@link String#equals(Object)}. Especially the insertion of
+ * invisible spaces: '\u200B' on the elements ".,;+-!?_" may be problematic. See
+ * the unit-test of this class
+ *
+ *
+ * @author Oliver Wolff
+ */
+@Named(MessageProducerImpl.BEAN_NAME)
+@Dependent
+@PortalMessageProducer
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@EqualsAndHashCode(doNotUseGetters = true)
+@ToString
+public class MessageProducerBean implements MessageProducer {
+
+ private static final int ABBRIDGE_SIZE = 256;
+
+ private static final int FORCE_BREAK_COUNT = 35;
+
+ /**
+ * Used for gracefully react on not existing message-keys.
+ */
+ public static final String MISSING_KEY_PREFIX = "Missing key : ";
+
+ private static final long serialVersionUID = 4405826619024002836L;
+
+ @Inject
+ @PortalResourceBundle
+ private ResourceBundle resourceBundle;
+
+ @Inject
+ private Provider
facesContextProvider;
+
+ @Override
+ public FacesMessage getMessageFor(final String messageKey, final Severity severity, final Object... parameter) {
+ try {
+ var resultingMessage = resourceBundle.getString(messageKey);
+ if (parameter.length > 0) {
+ resultingMessage = MessageFormat.format(resultingMessage, parameter);
+ }
+ var splitter = new TextSplitter(resultingMessage, FORCE_BREAK_COUNT, ABBRIDGE_SIZE);
+ var cleaned = splitter.getTextWithEnforcedLineBreaks();
+ return new FacesMessage(severity, cleaned, cleaned);
+ } catch (final MissingResourceException e) {
+ final var missingKey = MISSING_KEY_PREFIX + messageKey;
+ return new FacesMessage(severity, missingKey, missingKey);
+ }
+ }
+
+ @Override
+ public FacesMessage getErrorMessageFor(final String messageKey, final Object... parameter) {
+ return getMessageFor(messageKey, FacesMessage.SEVERITY_ERROR, parameter);
+ }
+
+ @Override
+ public FacesMessage getInfoMessageFor(final String messageKey, final Object... parameter) {
+ return getMessageFor(messageKey, FacesMessage.SEVERITY_INFO, parameter);
+ }
+
+ @Override
+ public void setFacesMessage(final String messagekey, final Severity severity, final String componentId,
+ final Object... parameter) {
+ facesContextProvider.get().addMessage(componentId, getMessageFor(messagekey, severity, parameter));
+ }
+
+ @Override
+ public void addMessage(String message, Severity severity, String componentId, Object... parameter) {
+ var resultingMessage = message;
+ if (!MoreCollections.isEmpty(parameter)) {
+ resultingMessage = MessageFormat.format(resultingMessage, parameter);
+ }
+ var splitter = new TextSplitter(resultingMessage, FORCE_BREAK_COUNT, ABBRIDGE_SIZE);
+ var cleaned = splitter.getTextWithEnforcedLineBreaks();
+ facesContextProvider.get().addMessage(componentId, new FacesMessage(severity, cleaned, cleaned));
+ }
+
+ @Override
+ public void setGlobalMessage(final String messagekey, final Severity severity, final Object... parameter) {
+ setFacesMessage(messagekey, severity, null, parameter);
+ }
+
+ @Override
+ public void addGlobalMessage(@NonNull final String message, @NonNull final Severity severity,
+ final Object... parameter) {
+ addMessage(message, severity, null, parameter);
+ }
+
+ @Override
+ public void setGlobalInfoMessage(final String messagekey, final Object... parameter) {
+ setGlobalMessage(messagekey, FacesMessage.SEVERITY_INFO, parameter);
+ }
+
+ @Override
+ public void setGlobalErrorMessage(final String messagekey, final Object... parameter) {
+ setGlobalMessage(messagekey, FacesMessage.SEVERITY_ERROR, parameter);
+ }
+
+ @Override
+ public void setGlobalWarningMessage(final String messagekey, final Object... parameter) {
+ setGlobalMessage(messagekey, FacesMessage.SEVERITY_WARN, parameter);
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/PortalApplication.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/PortalApplication.java
new file mode 100644
index 0000000..5630152
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/PortalApplication.java
@@ -0,0 +1,84 @@
+package de.cuioss.portal.ui.runtime.application;
+
+import java.util.Iterator;
+import java.util.Locale;
+
+import javax.faces.application.Application;
+import javax.faces.application.ApplicationWrapper;
+import javax.faces.application.ProjectStage;
+
+import de.cuioss.portal.configuration.application.PortalProjectStage;
+import de.cuioss.portal.core.cdi.PortalBeanManager;
+import de.cuioss.portal.ui.runtime.application.configuration.LocaleConfiguration;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Decorate the standard {@link Application} in order to bridge the portal
+ * specific implementations with the JSF-specific ones. Currently these are:
+ *
+ * - {@link Application#getProjectStage()}
+ *
+ *
+ * @author Oliver Wolff
+ * @author Sven Haag, Sven Haag
+ */
+@RequiredArgsConstructor
+public class PortalApplication extends ApplicationWrapper {
+
+ private static final CuiLogger log = new CuiLogger(PortalApplication.class);
+
+ private static final String PORTAL_105 = "Portal-105: Unable to load PortalBeanManager CDI-context. Defaults to ProjectStage.Production.";
+
+ @Getter
+ private final Application wrapped;
+
+ private PortalProjectStage portalProjectStage;
+
+ private LocaleConfiguration localeConfiguration;
+
+ @Override
+ public ProjectStage getProjectStage() {
+ if (null == portalProjectStage) {
+ try {
+ portalProjectStage = PortalBeanManager.resolveBean(PortalProjectStage.class, null)
+ .orElseThrow(() -> new IllegalArgumentException(
+ PortalBeanManager.createErrorMessage(PortalProjectStage.class, null)));
+ } catch (IllegalStateException | IllegalArgumentException e) {
+ log.warn(PORTAL_105, e);
+ }
+ }
+
+ if (null == portalProjectStage) {
+ return ProjectStage.Production;
+ }
+ if (portalProjectStage.getProjectStage().isDevelopment()) {
+ return ProjectStage.Development;
+ }
+ if (portalProjectStage.getProjectStage().isTest()) {
+ return ProjectStage.SystemTest;
+ }
+
+ return ProjectStage.Production;
+ }
+
+ private LocaleConfiguration getLocaleConfiguration() {
+ if (null == localeConfiguration) {
+ localeConfiguration = PortalBeanManager.resolveBean(LocaleConfiguration.class, null)
+ .orElseThrow(() -> new IllegalStateException("Locale configuration not available"));
+ }
+ return localeConfiguration;
+ }
+
+ @Override
+ public Locale getDefaultLocale() {
+ return getLocaleConfiguration().getDefaultLocale();
+ }
+
+ @Override
+ public Iterator getSupportedLocales() {
+ return getLocaleConfiguration().getAvailableLocales().iterator();
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/StickyMessageProducerBean.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/StickyMessageProducerBean.java
new file mode 100644
index 0000000..5ad4b83
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/StickyMessageProducerBean.java
@@ -0,0 +1,116 @@
+package de.cuioss.portal.ui.runtime.application;
+
+import static com.google.common.collect.Lists.newArrayList;
+import static de.cuioss.portal.ui.api.PortalCoreBeanNames.STICKY_MESSAGE_BEAN_NAME;
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+import static java.text.MessageFormat.format;
+import static java.util.Objects.requireNonNull;
+
+import java.io.Serializable;
+import java.util.HashSet;
+import java.util.List;
+import java.util.ResourceBundle;
+import java.util.Set;
+
+import javax.enterprise.context.SessionScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import de.cuioss.jsf.api.components.css.ContextState;
+import de.cuioss.jsf.api.components.events.ModelPayloadEvent;
+import de.cuioss.portal.core.bundle.PortalResourceBundle;
+import de.cuioss.portal.ui.api.message.PortalStickyMessageProducer;
+import de.cuioss.portal.ui.api.message.StickyMessage;
+import de.cuioss.portal.ui.api.message.StickyMessageProducer;
+import de.cuioss.uimodel.nameprovider.DisplayName;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * @author Matthias Walliczek
+ */
+@Named(STICKY_MESSAGE_BEAN_NAME)
+@SessionScoped
+@PortalStickyMessageProducer
+@EqualsAndHashCode(of = "messageSet", doNotUseGetters = true)
+@ToString(of = "messageSet", doNotUseGetters = true)
+public class StickyMessageProducerBean implements Serializable, StickyMessageProducer {
+
+ private static final long serialVersionUID = -7985606463263784288L;
+
+ private final Set messageSet = new HashSet<>();
+
+ @Inject
+ @PortalResourceBundle
+ private ResourceBundle resourceBundle;
+
+ /**
+ * @return the sticky messages as list.
+ */
+ @Override
+ public List getMessages() {
+ return mutableList(messageSet);
+ }
+
+ @Override
+ public void setInfoMessage(final String messageKey, final Object... parameter) {
+ setMessage(messageKey, ContextState.INFO, parameter);
+ }
+
+ @Override
+ public void setErrorMessage(final String messageKey, final Object... parameter) {
+ setMessage(messageKey, ContextState.DANGER, parameter);
+ }
+
+ @Override
+ public void setWarningMessage(final String messageKey, final Object... parameter) {
+ setMessage(messageKey, ContextState.WARNING, parameter);
+ }
+
+ @Override
+ public void setMessage(final String messageKey, final ContextState severity, final Object... parameter) {
+ setMessageAsString(resourceBundle.getString(messageKey), severity, parameter);
+ }
+
+ @Override
+ public void setMessageAsString(final String messageString, final ContextState severity, final Object... parameter) {
+ if (newArrayList(parameter).isEmpty()) {
+ addMessage(new StickyMessage(true, severity, new DisplayName(messageString)));
+ } else {
+ addMessage(new StickyMessage(true, severity, new DisplayName(format(messageString, parameter))));
+ }
+ }
+
+ @Override
+ public void addMessage(final StickyMessage message) {
+ messageSet.add(requireNonNull(message, "StickyMessage must not be null"));
+ }
+
+ @Override
+ public void removeMessage(final StickyMessage message) {
+ messageSet.remove(message);
+ }
+
+ /**
+ * To be called when the user dismisses the notification box.
+ *
+ * @param dismissEvent to identify the message to remove
+ */
+ public void dismissListener(final ModelPayloadEvent dismissEvent) {
+ removeMessage((StickyMessage) dismissEvent.getModel());
+ }
+
+ @Override
+ public void clearStoredMessages() {
+ messageSet.clear();
+ }
+
+ /**
+ * @return {@code true} if at least one message is available, {@code false}
+ * otherwise
+ */
+ @Override
+ public boolean isAnyMessageAvailable() {
+ return !messageSet.isEmpty();
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/PortalResourceBundleBean.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/PortalResourceBundleBean.java
new file mode 100644
index 0000000..38812ad
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/PortalResourceBundleBean.java
@@ -0,0 +1,115 @@
+package de.cuioss.portal.ui.runtime.application.bundle;
+
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+
+import java.io.Serializable;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+import java.util.Set;
+
+import javax.enterprise.context.Dependent;
+import javax.enterprise.inject.Instance;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.application.bundle.ResourceBundleWrapper;
+import de.cuioss.portal.configuration.application.PortalProjectStageProducer;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.core.bundle.PortalResourceBundle;
+import de.cuioss.tools.collect.CollectionBuilder;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.tools.string.Joiner;
+import de.cuioss.uimodel.application.CuiProjectStage;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Portal variant of CuiResourceBundle
+ *
+ * @author Oliver Wolff
+ */
+@Named(PortalResourceBundleBean.BEAN_NAME)
+@PortalResourceBundle
+@Dependent
+@EqualsAndHashCode(callSuper = false)
+@ToString
+public class PortalResourceBundleBean extends ResourceBundle implements Serializable {
+
+ private static final long serialVersionUID = 3953649686127640297L;
+
+ private static final CuiLogger log = new CuiLogger(PortalResourceBundleBean.class);
+
+ /** Lookup name for el-expression within views: "msgs" */
+ public static final String BEAN_NAME = "msgs";
+
+ private Set knownKeys;
+
+ @Inject
+ private Instance resourceBundleWrapper;
+
+ private transient List sortedBundleWrapper;
+
+ private String allBundleNames;
+
+ @Inject
+ @PortalProjectStageProducer
+ private Provider projectStageProducer;
+
+ @Override
+ protected Object handleGetObject(final String key) {
+
+ for (final ResourceBundleWrapper wrapper : getSortedBundleWrapper()) {
+ if (wrapper.keySet().contains(key)) {
+ return wrapper.getMessage(key);
+ }
+ }
+
+ final var errMsg = "Portal-104: No key '" + key + "' defined within any of the configured bundles: "
+ + allBundleNames;
+
+ if (projectStageProducer.get().isDevelopment()) {
+ throw new MissingResourceException(errMsg, "ResourceBundleWrapperImpl", key);
+ }
+
+ log.warn(errMsg);
+
+ return "??" + key + "??";
+ }
+
+ private List getSortedBundleWrapper() {
+ if (null == sortedBundleWrapper) {
+ sortedBundleWrapper = PortalPriorities.sortByPriority(mutableList(resourceBundleWrapper));
+ List bundleNames = mutableList();
+ sortedBundleWrapper.forEach(wrapper -> bundleNames.add(wrapper.getBundleContent()));
+ allBundleNames = Joiner.on("; ").skipNulls().join(bundleNames);
+ log.debug("Resolved bundles = {}", allBundleNames);
+ }
+ return sortedBundleWrapper;
+ }
+
+ @Override
+ public Enumeration getKeys() {
+ return Collections.enumeration(collectKeys());
+ }
+
+ @Override
+ public Set keySet() {
+ return collectKeys();
+ }
+
+ private Set collectKeys() {
+ if (null == knownKeys) {
+ final var builder = new CollectionBuilder();
+ for (final ResourceBundleWrapper wrapper : resourceBundleWrapper) {
+ builder.add(wrapper.keySet());
+ }
+ knownKeys = builder.toImmutableSet();
+ }
+ return knownKeys;
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/PortalResourceBundleWrapper.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/PortalResourceBundleWrapper.java
new file mode 100644
index 0000000..3ab769c
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/PortalResourceBundleWrapper.java
@@ -0,0 +1,131 @@
+package de.cuioss.portal.ui.runtime.application.bundle;
+
+import static de.cuioss.tools.collect.CollectionLiterals.mutableSet;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+import java.util.Set;
+import java.util.concurrent.CopyOnWriteArrayList;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.SessionScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.application.bundle.ResourceBundleWrapper;
+import de.cuioss.portal.configuration.application.PortalProjectStageProducer;
+import de.cuioss.portal.configuration.bundles.PortalResourceBundleRegistry;
+import de.cuioss.portal.configuration.bundles.ResourceBundleRegistry;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.core.locale.PortalLocale;
+import de.cuioss.portal.ui.api.locale.LocaleChangeEvent;
+import de.cuioss.tools.collect.CollectionBuilder;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.tools.string.Joiner;
+import de.cuioss.uimodel.application.CuiProjectStage;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Portal specific implementation of of {@link ResourceBundleWrapper}. It can do
+ * the following tricks:
+ *
+ * - Define a working serializable contract for resourceBundles
+ * - Listens and acts on {@link LocaleChangeEvent}s
+ *
+ *
+ * @author Oliver Wolff
+ */
+@Named
+@SessionScoped
+@Priority(PortalPriorities.DEFAULT_LEVEL)
+@EqualsAndHashCode(of = "keyList", doNotUseGetters = true)
+@ToString(of = "keyList", doNotUseGetters = true)
+public class PortalResourceBundleWrapper implements ResourceBundleWrapper {
+
+ private static final long serialVersionUID = 9136037316650210138L;
+
+ private static final CuiLogger log = new CuiLogger(PortalResourceBundleWrapper.class);
+
+ @SuppressWarnings("cdi-ambiguous-dependency")
+ @Inject
+ @PortalResourceBundleRegistry
+ private ResourceBundleRegistry resourceBundleRegistry;
+
+ private transient List resolvedBundles;
+
+ @Inject
+ @PortalProjectStageProducer
+ private Provider projectStage;
+
+ @Inject
+ @PortalLocale
+ private Provider localeProvider;
+
+ private final List keyList = new CopyOnWriteArrayList<>();
+
+ @Override
+ public String getMessage(final String key) {
+
+ for (final ResourceBundle bundle : getResolvedBundles()) {
+ if (bundle.containsKey(key)) {
+ return bundle.getString(key);
+ }
+ }
+
+ final var errMsg = "Portal-003 : No key '" + key + "' defined within any of the configured bundles: "
+ + resourceBundleRegistry.getResolvedPaths();
+
+ if (projectStage.get().isDevelopment()) {
+ throw new MissingResourceException(errMsg, "ResourceBundleWrapperImpl", key);
+ }
+
+ log.warn(errMsg);
+ return "??" + key + "??";
+
+ }
+
+ /**
+ * Listener for instances of {@link LocaleChangeEvent} Therefore it can react on
+ * changes of the locale by disposing the loaded {@link ResourceBundle}s and
+ * therefore forcing a reload of the newly set locale
+ *
+ * @param newLocale
+ */
+ void actOnLocaleChangeEven(@Observes @LocaleChangeEvent final Locale newLocale) {
+ resolvedBundles = null;
+ }
+
+ private List getResolvedBundles() {
+ if (null == resolvedBundles) {
+ var builder = new CollectionBuilder();
+ for (final String path : resourceBundleRegistry.getResolvedPaths()) {
+ builder.add(ResourceBundle.getBundle(path, localeProvider.get()));
+ }
+ resolvedBundles = builder.toImmutableList();
+ }
+ return resolvedBundles;
+ }
+
+ @Override
+ public Set keySet() {
+ if (keyList.isEmpty()) {
+ final Set builder = new HashSet<>();
+ for (final ResourceBundle bundle : getResolvedBundles()) {
+ builder.addAll(bundle.keySet());
+ }
+ keyList.addAll(builder);
+ }
+ return mutableSet(keyList);
+ }
+
+ @Override
+ public String getBundleContent() {
+ return Joiner.on(", ").join(resourceBundleRegistry.getResolvedPaths());
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/package-info.java
new file mode 100644
index 0000000..372564e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/bundle/package-info.java
@@ -0,0 +1,41 @@
+/**
+ *
+ * Provides the handling of the unified {@link java.util.ResourceBundle}
+ * analogous to
+ * {@link com.icw.ehf.cui.core.api.application.bundle.CuiResourceBundle}.
+ *
+ * Usage
+ *
+ * The central element is
+ * {@link de.icw.cui.portal.configuration.application.bundle.PortalResourceBundleBean}
+ * It is of type {@link java.util.ResourceBundle} and unifies all configured
+ * {@link java.util.ResourceBundle}s for the portal. In order to use it within a
+ * bean use
+ *
+ *
+ *
+ * @Inject
+ * @PortalResourceBundle
+ * private ResourceBundle resourceBundle;
+ *
+ *
+ * It is exposed as well as named bean "msgs" and can therefore used within
+ * xhtml as standard {@link java.util.ResourceBundle}:
+ *
+ *
+ * {@code #(msgs['page.dashboard.title'])}
+ *
+ *
+ *
+ * Configuration
+ *
+ * Extending the {@link java.util.ResourceBundle}s is quite easy on a module
+ * level. You only need to provide instance of
+ * {@link de.cuioss.portal.ui.api.cdi.api.bundle.PortalResourceBundleDescriptor}
+ * annotated with
+ * {@link de.cuioss.portal.ui.api.cdi.api.bundle.ResourceBundleDescripor}. The
+ * actual configuration will be done withn
+ * {@link de.icw.cui.portal.configuration.bundles.impl.ResourceBundleRegistryImpl}
+ *
+ */
+package de.cuioss.portal.ui.runtime.application.bundle;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/LocaleConfiguration.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/LocaleConfiguration.java
new file mode 100644
index 0000000..5205581
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/LocaleConfiguration.java
@@ -0,0 +1,96 @@
+package de.cuioss.portal.ui.runtime.application.configuration;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.LOCALES_AVAILABLE;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.LOCALE_DEFAULT;
+import static de.cuioss.tools.collect.CollectionLiterals.immutableList;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.configuration.types.ConfigAsLocale;
+import de.cuioss.portal.configuration.types.ConfigAsLocaleList;
+import de.cuioss.tools.collect.MoreCollections;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Defines the locale configuration for the cdi-portal. Instead of using the
+ * built-in mechanics of jsf we use a custom one in order to configure it with
+ * our property based configuration system. It consumes the properties
+ * {@link PortalConfigurationKeys#LOCALE_DEFAULT} and
+ * {@link PortalConfigurationKeys#LOCALES_AVAILABLE}
+ *
+ * @author Oliver Wolff
+ */
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@ApplicationScoped
+@EqualsAndHashCode(of = { "defaultLocale", "availableLocales" })
+@ToString(of = { "defaultLocale", "availableLocales" })
+public class LocaleConfiguration implements Serializable {
+
+ private static final long serialVersionUID = 4249111201638474035L;
+
+ private static final CuiLogger log = new CuiLogger(LocaleConfiguration.class);
+
+ @Inject
+ @ConfigAsLocale(name = LOCALE_DEFAULT, defaultToSystem = false)
+ private Provider localeDefaultProvider;
+
+ @Inject
+ @ConfigAsLocaleList(name = LOCALES_AVAILABLE, defaultToSystem = false)
+ private Provider> localesAvailableProvider;
+
+ @Getter
+ private Locale defaultLocale;
+
+ @Getter
+ private List availableLocales;
+
+ /**
+ * Configures the locales
+ */
+ @PostConstruct
+ public void init() {
+ try {
+ defaultLocale = localeDefaultProvider.get();
+ } catch (final IllegalArgumentException e) {
+ log.warn("Invalid configuration found for {} defaulting to {}", LOCALE_DEFAULT, Locale.ENGLISH);
+ defaultLocale = Locale.ENGLISH;
+ }
+
+ try {
+ availableLocales = localesAvailableProvider.get();
+ } catch (final IllegalArgumentException e) {
+ log.warn("Invalid configuration found for {} defaulting to {}", LOCALES_AVAILABLE, defaultLocale);
+ availableLocales = immutableList(defaultLocale);
+ }
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s. Reconfigures the
+ * locale-configuration
+ *
+ * @param deltaMap
+ */
+ void configurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (MoreCollections.containsKey(deltaMap, LOCALE_DEFAULT, LOCALES_AVAILABLE)) {
+ log.debug("Reloading locale Configuration");
+ init();
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/PortalResourceConfiguration.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/PortalResourceConfiguration.java
new file mode 100644
index 0000000..01ac505
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/PortalResourceConfiguration.java
@@ -0,0 +1,95 @@
+package de.cuioss.portal.ui.runtime.application.configuration;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.RESOURCE_HANDLED_LIBRARIES;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.RESOURCE_HANDLED_SUFFIXES;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.RESOURCE_VERSION;
+
+import java.util.List;
+import java.util.Map;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.application.resources.CuiResourceConfiguration;
+import de.cuioss.jsf.api.application.resources.impl.CuiResourceConfigurationImpl;
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.types.ConfigAsList;
+import de.cuioss.tools.collect.MoreCollections;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * The default implementation reads the Resource related configuration from the
+ * web.xml, the keys are described at {@link PortalConfigurationKeys}
+ *
+ * @author Oliver Wolff
+ */
+@ApplicationScoped
+@Named(CuiResourceConfigurationImpl.BEAN_NAME)
+@EqualsAndHashCode(of = { "version", "handledLibraries", "handledSuffixes" })
+@ToString(of = { "version", "handledLibraries", "handledSuffixes" })
+public class PortalResourceConfiguration implements CuiResourceConfiguration {
+
+ private static final long serialVersionUID = -4555046242472132960L;
+
+ private static final CuiLogger log = new CuiLogger(PortalResourceConfiguration.class);
+
+ @Inject
+ @ConfigAsList(name = RESOURCE_HANDLED_LIBRARIES, defaultValue = "com.icw.cui.fonts,com.icw.portal.css,com.icw.cui.javascript,thirdparty.legacy.js,thirdparty.js,vendor")
+ private Provider> handledLibrariesProvider;
+
+ @Inject
+ @ConfigAsList(name = RESOURCE_HANDLED_SUFFIXES)
+ private Provider> handledSuffixesProvider;
+
+ @Inject
+ @ConfigProperty(name = RESOURCE_VERSION)
+ private Provider versionProvider;
+
+ @Getter
+ private String version;
+
+ @Getter
+ private List handledLibraries;
+
+ @Getter
+ private List handledSuffixes;
+
+ /**
+ * Ensures that the configuration system is initialized properly
+ */
+ @PostConstruct
+ public void init() {
+ doConfigure();
+ }
+
+ private void doConfigure() {
+ version = versionProvider.get();
+ handledLibraries = handledLibrariesProvider.get();
+ handledSuffixes = handledSuffixesProvider.get();
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s. Reconfigures the
+ * default-resource-configuration
+ *
+ * @param deltaMap
+ */
+ void configurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (MoreCollections.containsKey(deltaMap, RESOURCE_VERSION, RESOURCE_HANDLED_LIBRARIES,
+ RESOURCE_HANDLED_SUFFIXES)) {
+ log.debug("Reloading Resource Configuration");
+ doConfigure();
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/ViewConfiguration.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/ViewConfiguration.java
new file mode 100644
index 0000000..7e0e111
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/ViewConfiguration.java
@@ -0,0 +1,105 @@
+package de.cuioss.portal.ui.runtime.application.configuration;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.NON_SECURED_VIEWS;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.SUPPRESSED_VIEWS;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.TRANSIENT_VIEWS;
+
+import java.io.Serializable;
+import java.util.Map;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.application.view.matcher.EmptyViewMatcher;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcher;
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.ui.api.configuration.types.ConfigAsViewMatcher;
+import de.cuioss.tools.collect.MoreCollections;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Reads the View specific configuration from the web.xml and provides
+ * corresponding {@link ViewMatcher}
+ *
+ * @author Oliver Wolff
+ */
+@ApplicationScoped
+@EqualsAndHashCode(of = { "nonSecuredViewMatcher", "transientViewMatcher", "suppressedViewMatcher" })
+@ToString(of = { "nonSecuredViewMatcher", "transientViewMatcher", "suppressedViewMatcher" })
+public class ViewConfiguration implements Serializable {
+
+ private static final long serialVersionUID = -2477375866558117201L;
+
+ private static final CuiLogger log = new CuiLogger(ViewConfiguration.class);
+
+ /**
+ * {@link ViewMatcher} checking for non secured views, defined with
+ * {@link #NON_SECURED_VIEWS}
+ */
+ @Getter
+ private ViewMatcher nonSecuredViewMatcher;
+
+ @Inject
+ @ConfigAsViewMatcher(name = NON_SECURED_VIEWS)
+ private Provider nonSecuredViewMatcherProvider;
+
+ /**
+ * {@link ViewMatcher} checking for transient views, defined with
+ * {@link #TRANSIENT_VIEWS}
+ */
+ @Getter
+ private ViewMatcher transientViewMatcher;
+
+ @Inject
+ @ConfigAsViewMatcher(name = TRANSIENT_VIEWS)
+ private Provider transientViewMatcherProvider;
+
+ /**
+ * {@link ViewMatcher} checking for non secured views, defined with
+ * {@link #SUPPRESSED_VIEWS}
+ */
+ @Getter
+ private ViewMatcher suppressedViewMatcher;
+
+ @Inject
+ @ConfigAsViewMatcher(name = SUPPRESSED_VIEWS)
+ private Provider suppressedViewMatcherProvider;
+
+ /**
+ * Initializes the bean, see class documentation for details
+ */
+ @PostConstruct
+ public void initBean() {
+ doConfigure();
+ }
+
+ private void doConfigure() {
+ nonSecuredViewMatcher = nonSecuredViewMatcherProvider.get();
+ if (nonSecuredViewMatcher instanceof EmptyViewMatcher) {
+ log.warn("The configuration of " + NON_SECURED_VIEWS
+ + " results in all views of the application being only accessible for authorized user. If this is intentional you can ignore this warning");
+ }
+ transientViewMatcher = transientViewMatcherProvider.get();
+ suppressedViewMatcher = suppressedViewMatcherProvider.get();
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s. Reconfigures the
+ * default-resource-configuration
+ *
+ * @param deltaMap
+ */
+ void configurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (MoreCollections.containsKey(deltaMap, NON_SECURED_VIEWS, TRANSIENT_VIEWS, SUPPRESSED_VIEWS)) {
+ log.debug("Change in view configuration found, reconfigure");
+ doConfigure();
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/package-info.java
new file mode 100644
index 0000000..ad8a353
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/configuration/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides the CDI-portal specific default implementations for configuring
+ * view, resources and theming by using the web.xml
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.application.configuration;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CachedCustomizationResource.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CachedCustomizationResource.java
new file mode 100644
index 0000000..bbf00f9
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CachedCustomizationResource.java
@@ -0,0 +1,79 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.util.Map;
+
+import javax.faces.context.FacesContext;
+
+import de.cuioss.portal.ui.api.resources.CacheableResource;
+import de.cuioss.tools.io.IOStreams;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * To allow caching of {@link CustomizationResource}s in case of
+ * {@link ProjectStage#PRODUCTION}
+ *
+ * @author Matthias Walliczek
+ */
+@ToString(callSuper = true, of = "eTag", doNotUseGetters = true)
+@EqualsAndHashCode(callSuper = true, of = "eTag", doNotUseGetters = true)
+public class CachedCustomizationResource extends CacheableResource {
+
+ @Getter
+ private final String eTag;
+
+ @Getter
+ private final Map responseHeaders;
+
+ private final byte[] content;
+ private final IOException contentException;
+ private final URL url;
+
+ /**
+ * Constructor to create a new cached instance of the given resource. Will try
+ * to retrieve the content and persist it.
+ *
+ * @param resource
+ */
+ public CachedCustomizationResource(final CustomizationResource resource) {
+ super.setResourceName(resource.getResourceName());
+ super.setLibraryName(resource.getLibraryName());
+ super.setContentType(resource.getContentType());
+ eTag = resource.getETag();
+ responseHeaders = resource.getResponseHeaders();
+ byte[] resourceContent = { 0 };
+ IOException exceptionOccursOnRead = null;
+ try {
+ resourceContent = IOStreams.toByteArray(resource.getInputStream());
+ } catch (final IOException e) {
+ exceptionOccursOnRead = e;
+ }
+ contentException = exceptionOccursOnRead;
+ content = resourceContent;
+ url = resource.getURL();
+ }
+
+ @Override
+ public InputStream getInputStream() throws IOException {
+ if (null != contentException) {
+ throw contentException;
+ }
+ return new ByteArrayInputStream(content);
+ }
+
+ @Override
+ public String getRequestPath() {
+ final var context = FacesContext.getCurrentInstance();
+ return context.getApplication().getViewHandler().getResourceURL(context, super.determineResourcePath());
+ }
+
+ @Override
+ public URL getURL() {
+ return url;
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResource.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResource.java
new file mode 100644
index 0000000..e9dacac
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResource.java
@@ -0,0 +1,110 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import static de.cuioss.portal.configuration.util.ConfigurationHelper.resolveConfigProperty;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Optional;
+import java.util.TimeZone;
+
+import javax.faces.context.FacesContext;
+
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.application.PortalProjectStageProducer;
+import de.cuioss.portal.core.cdi.PortalBeanManager;
+import de.cuioss.portal.ui.api.resources.CacheableResource;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.uimodel.application.CuiProjectStage;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Implementation of a {@link File} based {@link CacheableResource}.
+ *
+ * @author Matthias Walliczek
+ *
+ */
+@ToString(of = "resourceFile", callSuper = false)
+@EqualsAndHashCode(of = "resourceFile", callSuper = false)
+public final class CustomizationResource extends CacheableResource {
+
+ private static final CuiLogger log = new CuiLogger(CustomizationResource.class);
+
+ private static final String HEADER_LAST_MODIFIED = "Last-Modified";
+ private static final String HEADER_EXPIRES = "Expires";
+ private static final String RFC1123_DATE_PATTERN = "EEE, dd MMM yyyy HH:mm:ss zzz";
+ private final TimeZone gmt = TimeZone.getTimeZone("GMT");
+
+ private final File resourceFile;
+
+ /**
+ * @param resourceFile
+ * @param resourceName
+ * @param libraryName
+ * @param contentType
+ */
+ public CustomizationResource(final File resourceFile, final String resourceName, final String libraryName,
+ final String contentType) {
+ this.resourceFile = resourceFile;
+ setResourceName(resourceName);
+ setLibraryName(libraryName);
+ setContentType(contentType);
+ }
+
+ @Override
+ public InputStream getInputStream() throws IOException {
+ return new FileInputStream(resourceFile);
+ }
+
+ @Override
+ public Map getResponseHeaders() {
+ final var responseHeaders = super.getResponseHeaders();
+ final var format = new SimpleDateFormat(RFC1123_DATE_PATTERN, Locale.US);
+ format.setTimeZone(gmt);
+ final long expiresTime;
+ final Optional projectStageBean = PortalBeanManager.resolveBean(CuiProjectStage.class,
+ PortalProjectStageProducer.class);
+ if (projectStageBean.isPresent() && projectStageBean.get().isDevelopment()) {
+ expiresTime = new Date().getTime();
+ } else {
+ final var maxAge = Integer.parseInt(
+ resolveConfigProperty(PortalConfigurationKeys.RESOURCE_MAXAGE).orElse("10080")) * 60L * 1000L;
+ expiresTime = new Date().getTime() + maxAge;
+ }
+ responseHeaders.put(HEADER_EXPIRES, format.format(new Date(expiresTime)));
+ responseHeaders.put(HEADER_LAST_MODIFIED, format.format(new Date(resourceFile.lastModified())));
+
+ return responseHeaders;
+ }
+
+ @Override
+ protected String getETag() {
+ return "W/\"" + resourceFile.length() + '-' + resourceFile.lastModified() + '"';
+ }
+
+ @Override
+ public String getRequestPath() {
+ final var context = FacesContext.getCurrentInstance();
+ return context.getApplication().getViewHandler().getResourceURL(context, super.determineResourcePath());
+ }
+
+ @Override
+ public URL getURL() {
+ try {
+ return resourceFile.toURI().toURL();
+ } catch (final MalformedURLException e) {
+ log.warn("Portal-145: Customization resource '" + resourceFile.toString()
+ + "' can not be resolved to an URL", e);
+ throw new IllegalStateException(e);
+ }
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceBundleWrapper.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceBundleWrapper.java
new file mode 100644
index 0000000..af25a73
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceBundleWrapper.java
@@ -0,0 +1,179 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CUSTOMIZATION_DIR;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CUSTOMIZATION_ENABLED;
+import static de.cuioss.tools.collect.CollectionLiterals.immutableSet;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Properties;
+import java.util.Set;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.application.bundle.ResourceBundleWrapper;
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.configuration.schedule.FileChangedEvent;
+import de.cuioss.portal.configuration.schedule.FileWatcherService;
+import de.cuioss.portal.configuration.schedule.PortalFileWatcherService;
+import de.cuioss.portal.core.locale.PortalLocale;
+import de.cuioss.tools.io.MorePaths;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Implementation of a {@link ResourceBundleWrapper} to retrieve messages from
+ * the {@link #RESOURCES_DIRECTORY} directory inside
+ * {@link PortalConfigurationKeys#PORTAL_CUSTOMIZATION_DIR} at the file system.
+ * Takes care of the locale. A FileWatcher is registered and at each change all
+ * messages are reloaded.
+ *
+ * @author Matthias Walliczek
+ *
+ */
+@ApplicationScoped
+@EqualsAndHashCode(of = "resourcePath", callSuper = false)
+@ToString(of = "resourcePath")
+@Priority(PortalPriorities.PORTAL_INSTALLATION_LEVEL)
+public class CustomizationResourceBundleWrapper implements ResourceBundleWrapper {
+
+ private static final long serialVersionUID = 919996532090944489L;
+
+ private static final CuiLogger log = new CuiLogger(CustomizationResourceBundleWrapper.class);
+
+ private static final String MESSAGES_SUFFIX = ".properties";
+
+ private static final String MESSAGES_PREFIX = "messages_";
+
+ private static final String DEFAULT_MESSAGES_PROPERTIES = "messages.properties";
+
+ /**
+ * The name of the folder inside the
+ * {@link PortalConfigurationKeys#PORTAL_CUSTOMIZATION_DIR}.
+ */
+ public static final String RESOURCES_DIRECTORY = "i18n";
+
+ @SuppressWarnings("cdi-ambiguous-dependency")
+ @Inject
+ @PortalLocale
+ private Provider localeProvider;
+
+ @SuppressWarnings("cdi-ambiguous-dependency")
+ @Inject
+ @PortalFileWatcherService
+ private FileWatcherService fileWatcherServiceProvider;
+
+ @SuppressWarnings("cdi-ambiguous-dependency")
+ @Inject
+ @ConfigProperty(name = PORTAL_CUSTOMIZATION_ENABLED)
+ private Provider customizationEnabledProvider;
+
+ @SuppressWarnings("cdi-ambiguous-dependency")
+ @Inject
+ @ConfigProperty(name = PORTAL_CUSTOMIZATION_DIR)
+ private Provider> customizationDir;
+
+ private File resourcePath;
+
+ private Map properties;
+
+ @Override
+ public String getMessage(final String key) {
+ return getProperties(localeProvider.get()).getProperty(key);
+ }
+
+ @Override
+ public Set keySet() {
+ return immutableSet(getProperties(localeProvider.get()).stringPropertyNames());
+ }
+
+ @Override
+ public String getBundleContent() {
+ return toString();
+ }
+
+ private Properties getProperties(final Locale locale) {
+ if (null == properties) {
+ configureResourcePath();
+ }
+ return properties.computeIfAbsent(locale, this::retrievePropertiesForLocale);
+ }
+
+ private Properties retrievePropertiesForLocale(final Locale locale) {
+ var currentProperties = new Properties();
+ if (null != resourcePath && resourcePath.isDirectory()) {
+ checkAndParseFile(currentProperties, DEFAULT_MESSAGES_PROPERTIES);
+ checkAndParseFile(currentProperties, MESSAGES_PREFIX + locale.getLanguage() + MESSAGES_SUFFIX);
+ checkAndParseFile(currentProperties, MESSAGES_PREFIX + locale.toString() + MESSAGES_SUFFIX);
+ }
+ log.debug("retrieve properties for locale {}: {}", locale, currentProperties);
+ return currentProperties;
+ }
+
+ private void configureResourcePath() {
+ properties = new HashMap<>();
+ if (null != resourcePath) {
+ fileWatcherServiceProvider.unregister(resourcePath.toPath());
+ }
+ resourcePath = null;
+ if (!customizationEnabledProvider.get().booleanValue()) {
+ return;
+ }
+ var customizationDirectory = customizationDir.get();
+ if (customizationDirectory.isPresent()) {
+ resourcePath = Paths.get(customizationDirectory.get()).resolve(RESOURCES_DIRECTORY).toFile();
+ if (resourcePath.exists() && resourcePath.isDirectory()) {
+ fileWatcherServiceProvider.register(resourcePath.toPath());
+ } else {
+ log.warn("Portal-157: Customization resources directory not available: {}", resourcePath);
+ }
+ }
+ }
+
+ private void checkAndParseFile(final Properties currentProperties, final String fileName) {
+ var defaultPath = resourcePath.toPath().resolve(fileName).toFile();
+ if (defaultPath.isFile()) {
+ try (var stream = new FileInputStream(defaultPath)) {
+ currentProperties.load(stream);
+ } catch (IOException e) {
+ log.warn(e, "Portal-124: Customization messages properties file {} could not be read", defaultPath);
+ }
+ }
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s. Emptying our properties
+ * to trigger re-configuration.
+ *
+ * @param deltaMap changed configuration properties
+ */
+ void portalConfigurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (deltaMap.containsKey(PORTAL_CUSTOMIZATION_ENABLED) || deltaMap.containsKey(PORTAL_CUSTOMIZATION_DIR)) {
+ properties = null;
+ }
+ }
+
+ void fileChangeListener(@Observes @FileChangedEvent final Path newPath) {
+ if (null != resourcePath && MorePaths.isSameFile(resourcePath.toPath(), newPath)) {
+ log.info("Portal-018: Changes in customization dir ({}) detected. Reloading.", newPath.toAbsolutePath());
+ properties = null;
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceHandler.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceHandler.java
new file mode 100644
index 0000000..547494b
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceHandler.java
@@ -0,0 +1,46 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import java.util.Optional;
+
+import javax.faces.application.Resource;
+import javax.faces.application.ResourceHandler;
+import javax.faces.application.ResourceHandlerWrapper;
+
+import de.cuioss.portal.core.cdi.PortalBeanManager;
+import de.cuioss.tools.base.Preconditions;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Allows to override specific resources at the installation. Delegates to
+ * {@link ResourceProducer}.
+ *
+ * @author Matthias Walliczek
+ */
+@RequiredArgsConstructor
+public class CustomizationResourceHandler extends ResourceHandlerWrapper {
+
+ /**
+ * Wrapped resource handler.
+ */
+ @Getter
+ private final ResourceHandler wrapped;
+
+ @Override
+ @SuppressWarnings("java:S3655") // owolff: False Positive, isPresent is checked properly
+ public Resource createResource(final String resourceName, final String libraryName) {
+ final Optional resourceProducer = PortalBeanManager.resolveBean(ResourceProducer.class,
+ PortalResourceProducer.class);
+
+ Preconditions.checkArgument(resourceProducer.isPresent(),
+ PortalBeanManager.createLogMessage(ResourceProducer.class, PortalResourceProducer.class));
+
+ var result = resourceProducer.get().retrieveResource(resourceName, libraryName);
+ if (null != result) {
+ return result;
+ }
+
+ return super.createResource(resourceName, libraryName);
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceProducer.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceProducer.java
new file mode 100644
index 0000000..dcc0eca
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationResourceProducer.java
@@ -0,0 +1,270 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CUSTOMIZATION_DIR;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CUSTOMIZATION_ENABLED;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_STAGE;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.enterprise.inject.Instance;
+import javax.faces.application.Resource;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.application.PortalProjectStageProducer;
+import de.cuioss.portal.configuration.schedule.FileChangedEvent;
+import de.cuioss.portal.configuration.schedule.FileWatcherService;
+import de.cuioss.portal.configuration.schedule.PortalFileWatcherService;
+import de.cuioss.tools.io.MorePaths;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.tools.string.MoreStrings;
+import de.cuioss.tools.string.Splitter;
+import de.cuioss.uimodel.application.CuiProjectStage;
+import lombok.Synchronized;
+
+/**
+ * Allow overriding {@link Resource}s for customization at the file system. Will
+ * retrieve all files in {@link #RESOURCES_DIRECTORY} and return these files
+ * when asked for a matching resource. During {@link ProjectStage#PRODUCTION}
+ * all resources are cached.
+ *
+ * @author Matthias Walliczek
+ */
+@ApplicationScoped
+@PortalResourceProducer
+public class CustomizationResourceProducer implements ResourceProducer {
+
+ private static final CuiLogger log = new CuiLogger(CustomizationResourceProducer.class);
+
+ /**
+ * The name of the folder inside the
+ * {@link PortalConfigurationKeys#PORTAL_CUSTOMIZATION_DIR}.
+ */
+ public static final String RESOURCES_DIRECTORY = "resources";
+
+ @Inject
+ @PortalProjectStageProducer
+ private Provider projectStageProvider;
+
+ @Inject
+ @PortalFileWatcherService
+ private Instance fileWatcherServiceProvider;
+
+ @Inject
+ private Provider facesContextProvider;
+
+ @Inject
+ @ConfigProperty(name = PORTAL_CUSTOMIZATION_ENABLED)
+ private Provider customizationEnabledProvider;
+
+ @Inject
+ @ConfigProperty(name = PortalConfigurationKeys.PORTAL_CUSTOMIZATION_DIR)
+ private Provider> customizationDirProvider;
+
+ private File resourcePath;
+
+ private Map> foundResources;
+
+ private Map resourcesCache;
+
+ @Override
+ public Resource retrieveResource(final String resourceName, final String libraryName) {
+ // lazy init
+ if (null == foundResources) {
+ determineResources();
+ }
+
+ if (foundResources.containsKey(libraryName) && foundResources.get(libraryName).contains(resourceName)) {
+ return createCustomizationResource(resourceName, libraryName);
+ }
+
+ if (libraryName == null && !MoreStrings.isEmpty(resourceName)) {
+ for (final String libName : foundResources.keySet()) {
+ final var libNameAsPrefix = libName + "/";
+ if (resourceName.startsWith(libNameAsPrefix)) {
+ // recursion
+ return retrieveResource(resourceName.substring(libNameAsPrefix.length()), libName);
+ }
+ }
+ }
+ return null;
+ }
+
+ private Resource createCustomizationResource(final String resourceName, final String libraryName) {
+
+ final var resourceFile = loadFile(resourceName, libraryName);
+
+ log.trace("create customization resource: libraryName {}, resourceName {}", libraryName, resourceName);
+ // during development create each time new resource
+ if (projectStageProvider.get().isDevelopment()) {
+ return new CustomizationResource(resourceFile, resourceName, libraryName, determineMimeType(resourceFile));
+ }
+
+ if (!resourcesCache.containsKey(resourceFile)) {
+ final var mimeType = determineMimeType(resourceFile);
+ resourcesCache.put(resourceFile, new CachedCustomizationResource(
+ new CustomizationResource(resourceFile, resourceName, libraryName, mimeType)));
+ }
+
+ return resourcesCache.get(resourceFile);
+ }
+
+ private File loadFile(final String resourceName, final String libraryName) {
+
+ if (!projectStageProvider.get().isDevelopment()) {
+
+ final var resourceNameMinified = createResourceNameInMinifiedSytle(resourceName);
+
+ if (null != resourceNameMinified && foundResources.get(libraryName).contains(resourceNameMinified)) {
+ return resourcePath.toPath().resolve(libraryName).resolve(resourceNameMinified).toFile();
+ }
+ }
+
+ return resourcePath.toPath().resolve(libraryName).resolve(resourceName).toFile();
+ }
+
+ private static String createResourceNameInMinifiedSytle(final String resourceName) {
+ final var parts = Splitter.on('.').trimResults().limit(2).splitToList(resourceName);
+ if (!parts.isEmpty() && parts.size() > 1) {
+ return parts.get(0) + ".min." + parts.get(1);
+ }
+ return null;
+ }
+
+ private String determineMimeType(final File resourceFile) {
+ return facesContextProvider.get().getExternalContext().getMimeType(resourceFile.toString());
+ }
+
+ private void determineResources() {
+
+ foundResources = new HashMap<>(0);
+
+ resourcesCache = new HashMap<>(0);
+
+ prepareFileWatcherService();
+
+ customizationDirProvider.get()
+ .ifPresent(customizationDir -> resourcePath = lookupResourceDirectory(Paths.get(customizationDir)));
+
+ if (null != resourcePath) {
+
+ log.debug("Register file watcher to react for changes in directory {}", resourcePath.getAbsolutePath());
+
+ fileWatcherServiceProvider.forEach(provider -> provider.register(resourcePath.toPath()));
+
+ log.info("Searching customization resources in folder {}", resourcePath.getAbsolutePath());
+
+ try (final var directoryStream = Files.newDirectoryStream(resourcePath.toPath())) {
+ for (final Path path : directoryStream) {
+ if (path.toFile().isDirectory()) {
+
+ final var pathName = path.toFile().getName();
+
+ final var filesInDirectory = findFilesInDirectory(
+ resourcePath.toPath().resolve(path.getFileName()));
+
+ foundResources.put(pathName, filesInDirectory);
+ }
+ }
+ log.info("Found resources: {}", foundResources);
+ } catch (final IOException ex) {
+ log.warn(ex, "Portal-122: Unable to search path: {}", resourcePath.toString());
+ }
+ }
+
+ }
+
+ private static File lookupResourceDirectory(final Path customizationPath) {
+ if (null != customizationPath) {
+ final var resourcesDir = customizationPath.resolve(RESOURCES_DIRECTORY).toFile();
+ if (resourcesDir.exists() && resourcesDir.isDirectory()) {
+ return resourcesDir;
+ }
+ }
+ log.info(
+ "No installation specific customization detected, using defaults. If this is intentional you can ignore this message");
+ return null;
+ }
+
+ private void prepareFileWatcherService() {
+ // if was executed before there may be some file watches registered
+ if (null != resourcePath) {
+ // cleanup
+ fileWatcherServiceProvider.forEach(provider -> provider.unregister(resourcePath.toPath()));
+ // may customization path was adapted
+ resourcePath = null;
+ }
+ }
+
+ private static List findFilesInDirectory(final Path path) {
+
+ File[] filesInDirectory = null;
+
+ try {
+ filesInDirectory = path.toFile().listFiles(File::isFile);
+ } catch (final SecurityException e) {
+ // it's not critical enough to explode if access to directory failed
+ log.warn(e, "Portal-122 : access denied to: {}", path.toFile().getName());
+ }
+
+ if (null == filesInDirectory) {
+ return Collections.emptyList();
+ }
+
+ return Arrays.stream(filesInDirectory).map(File::getName).collect(Collectors.toList());
+ }
+
+ void fileChangeListener(@Observes @FileChangedEvent final Path newPath) {
+ if (null != resourcePath && MorePaths.isSameFile(resourcePath.toPath(), newPath)) {
+ forceDetermineResources();
+ }
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s. Reconfigures the
+ * project-stage-configuration
+ *
+ * @param deltaMap changed configuration properties
+ */
+ void portalConfigurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (deltaMap.containsKey(PORTAL_STAGE) || deltaMap.containsKey(PORTAL_CUSTOMIZATION_ENABLED)
+ || deltaMap.containsKey(PORTAL_CUSTOMIZATION_DIR)) {
+ forceDetermineResources();
+ }
+ }
+
+ @Synchronized
+ private void forceDetermineResources() {
+
+ if (null != foundResources) {
+ foundResources.clear();
+ }
+
+ foundResources = null;
+
+ if (null != resourcesCache) {
+ resourcesCache.clear();
+ }
+
+ resourcesCache = null;
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationViewResourcesDescriptor.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationViewResourcesDescriptor.java
new file mode 100644
index 0000000..652428c
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/CustomizationViewResourcesDescriptor.java
@@ -0,0 +1,197 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CUSTOMIZATION_DIR;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_CUSTOMIZATION_ENABLED;
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Event;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.configuration.schedule.FileChangedEvent;
+import de.cuioss.portal.configuration.schedule.FileWatcherService;
+import de.cuioss.portal.configuration.schedule.PortalFileWatcherService;
+import de.cuioss.portal.ui.api.templating.PortalTemplateDescriptor;
+import de.cuioss.portal.ui.api.templating.PortalViewDescriptor;
+import de.cuioss.portal.ui.api.templating.PortalViewResourcesConfigChanged;
+import de.cuioss.portal.ui.api.templating.PortalViewResourcesConfigChangedType;
+import de.cuioss.portal.ui.api.templating.StaticTemplateDescriptor;
+import de.cuioss.portal.ui.api.templating.StaticViewDescriptor;
+import de.cuioss.tools.io.MorePaths;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.tools.string.MoreStrings;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Descriptor to handle customized views and templates.
+ *
+ * Searches for templates and views inside of
+ * {@value PortalConfigurationKeys#PORTAL_CUSTOMIZATION_DIR}.
+ *
+ * In {@link ProjectStage#DEVELOPMENT} the folders are monitored and new created
+ * / deleted files will result in a reset of the corresponding file lists.
+ *
+ * @author Matthias Walliczek
+ */
+@PortalTemplateDescriptor
+@PortalViewDescriptor
+@ApplicationScoped
+@Priority(PortalPriorities.PORTAL_INSTALLATION_LEVEL)
+@Named
+@ToString(exclude = { "fileWatcherService", "viewResourcesConfigChangedEvent" })
+@EqualsAndHashCode(exclude = { "fileWatcherService", "viewResourcesConfigChangedEvent" })
+public class CustomizationViewResourcesDescriptor implements StaticTemplateDescriptor, StaticViewDescriptor {
+
+ private static final CuiLogger log = new CuiLogger(CustomizationViewResourcesDescriptor.class);
+
+ private static final String TEMPLATES_DIRECTORY = "templates";
+ private static final String VIEWS_DIRECTORY = "views";
+
+ private static final long serialVersionUID = 2575347911928721019L;
+
+ @Inject
+ @PortalFileWatcherService
+ private FileWatcherService fileWatcherService;
+
+ @Inject
+ @PortalViewResourcesConfigChanged
+ private Event viewResourcesConfigChangedEvent;
+
+ @Inject
+ @ConfigProperty(name = PORTAL_CUSTOMIZATION_ENABLED)
+ private Provider customizationEnabledProvider;
+
+ @Inject
+ @ConfigProperty(name = PortalConfigurationKeys.PORTAL_CUSTOMIZATION_DIR)
+ private Provider> customizationDir;
+
+ @Getter
+ private List handledTemplates;
+
+ @Getter
+ private String templatePath;
+
+ @Getter
+ private List handledViews;
+
+ @Getter
+ private String viewPath;
+
+ /**
+ * Initialization.
+ */
+ @PostConstruct
+ public void initialize() {
+ if (!MoreStrings.isEmpty(templatePath)) {
+ fileWatcherService.unregister(Paths.get(templatePath));
+ }
+ if (!MoreStrings.isEmpty(viewPath)) {
+ fileWatcherService.unregister(Paths.get(viewPath));
+ }
+ templatePath = null;
+ handledTemplates = Collections.emptyList();
+ viewPath = null;
+ handledViews = Collections.emptyList();
+ if (!customizationEnabledProvider.get().booleanValue()) {
+ return;
+ }
+ final var customizationDirectory = customizationDir.get();
+ if (!customizationDirectory.isPresent()) {
+ return;
+ }
+ final var customizationPath = Paths.get(customizationDirectory.get());
+ var currentTemplatePath = customizationPath.resolve(TEMPLATES_DIRECTORY);
+ if (currentTemplatePath.toFile().exists()) {
+ templatePath = currentTemplatePath.toString();
+ handledTemplates = retrieveViewResources(currentTemplatePath, "");
+ log.debug("Found custom templates folder {} and registered these templates: {}", templatePath,
+ handledTemplates.toString());
+ fileWatcherService.register(currentTemplatePath);
+ } else {
+ log.debug("TEMPLATES folder {} does not exists", templatePath);
+ }
+ var currentViewPath = customizationPath.resolve(VIEWS_DIRECTORY);
+ if (currentViewPath.toFile().exists()) {
+ viewPath = currentViewPath.toString();
+ handledViews = retrieveViewResources(currentViewPath, "");
+ log.debug("Found custom views folder {} and registered these views: {}", viewPath, handledViews.toString());
+ fileWatcherService.register(currentViewPath);
+ } else {
+ log.debug("VIEWS folder {} does not exists", viewPath);
+ }
+ }
+
+ private static List retrieveViewResources(final Path currentTemplatePath, final String prefix) {
+ List result = mutableList();
+ try (var directoryStream = Files.newDirectoryStream(currentTemplatePath)) {
+ for (Path pathname : directoryStream) {
+ if (pathname.toFile().isFile() && pathname.toString().endsWith(".xhtml")) {
+ result.add(prefix.concat(pathname.toFile().getName()));
+ } else if (pathname.toFile().isDirectory()) {
+ result.addAll(retrieveViewResources(currentTemplatePath.resolve(pathname.toFile().getName()),
+ prefix.concat(pathname.toFile().getName() + "/")));
+ }
+ }
+ } catch (IOException ex) {
+ log.warn(ex, "Portal-122: Unable to search path: {}", currentTemplatePath.toString());
+ }
+ return result;
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s. Reconfigures the
+ * project-stage-configuration
+ *
+ * @param deltaMap changed configuration properties
+ */
+ void portalConfigurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (deltaMap.containsKey(PORTAL_CUSTOMIZATION_ENABLED) || deltaMap.containsKey(PORTAL_CUSTOMIZATION_DIR)) {
+ reloadAndFireEvents();
+ }
+ }
+
+ void fileChangeListener(@Observes @FileChangedEvent final Path newPath) {
+ if (null != templatePath && MorePaths.isSameFile(Paths.get(templatePath), newPath)
+ || null != viewPath && MorePaths.isSameFile(Paths.get(viewPath), newPath)) {
+ reloadAndFireEvents();
+ }
+ }
+
+ private void reloadAndFireEvents() {
+ log.debug("Portal-007: Reloading custom view resources");
+ var oldTemplatePath = templatePath;
+ var oldHandledTemplates = handledTemplates;
+ var oldViewPath = viewPath;
+ var oldHandledViews = handledViews;
+ initialize();
+ if (!MoreStrings.nullToEmpty(templatePath).equals(oldTemplatePath)
+ || !handledTemplates.equals(oldHandledTemplates)) {
+ viewResourcesConfigChangedEvent.fire(PortalViewResourcesConfigChangedType.TEMPLATES);
+ }
+ if (!MoreStrings.nullToEmpty(viewPath).equals(oldViewPath) || !handledViews.equals(oldHandledViews)) {
+ viewResourcesConfigChangedEvent.fire(PortalViewResourcesConfigChangedType.VIEWS);
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/PortalResourceProducer.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/PortalResourceProducer.java
new file mode 100644
index 0000000..263c1d1
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/PortalResourceProducer.java
@@ -0,0 +1,25 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import javax.inject.Qualifier;
+
+/**
+ * Annotation for a {@link ResourceProducer}.
+ *
+ * @author Matthias Walliczek
+ *
+ */
+@Qualifier
+@Retention(RUNTIME)
+@Target({ TYPE, METHOD, FIELD, PARAMETER })
+public @interface PortalResourceProducer {
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/ResourceProducer.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/ResourceProducer.java
new file mode 100644
index 0000000..bbc5ec2
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/ResourceProducer.java
@@ -0,0 +1,21 @@
+package de.cuioss.portal.ui.runtime.application.customization;
+
+import javax.faces.application.Resource;
+
+/**
+ * To be used by {@link CustomizationResourceHandler}.
+ *
+ * @author Matthias Walliczek
+ *
+ */
+public interface ResourceProducer {
+
+ /**
+ * @param resourceName
+ * @param libraryName
+ * @return the resource with given resourceName and libraryName if found,
+ * otherwise null
+ */
+ Resource retrieveResource(String resourceName, String libraryName);
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/package-info.java
new file mode 100644
index 0000000..148dcd9
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/customization/package-info.java
@@ -0,0 +1,28 @@
+/**
+ *
+ * Allows to customize an installation. To activate either create a
+ * "customization" folder inside
+ * {@link de.icw.cui.portal.configuration.PortalConfigurationKeys#PORTAL_CONFIG_DIR}
+ * or configure
+ * {@link de.icw.cui.portal.configuration.PortalConfigurationKeys#PORTAL_CUSTOMIZATION_DIR}.
+ *
+ *
+ *
+ * Within this folder a specific structure is expected:
+ *
+ * - /i18n: To customize message properties
+ * - /resources: To customize resources like images, css, composite
+ * components...
+ * - /templates: To customize templates like master_centered.xhtml
+ * - /views: To customize views like guest/login.xhtml (which is maintained in
+ * cui-portal as /faces/guest/login.xhtml). implicit conventions : overwrite
+ * only possible up from /faces folder!
+ *
+ *
+ *
+ * See also:
+ * CUI
+ * Customization concept
+ *
+ */
+package de.cuioss.portal.ui.runtime.application.customization;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/dashboard/DashboardWidgetRegistration.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/dashboard/DashboardWidgetRegistration.java
new file mode 100644
index 0000000..1cf455e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/dashboard/DashboardWidgetRegistration.java
@@ -0,0 +1,64 @@
+package de.cuioss.portal.ui.runtime.application.dashboard;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.DASHBOARD_WIDGET;
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+
+import java.io.Serializable;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.inject.Instance;
+import javax.faces.view.ViewScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import de.cuioss.jsf.api.components.model.widget.DashboardWidgetModel;
+import de.cuioss.jsf.api.components.model.widget.WidgetModel;
+import de.cuioss.portal.configuration.types.ConfigAsFilteredMap;
+import de.cuioss.portal.ui.api.dashboard.PortalDashboardWidget;
+import de.cuioss.tools.string.MoreStrings;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+@ViewScoped
+@Named
+@ToString
+@EqualsAndHashCode
+public class DashboardWidgetRegistration implements Serializable {
+
+ private static final long serialVersionUID = -8229255432062229719L;
+
+ @Getter
+ private List widgets;
+
+ @Inject
+ @PortalDashboardWidget
+ private Instance widgetsInstances;
+
+ @Inject
+ @ConfigAsFilteredMap(startsWith = DASHBOARD_WIDGET, stripPrefix = true)
+ private Map widgetConfig;
+
+ @PostConstruct
+ public void init() {
+ widgets = mutableList(
+ widgetsInstances.stream().filter(widget -> widget.isRendered() && getOrder(widget).isPresent())
+ .sorted(Comparator.comparing((DashboardWidgetModel o) -> getOrder(o).get()))
+ .collect(Collectors.toList()));
+ }
+
+ private Optional getOrder(WidgetModel widget) {
+ var orderKey = widget.getId() + ".order";
+ var enabledKey = widget.getId() + ".enabled";
+ if (MoreStrings.isEmpty(widget.getId()) || !widgetConfig.containsKey(orderKey)
+ || widgetConfig.containsKey(enabledKey) && !Boolean.parseBoolean(widgetConfig.get(enabledKey))) {
+ return Optional.empty();
+ }
+ return Optional.of(Integer.valueOf(widgetConfig.get(orderKey)));
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/factory/PortalApplicationFactory.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/factory/PortalApplicationFactory.java
new file mode 100644
index 0000000..adbe0e4
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/factory/PortalApplicationFactory.java
@@ -0,0 +1,64 @@
+package de.cuioss.portal.ui.runtime.application.factory;
+
+import javax.faces.application.Application;
+import javax.faces.application.ApplicationFactory;
+import javax.faces.application.ApplicationWrapper;
+
+import de.cuioss.portal.ui.runtime.application.PortalApplication;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Factory for creating / wrapping an existing {@link ApplicationFactory}
+ *
+ * @author Oliver Wolff
+ */
+@RequiredArgsConstructor
+public class PortalApplicationFactory extends ApplicationFactory {
+
+ @Getter
+ private final ApplicationFactory wrapped;
+ private volatile Application application;
+
+ /**
+ * Returns an instance of {@link PortalApplication} which wraps the original
+ * application.
+ */
+ @Override
+ public Application getApplication() {
+ return application == null ? createPortalApplication(wrapped.getApplication()) : application;
+ }
+
+ /**
+ * Sets the given application instance as the current instance. If it's not an
+ * instance of {@link PortalApplication}, nor wraps the
+ * {@link PortalApplication}, then it will be wrapped by a new instance of
+ * {@link PortalApplication}.
+ */
+ @Override
+ public void setApplication(final Application application) {
+ wrapped.setApplication(createPortalApplication(application));
+ }
+
+ /**
+ * If the given application not an instance of {@link PortalApplication}, nor
+ * wraps the {@link PortalApplication}, then it will be wrapped by a new
+ * instance of {@link PortalApplication} and set as the current instance and
+ * returned.
+ */
+ private Application createPortalApplication(final Application application) {
+ synchronized (PortalApplicationFactory.class) {
+ var toBeWrapped = application;
+ while (!(toBeWrapped instanceof PortalApplication) && toBeWrapped instanceof ApplicationWrapper) {
+ toBeWrapped = ((ApplicationWrapper) toBeWrapped).getWrapped();
+ }
+
+ if (!(toBeWrapped instanceof PortalApplication)) {
+ toBeWrapped = new PortalApplication(toBeWrapped);
+ }
+ this.application = toBeWrapped;
+ return this.application;
+ }
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/DefaultHistoryConfiguration.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/DefaultHistoryConfiguration.java
new file mode 100644
index 0000000..8f88653
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/DefaultHistoryConfiguration.java
@@ -0,0 +1,68 @@
+package de.cuioss.portal.ui.runtime.application.history;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.HISTORY_EXCLUDE_PARAMETER;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.HISTORY_VIEW_EXCLUDE_PARAMETER;
+
+import java.util.List;
+
+import javax.enterprise.context.Dependent;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.application.history.HistoryConfiguration;
+import de.cuioss.jsf.api.application.history.impl.HistoryConfigurationImpl;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcher;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.ui.api.configuration.types.ConfigAsViewMatcher;
+import de.cuioss.portal.ui.api.ui.pages.HomePage;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Default {@link HistoryConfiguration} for the CDI-Portal, defaulting to:
+ *
+ * - fallbackOutcome = {@link HomePage#OUTCOME}
+ * - excludeParameter = derived by web.xml with the key
+ * {@link PortalConfigurationKeys#HISTORY_EXCLUDE_PARAMETER}
+ * - excludeFromHistoryMatcher = derived by web.xml with the key
+ * {@link PortalConfigurationKeys#HISTORY_VIEW_EXCLUDE_PARAMETER}
+ * - historySize=10
+ * - excludeFacesParameter=true
+ *
+ *
+ * @author Oliver Wolff
+ */
+@Dependent
+@Named(HistoryConfigurationImpl.BEAN_NAME)
+@EqualsAndHashCode
+@ToString
+public class DefaultHistoryConfiguration implements HistoryConfiguration {
+
+ private static final long serialVersionUID = 8178547799619418410L;
+
+ @Getter
+ private String fallback;
+
+ @Getter
+ private final String fallbackOutcome = HomePage.OUTCOME;
+
+ @Getter
+ private final int historySize = HistoryConfigurationImpl.DEFAULT_HISTORY_SIZE;
+
+ @Getter
+ private final boolean excludeFacesParameter = true;
+
+ @Getter
+ @Inject
+ @ConfigProperty(name = HISTORY_EXCLUDE_PARAMETER)
+ private List excludeParameter;
+
+ @Getter
+ @Inject
+ @ConfigAsViewMatcher(name = HISTORY_VIEW_EXCLUDE_PARAMETER)
+ private ViewMatcher excludeFromHistoryMatcher;
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/HistoryManagerBean.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/HistoryManagerBean.java
new file mode 100644
index 0000000..fbae89f
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/HistoryManagerBean.java
@@ -0,0 +1,54 @@
+package de.cuioss.portal.ui.runtime.application.history;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.apache.deltaspike.core.api.scope.WindowScoped;
+
+import de.cuioss.jsf.api.application.history.HistoryManager;
+import de.cuioss.jsf.api.application.history.impl.HistoryManagerImpl;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.history.PortalHistoryManager;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.experimental.Delegate;
+
+/**
+ * Bean keeping track of the view history. For configuration see package-info
+ * The implementation utilizes a stack to store the history. The actual work is
+ * done by {@link HistoryManagerImpl}.
+ *
+ * @author Oliver Wolff
+ */
+@PortalHistoryManager
+@WindowScoped
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@Named(HistoryManagerImpl.BEAN_NAME)
+@EqualsAndHashCode(exclude = "delegate")
+@ToString(exclude = "delegate")
+public class HistoryManagerBean implements HistoryManager {
+
+ private static final long serialVersionUID = 8385906931652178190L;
+
+ @Inject
+ private DefaultHistoryConfiguration historyConfiguration;
+
+ @Delegate(types = HistoryManager.class)
+ private HistoryManager delegate;
+
+ @Inject
+ private Provider facesContextProvider;
+
+ /**
+ * Initializes the bean. See class documentation for expected result.
+ */
+ @PostConstruct
+ public void initBean() {
+ delegate = new HistoryManagerImpl(historyConfiguration);
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/package-info.java
new file mode 100644
index 0000000..eacf301
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/history/package-info.java
@@ -0,0 +1,15 @@
+/**
+ * Provides the portal specific implementation of
+ * {@link com.icw.ehf.cui.application.history.HistoryManager}. Usually the
+ * default implementation should suffice, it only needs the outcome. It uses
+ * {@link de.icw.cui.portal.configuration.application.history.DefaultHistoryConfiguration}
+ * of configuration. {@link de.cuioss.portal.ui.api.ui.pages.HomePage#OUTCOME}
+ * 'home' to be set in order to work. If you need a different configuration your
+ * module should. In addition the web.xml parameter
+ * {@link de.icw.cui.portal.configuration.PortalConfigurationKeys#HISTORY_EXCLUDE_PARAMETER}
+ * will be evaluated. If you need a more fine grained control you need to
+ * provide an instance of
+ * {@link com.icw.ehf.cui.application.history.HistoryConfiguration} annotated
+ * with {@link de.cuioss.portal.ui.api.history.PortalHistoryConfiguration}
+ */
+package de.cuioss.portal.ui.runtime.application.history;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/FutureHandle.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/FutureHandle.java
new file mode 100644
index 0000000..8b5565e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/FutureHandle.java
@@ -0,0 +1,29 @@
+package de.cuioss.portal.ui.runtime.application.lazyloading;
+
+import java.util.concurrent.Future;
+
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * DTO to store and retrieve {@link Future}s in {@link ThreadManager}.
+ */
+@Data
+@RequiredArgsConstructor
+class FutureHandle {
+
+ /**
+ * The {@link Future} to store.
+ */
+ private final Future future;
+
+ /**
+ * A context.
+ */
+ private final Object context;
+
+ /**
+ * Timestamp of creation in milliseconds.
+ */
+ private final long timestamp;
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/LazyLoadingViewControllerImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/LazyLoadingViewControllerImpl.java
new file mode 100644
index 0000000..587661f
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/LazyLoadingViewControllerImpl.java
@@ -0,0 +1,37 @@
+package de.cuioss.portal.ui.runtime.application.lazyloading;
+
+import java.io.Serializable;
+
+import javax.enterprise.context.Dependent;
+import javax.inject.Inject;
+
+import de.cuioss.portal.configuration.initializer.PortalInitializer;
+import de.cuioss.portal.ui.api.ui.lazyloading.LazyLoadingRequest;
+import de.cuioss.portal.ui.api.ui.lazyloading.LazyLoadingViewController;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Implementation of {@link LazyLoadingViewController} using the
+ * {@link ThreadManager} to start backend requests.
+ */
+@Dependent
+@EqualsAndHashCode(exclude = { "threadManager" })
+@ToString(exclude = { "threadManager" })
+public class LazyLoadingViewControllerImpl implements LazyLoadingViewController, Serializable {
+
+ private static final long serialVersionUID = 4698361355745984370L;
+
+ private static final CuiLogger log = new CuiLogger(LazyLoadingViewControllerImpl.class);
+
+ @Inject
+ @PortalInitializer
+ private ThreadManager threadManager;
+
+ @Override
+ public void startRequest(LazyLoadingRequest request) {
+ log.trace("startRequest {}", request);
+ threadManager.store(request.getRequestId(), request::backendRequest, request);
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/LazyLoadingViewModelImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/LazyLoadingViewModelImpl.java
new file mode 100644
index 0000000..e83bed0
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/LazyLoadingViewModelImpl.java
@@ -0,0 +1,159 @@
+package de.cuioss.portal.ui.runtime.application.lazyloading;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LAZYLOADING_REQUEST_RETRIEVE_TIMEOUT;
+
+import java.io.Serializable;
+import java.util.Random;
+import java.util.concurrent.CancellationException;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+import javax.enterprise.context.Dependent;
+import javax.faces.application.FacesMessage;
+import javax.faces.event.ActionEvent;
+import javax.inject.Inject;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.application.message.DisplayNameProviderMessageProducer;
+import de.cuioss.jsf.api.application.message.MessageProducer;
+import de.cuioss.jsf.api.components.css.ContextState;
+import de.cuioss.jsf.api.components.model.lazyloading.LazyLoadingThreadModel;
+import de.cuioss.jsf.api.components.model.resultContent.ErrorController;
+import de.cuioss.jsf.api.components.model.resultContent.ResultErrorHandler;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.initializer.PortalInitializer;
+import de.cuioss.portal.ui.api.message.PortalMessageProducer;
+import de.cuioss.portal.ui.api.message.PortalStickyMessageProducer;
+import de.cuioss.portal.ui.api.message.StickyMessageProducer;
+import de.cuioss.portal.ui.api.ui.lazyloading.LazyLoadingErrorHandler;
+import de.cuioss.portal.ui.api.ui.lazyloading.LazyLoadingRequest;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.uimodel.nameprovider.IDisplayNameProvider;
+import de.cuioss.uimodel.result.ResultObject;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.ToString;
+
+/**
+ * Implementation of a {@link LazyLoadingThreadModel } using the
+ * {@link ThreadManager} to retrieve the result and errors from the request.
+ *
+ * Will wait max
+ * {@link PortalConfigurationKeys#PORTAL_LAZYLOADING_REQUEST_RETRIEVE_TIMEOUT}
+ * for the request to return, otherwise it will be terminated.
+ *
+ * @param should implement {@link Serializable}
+ */
+@EqualsAndHashCode(of = { "requestId" })
+@ToString(of = { "requestId", "initialized", "renderContent", "notificationBoxValue" })
+@Dependent
+public class LazyLoadingViewModelImpl implements LazyLoadingThreadModel, ErrorController {
+
+ private static final Random RANDOM = new Random();
+
+ private static final long serialVersionUID = -3343380539839996245L;
+
+ private static final CuiLogger log = new CuiLogger(LazyLoadingViewModelImpl.class);
+
+ @Inject
+ @PortalInitializer
+ private ThreadManager threadManager;
+
+ @Inject
+ @ConfigProperty(name = PORTAL_LAZYLOADING_REQUEST_RETRIEVE_TIMEOUT)
+ private int requestRetrieveTimeout;
+
+ @PortalMessageProducer
+ @Inject
+ private MessageProducer messageProducer;
+
+ @Inject
+ @PortalStickyMessageProducer
+ private StickyMessageProducer stickyMessageProducer;
+
+ @Getter
+ private IDisplayNameProvider notificationBoxValue;
+
+ @Getter
+ private ContextState notificationBoxState;
+
+ @Getter
+ @Setter
+ private boolean renderContent;
+
+ @Getter
+ private boolean initialized;
+
+ @Getter
+ private long requestId = RANDOM.nextLong();
+
+ /**
+ * Will be called by the ajax call to update the lazy loading content.
+ *
+ * Tries to retrieve the result of the backend call and handles errors.
+ *
+ * @param actionEvent dummy.
+ */
+ @SuppressWarnings("unchecked")
+ @Override
+ public void processAction(ActionEvent actionEvent) {
+ log.trace("retrieveRequest {}", requestId);
+ var handle = threadManager.retrieve(requestId);
+ if (null == handle) {
+ new LazyLoadingErrorHandler().handleRequestError(null, "The request handle could not be found.", this, log);
+ initialized = true;
+ return;
+ }
+ var request = (LazyLoadingRequest) handle.getContext();
+ try {
+ var result = (ResultObject) handle.getFuture().get(requestRetrieveTimeout, TimeUnit.SECONDS);
+ log.trace("result of {}: {}", requestId, result);
+ handleRequestResult(result, request.getErrorHandler());
+ request.handleResult(result.getResult());
+ initialized = true;
+ } catch (ExecutionException | TimeoutException | CancellationException e) {
+ request.getErrorHandler().handleRequestError(e, "The request failed", this, log);
+ initialized = true;
+ } catch (InterruptedException ie) {
+ request.getErrorHandler().handleRequestError(ie, "The request was interrupted", this, log);
+ initialized = true;
+ Thread.currentThread().interrupt();
+ }
+ }
+
+ @Override
+ public void addNotificationBox(IDisplayNameProvider value, ContextState state) {
+ notificationBoxValue = value;
+ notificationBoxState = state;
+ }
+
+ @Override
+ public void addGlobalFacesMessage(IDisplayNameProvider value, FacesMessage.Severity severity) {
+ new DisplayNameProviderMessageProducer(messageProducer).showAsGlobalMessage(value, severity);
+ }
+
+ @Override
+ public void addStickyMessage(IDisplayNameProvider value, ContextState state) {
+ stickyMessageProducer.setMessageAsString(DisplayNameProviderMessageProducer.resolve(value), state);
+ }
+
+ @Override
+ public void resetNotificationBox() {
+ notificationBoxValue = null;
+ renderContent = false;
+ }
+
+ @Override
+ public void handleRequestResult(ResultObject result, ResultErrorHandler errorHandler) {
+ var resultDetail = result.getResultDetail();
+ if (resultDetail.isPresent()) {
+ errorHandler.handleResultDetail(result.getState(), resultDetail.get(), result.getErrorCode().orElse(null),
+ this, log);
+ } else {
+ setRenderContent(true);
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/ThreadManager.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/ThreadManager.java
new file mode 100644
index 0000000..b014ab7
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/lazyloading/ThreadManager.java
@@ -0,0 +1,160 @@
+package de.cuioss.portal.ui.runtime.application.lazyloading;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LAZYLOADING_REQUEST_HANDLE_TIMEOUT;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.Callable;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.TimeUnit;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.initializer.ApplicationInitializer;
+import de.cuioss.portal.configuration.initializer.PortalInitializer;
+import de.cuioss.tools.logging.CuiLogger;
+
+/**
+ * Manages FutureHandle based requests and executes them via
+ * {@link Executors#newCachedThreadPool()}. All requests that were not retrieved
+ * after
+ * {@link PortalConfigurationKeys#PORTAL_LAZYLOADING_REQUEST_HANDLE_TIMEOUT}
+ * seconds are canceled and removed.
+ */
+@ApplicationScoped
+@PortalInitializer
+public class ThreadManager implements ApplicationInitializer {
+
+ /**
+ * Milliseconds to sleep between a cleanup cycle.
+ */
+ private static final int CLEANUP_SLEEP = 1000;
+
+ private static final CuiLogger log = new CuiLogger(ThreadManager.class);
+
+ @Inject
+ @ConfigProperty(name = PORTAL_LAZYLOADING_REQUEST_HANDLE_TIMEOUT)
+ private Provider requestHandleTimeoutProvider;
+
+ private int requestHandleTimeout;
+
+ private ExecutorService executorService;
+
+ /**
+ * To stop the cleanup worker thread.
+ */
+ private boolean executorRunning = false;
+
+ private final Map registry = new HashMap<>();
+
+ /**
+ * Store and start a {@link Callable} task.
+ *
+ * @param id a unique id to store and #retrieve(long) the task afterwards
+ * @param task the task to execute
+ * @param context a context object
+ */
+ public void store(final long id, final Callable task, final Object context) {
+ synchronized (registry) {
+ var timestamp = System.currentTimeMillis();
+ log.debug(() -> "task " + id + " added at time (ms): " + timestamp);
+ registry.put(id, new FutureHandle(executorService.submit(task), context, timestamp));
+ }
+ }
+
+ /*
+ * private Callable propagateMdcToCallable(final Callable task) { final
+ * Map context = ThreadContext.getContext(); return () -> { Map
+ * previous = ThreadContext.getContext(); if (context == null) {
+ * ThreadContext.clearAll();clear(); } else {
+ * ThreadContext.setContextMap(context); } try { return task.call(); } finally {
+ * if (previous == null) { ThreadContext.clear(); } else {
+ * ThreadContext.setContextMap(previous); } } }; }
+ */
+
+ /**
+ * Retrieve a task that was {@link #store(long, Callable, Object)}ed before.
+ *
+ * @param id the unique id
+ * @return a {@link FutureHandle} containing the task and the context object
+ */
+ FutureHandle retrieve(final long id) {
+ synchronized (registry) {
+ log.debug(() -> "task retrieved and removed: " + id);
+ return registry.remove(id);
+ }
+ }
+
+ @Override
+ public void initialize() {
+ log.debug("Starting ThreadManager");
+ if (null == requestHandleTimeoutProvider || null == requestHandleTimeoutProvider.get()) {
+ throw new IllegalStateException(
+ "Invalid configuration, please check property " + PORTAL_LAZYLOADING_REQUEST_HANDLE_TIMEOUT);
+ }
+ requestHandleTimeout = requestHandleTimeoutProvider.get();
+ log.trace("requestHandleTimeout={}", requestHandleTimeout);
+ executorService = Executors.newCachedThreadPool();
+ executorService.execute(cleanupExecutor());
+ executorRunning = true;
+ }
+
+ @Override
+ public void destroy() {
+ log.debug("Shutting down ThreadManager");
+ executorRunning = false;
+ if (null != executorService) {
+ executorService.shutdownNow();
+ }
+ }
+
+ @Override
+ public Integer getOrder() {
+ return ApplicationInitializer.ORDER_LATE;
+ }
+
+ void configurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (deltaMap.containsKey(PORTAL_LAZYLOADING_REQUEST_HANDLE_TIMEOUT)) {
+ requestHandleTimeout = Integer.parseInt(deltaMap.get(PORTAL_LAZYLOADING_REQUEST_HANDLE_TIMEOUT));
+ log.debug("Portal-011: Changed configuration of '{}' found, new value is '{}', reconfigure",
+ PORTAL_LAZYLOADING_REQUEST_HANDLE_TIMEOUT, requestHandleTimeout);
+ }
+ }
+
+ private Runnable cleanupExecutor() {
+ return () -> {
+ while (executorRunning) {
+ try {
+ TimeUnit.MILLISECONDS.sleep(CLEANUP_SLEEP);
+ } catch (final InterruptedException e) {
+ log.debug("Interrupted cleanup timout, exiting loop", e);
+ Thread.currentThread().interrupt();
+ break;
+ }
+
+ synchronized (registry) {
+ for (final Map.Entry entry : registry.entrySet()) {
+ if ((System.currentTimeMillis() - entry.getValue().getTimestamp())
+ / 1000 > requestHandleTimeout) {
+
+ log.debug("timeout. terminating id={}, future={}", entry.getKey(), entry.getValue());
+
+ entry.getValue().getFuture().cancel(true);
+ registry.remove(entry.getKey());
+ break;
+ }
+ }
+ }
+ }
+ };
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/afterconfiguration/ElAccessibleObjectInitializer.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/afterconfiguration/ElAccessibleObjectInitializer.java
new file mode 100644
index 0000000..158c067
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/afterconfiguration/ElAccessibleObjectInitializer.java
@@ -0,0 +1,33 @@
+package de.cuioss.portal.ui.runtime.application.listener.afterconfiguration;
+
+import javax.enterprise.context.Dependent;
+import javax.inject.Inject;
+
+import de.cuioss.portal.configuration.initializer.ApplicationInitializer;
+import de.cuioss.portal.configuration.initializer.PortalInitializer;
+import de.cuioss.portal.ui.api.templating.MultiViewMapper;
+import de.cuioss.portal.ui.api.templating.PortalMultiViewMapper;
+
+/**
+ * See package javadoc for details
+ *
+ * @author Oliver Wolff
+ */
+@PortalInitializer
+@Dependent
+public class ElAccessibleObjectInitializer implements ApplicationInitializer {
+
+ @Inject
+ @PortalMultiViewMapper
+ private MultiViewMapper multiViewMapper;
+
+ @Override
+ public void initialize() {
+ multiViewMapper.toString();
+ }
+
+ @Override
+ public Integer getOrder() {
+ return ApplicationInitializer.ORDER_LATE;
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/afterconfiguration/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/afterconfiguration/package-info.java
new file mode 100644
index 0000000..967382c
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/afterconfiguration/package-info.java
@@ -0,0 +1,13 @@
+/**
+ * Contains
+ * {@link de.icw.cui.portal.configuration.initializer.ApplicationInitializer}
+ * that are responsible for dealing with corner cases within the portal, e.g.
+ * {@link de.icw.cui.portal.configuration.application.templating.PortalViewMapper}
+ * that needs to be initialized after the configuration system is up and running
+ * and before JSF-specific classes like
+ * {@link javax.faces.application.Application} access the corresponding beans
+ * using the {@link javax.el.ELResolver}
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.application.listener.afterconfiguration;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/HistoryManagerListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/HistoryManagerListener.java
new file mode 100644
index 0000000..7e9f4bf
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/HistoryManagerListener.java
@@ -0,0 +1,86 @@
+package de.cuioss.portal.ui.runtime.application.listener.view;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LISTENER_HISTORYMANAGER;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.enterprise.event.Event;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.application.history.HistoryManager;
+import de.cuioss.jsf.api.application.navigation.NavigationUtils;
+import de.cuioss.jsf.api.application.navigation.ViewIdentifier;
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.events.PageRefreshEvent;
+import de.cuioss.portal.ui.api.history.PortalHistoryManager;
+import de.cuioss.portal.ui.api.listener.view.PhaseExecution;
+import de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener;
+import de.cuioss.portal.ui.api.listener.view.ViewListener;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Listener that calls
+ * {@link HistoryManager#addCurrentUriToHistory(ViewDescriptor)}
+ *
+ * @author Oliver Wolff
+ */
+@PortalRestoreViewListener(PhaseExecution.AFTER_PHASE_EXCLUDE_POSTBACK)
+@Dependent
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@EqualsAndHashCode
+@ToString
+public class HistoryManagerListener implements ViewListener {
+
+ private static final long serialVersionUID = 6342018758236517336L;
+
+ @Inject
+ @PortalHistoryManager
+ private Provider historyManagerProvider;
+
+ @Inject
+ private Event event;
+
+ @Getter
+ @Inject
+ @ConfigProperty(name = PORTAL_LISTENER_HISTORYMANAGER)
+ private boolean enabled;
+
+ @Override
+ public void handleView(final ViewDescriptor viewDescriptor) {
+
+ if (requestWasPageReload()) {
+ historyManagerProvider.get().setPageReload(true);
+ event.fire(new PageRefreshEvent(viewDescriptor.getViewId()));
+ } else {
+ historyManagerProvider.get().setPageReload(false);
+ }
+
+ // The HistoryManager info must be accessed dynamically because of the
+ // scoping of the Listener
+ historyManagerProvider.get().addCurrentUriToHistory(viewDescriptor);
+ }
+
+ private boolean requestWasPageReload() {
+ final var context = FacesContext.getCurrentInstance();
+ var reload = false;
+ if (!context.isPostback()) {
+
+ final var manager = historyManagerProvider.get();
+
+ final var current = ViewIdentifier.getFromViewDesciptor(NavigationUtils.getCurrentView(context),
+ manager.getParameterFilter());
+ if (null != current) {
+ reload = current.equals(manager.getCurrentView());
+ }
+ }
+ return reload;
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/PortalRestoreViewPhaseListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/PortalRestoreViewPhaseListener.java
new file mode 100644
index 0000000..e0de7b9
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/PortalRestoreViewPhaseListener.java
@@ -0,0 +1,124 @@
+package de.cuioss.portal.ui.runtime.application.listener.view;
+
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+
+import java.util.List;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.inject.Instance;
+import javax.faces.context.FacesContext;
+import javax.faces.event.PhaseEvent;
+import javax.faces.event.PhaseId;
+import javax.faces.event.PhaseListener;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.apache.deltaspike.jsf.api.listener.phase.JsfPhaseListener;
+
+import de.cuioss.jsf.api.common.util.CheckContextState;
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.listener.view.PhaseExecution;
+import de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener;
+import de.cuioss.portal.ui.api.listener.view.ViewListener;
+import de.cuioss.portal.ui.api.ui.context.CuiCurrentView;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Collects instances of {@link ViewListener}, sorts them and calls them with
+ * the requested view id.
+ *
+ * @author Oliver Wolff
+ */
+@JsfPhaseListener
+@EqualsAndHashCode(of = { "sortedAfterListeners", "sortedAfterNonPostbackListeners", "sortedBeforeListeners" })
+@ToString(of = { "sortedAfterListeners", "sortedAfterNonPostbackListeners", "sortedBeforeListeners" })
+public class PortalRestoreViewPhaseListener implements PhaseListener {
+
+ private static final long serialVersionUID = 7620545331100921567L;
+
+ private static final CuiLogger log = new CuiLogger(PortalRestoreViewPhaseListener.class);
+
+ @Inject
+ @PortalRestoreViewListener(PhaseExecution.BEFORE_PHASE)
+ private Instance beforeListeners;
+
+ @Inject
+ @CuiCurrentView
+ private Provider currentViewProvider;
+
+ private List sortedBeforeListeners;
+
+ @Inject
+ @PortalRestoreViewListener(PhaseExecution.AFTER_PHASE)
+ private Instance afterListeners;
+
+ private List sortedAfterListeners;
+
+ @Inject
+ @PortalRestoreViewListener(PhaseExecution.AFTER_PHASE_EXCLUDE_POSTBACK)
+ private Instance afterListenersNonPostback;
+
+ private List sortedAfterNonPostbackListeners;
+
+ /**
+ * Sorts and filters the injected listeners
+ */
+ @PostConstruct
+ public void init() {
+ sortedBeforeListeners = PortalPriorities.sortByPriority(mutableList(beforeListeners));
+ sortedAfterListeners = PortalPriorities.sortByPriority(mutableList(afterListeners));
+ sortedAfterNonPostbackListeners = PortalPriorities.sortByPriority(mutableList(afterListenersNonPostback));
+
+ }
+
+ @Override
+ public void afterPhase(final PhaseEvent event) {
+ if (sortedAfterListeners.isEmpty() && sortedAfterNonPostbackListeners.isEmpty()) {
+ return;
+ }
+ final var context = event.getFacesContext();
+ final var currentView = currentViewProvider.get();
+ if (currentView.isViewDefined()) {
+ handleListener(sortedAfterListeners, context, currentView);
+ if (!event.getFacesContext().isPostback()) {
+ handleListener(sortedAfterNonPostbackListeners, context, currentView);
+ }
+ } else {
+ log.warn("Unable to determine view.");
+ }
+ }
+
+ private void handleListener(List listeners, FacesContext context, ViewDescriptor currentView) {
+ for (final ViewListener listener : listeners) {
+ if (CheckContextState.isResponseNotComplete(context) && listener.isEnabled()) {
+ listener.handleView(currentView);
+ }
+ }
+ }
+
+ @Override
+ public void beforePhase(final PhaseEvent event) {
+ if (!sortedBeforeListeners.isEmpty()) {
+ final var currentView = currentViewProvider.get();
+ final var context = event.getFacesContext();
+ if (currentView.isViewDefined()) {
+ for (final ViewListener listener : sortedBeforeListeners) {
+ if (CheckContextState.isResponseNotComplete(context) && listener.isEnabled()) {
+ listener.handleView(currentView);
+ }
+ }
+ } else {
+ log.warn("Unable to determine view.");
+ }
+ }
+ }
+
+ @Override
+ public PhaseId getPhaseId() {
+ return PhaseId.RESTORE_VIEW;
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/PortalStageModeListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/PortalStageModeListener.java
new file mode 100644
index 0000000..62ad682
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/PortalStageModeListener.java
@@ -0,0 +1,54 @@
+package de.cuioss.portal.ui.runtime.application.listener.view;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.enterprise.event.Event;
+import javax.inject.Inject;
+
+import org.apache.deltaspike.core.api.exception.control.event.ExceptionToCatchEvent;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.configuration.application.PortalProjectStageProducer;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.configuration.PortalNotConfiguredException;
+import de.cuioss.portal.ui.api.listener.view.PhaseExecution;
+import de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener;
+import de.cuioss.portal.ui.api.listener.view.ViewListener;
+import de.cuioss.uimodel.application.CuiProjectStage;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * This listener checks the portal stage configuration. In case the portal stage
+ * is 'configuration' it will fire an {@link PortalNotConfiguredException}.
+ *
+ * @author Sven Haag, Sven Haag
+ */
+@PortalRestoreViewListener(PhaseExecution.AFTER_PHASE)
+@Dependent
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL + 5) // Must be called before other listeners
+@EqualsAndHashCode(of = "stageProducer")
+@ToString(of = "stageProducer")
+public class PortalStageModeListener implements ViewListener {
+
+ private static final long serialVersionUID = 8427405526881056257L;
+
+ @Inject
+ @PortalProjectStageProducer
+ private CuiProjectStage stageProducer;
+
+ @Inject
+ private Event catchEvent;
+
+ @Override
+ public void handleView(final ViewDescriptor viewDescriptor) {
+ if (stageProducer.isConfiguration()) {
+ this.catchEvent.fire(new ExceptionToCatchEvent(new PortalNotConfiguredException()));
+ }
+ }
+
+ @Override
+ public boolean isEnabled() {
+ return true;
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/StickyMessageCollectorViewListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/StickyMessageCollectorViewListener.java
new file mode 100644
index 0000000..b1e5e8e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/StickyMessageCollectorViewListener.java
@@ -0,0 +1,70 @@
+package de.cuioss.portal.ui.runtime.application.listener.view;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LISTENER_STICKYMESSAGES;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.enterprise.inject.Instance;
+import javax.inject.Inject;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.listener.view.PhaseExecution;
+import de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener;
+import de.cuioss.portal.ui.api.listener.view.ViewListener;
+import de.cuioss.portal.ui.api.message.PortalStickyMessageProducer;
+import de.cuioss.portal.ui.api.message.StickyMessage;
+import de.cuioss.portal.ui.api.message.StickyMessageProducer;
+import de.cuioss.portal.ui.api.message.StickyMessageProvider;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * View Listener act on each page. The listener collect new available sticky
+ * messages for all registered StickyMessageProviders and put them to
+ * StickyMessageProducer. Expected is that StickyMessageProducer is a session
+ * scoped bean.
+ *
+ * @author i000576
+ */
+@PortalRestoreViewListener(PhaseExecution.BEFORE_PHASE)
+@Dependent
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@ToString
+@EqualsAndHashCode
+public class StickyMessageCollectorViewListener implements ViewListener {
+
+ private static final long serialVersionUID = 1106398052992964929L;
+
+ @Inject
+ private Instance providers;
+
+ @Inject
+ @PortalStickyMessageProducer
+ private StickyMessageProducer stickyMessageProducer;
+
+ @Getter
+ @Inject
+ @ConfigProperty(name = PORTAL_LISTENER_STICKYMESSAGES)
+ private boolean enabled;
+
+ @Override
+ public void handleView(final ViewDescriptor viewDescriptor) {
+ final var collected = collectAndCleanup();
+ collected.forEach(sMessage -> stickyMessageProducer.addMessage(sMessage));
+ }
+
+ private Set collectAndCleanup() {
+ final Set collected = new HashSet<>(0);
+ for (final StickyMessageProvider provider : providers) {
+ collected.addAll(provider.retrieveMessages());
+ }
+ return collected;
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewAuthenticationListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewAuthenticationListener.java
new file mode 100644
index 0000000..44f5902
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewAuthenticationListener.java
@@ -0,0 +1,75 @@
+package de.cuioss.portal.ui.runtime.application.listener.view;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LISTENER_AUTHENTICATION;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.enterprise.event.Event;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.apache.deltaspike.core.api.exception.control.event.ExceptionToCatchEvent;
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.authentication.AuthenticatedUserInfo;
+import de.cuioss.portal.authentication.PortalUser;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.authentication.UserNotAuthenticatedException;
+import de.cuioss.portal.ui.api.listener.view.PhaseExecution;
+import de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener;
+import de.cuioss.portal.ui.api.listener.view.ViewListener;
+import de.cuioss.portal.ui.runtime.application.configuration.ViewConfiguration;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * This listener checks the authorization status of a given request. In case the
+ * injected {@link ViewConfiguration#getNonSecuredViewMatcher()} returns false
+ * and the current {@link AuthenticatedUserInfo#isAuthenticated()} returns false
+ * it will fire an {@link UserNotAuthenticatedException}.
+ *
+ * @author Oliver Wolff
+ */
+@PortalRestoreViewListener(PhaseExecution.AFTER_PHASE)
+@Dependent
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@EqualsAndHashCode(of = "viewConfiguration")
+@ToString(of = "viewConfiguration")
+public class ViewAuthenticationListener implements ViewListener {
+
+ private static final long serialVersionUID = 8427405526881056257L;
+
+ private static final CuiLogger log = new CuiLogger(ViewAuthenticationListener.class);
+
+ @Inject
+ private ViewConfiguration viewConfiguration;
+
+ @Inject
+ private Event catchEvent;
+
+ @Inject
+ @PortalUser
+ private Provider userInfoProvider;
+
+ @Getter
+ @Inject
+ @ConfigProperty(name = PORTAL_LISTENER_AUTHENTICATION)
+ private boolean enabled;
+
+ @Override
+ public void handleView(final ViewDescriptor viewDescriptor) {
+ if (!viewConfiguration.getNonSecuredViewMatcher().match(viewDescriptor)) {
+ // The user info must be accessed dynamically because of the scoping
+ // of the Listener
+ final var userInfo = userInfoProvider.get();
+ if (!userInfo.isAuthenticated()) {
+ log.debug("Try to access '" + viewDescriptor.getLogicalViewId() + "' which does not match '"
+ + viewConfiguration.getNonSecuredViewMatcher() + "' -> UserNotAuthenticatedException");
+ catchEvent.fire(new ExceptionToCatchEvent(new UserNotAuthenticatedException()));
+ }
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewAuthorizationListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewAuthorizationListener.java
new file mode 100644
index 0000000..c42876b
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewAuthorizationListener.java
@@ -0,0 +1,81 @@
+package de.cuioss.portal.ui.runtime.application.listener.view;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LISTENER_AUTHORIZATION;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.enterprise.event.Event;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.apache.deltaspike.core.api.exception.control.event.ExceptionToCatchEvent;
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.authentication.AuthenticatedUserInfo;
+import de.cuioss.portal.authentication.PortalUser;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.authentication.UserNotAuthorizedException;
+import de.cuioss.portal.ui.api.listener.view.PhaseExecution;
+import de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener;
+import de.cuioss.portal.ui.api.listener.view.ViewListener;
+import de.cuioss.portal.ui.api.view.PortalViewRestrictionManager;
+import de.cuioss.portal.ui.api.view.ViewRestrictionManager;
+import de.cuioss.portal.ui.runtime.application.configuration.ViewConfiguration;
+import de.cuioss.portal.ui.runtime.application.view.DefaultViewRestrictionManager;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * This listener checks the authorization status of a given request. It uses
+ * {@link DefaultViewRestrictionManager} to determine the corresponding
+ * access-rights. If the request addresses a view that is not admitted, it will
+ * fire a {@link UserNotAuthorizedException}.
+ *
+ * @author Oliver Wolff
+ */
+@PortalRestoreViewListener(PhaseExecution.AFTER_PHASE)
+@Dependent
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL - 1)
+// Must be called after AuthenticatationListener
+@EqualsAndHashCode(of = "viewConfiguration")
+@ToString(of = "viewConfiguration")
+public class ViewAuthorizationListener implements ViewListener {
+
+ private static final long serialVersionUID = 8427405526881056257L;
+
+ @Inject
+ private ViewConfiguration viewConfiguration;
+
+ @Inject
+ @PortalViewRestrictionManager
+ private Provider viewRestrictionManagerProvider;
+
+ @Inject
+ private Event catchEvent;
+
+ @Inject
+ @PortalUser
+ private Provider userInfoProvider;
+
+ @Getter
+ @Inject
+ @ConfigProperty(name = PORTAL_LISTENER_AUTHORIZATION)
+ private boolean enabled;
+
+ @Override
+ public void handleView(final ViewDescriptor viewDescriptor) {
+ // Should only be checked is the view is a secured view
+ if (!viewConfiguration.getNonSecuredViewMatcher().match(viewDescriptor)) {
+ // ViewRestrictionManager is stateful, therefore we need a provider
+ var defaultViewRestrictionManager = viewRestrictionManagerProvider.get();
+ if (!defaultViewRestrictionManager.isUserAuthorized(viewDescriptor)) {
+ var requiredRoles = defaultViewRestrictionManager.getRequiredRolesForView(viewDescriptor);
+ // AuthenticatedUserInfo is stateful, therefore we need a provider
+ catchEvent.fire(new ExceptionToCatchEvent(new UserNotAuthorizedException(viewDescriptor, requiredRoles,
+ userInfoProvider.get().getRoles())));
+ }
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewSupressionListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewSupressionListener.java
new file mode 100644
index 0000000..702aa67
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/ViewSupressionListener.java
@@ -0,0 +1,58 @@
+package de.cuioss.portal.ui.runtime.application.listener.view;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LISTENER_VIEW_SUPRESSION;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.enterprise.event.Event;
+import javax.inject.Inject;
+
+import org.apache.deltaspike.core.api.exception.control.event.ExceptionToCatchEvent;
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.listener.view.PhaseExecution;
+import de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener;
+import de.cuioss.portal.ui.api.listener.view.ViewListener;
+import de.cuioss.portal.ui.runtime.application.configuration.ViewConfiguration;
+import de.cuioss.portal.ui.runtime.application.view.ViewSuppressedException;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Checks whether the current page is to be suppressed and fires an
+ * {@link ViewSuppressedException} if so.
+ *
+ * @author Oliver Wolff
+ */
+@PortalRestoreViewListener(PhaseExecution.AFTER_PHASE)
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL + 1)
+// Must be called before AuthenticatationListener
+@Dependent
+@EqualsAndHashCode(of = "viewConfiguration")
+@ToString(of = "viewConfiguration")
+public class ViewSupressionListener implements ViewListener {
+
+ private static final long serialVersionUID = -1757867591272259164L;
+
+ @Inject
+ private ViewConfiguration viewConfiguration;
+
+ @Inject
+ private Event catchEvent;
+
+ @Override
+ public void handleView(final ViewDescriptor viewDescriptor) {
+ if (this.viewConfiguration.getSuppressedViewMatcher().match(viewDescriptor)) {
+ this.catchEvent.fire(new ExceptionToCatchEvent(new ViewSuppressedException(viewDescriptor)));
+ }
+ }
+
+ @Getter
+ @Inject
+ @ConfigProperty(name = PORTAL_LISTENER_VIEW_SUPRESSION)
+ private boolean enabled;
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/package-info.java
new file mode 100644
index 0000000..588535f
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/listener/view/package-info.java
@@ -0,0 +1,25 @@
+/**
+ * The
+ * {@link de.icw.cui.portal.configuration.application.listener.view.PortalRestoreViewPhaseListener}
+ * is the central element of this package. For some checks, like authentication
+ * and page suppression it is needed to be run before the phase
+ * {@link javax.faces.event.PhaseId#RESTORE_VIEW} in order to prevent building
+ * of that views. Instead of creating single
+ * {@link javax.faces.event.PhaseListener} the
+ * {@link de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener} will
+ * pick up each implementation of
+ * {@link de.cuioss.portal.ui.api.listener.view.ViewListener} annotated with
+ * {@link de.cuioss.portal.ui.api.listener.view.PortalRestoreViewListener} and
+ * calls the method
+ * {@link de.cuioss.portal.ui.api.listener.view.ViewListener#handleView(String)}
+ * with the currently requested viewID. The ordering of this listener will be
+ * done the {@link javax.annotation.Priority} annotation: The higher the number
+ * the earlier the corresponding listener will be called. The concrete listener
+ * methods are void and need therefore the eventing / exception mechanism to
+ * interact. See
+ * {@link de.icw.cui.portal.configuration.application.listener.view.ViewAuthenticationListener}
+ * for an example.
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.application.listener.view;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/PortalLocaleManagerBean.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/PortalLocaleManagerBean.java
new file mode 100644
index 0000000..349067c
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/PortalLocaleManagerBean.java
@@ -0,0 +1,97 @@
+package de.cuioss.portal.ui.runtime.application.locale;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Locale;
+
+import javax.enterprise.context.Dependent;
+import javax.enterprise.context.SessionScoped;
+import javax.enterprise.event.Event;
+import javax.enterprise.inject.Alternative;
+import javax.enterprise.inject.Produces;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.application.locale.LocaleProducer;
+import de.cuioss.jsf.api.application.locale.LocaleProducerImpl;
+import de.cuioss.portal.core.locale.PortalLocale;
+import de.cuioss.portal.ui.api.locale.LocaleChangeEvent;
+import de.cuioss.portal.ui.api.locale.LocaleResolverService;
+import de.cuioss.portal.ui.api.locale.PortalLocaleResolver;
+import de.cuioss.portal.ui.runtime.application.locale.impl.PortalLocaleResolverServiceImpl;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * The {@link PortalLocaleManagerBean} is about tracking and interaction of
+ * client specific locales. The implementation is a fixed (CDI-) scoped bean. In
+ * order to change behavior the extension point is an implementation of
+ * {@link LocaleResolverService} defined as an {@link Alternative} for
+ * {@link PortalLocaleResolver}. The default implementation
+ * {@link PortalLocaleResolverServiceImpl} uses the jsf based in standard
+ * behavior. In addition it provides a producer method for {@link PortalLocale}
+ * To put in other words: This bean provides a session-scoped cache for locale,
+ * the used service is agnostic of state or bean specific types. In addition it
+ * acts as an implementation of {@link LocaleProducer}: Caution::
+ * Within CDI-beans the only way to access the locale is injecting
+ * {@link PortalLocale}. The producer is only meant as legacy bridge.
+ *
+ * @author Oliver Wolff
+ */
+@Named(LocaleProducerImpl.BEAN_NAME)
+@SessionScoped
+@EqualsAndHashCode(of = "locale")
+@ToString(of = "locale")
+public class PortalLocaleManagerBean implements Serializable, LocaleResolverService {
+
+ private static final long serialVersionUID = -3555387539352353982L;
+
+ @Inject
+ @PortalLocaleResolver
+ private LocaleResolverService resolverService;
+
+ private Locale locale;
+
+ @Inject
+ @LocaleChangeEvent
+ private Event localeChangeEvent;
+
+ @Inject
+ private Provider facesContextProvider;
+
+ /**
+ * Producer method for {@link Locale} identified by {@link PortalLocale}
+ *
+ * @return the corresponding user specific locale.
+ */
+ @Produces
+ @PortalLocale
+ @Dependent
+ Locale produceClientLocale() {
+ return getLocale();
+ }
+
+ @Override
+ public List getAvailableLocales() {
+ return this.resolverService.getAvailableLocales();
+ }
+
+ @Override
+ public void saveUserLocale(final Locale localeValue) {
+ this.locale = localeValue;
+ this.facesContextProvider.get().getViewRoot().setLocale(this.locale);
+ this.resolverService.saveUserLocale(this.locale);
+ this.localeChangeEvent.fire(this.locale);
+ }
+
+ @Override
+ public Locale getLocale() {
+ if (null == locale) {
+ this.locale = this.resolverService.getLocale();
+ }
+ return locale;
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/impl/PortalLocaleResolverServiceImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/impl/PortalLocaleResolverServiceImpl.java
new file mode 100644
index 0000000..935993b
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/impl/PortalLocaleResolverServiceImpl.java
@@ -0,0 +1,116 @@
+package de.cuioss.portal.ui.runtime.application.locale.impl;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.LOCALE_DEFAULT;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Locale;
+import java.util.Optional;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.enterprise.context.SessionScoped;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.core.storage.ClientStorage;
+import de.cuioss.portal.core.storage.PortalClientStorage;
+import de.cuioss.portal.ui.api.locale.LocaleResolverService;
+import de.cuioss.portal.ui.api.locale.PortalLocaleResolver;
+import de.cuioss.portal.ui.runtime.application.configuration.LocaleConfiguration;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Default implementation of {@link LocaleResolverService} that uses the jsf
+ * standard behavior. The actual configuration of the locales is derived from
+ * {@link LocaleConfiguration}. If you want to change this you must provide an
+ * implementation with a higher {@link Priority}.
+ *
+ * @author Oliver Wolff
+ */
+@PortalLocaleResolver
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@Named
+@SessionScoped
+@EqualsAndHashCode(of = { "locale", "availableLocales" }, doNotUseGetters = true)
+@ToString(of = { "locale", "availableLocales" }, doNotUseGetters = true)
+public class PortalLocaleResolverServiceImpl implements LocaleResolverService, Serializable {
+
+ private static final long serialVersionUID = 2745227675026232302L;
+
+ private Locale locale;
+
+ @Getter
+ private List availableLocales;
+
+ @Inject
+ private Provider facesContextProvider;
+
+ @Inject
+ private LocaleConfiguration localeConfiguration;
+
+ @Inject
+ @PortalClientStorage
+ private ClientStorage clientStorage;
+
+ /**
+ * Initializer method for the bean
+ */
+ @PostConstruct
+ public void initBean() {
+ availableLocales = localeConfiguration.getAvailableLocales();
+ }
+
+ @Override
+ public void saveUserLocale(final Locale localeValue) {
+ if (!getAvailableLocales().contains(localeValue)) {
+ throw new IllegalArgumentException(
+ "Locale must be one of " + getAvailableLocales() + ", but was " + this.locale);
+ }
+ this.clientStorage.put(LOCALE_DEFAULT, localeValue.toLanguageTag());
+ this.locale = null;
+ }
+
+ @Override
+ public Locale getLocale() {
+ if (null == locale) {
+
+ final var localeFromClientStorage = extractFromClientStorage();
+ if (localeFromClientStorage.isPresent()) {
+ this.locale = localeFromClientStorage.get();
+ } else {
+ final var localeFromViewRoot = extractFromViewRoot();
+ if (!localeFromViewRoot.isPresent()) {
+ // do not persist "dirty" result in this session scoped bean
+ return localeConfiguration.getDefaultLocale();
+ }
+ this.locale = localeFromViewRoot.get();
+ }
+ }
+ return locale;
+ }
+
+ private Optional extractFromViewRoot() {
+ var facesContext = facesContextProvider.get();
+ if (!facesContext.isReleased()) {
+ return Optional.ofNullable(facesContext.getApplication().getViewHandler().calculateLocale(facesContext));
+ }
+ return Optional.empty();
+ }
+
+ private Optional extractFromClientStorage() {
+ if (clientStorage.containsKey(LOCALE_DEFAULT)) {
+ final var storedLocale = Locale.forLanguageTag(this.clientStorage.get(LOCALE_DEFAULT));
+ if (getAvailableLocales().contains(storedLocale)) {
+ return Optional.of(storedLocale);
+ }
+ }
+ return Optional.empty();
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/package-info.java
new file mode 100644
index 0000000..9a33ab3
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/locale/package-info.java
@@ -0,0 +1,34 @@
+/**
+ * Provides ways to unify the handling of locales. The
+ * {@link de.icw.cui.portal.configuration.application.locale.PortalLocaleManagerBean}
+ * is about tracking and interaction of client specific locales. The
+ * implementation at portal level is a fixed (CDI-) scoped bean.
+ *
+ * In order to change behavior the extension point is an implementation of
+ * {@link de.cuioss.portal.ui.api.locale.LocaleResolverService} defined as an
+ * {@link de.cuioss.portal.ui.api.cdi.api.PortalOverride} for
+ * {@link de.cuioss.portal.ui.api.locale.PortalLocaleResolver}. The default
+ * implementation
+ * {@link de.icw.cui.portal.configuration.application.locale.impl.PortalLocaleResolverServiceImpl}
+ * uses the jsf based in standard behavior.
+ *
+ *
+ * In addition it provides a producer method for
+ * {@link de.icw.cui.portal.locale.PortalLocale} To put in other words: This
+ * bean provides a session-scoped cache for locale, the used service is agnostic
+ * of state or bean specific types.
+ *
+ *
+ * The
+ * {@link de.icw.cui.portal.configuration.application.locale.PortalLocaleManagerBean}
+ * fires an {@link de.cuioss.portal.ui.api.locale.LocaleChangeEvent} on changing
+ * of the locale. If you want to listen to this event, the listener can be
+ * implemented like:
+ *
+ *
+ * {@code void actOnLocaleChangeEven(@Observes @LocaleChangeEvent Locale newLocale)}
+ *
+ *
+ *
+ */
+package de.cuioss.portal.ui.runtime.application.locale;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/NavigationMenuPageBean.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/NavigationMenuPageBean.java
new file mode 100644
index 0000000..588a155
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/NavigationMenuPageBean.java
@@ -0,0 +1,53 @@
+package de.cuioss.portal.ui.runtime.application.menu;
+
+import java.io.Serializable;
+import java.util.List;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.context.RequestScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import de.cuioss.jsf.api.components.model.menu.NavigationMenuItem;
+import de.cuioss.portal.authentication.AuthenticatedUserInfo;
+import de.cuioss.portal.authentication.PortalUser;
+import de.cuioss.portal.ui.api.menu.NavigationMenuProvider;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Helper bean used for page access.
+ *
+ * @author Oliver Wolff
+ */
+@Named("navigationMenuPageBean")
+@RequestScoped
+@EqualsAndHashCode(of = { "displayMenu", "navigationMenuItems" })
+@ToString(of = { "displayMenu", "navigationMenuItems" })
+public class NavigationMenuPageBean implements Serializable {
+
+ private static final long serialVersionUID = 2241686723846198192L;
+
+ @PortalUser
+ @Inject
+ private AuthenticatedUserInfo userInfo;
+
+ @Inject
+ private NavigationMenuProvider menuProvider;
+
+ @Getter
+ private boolean displayMenu = false;
+
+ @Getter
+ private List navigationMenuItems;
+
+ /**
+ * Initializes the bean.
+ */
+ @PostConstruct
+ public void initBean() {
+ displayMenu = userInfo.isAuthenticated();
+ navigationMenuItems = menuProvider.getNavigationMenuRoots();
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/NavigationMenuProviderImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/NavigationMenuProviderImpl.java
new file mode 100644
index 0000000..17beebd
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/NavigationMenuProviderImpl.java
@@ -0,0 +1,246 @@
+package de.cuioss.portal.ui.runtime.application.menu;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.MENU_BASE;
+import static de.cuioss.tools.collect.CollectionLiterals.immutableList;
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+import static de.cuioss.tools.string.MoreStrings.isEmpty;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.enterprise.context.RequestScoped;
+import javax.enterprise.inject.Instance;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import de.cuioss.jsf.api.components.model.menu.NavigationMenuItem;
+import de.cuioss.jsf.api.components.model.menu.NavigationMenuItemContainer;
+import de.cuioss.jsf.api.components.model.menu.NavigationMenuItemSeparator;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.configuration.types.ConfigAsFilteredMap;
+import de.cuioss.portal.ui.api.menu.NavigationMenuProvider;
+import de.cuioss.portal.ui.api.menu.PortalMenuItem;
+import de.cuioss.tools.collect.CollectionBuilder;
+import de.cuioss.tools.string.MoreStrings;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Default implementation for {@link NavigationMenuProvider} that acts as a
+ * registry for the navigation-menu. The algorithm:
+ *
+ * - Collect all instances of {@link NavigationMenuItem} that are annotated
+ * with {@link PortalMenuItem}
+ * - Filter all elements with {@link NavigationMenuItem#getParentId()} is
+ * {@value PortalConfigurationKeys#MENU_TOP_IDENTIFIER}: This are the
+ * root-elements for top-level-menu
+ * - Add all other menu-items as child to the top-menu elements identified by
+ * {@link NavigationMenuItem#getParentId()}
+ *
+ *
+ * @author Oliver Wolff
+ */
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@RequestScoped
+@Named("navigationMenuProvider")
+@EqualsAndHashCode(of = { "navigationMenuRoots" })
+@ToString(of = { "navigationMenuRoots" })
+public class NavigationMenuProviderImpl implements NavigationMenuProvider {
+
+ private static final long serialVersionUID = 8780699386708876208L;
+
+ @Inject
+ @PortalMenuItem
+ private Instance injectedItems;
+
+ @Inject
+ @ConfigAsFilteredMap(startsWith = MENU_BASE, stripPrefix = true)
+ private Map menuConfig;
+
+ @Getter
+ private List navigationMenuRoots = new ArrayList<>();
+
+ private final Map> virtualParentContainer = new HashMap<>();
+
+ /**
+ * Defines all elements that are rendered.
+ */
+ private List renderedMenuItems = Collections.emptyList();
+
+ /**
+ * Initializes the bean by collecting all elements specific to the navigation
+ * menu.
+ */
+ @PostConstruct
+ public void initBean() {
+ determineMenuStructure();
+
+ handleMenuSeparator();
+
+ // sort top level container children
+ var iterator = navigationMenuRoots.listIterator();
+ while (iterator.hasNext()) {
+ var topLevelItem = iterator.next();
+ if (topLevelItem instanceof NavigationMenuItemContainer) {
+ var container = (NavigationMenuItemContainer) topLevelItem;
+ var renderedChildren = container.getChildren().size();
+ if (renderedChildren > 0) {
+ Collections.sort(container.getChildren());
+ } else {
+ iterator.remove();
+ }
+ }
+ }
+
+ // sort top level items
+ Collections.sort(navigationMenuRoots);
+
+ navigationMenuRoots.forEach(navigationMenuItem -> {
+ if (navigationMenuItem instanceof NavigationMenuItemContainer) {
+ var children = ((NavigationMenuItemContainer) navigationMenuItem).getChildren();
+ while (children.get(children.size() - 1) instanceof NavigationMenuItemSeparator) {
+ children.remove(children.size() - 1);
+ }
+ }
+ });
+ }
+
+ private void handleMenuSeparator() {
+ List handledIds = new ArrayList<>();
+ for (final Map.Entry menuConfigEntry : menuConfig.entrySet()) {
+ if (menuConfigEntry.getKey().startsWith("separator") && menuConfigEntry.getKey().contains(".")) {
+ var id = menuConfigEntry.getKey().split("\\.")[0];
+ if (!handledIds.contains(id)) {
+ handledIds.add(id);
+ final var separatorMenuItem = new PortalNavigationMenuItemSeparatorImpl(id, menuConfig);
+ if (!separatorMenuItem.isRendered()) {
+ continue;
+ }
+ insertSeparatorMenuItem(separatorMenuItem);
+
+ }
+ }
+ }
+ }
+
+ private void determineMenuStructure() {
+
+ final List workList = injectedItems.stream().filter(NavigationMenuItem::isRendered)
+ .filter(item -> item.getOrder() > 0).collect(Collectors.toCollection(ArrayList::new));
+ renderedMenuItems = immutableList(workList);
+
+ List noNavigationMenuRoots = workList.stream()
+ .filter(item -> MoreStrings.isEmpty(item.getParentId()))
+ .collect(Collectors.toCollection(ArrayList::new));
+
+ // Remove all un-rooted
+ workList.removeAll(noNavigationMenuRoots);
+
+ // Filter NavigationMenu-Roots items
+ navigationMenuRoots = workList.stream()
+ .filter(item -> PortalConfigurationKeys.MENU_TOP_IDENTIFIER.equals(item.getParentId()))
+ .collect(Collectors.toCollection(ArrayList::new));
+
+ // remove all roots
+ workList.removeAll(navigationMenuRoots);
+
+ // Create a combined list with all NavigationMenuItemContainer that may contain
+ // a child
+ final var activeContainer = createCombinedContainerList(navigationMenuRoots, noNavigationMenuRoots);
+
+ // Add sub items to top-level container items
+ var iterator = workList.listIterator();
+ while (iterator.hasNext()) {
+ var item = iterator.next();
+ final var topLevelItem = activeContainer.stream()
+ .filter(candidate -> item.getParentId().equals(candidate.getId())).findFirst();
+ if (topLevelItem.isPresent()) {
+ topLevelItem.get().getChildren().add(item);
+ } else if (virtualParentContainer.containsKey(item.getParentId())) {
+ virtualParentContainer.get(item.getParentId()).add(item);
+ Collections.sort(virtualParentContainer.get(item.getParentId()));
+ } else {
+ virtualParentContainer.put(item.getParentId(), mutableList(item));
+ }
+
+ iterator.remove();
+ }
+
+ }
+
+ private List createCombinedContainerList(final List roots,
+ final List noRoots) {
+ final List result = new ArrayList<>();
+ for (final NavigationMenuItem item : roots) {
+ if (item instanceof NavigationMenuItemContainer) {
+ result.add((NavigationMenuItemContainer) item);
+ }
+ }
+ for (final NavigationMenuItem item : noRoots) {
+ if (item instanceof NavigationMenuItemContainer) {
+ result.add((NavigationMenuItemContainer) item);
+ }
+ }
+ return result;
+ }
+
+ private void insertSeparatorMenuItem(final PortalNavigationMenuItemSeparatorImpl separatorMenuItem) {
+ final var topLevelItem = getContainerMenuItemById(separatorMenuItem.getParentId());
+ if (!topLevelItem.isPresent()) {
+ return;
+ }
+ topLevelItem.get().getChildren().add(separatorMenuItem);
+ }
+
+ @Override
+ public boolean isDisplayNavigationMenu() {
+ return !navigationMenuRoots.isEmpty();
+ }
+
+ @Override
+ public Optional getMenuItemById(String id) {
+ if (isEmpty(id)) {
+ return Optional.empty();
+ }
+ return renderedMenuItems.stream().filter(item -> id.equalsIgnoreCase(item.getId())).findFirst();
+ }
+
+ @Override
+ public List getMenuItemsByIds(String... ids) {
+ if (null == ids || ids.length == 0) {
+ return Collections.emptyList();
+ }
+ var builder = new CollectionBuilder();
+ for (String id : ids) {
+ var element = getMenuItemById(id);
+ element.ifPresent(builder::add);
+ }
+ return builder.toImmutableList();
+ }
+
+ @Override
+ public List getMenuItemsByParentId(String parentId) {
+ if (virtualParentContainer.containsKey(parentId)) {
+ return virtualParentContainer.get(parentId);
+ }
+ return mutableList();
+ }
+
+ @Override
+ public Optional getContainerMenuItemById(String id) {
+ var item = getMenuItemById(id);
+ if (!item.isPresent() || !(item.get() instanceof NavigationMenuItemContainer)) {
+ return Optional.empty();
+ }
+ return Optional.of((NavigationMenuItemContainer) item.get());
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/PortalNavigationMenuItemSeparatorImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/PortalNavigationMenuItemSeparatorImpl.java
new file mode 100644
index 0000000..dd74070
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/PortalNavigationMenuItemSeparatorImpl.java
@@ -0,0 +1,62 @@
+package de.cuioss.portal.ui.runtime.application.menu;
+
+import java.util.Map;
+
+import de.cuioss.jsf.api.components.model.menu.NavigationMenuItem;
+import de.cuioss.jsf.api.components.model.menu.NavigationMenuItemSeparator;
+import de.cuioss.portal.ui.api.menu.PortalNavigationMenuConfigParser;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * @author Oliver Wolff
+ *
+ */
+@RequiredArgsConstructor
+public class PortalNavigationMenuItemSeparatorImpl extends PortalNavigationMenuConfigParser
+ implements NavigationMenuItemSeparator {
+
+ private static final long serialVersionUID = -4539137375412075634L;
+
+ @Getter
+ private final String id;
+
+ @Getter(value = AccessLevel.PROTECTED)
+ private final Map menuConfig;
+
+ @Override
+ public String getResolvedTitle() {
+ return null;
+ }
+
+ @Override
+ public String getTitleKey() {
+ return null;
+ }
+
+ @Override
+ public String getTitleValue() {
+ return null;
+ }
+
+ @Override
+ public boolean isTitleAvailable() {
+ return false;
+ }
+
+ @Override
+ public String getIconStyleClass() {
+ return null;
+ }
+
+ @Override
+ public boolean isDisabled() {
+ return false;
+ }
+
+ @Override
+ public int compareTo(final NavigationMenuItem other) {
+ return getOrder().compareTo(other.getOrder());
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/package-info.java
new file mode 100644
index 0000000..3ed2687
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/menu/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Provides structures for dynamically creating / managing the navigation-menu.
+ * See package-info de.cuioss.portal.ui.api.menu of cdi-portal-core-spec for
+ * details
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.application.menu;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/PhaseTracer.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/PhaseTracer.java
new file mode 100644
index 0000000..13f910e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/PhaseTracer.java
@@ -0,0 +1,128 @@
+package de.cuioss.portal.ui.runtime.application.metrics;
+
+import static java.util.Objects.requireNonNull;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+import javax.faces.event.PhaseId;
+
+import de.cuioss.tools.concurrent.StopWatch;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.tools.string.MoreStrings;
+import lombok.AccessLevel;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+
+/**
+ * Helper Object aggregating a {@link PhaseId} and a {@link StopWatch}
+ *
+ * @author Oliver Wolff
+ *
+ */
+@EqualsAndHashCode(of = { "phaseOrdinal", "phaseName", "didRun" })
+public class PhaseTracer implements Serializable, Comparable {
+
+ private static final long serialVersionUID = -8784042523143046556L;
+
+ private static final CuiLogger log = new CuiLogger(PhaseTracer.class);
+
+ @Getter
+ private final Integer phaseOrdinal;
+
+ @Getter
+ private final String phaseName;
+
+ @Getter(AccessLevel.PACKAGE)
+ private final StopWatch stopWatch;
+
+ /** Boolean indicating whether the timer for this phase was run at all. */
+ @Getter
+ private boolean didRun;
+
+ /**
+ * Creates a new Instance containing an unstarted timer
+ *
+ * @param phaseId must not be null
+ */
+ public PhaseTracer(PhaseId phaseId) {
+ this(phaseId, StopWatch.createUnstarted());
+ }
+
+ /**
+ * @param phaseId identifying the {@link PhaseId} to be tracked, must not be
+ * null
+ * @param stopWatch to be used for stopping the time, must not be null.
+ */
+ public PhaseTracer(PhaseId phaseId, StopWatch stopWatch) {
+ requireNonNull(phaseId);
+ requireNonNull(stopWatch);
+ phaseOrdinal = phaseId.getOrdinal();
+ phaseName = phaseId.getName();
+ this.stopWatch = stopWatch;
+ didRun = false;
+ }
+
+ /**
+ * Starts the timer for the contained phase. It implicitly checks whether it is
+ * already running-
+ *
+ * @return The instance itself to enable a fluent-like access
+ */
+ public PhaseTracer start() {
+ didRun = true;
+ if (stopWatch.isRunning()) {
+ log.warn("IllegalState: Must only be started once, phaseName='%s'", phaseName);
+ } else {
+ log.trace("Starting tracing for phase='%s'", phaseName);
+ stopWatch.start();
+ }
+ return this;
+ }
+
+ /**
+ * Stops the timer for the contained phase. It implicitly checks whether it is
+ * already running.
+ *
+ * @return The instance itself to enable a fluent-like access
+ */
+ public PhaseTracer stop() {
+ if (stopWatch.isRunning()) {
+ log.trace("Stoping tracing for phase='%s'", phaseName);
+ stopWatch.stop();
+ } else {
+ log.warn("IllegalState: Must ony be started once, phase='%s'", phaseName);
+ }
+ return this;
+ }
+
+ @Override
+ public String toString() {
+ if (didRun) {
+ return MoreStrings.lenientFormat("Phase %s-%s took %s", phaseOrdinal, phaseName, stopWatch);
+ }
+ return MoreStrings.lenientFormat("Phase %s-%s did not run", phaseOrdinal, phaseName);
+ }
+
+ /**
+ * @param timer List of Timer where the current time in Millis should be added
+ * to. If it did not run (was not called) the method is expected to
+ * add -1. Must not be null but may be empty
+ */
+ void addTimeToList(List timer) {
+ var builder = new StringBuilder();
+ builder.append(phaseOrdinal).append("-").append(phaseName).append(": ");
+ if (!didRun) {
+ builder.append("-1");
+ } else {
+ builder.append(stopWatch.elapsed(TimeUnit.MILLISECONDS));
+ }
+ timer.add(builder.toString());
+ }
+
+ @Override
+ public int compareTo(PhaseTracer o) {
+ return phaseOrdinal.compareTo(o.phaseOrdinal);
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/RequestTracer.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/RequestTracer.java
new file mode 100644
index 0000000..85d08d9
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/RequestTracer.java
@@ -0,0 +1,170 @@
+package de.cuioss.portal.ui.runtime.application.metrics;
+
+import static de.cuioss.portal.configuration.MetricsConfigKeys.PORTAL_METRICS_ENABLED;
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+
+import java.io.Serializable;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import javax.enterprise.context.RequestScoped;
+import javax.faces.event.PhaseId;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+import org.eclipse.microprofile.metrics.MetricRegistry;
+import org.eclipse.microprofile.metrics.Tag;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.ui.api.ui.context.CuiCurrentView;
+import de.cuioss.tools.logging.CuiLogger;
+
+/**
+ * Gathers all lifecycle-information regarding tracing of certain Phases.
+ *
+ * @author Oliver Wolff
+ *
+ */
+@RequestScoped
+public class RequestTracer implements Serializable {
+
+ static final String PROCESSING_IDENTIFIER = "Processing of view '";
+
+ static final String NO_TRACING_INFORMATION_AVAILABLE = "No tracing information available";
+
+ private static final CuiLogger log = new CuiLogger(RequestTracer.class);
+
+ private static final long serialVersionUID = 2706209506496310554L;
+
+ private final Map tracerMap = new HashMap<>();
+
+ private final PhaseTracer complete = new PhaseTracer(PhaseId.ANY_PHASE);
+
+ private static final String METRIC_ID_PHASE = "jsf.view.phase";
+ private static final String METRIC_ID_TOTAL = "jsf.view.total";
+
+ @Inject
+ @CuiCurrentView
+ private Provider currentViewProvider;
+
+ /**
+ * The default value is explicitly set here, because the actual configuration of
+ * that value is set by the "portal-metrics" module which is optional .
+ */
+ @Inject
+ @ConfigProperty(name = PORTAL_METRICS_ENABLED, defaultValue = "false")
+ private boolean metricsEnabled;
+
+ @Inject
+ private Provider metricRegistry;
+
+ /**
+ * Starts the tracing of a certain phase.
+ *
+ * @param id identifying the phase. Must not be null. {@link PhaseId#ANY_PHASE}
+ * will be ignored
+ */
+ public void start(PhaseId id) {
+ if (0 == id.getOrdinal()) {
+ log.trace("Ignoring any-phase");
+ return;
+ }
+ if (PhaseId.RESTORE_VIEW.equals(id)) {
+ log.trace("Using RESTORE_VIEW as starting point for measuring the full processing");
+ complete.start();
+ startMetricTotal();
+ }
+ tracerMap.put(id.getOrdinal(), new PhaseTracer(id).start());
+ startMetricPhase(id);
+ }
+
+ /**
+ * Stops the tracing of a certain phase if applicable.
+ *
+ * @param id identifying the phase. Must not be null. It solely stops elements
+ * that have been initially started
+ */
+ public void stop(PhaseId id) {
+ if (PhaseId.RENDER_RESPONSE.equals(id)) {
+ log.trace("Using RENDER_RESPONSE as termination for measuring the full processing");
+ complete.stop();
+ stopMetricTotal();
+ }
+ if (!tracerMap.containsKey(id.getOrdinal())) {
+ log.trace("Tracer for Phase '%s' is not present, ignoring call", id);
+ return;
+ }
+ tracerMap.get(id.getOrdinal()).stop();
+ stopMetricPhase(id);
+ }
+
+ /**
+ * Writes / persists statistics, depending on the configuration. It will be
+ * implicitly logged at debug-level. Later on it will be written to the
+ * Metrics-registry
+ */
+ public void writeStatistics() {
+ if (log.isDebugEnabled()) {
+ var builder = new StringBuilder();
+ builder.append("\n").append(PROCESSING_IDENTIFIER).append(determineCurrentView()).append("'");
+ if (!complete.isDidRun()) {
+ builder.append("\n").append(NO_TRACING_INFORMATION_AVAILABLE);
+ } else {
+ builder.append(", took ").append(complete.getStopWatch().toString());
+ List tracer = mutableList(tracerMap.values());
+ Collections.sort(tracer);
+ List elements = mutableList();
+ var elapsedComplete = complete.getStopWatch().elapsed(TimeUnit.MILLISECONDS);
+ elements.add("0-Request Total: " + elapsedComplete);
+ tracer.forEach(phase -> phase.addTimeToList(elements));
+ log.trace("Gathering differential timings");
+ for (PhaseTracer phaseTracer : tracer) {
+ elapsedComplete = elapsedComplete - phaseTracer.getStopWatch().elapsed(TimeUnit.MILLISECONDS);
+ }
+ elements.add("Delta: " + elapsedComplete);
+ builder.append("\nTimings in ms: ").append(elements);
+ }
+ log.debug(builder.toString());
+ }
+ }
+
+ private String determineCurrentView() {
+ var currentView = currentViewProvider.get();
+ if (currentView.isViewDefined()) {
+ return currentView.getLogicalViewId();
+ }
+ return "unknown";
+ }
+
+ void startMetricTotal() {
+ if (metricsEnabled) {
+ metricRegistry.get().timer(METRIC_ID_TOTAL, new Tag("view", determineCurrentView())).time();
+ }
+ }
+
+ void stopMetricTotal() {
+ if (metricsEnabled) {
+ metricRegistry.get().timer(METRIC_ID_TOTAL, new Tag("view", determineCurrentView())).time().stop();
+ }
+ }
+
+ void startMetricPhase(final PhaseId id) {
+ if (metricsEnabled) {
+ metricRegistry.get()
+ .timer(METRIC_ID_PHASE, new Tag("phase", id.getName()), new Tag("view", determineCurrentView()))
+ .time();
+ }
+ }
+
+ void stopMetricPhase(final PhaseId id) {
+ if (metricsEnabled) {
+ metricRegistry.get()
+ .timer(METRIC_ID_PHASE, new Tag("phase", id.getName()), new Tag("view", determineCurrentView()))
+ .time().stop();
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/TraceListener.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/TraceListener.java
new file mode 100644
index 0000000..6db6b29
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/TraceListener.java
@@ -0,0 +1,74 @@
+package de.cuioss.portal.ui.runtime.application.metrics;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_LISTENER_TRACE_ENABLED;
+
+import javax.faces.event.PhaseEvent;
+import javax.faces.event.PhaseId;
+import javax.faces.event.PhaseListener;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import org.apache.deltaspike.jsf.api.listener.phase.JsfPhaseListener;
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.tools.logging.CuiLogger;
+
+/**
+ * Uses the deltaspike mechanism for registering a {@link PhaseListener} at the
+ * desired location. The very high ordinal of 5000 ensures that the tracing
+ * starts before any other listener and will be stopped after all other
+ * listeners: deltaspike takes care on this by sorting / reverse sorting. This
+ * feature is enabled by the configuration of the key
+ * {@link PortalConfigurationKeys#PORTAL_LISTENER_TRACE_ENABLED}. In order to
+ * materialize at the log the Logger for {@link RequestTracer} must be set to
+ * debug.
+ *
+ * @author Oliver Wolff
+ *
+ */
+@JsfPhaseListener(ordinal = 5000)
+public class TraceListener implements PhaseListener {
+
+ private static final String DISABLED_BY_CONFIGURATION = "Disabled by configuration";
+
+ private static final long serialVersionUID = -3549927752283027321L;
+
+ private static final CuiLogger log = new CuiLogger(TraceListener.class);
+
+ @Inject
+ @ConfigProperty(name = PORTAL_LISTENER_TRACE_ENABLED)
+ private boolean enabled;
+
+ @Inject
+ private Provider traceProvider;
+
+ @Override
+ public void beforePhase(PhaseEvent event) {
+ if (enabled) {
+ traceProvider.get().start(event.getPhaseId());
+ } else {
+ log.trace(DISABLED_BY_CONFIGURATION);
+ }
+ }
+
+ @Override
+ public void afterPhase(PhaseEvent event) {
+ if (enabled) {
+ var requestTracer = traceProvider.get();
+ requestTracer.stop(event.getPhaseId());
+ if (PhaseId.RENDER_RESPONSE.equals(event.getPhaseId())) {
+ requestTracer.writeStatistics();
+ }
+ } else {
+ log.trace(DISABLED_BY_CONFIGURATION);
+ }
+
+ }
+
+ @Override
+ public PhaseId getPhaseId() {
+ return PhaseId.ANY_PHASE;
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/package-info.java
new file mode 100644
index 0000000..fdf1a45
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/metrics/package-info.java
@@ -0,0 +1,9 @@
+/**
+ * Defines runtime metrics for the portal. The first element is to define a
+ * system for retrieving information how long an actual request really took:
+ * {@link de.cuioss.portal.ui.runtime.application.metrics.RequestTracer}
+ *
+ * @author Oliver Wolff
+ *
+ */
+package de.cuioss.portal.ui.runtime.application.metrics;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/PortalClientStorageImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/PortalClientStorageImpl.java
new file mode 100644
index 0000000..b267ba5
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/PortalClientStorageImpl.java
@@ -0,0 +1,91 @@
+package de.cuioss.portal.ui.runtime.application.storage;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.CLIENT_STORAGE_COOKIE_MAXAGE;
+import static de.cuioss.portal.ui.api.PortalCoreBeanNames.CLIENT_STORAGE_BEAN_NAME;
+import static org.omnifaces.util.Faces.addResponseCookie;
+import static org.omnifaces.util.Faces.getRequestCookie;
+import static org.omnifaces.util.Faces.removeResponseCookie;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.RequestScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.core.servlet.CuiContextPath;
+import de.cuioss.portal.core.storage.ClientStorage;
+import de.cuioss.portal.core.storage.PortalClientStorage;
+import de.cuioss.tools.string.MoreStrings;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Represents the request scoped runtime representation of
+ * {@link PortalClientStorage}, using cookies theirs
+ * {@link PortalClientStorage}, using cookies as storage.
+ *
+ * @author Matthias Walliczek
+ */
+@PortalClientStorage
+@RequestScoped
+@EqualsAndHashCode
+@ToString
+@Named(CLIENT_STORAGE_BEAN_NAME)
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+public class PortalClientStorageImpl implements ClientStorage {
+
+ private static final long serialVersionUID = 1573344347429735050L;
+
+ private final Map cache = new HashMap<>();
+
+ @Inject
+ @ConfigProperty(name = CLIENT_STORAGE_COOKIE_MAXAGE)
+ private String cookieMaxAge;
+
+ @Inject
+ @CuiContextPath
+ private Provider contextPathProvider;
+
+ @Override
+ public String get(final String key) {
+ if (!cache.containsKey(key)) {
+ cache.put(key, getRequestCookie(key));
+ }
+ return cache.get(key);
+ }
+
+ @Override
+ public String get(final String key, final String defaultValue) {
+ final var value = get(key);
+ if (MoreStrings.isEmpty(value)) {
+ return defaultValue;
+ }
+ return value;
+ }
+
+ @Override
+ public void put(final String key, final String object) {
+ addResponseCookie(key, object, contextPathProvider.get(), Integer.parseInt(cookieMaxAge));
+ cache.put(key, object);
+ }
+
+ @Override
+ public String remove(final String key) {
+ final var result = get(key);
+ removeResponseCookie(key, contextPathProvider.get());
+ cache.put(key, null);
+ return result;
+ }
+
+ @Override
+ public boolean containsKey(final String key) {
+ return null != get(key);
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/PortalSessionStorageImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/PortalSessionStorageImpl.java
new file mode 100644
index 0000000..c811128
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/PortalSessionStorageImpl.java
@@ -0,0 +1,30 @@
+package de.cuioss.portal.ui.runtime.application.storage;
+
+import static de.cuioss.portal.ui.api.PortalCoreBeanNames.SESSION_STORAGE_BEAN_NAME;
+
+import java.io.Serializable;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.SessionScoped;
+import javax.inject.Named;
+
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.core.storage.PortalSessionStorage;
+import de.cuioss.portal.core.storage.SessionStorage;
+import de.cuioss.portal.core.storage.impl.MapStorageImpl;
+
+/**
+ * Represents the session scoped runtime representation of
+ * {@link PortalSessionStorage}
+ *
+ * @author Oliver Wolff
+ */
+@PortalSessionStorage
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@SessionScoped
+@Named(SESSION_STORAGE_BEAN_NAME)
+public class PortalSessionStorageImpl extends MapStorageImpl implements SessionStorage {
+
+ private static final long serialVersionUID = 1573344347429735050L;
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/package-info.java
new file mode 100644
index 0000000..7aae742
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/storage/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * See package-info de.cuioss.portal.ui.api.storage of cdi-portal-core-spec for
+ * details
+ */
+package de.cuioss.portal.ui.runtime.application.storage;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalTemplateMapper.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalTemplateMapper.java
new file mode 100644
index 0000000..53cdac4
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalTemplateMapper.java
@@ -0,0 +1,123 @@
+package de.cuioss.portal.ui.runtime.application.templating;
+
+import static de.cuioss.portal.ui.api.PortalCoreBeanNames.MULTI_TEMPLATING_MAPPER_BEAN_NAME;
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+
+import java.net.URL;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.enterprise.inject.Instance;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.templating.MultiTemplatingMapper;
+import de.cuioss.portal.ui.api.templating.PortalMultiTemplatingMapper;
+import de.cuioss.portal.ui.api.templating.PortalTemplateDescriptor;
+import de.cuioss.portal.ui.api.templating.PortalViewResourcesConfigChanged;
+import de.cuioss.portal.ui.api.templating.PortalViewResourcesConfigChangedType;
+import de.cuioss.portal.ui.api.templating.StaticTemplateDescriptor;
+import de.cuioss.tools.collect.MapBuilder;
+import de.cuioss.tools.io.FileLoaderUtility;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * The Mapper collects all instances of {@link StaticTemplateDescriptor} and
+ * sorts the templates accordingly. Itself it acts as a
+ * {@link MultiTemplatingMapper}
+ *
+ * @author Oliver Wolff
+ */
+@PortalMultiTemplatingMapper
+@ApplicationScoped
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@Named(MULTI_TEMPLATING_MAPPER_BEAN_NAME)
+@EqualsAndHashCode(of = "templateMap")
+@ToString(of = "templateMap")
+public class PortalTemplateMapper implements MultiTemplatingMapper {
+
+ private static final long serialVersionUID = -8398917391620682636L;
+
+ private static final CuiLogger log = new CuiLogger(PortalTemplateMapper.class);
+
+ private Map templateMap;
+
+ @Inject
+ @PortalTemplateDescriptor
+ private Instance descriptors;
+
+ /**
+ * Sorts the descriptors according to Priority annotation and creates the
+ * corresponding mapping.
+ */
+ @PostConstruct
+ public void init() {
+ final List sortedDescriptors = PortalPriorities
+ .sortByPriority(mutableList(descriptors));
+ // Now iterate over sorted descriptors and create the mapping
+ final Map builderMap = new HashMap<>();
+ for (final StaticTemplateDescriptor descriptor : sortedDescriptors) {
+ for (final String resourceName : descriptor.getHandledTemplates()) {
+ if (!builderMap.containsKey(resourceName)) {
+ handleDescriptor(builderMap, descriptor, resourceName);
+ }
+ }
+ }
+ templateMap = MapBuilder.copyFrom(builderMap).toImmutableMap();
+ if (log.isDebugEnabled()) {
+ final var viewMapDebug = new StringBuilder("Resulting templates map:\r");
+ templateMap
+ .forEach((key, value) -> viewMapDebug.append(String.format("%-30s -> %s\r", key, value.getPath())));
+ log.debug(viewMapDebug.toString());
+ }
+ }
+
+ public void handleDescriptor(final Map builderMap, final StaticTemplateDescriptor descriptor,
+ final String resourceName) {
+ try {
+ final var url = FileLoaderUtility.getLoaderForPath(descriptor.getTemplatePath() + '/' + resourceName)
+ .getURL();
+ if (null == url) {
+ log.warn("Portal-126: Template {} with path {} from descriptor {} was not found", resourceName,
+ descriptor.getTemplatePath(), descriptor.toString());
+ } else {
+ builderMap.put(resourceName, url);
+ }
+ } catch (final IllegalArgumentException e) {
+ log.warn(
+ "Portal-144: Configured view/template resource '" + resourceName + "' can not be resolved, skipped",
+ e);
+ }
+ }
+
+ @Override
+ public URL resolveTemplatePath(final String requestedResource) {
+ final var resolved = templateMap.get(requestedResource);
+ if (null == resolved) {
+ throw new IllegalArgumentException("No mapping found for " + requestedResource);
+ }
+ return resolved;
+ }
+
+ /**
+ * Listener for {@link PortalViewResourcesConfigChanged}s. Reinitialize the
+ * templates map.
+ *
+ * @param type
+ */
+ void configurationChangeEventListener(
+ @Observes @PortalViewResourcesConfigChanged final PortalViewResourcesConfigChangedType type) {
+ if (PortalViewResourcesConfigChangedType.TEMPLATES == type) {
+ log.debug("Reinitialize templates map");
+ init();
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalTemplates.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalTemplates.java
new file mode 100644
index 0000000..8f1a0c9
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalTemplates.java
@@ -0,0 +1,41 @@
+package de.cuioss.portal.ui.runtime.application.templating;
+
+import static de.cuioss.tools.collect.CollectionLiterals.immutableList;
+
+import java.util.List;
+
+import javax.annotation.Priority;
+import javax.enterprise.context.Dependent;
+import javax.inject.Named;
+
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.templating.PortalTemplateDescriptor;
+import de.cuioss.portal.ui.api.templating.StaticTemplateDescriptor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Defines the Portal defined templates
+ *
+ * @author Oliver Wolff
+ */
+@PortalTemplateDescriptor
+@Dependent
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@Named
+@EqualsAndHashCode
+@ToString
+public class PortalTemplates implements StaticTemplateDescriptor {
+
+ private static final long serialVersionUID = 1933293647595996193L;
+
+ @Getter
+ private final List handledTemplates = immutableList("master.xhtml", "plainView.xhtml",
+ "master_centered.xhtml", "http_error_page.xhtml", "technical_root.xhtml", "root.xhtml",
+ "layout_footer.xhtml");
+
+ @Getter
+ private final String templatePath = "classpath:/META-INF/templates/portal";
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalViewMapper.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalViewMapper.java
new file mode 100644
index 0000000..a21f247
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/PortalViewMapper.java
@@ -0,0 +1,123 @@
+package de.cuioss.portal.ui.runtime.application.templating;
+
+import static de.cuioss.portal.ui.api.PortalCoreBeanNames.MULTI_VIEW_MAPPER_BEAN_NAME;
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+
+import java.net.URL;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.enterprise.inject.Instance;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import de.cuioss.portal.configuration.application.PortalProjectStageProducer;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.ui.api.templating.MultiViewMapper;
+import de.cuioss.portal.ui.api.templating.PortalMultiViewMapper;
+import de.cuioss.portal.ui.api.templating.PortalViewDescriptor;
+import de.cuioss.portal.ui.api.templating.PortalViewResourcesConfigChanged;
+import de.cuioss.portal.ui.api.templating.PortalViewResourcesConfigChangedType;
+import de.cuioss.portal.ui.api.templating.StaticViewDescriptor;
+import de.cuioss.tools.io.FileLoaderUtility;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.uimodel.application.CuiProjectStage;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * The Mapper collects all instances of {@link StaticViewDescriptor} and sorts
+ * the templates accordingly. Itself it acts as a {@link MultiViewMapper}
+ *
+ * @author Oliver Wolff
+ */
+@PortalMultiViewMapper
+@ApplicationScoped
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@Named(MULTI_VIEW_MAPPER_BEAN_NAME)
+@EqualsAndHashCode(of = "viewMap")
+@ToString(of = "viewMap")
+public class PortalViewMapper implements MultiViewMapper {
+
+ private static final long serialVersionUID = -8398917391620682636L;
+
+ private static final CuiLogger log = new CuiLogger(PortalViewMapper.class);
+
+ private Map viewMap;
+
+ @Inject
+ @PortalViewDescriptor
+ private Instance descriptors;
+
+ @Inject
+ @PortalProjectStageProducer
+ private Provider projectStageProvider;
+
+ /**
+ * Sorts the descriptors according to Priority annotation and creates the
+ * corresponding mapping.
+ */
+ @PostConstruct
+ public void init() {
+ final List sortedDescriptors = PortalPriorities.sortByPriority(mutableList(descriptors));
+ // Now iterate over sorted descriptors and create the mapping
+ viewMap = new HashMap<>();
+ for (final StaticViewDescriptor descriptor : sortedDescriptors) {
+ log.debug("found descriptor: {}", descriptor.getClass().getCanonicalName());
+ for (final String resourceName : descriptor.getHandledViews()) {
+ if (!viewMap.containsKey(resourceName)) {
+ handleDescriptor(viewMap, descriptor, resourceName);
+ } else {
+ log.debug("skipping view {}", resourceName);
+ }
+ }
+ }
+ if (log.isDebugEnabled()) {
+ final var viewMapDebug = new StringBuilder("Resulting view map:\r");
+ viewMap.forEach((key, value) -> viewMapDebug.append(String.format("%-30s -> %s\r", key, value.getPath())));
+ log.debug(viewMapDebug.toString());
+ }
+ }
+
+ private void handleDescriptor(final Map builderMap, final StaticViewDescriptor descripor,
+ final String resourceName) {
+ try {
+ final var url = FileLoaderUtility.getLoaderForPath(descripor.getViewPath() + '/' + resourceName).getURL();
+ if (null == url) {
+ log.warn("Portal-127: View {} with path {} from descriptor {} was not found", resourceName,
+ descripor.getViewPath(), descripor.toString());
+ } else {
+ log.debug("adding view {}", resourceName);
+ builderMap.put(resourceName, url);
+ }
+ } catch (final IllegalArgumentException e) {
+ log.warn("Portal-144: Configured view/template resource '{}' can not be resolved, skipped", resourceName);
+ }
+ }
+
+ @Override
+ public URL resolveViewPath(final String requestedResource) {
+ return viewMap.computeIfAbsent(requestedResource,
+ key -> FileLoaderUtility.getLoaderForPath("classpath:/META-INF/faces/" + key).getURL());
+ }
+
+ /**
+ * Listener for {@link PortalViewResourcesConfigChanged}s. Reinitialize the
+ * templates map.
+ *
+ * @param type
+ */
+ void configurationChangeEventListener(
+ @Observes @PortalViewResourcesConfigChanged final PortalViewResourcesConfigChangedType type) {
+ if (PortalViewResourcesConfigChangedType.VIEWS == type) {
+ log.debug("Reinitialize templates map");
+ init();
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/ViewResourceHandler.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/ViewResourceHandler.java
new file mode 100644
index 0000000..22fcb73
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/ViewResourceHandler.java
@@ -0,0 +1,110 @@
+package de.cuioss.portal.ui.runtime.application.templating;
+
+import static de.cuioss.tools.collect.CollectionLiterals.mutableList;
+import static de.cuioss.tools.string.MoreStrings.nullToEmpty;
+
+import java.net.URL;
+import java.util.List;
+
+import javax.faces.application.ResourceHandler;
+import javax.faces.application.ResourceHandlerWrapper;
+import javax.faces.application.ViewResource;
+import javax.faces.context.FacesContext;
+
+import de.cuioss.portal.core.cdi.PortalBeanManager;
+import de.cuioss.portal.ui.api.templating.MultiTemplatingMapper;
+import de.cuioss.portal.ui.api.templating.MultiViewMapper;
+import de.cuioss.portal.ui.api.templating.PortalMultiTemplatingMapper;
+import de.cuioss.portal.ui.api.templating.PortalMultiViewMapper;
+import de.cuioss.tools.string.Joiner;
+import de.cuioss.tools.string.Splitter;
+import lombok.Getter;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * This resource Handler has two purposes.
+ *
+ * - Loading views from classpath: Classpath views are expected at
+ * /META-INF/faces.
+ * - Implementation of Multitemplating: see package-doc
+ * com.icw.ehf.cui.application.templating for details
+ *
+ *
+ * @author Oliver Wolff
+ */
+@RequiredArgsConstructor
+public class ViewResourceHandler extends ResourceHandlerWrapper {
+
+ private static final String RESOURCE_PREFIX_FACES_VIEW = "/faces/";
+
+ private static final String RESOURCE_PREFIX_TEMPLATES = "/templates/";
+
+ private MultiViewMapper multiViewMapper;
+
+ private MultiTemplatingMapper multiTemplatingMapper;
+
+ @Getter
+ @NonNull
+ private final ResourceHandler wrapped;
+
+ @Override
+ public ViewResource createViewResource(final FacesContext context, final String resourceName) {
+ if (shouldHandleResource(resourceName)) {
+ return new ViewResource() {
+
+ @Override
+ public URL getURL() {
+ return computeURL(resourceName);
+ }
+ };
+ }
+ return super.createViewResource(context, resourceName);
+ }
+
+ /**
+ * Computes a corresponding classpath related url.
+ *
+ * @param resourceName
+ * @return
+ */
+ URL computeURL(final String resourceName) {
+ checkMapper();
+ if (resourceName.startsWith(RESOURCE_PREFIX_FACES_VIEW)) {
+ return multiViewMapper.resolveViewPath(removePrefix(resourceName));
+ }
+ // A request for a template;
+ return multiTemplatingMapper.resolveTemplatePath(removePrefix(resourceName));
+ }
+
+ private void checkMapper() {
+ if (null == multiTemplatingMapper) {
+ multiTemplatingMapper = PortalBeanManager
+ .resolveBean(MultiTemplatingMapper.class, PortalMultiTemplatingMapper.class)
+ .orElseThrow(() -> new IllegalArgumentException(PortalBeanManager
+ .createErrorMessage(MultiTemplatingMapper.class, PortalMultiTemplatingMapper.class)));
+ }
+
+ if (null == multiViewMapper) {
+ multiViewMapper = PortalBeanManager.resolveBean(MultiViewMapper.class, PortalMultiViewMapper.class)
+ .orElseThrow(() -> new IllegalArgumentException(
+ PortalBeanManager.createErrorMessage(MultiViewMapper.class, PortalMultiViewMapper.class)));
+ }
+ }
+
+ private static String removePrefix(final String resourceName) {
+ List list = mutableList(Splitter.on("/").omitEmptyStrings().splitToList(resourceName));
+ if (list.size() < 2) {
+ throw new IllegalStateException(
+ "Expected identifier in form of '/faces/xyz.xhtml' or '/templates/xyz.xhtml', actually: "
+ + resourceName);
+ }
+ return Joiner.on('/').join(list.subList(1, list.size()));
+ }
+
+ private static boolean shouldHandleResource(final String resourceName) {
+ var safeResource = nullToEmpty(resourceName);
+ return safeResource.startsWith(RESOURCE_PREFIX_FACES_VIEW)
+ || safeResource.startsWith(RESOURCE_PREFIX_TEMPLATES);
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/package-info.java
new file mode 100644
index 0000000..ecf8d03
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/templating/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Provides the default templating mechanics of the portal. See package-info
+ * de.cuioss.portal.ui.api.templating of cdi-portal-core-spec for details on
+ * Multi-Templating.
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.application.templating;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/DefaultThemeConfiguration.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/DefaultThemeConfiguration.java
new file mode 100644
index 0000000..1a5609e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/DefaultThemeConfiguration.java
@@ -0,0 +1,110 @@
+package de.cuioss.portal.ui.runtime.application.theme;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.THEME_AVAILABLE;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.THEME_DEFAULT;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.application.theme.ThemeConfiguration;
+import de.cuioss.jsf.api.application.theme.impl.ThemeConfigurationImpl;
+import de.cuioss.jsf.api.application.theme.impl.ThemeManager;
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.types.ConfigAsList;
+import de.cuioss.portal.ui.api.theme.PortalThemeConfiguration;
+import de.cuioss.tools.logging.CuiLogger;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Default {@link ThemeConfiguration} reads default-theme and available themes
+ * from the configuration system
+ *
+ * @author Oliver Wolff
+ */
+@ApplicationScoped
+@PortalThemeConfiguration
+@Named(ThemeConfigurationImpl.BEAN_NAME)
+@EqualsAndHashCode(of = { "availableThemes", "defaultTheme", "cssName", "cssLibrary" }, doNotUseGetters = true)
+@ToString(of = { "availableThemes", "defaultTheme", "cssName", "cssLibrary" }, doNotUseGetters = true)
+public class DefaultThemeConfiguration implements ThemeConfiguration, Serializable {
+
+ private static final long serialVersionUID = 3077568114159593192L;
+
+ private static final CuiLogger log = new CuiLogger(DefaultThemeConfiguration.class);
+
+ private ThemeManager themeManager;
+
+ @Inject
+ @ConfigAsList(name = THEME_AVAILABLE)
+ private Provider> availableThemesProvider;
+
+ @Inject
+ @ConfigProperty(name = THEME_DEFAULT)
+ private Provider defaultThemeProvider;
+
+ /** The names of the available themes. */
+ @Getter
+ private List availableThemes;
+
+ /**
+ * Identifying the default theme.
+ */
+ @Getter
+ private String defaultTheme;
+
+ /** Defaults to "application.css" */
+ @Getter
+ private final String cssName = "application.css";
+
+ /** Defaults to "com.icw.portal.css" */
+ @Getter
+ private final String cssLibrary = "com.icw.portal.css";
+
+ /**
+ * Initializes the bean, see class documentation for details
+ */
+ @PostConstruct
+ public void initBean() {
+ doConfigure();
+ }
+
+ private void doConfigure() {
+
+ defaultTheme = defaultThemeProvider.get();
+ availableThemes = availableThemesProvider.get();
+ themeManager = new ThemeManager(this);
+ }
+
+ @Override
+ public String getCssForThemeName(final String themeName) {
+ return themeManager.getCssForThemeName(themeName);
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s. Reconfigures the
+ * theme-configuration
+ *
+ * @param deltaMap
+ */
+ void configurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (deltaMap.containsKey(THEME_DEFAULT) || deltaMap.containsKey(THEME_AVAILABLE)) {
+ log.debug("Setting default theme to {} and available themes to {}", defaultThemeProvider.get(),
+ availableThemesProvider.get());
+ doConfigure();
+ }
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/PortalThemeManager.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/PortalThemeManager.java
new file mode 100644
index 0000000..8fc9b4f
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/PortalThemeManager.java
@@ -0,0 +1,68 @@
+package de.cuioss.portal.ui.runtime.application.theme;
+
+import java.io.Serializable;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.context.RequestScoped;
+import javax.enterprise.context.SessionScoped;
+import javax.enterprise.inject.Produces;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import de.cuioss.jsf.api.application.theme.ThemeNameProducer;
+import de.cuioss.jsf.api.application.theme.impl.ThemeNameProducerImpl;
+import de.cuioss.portal.ui.api.theme.PortalThemeNameProducer;
+import de.cuioss.portal.ui.api.theme.PortalThemePersistencesService;
+import de.cuioss.portal.ui.api.theme.ThemePersistenceService;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Provides as central point for accessing theme related aspects.
+ *
+ * - It produces instances of {@link ThemeNameProducer}
+ * - It acts as a session scoped cache for the actual selected theme>
+ * - It separates inline usage (Portal, managed beans) from the extension
+ * point, defined with {@link ThemePersistenceService}.
+ *
+ *
+ * @author Oliver Wolff
+ */
+@Named
+@SessionScoped
+@EqualsAndHashCode(of = "theme", doNotUseGetters = true)
+@ToString(of = "theme", doNotUseGetters = true)
+public class PortalThemeManager implements Serializable, ThemePersistenceService {
+
+ private static final long serialVersionUID = -2817492210744540637L;
+
+ @Inject
+ @PortalThemePersistencesService
+ private ThemePersistenceService themePersistenceService;
+
+ @Getter
+ private String theme;
+
+ /**
+ * Initializer method for the bean
+ */
+ @PostConstruct
+ public void init() {
+ theme = themePersistenceService.getTheme();
+ }
+
+ @Produces
+ @Named(ThemeNameProducerImpl.BEAN_NAME)
+ @PortalThemeNameProducer
+ @RequestScoped
+ ThemeNameProducer produceThemeNameProducer() {
+ return themePersistenceService;
+ }
+
+ @Override
+ public void saveTheme(final String newTheme) {
+ theme = newTheme;
+ themePersistenceService.saveTheme(newTheme);
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/impl/PortalThemePersistenceServiceImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/impl/PortalThemePersistenceServiceImpl.java
new file mode 100644
index 0000000..879a3cd
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/impl/PortalThemePersistenceServiceImpl.java
@@ -0,0 +1,76 @@
+package de.cuioss.portal.ui.runtime.application.theme.impl;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.THEME_DEFAULT;
+
+import java.io.Serializable;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.Priority;
+import javax.enterprise.context.SessionScoped;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.application.theme.ThemeConfiguration;
+import de.cuioss.portal.configuration.common.PortalPriorities;
+import de.cuioss.portal.core.storage.ClientStorage;
+import de.cuioss.portal.core.storage.PortalClientStorage;
+import de.cuioss.portal.ui.api.theme.PortalThemeConfiguration;
+import de.cuioss.portal.ui.api.theme.PortalThemePersistencesService;
+import de.cuioss.portal.ui.api.theme.ThemePersistenceService;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Default implementation that stores the currently active / selected theme
+ * within session. Should be replaced by concrete implementation that stores it
+ * in some persistence layer. FIXME owolff consider using cookie instead of
+ * session as default.
+ *
+ * @author Oliver Wolff
+ */
+@PortalThemePersistencesService
+@Priority(PortalPriorities.PORTAL_CORE_LEVEL)
+@SessionScoped
+@EqualsAndHashCode
+@ToString
+public class PortalThemePersistenceServiceImpl implements Serializable, ThemePersistenceService {
+
+ private static final long serialVersionUID = 5242120351578770611L;
+
+ @Inject
+ @PortalThemeConfiguration
+ private ThemeConfiguration themeConfiguration;
+
+ @Getter
+ private String theme;
+
+ @Inject
+ @PortalClientStorage
+ private Provider clientStorage;
+
+ /**
+ * Initializer method for the bean
+ */
+ @PostConstruct
+ public void init() {
+ this.theme = this.themeConfiguration.getDefaultTheme();
+ if (this.clientStorage.get().containsKey(THEME_DEFAULT)) {
+ final var storedTheme = this.clientStorage.get().get(THEME_DEFAULT);
+ if (this.themeConfiguration.getAvailableThemes().contains(storedTheme)) {
+ this.theme = storedTheme;
+ }
+ }
+ }
+
+ @Override
+ public void saveTheme(final String newTheme) {
+ if (!this.themeConfiguration.getAvailableThemes().contains(newTheme)) {
+ throw new IllegalArgumentException(
+ "Given theme '" + newTheme + "' must be one of " + this.themeConfiguration.getAvailableThemes());
+ }
+ this.theme = newTheme;
+ this.clientStorage.get().put(THEME_DEFAULT, newTheme);
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/impl/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/impl/package-info.java
new file mode 100644
index 0000000..c37407c
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/impl/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Provides implementation classes for theming
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.application.theme.impl;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/package-info.java
new file mode 100644
index 0000000..2a01b03
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/theme/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Provides the portal specific theme integration, see Provides theming related
+ * identifier. See com.icw.ehf.cui.core.api.application.theme on how theming
+ * works within cui.
+ *
+ * @author Matthias Walliczek
+ */
+package de.cuioss.portal.ui.runtime.application.theme;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/DefaultViewRestrictionManager.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/DefaultViewRestrictionManager.java
new file mode 100644
index 0000000..261508e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/DefaultViewRestrictionManager.java
@@ -0,0 +1,96 @@
+package de.cuioss.portal.ui.runtime.application.view;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.CONTEXT_PARAM_SEPARATOR;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.VIEW_ROLE_RESTRICTION_PREFIX;
+
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Set;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.context.RequestScoped;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.application.navigation.NavigationUtils;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcher;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcherImpl;
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.authentication.AuthenticatedUserInfo;
+import de.cuioss.portal.authentication.PortalUser;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.types.ConfigAsFilteredMap;
+import de.cuioss.portal.ui.api.view.PortalViewRestrictionManager;
+import de.cuioss.portal.ui.api.view.ViewRestrictionManager;
+import de.cuioss.tools.collect.MapBuilder;
+import de.cuioss.tools.string.Splitter;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Helper class that handles the checking of the roles needed to access a
+ * certain view. For the configuration of the restricted views see
+ * {@link PortalConfigurationKeys#VIEW_ROLE_RESTRICTION_PREFIX}. The actual
+ * 'business' method is {@link #isUserAuthorized(ViewDescriptor)}
+ *
+ * @author Oliver Wolff
+ */
+@PortalViewRestrictionManager
+@RequestScoped
+@EqualsAndHashCode(of = "roleMatcherMap")
+@ToString(of = "roleMatcherMap")
+public class DefaultViewRestrictionManager implements ViewRestrictionManager {
+
+ private static final long serialVersionUID = -3987276415425723519L;
+
+ @Inject
+ @ConfigAsFilteredMap(startsWith = VIEW_ROLE_RESTRICTION_PREFIX, stripPrefix = true)
+ private Provider> viewRestrictions;
+
+ private Map roleMatcherMap;
+
+ @Inject
+ @PortalUser
+ private AuthenticatedUserInfo userInfo;
+
+ @Inject
+ private Provider facesContextProvider;
+
+ /**
+ * Initializes the configured view Matcher
+ */
+ @PostConstruct
+ public void init() {
+ var builder = new MapBuilder();
+ for (Entry entry : viewRestrictions.get().entrySet()) {
+ var entries = Splitter.on(CONTEXT_PARAM_SEPARATOR).omitEmptyStrings().trimResults()
+ .splitToList(entry.getValue());
+ builder.put(entry.getKey(), new ViewMatcherImpl(entries));
+ }
+ roleMatcherMap = builder.toImmutableMap();
+ }
+
+ @Override
+ public boolean isUserAuthorized(final ViewDescriptor descriptor) {
+ return userInfo.getRoles().containsAll(getRequiredRolesForView(descriptor));
+ }
+
+ @Override
+ public Set getRequiredRolesForView(final ViewDescriptor descriptor) {
+ Set requiredRoles = new HashSet<>();
+ for (Entry entry : roleMatcherMap.entrySet()) {
+ if (entry.getValue().match(descriptor)) {
+ requiredRoles.add(entry.getKey());
+ }
+ }
+ return requiredRoles;
+ }
+
+ @Override
+ public boolean isUserAuthorizedForViewOutcome(final String viewOutcome) {
+ return isUserAuthorized(NavigationUtils.lookUpToViewDescriptorBy(facesContextProvider.get(), viewOutcome));
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/HttpHeader.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/HttpHeader.java
new file mode 100644
index 0000000..25ed8e8
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/HttpHeader.java
@@ -0,0 +1,51 @@
+package de.cuioss.portal.ui.runtime.application.view;
+
+import java.io.Serializable;
+
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcher;
+import lombok.Data;
+
+/**
+ * Http header setting
+ *
+ * @author Matthias Walliczek
+ */
+@Data
+class HttpHeader implements Serializable, Comparable {
+
+ private static final long serialVersionUID = -8089609030535127942L;
+
+ private String key;
+
+ private String value;
+
+ private boolean enabled;
+
+ private ViewMatcher viewMatcher;
+
+ /**
+ * Compare two HttpHeader based on the specification of the view matcher to find
+ * the most specific http header. Returns a negative integer, zero, or a
+ * positive integer as this object is less than, equal to, or greater than the
+ * specified object.
+ *
+ * @param other the object to be compared.
+ *
+ * @return a negative integer, zero, or a positive integer as this object is
+ * less than, equal to, or greater than the specified object.
+ * @throws NullPointerException if the specified object is null
+ * @throws ClassCastException if the specified object's type prevents it from
+ * being compared to this object.
+ */
+ @Override
+ public int compareTo(final HttpHeader other) {
+ return Integer.compare(pathLength(this.getViewMatcher()), pathLength(other.getViewMatcher()));
+ }
+
+ private static int pathLength(final ViewMatcher matcher) {
+ if (null == matcher) {
+ return 0;
+ }
+ return matcher.toString().length();
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/HttpHeaderFilterImpl.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/HttpHeaderFilterImpl.java
new file mode 100644
index 0000000..6ba923e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/HttpHeaderFilterImpl.java
@@ -0,0 +1,169 @@
+package de.cuioss.portal.ui.runtime.application.view;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.HTTP_HEADER_BASE;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.HTTP_HEADER_ENABLED;
+import static de.cuioss.tools.string.MoreStrings.isEmpty;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.stream.Collectors;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.event.Observes;
+import javax.inject.Inject;
+import javax.inject.Provider;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.jsf.api.application.navigation.NavigationUtils;
+import de.cuioss.jsf.api.application.view.matcher.EmptyViewMatcher;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcher;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcherImpl;
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.jsf.api.common.view.ViewDescriptorImpl;
+import de.cuioss.portal.configuration.PortalConfigurationChangeEvent;
+import de.cuioss.portal.configuration.PortalConfigurationKeys;
+import de.cuioss.portal.configuration.initializer.ApplicationInitializer;
+import de.cuioss.portal.configuration.initializer.PortalInitializer;
+import de.cuioss.portal.configuration.types.ConfigAsFilteredMap;
+import de.cuioss.portal.core.listener.literal.ServletInitialized;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.tools.string.MoreStrings;
+import de.cuioss.tools.string.Splitter;
+
+/**
+ * Allow setting of custom http headers via configuration.
+ *
+ * @author Matthias Walliczek
+ */
+@ApplicationScoped
+@PortalInitializer
+public class HttpHeaderFilterImpl implements ApplicationInitializer {
+
+ private static final CuiLogger log = new CuiLogger(HttpHeaderFilterImpl.class);
+
+ private static final String INVALID_KEY = "Portal-128: Invalid configuration key '{}'";
+
+ private static final String INVALID_VALUE = "Portal-129: Invalid configuration value '{}' for key '{}'";
+
+ @Inject
+ @ConfigAsFilteredMap(startsWith = HTTP_HEADER_BASE, stripPrefix = true)
+ private Provider> headerMapProvider;
+
+ @Inject
+ @ConfigProperty(name = HTTP_HEADER_ENABLED, defaultValue = "true")
+ private Boolean enabled;
+
+ private List headerList;
+
+ @Inject
+ private Provider requestProvider;
+
+ @Override
+ public void initialize() {
+
+ headerList = Collections.emptyList();
+
+ if (Boolean.FALSE.equals(enabled)) {
+ return;
+ }
+ final var headerConfigurationMap = headerMapProvider.get();
+ final Map headerMap = new HashMap<>(0);
+ for (final Entry entry : headerConfigurationMap.entrySet()) {
+ final var split = Splitter.on('.').splitToList(entry.getKey());
+ if (split.size() != 2) {
+ log.error(INVALID_KEY, entry.getKey());
+ } else {
+ switch (split.get(1).toLowerCase(Locale.ROOT)) {
+ case "enabled":
+ getOrCreateHeader(split.get(0), headerMap)
+ .setEnabled(Boolean.parseBoolean(entry.getValue().trim()));
+ break;
+ case "views":
+ getOrCreateHeader(split.get(0), headerMap).setViewMatcher(createViewMatcher(entry.getValue()));
+ break;
+ case "content":
+ final var header = getOrCreateHeader(split.get(0), headerMap);
+ final var value = entry.getValue().trim();
+ final var splitValues = Splitter.on(": ").splitToList(value);
+ if (splitValues.size() < 2) {
+ log.warn(INVALID_VALUE, entry.getValue(), entry.getKey());
+ break;
+ }
+ header.setKey(splitValues.get(0).trim());
+ header.setValue(value.substring(value.indexOf(": ") + 2));
+ break;
+ default:
+ log.warn(INVALID_KEY, entry.getKey());
+ }
+ }
+ }
+ headerList = headerMap.values().stream().filter(HttpHeader::isEnabled).sorted().collect(Collectors.toList());
+ }
+
+ private static ViewMatcher createViewMatcher(final String value) {
+ if (MoreStrings.isEmpty(value)) {
+ return new EmptyViewMatcher(false);
+ }
+ return new ViewMatcherImpl(Splitter.on(PortalConfigurationKeys.CONTEXT_PARAM_SEPARATOR).trimResults()
+ .omitEmptyStrings().splitToList(value));
+ }
+
+ private static HttpHeader getOrCreateHeader(final String key, final Map headerMap) {
+ return headerMap.computeIfAbsent(key, v -> new HttpHeader());
+ }
+
+ /**
+ * Listener for {@link PortalConfigurationChangeEvent}s.
+ *
+ * @param deltaMap changed configuration map must not be null
+ */
+ void configurationChangeEventListener(
+ @Observes @PortalConfigurationChangeEvent final Map deltaMap) {
+ if (deltaMap.keySet().stream().anyMatch(k -> k.startsWith(HTTP_HEADER_BASE))) {
+ log.debug("Reloading header configuration");
+ initialize();
+ }
+ }
+
+ /**
+ * Add headers if view matches any defined httpHeader rule
+ *
+ * @param response {@link HttpServletResponse} must not be null
+ */
+ public void onCreate(@Observes @ServletInitialized final HttpServletResponse response) {
+ final var currentDescriptor = createViewDescriptor();
+ log.debug("Act on Created HttpServletResponse for view %s", currentDescriptor);
+ for (final HttpHeader entry : headerList) {
+ if (null == entry.getViewMatcher() || entry.getViewMatcher().match(currentDescriptor)) {
+ response.setHeader(entry.getKey(), entry.getValue());
+ }
+ }
+ }
+
+ private ViewDescriptor createViewDescriptor() {
+ final var request = requestProvider.get();
+ final var builder = ViewDescriptorImpl.builder();
+ final var foundId = NavigationUtils.extractRequestUri(request);
+
+ if (!isEmpty(foundId)) {
+ builder.withViewId(foundId);
+ builder.withLogicalViewId(NavigationUtils.handleViewIdSuffix(foundId));
+ }
+ builder.withUrlParameter(NavigationUtils.extractUrlParameters(request));
+
+ return builder.build();
+ }
+
+ @Override
+ public Integer getOrder() {
+ return ORDER_LATE;
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/ViewSuppressedException.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/ViewSuppressedException.java
new file mode 100644
index 0000000..3adc2ad
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/ViewSuppressedException.java
@@ -0,0 +1,23 @@
+package de.cuioss.portal.ui.runtime.application.view;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.ToString;
+
+/**
+ * To be thrown at if a view needs to be supressed.
+ *
+ * @author Oliver Wolff
+ */
+@RequiredArgsConstructor
+@EqualsAndHashCode(callSuper = false)
+@ToString(callSuper = false)
+public class ViewSuppressedException extends RuntimeException {
+
+ private static final long serialVersionUID = 7490217437815485262L;
+
+ @Getter
+ private final ViewDescriptor suppressedViewDescriptor;
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/ViewTransientManagerBean.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/ViewTransientManagerBean.java
new file mode 100644
index 0000000..bd8f71a
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/ViewTransientManagerBean.java
@@ -0,0 +1,56 @@
+package de.cuioss.portal.ui.runtime.application.view;
+
+import java.io.Serializable;
+
+import javax.annotation.PostConstruct;
+import javax.enterprise.context.RequestScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.ui.api.ui.context.CuiCurrentView;
+import de.cuioss.portal.ui.runtime.application.configuration.ViewConfiguration;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * Managed bean bridging the view with instances of
+ *
+ * @author Oliver Wolff
+ */
+@Named(ViewTransientManagerBean.BEAN_NAME)
+@RequestScoped
+@EqualsAndHashCode(of = "transientView", doNotUseGetters = true)
+@ToString(of = "transientView", doNotUseGetters = true)
+public class ViewTransientManagerBean implements Serializable {
+
+ /**
+ * Bean name for looking up instances.
+ */
+ static final String BEAN_NAME = "viewTransientManager";
+
+ private static final long serialVersionUID = -8225392922526412945L;
+
+ @Getter
+ private boolean transientView = false;
+
+ @Inject
+ private ViewConfiguration viewConfiguration;
+
+ @Inject
+ @CuiCurrentView
+ private Provider currentViewProvider;
+
+ /**
+ * Initializes the bean. See class documentation for expected result.
+ */
+ @PostConstruct
+ public void initBean() {
+ final var viewDescriptor = currentViewProvider.get();
+ if (viewDescriptor.isViewDefined()) {
+ transientView = viewConfiguration.getTransientViewMatcher().match(viewDescriptor);
+ }
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/matcher/ViewMatcherProducer.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/matcher/ViewMatcherProducer.java
new file mode 100644
index 0000000..268a13a
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/matcher/ViewMatcherProducer.java
@@ -0,0 +1,39 @@
+package de.cuioss.portal.ui.runtime.application.view.matcher;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.enterprise.context.Dependent;
+import javax.enterprise.inject.Produces;
+import javax.enterprise.inject.spi.InjectionPoint;
+
+import de.cuioss.jsf.api.application.view.matcher.EmptyViewMatcher;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcher;
+import de.cuioss.jsf.api.application.view.matcher.ViewMatcherImpl;
+import de.cuioss.portal.configuration.util.ConfigurationHelper;
+import de.cuioss.portal.ui.api.configuration.types.ConfigAsViewMatcher;
+import de.cuioss.tools.string.MoreStrings;
+import de.cuioss.tools.string.Splitter;
+
+/**
+ * Provides specific producer methods for elements not covered by the standard
+ * configuration converter
+ *
+ * @author Oliver Wolff
+ */
+@ApplicationScoped
+public class ViewMatcherProducer {
+
+ @Produces
+ @Dependent
+ @ConfigAsViewMatcher(name = "unused")
+ ViewMatcher produceViewMatcher(final InjectionPoint injectionPoint) {
+ final var metaData = ConfigurationHelper.resolveAnnotation(injectionPoint, ConfigAsViewMatcher.class)
+ .orElseThrow(() -> new IllegalStateException("Type must provide annotation ConfigAsViewMatcher"));
+ final var configuredValue = ConfigurationHelper.resolveConfigProperty(metaData.name()).orElse(null);
+ if (MoreStrings.isEmpty(configuredValue)) {
+ return new EmptyViewMatcher(false);
+ }
+ return new ViewMatcherImpl(
+ Splitter.on(metaData.separator()).trimResults().omitEmptyStrings().splitToList(configuredValue));
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/package-info.java
new file mode 100644
index 0000000..f746dfe
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/application/view/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Provides classes dealing with view specific aspects.
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.application.view;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/ClientWindowManager.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/ClientWindowManager.java
new file mode 100644
index 0000000..0a9c0b0
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/ClientWindowManager.java
@@ -0,0 +1,65 @@
+package de.cuioss.portal.ui.runtime.common;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_SESSION_MAX_INACTIVE_INTERVAL;
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.PORTAL_SESSION_TIMEOUT;
+
+import java.io.Serializable;
+
+import javax.enterprise.context.SessionScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+import de.cuioss.portal.ui.runtime.application.view.ViewTransientManagerBean;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+
+/**
+ * Session bean to control over timeout.
+ *
+ * @author Oliver Wolff
+ */
+@Named(ClientWindowManager.BEAN_NAME)
+@SessionScoped
+@EqualsAndHashCode(of = "maxInactiveInterval", doNotUseGetters = true)
+@ToString(of = "maxInactiveInterval", doNotUseGetters = true)
+public class ClientWindowManager implements Serializable {
+
+ /**
+ * Bean name for looking up instances using EL.
+ */
+ public static final String BEAN_NAME = "clientWindowManager";
+
+ private static final long serialVersionUID = 8603571267932838043L;
+
+ @Inject
+ @ConfigProperty(name = PORTAL_SESSION_MAX_INACTIVE_INTERVAL)
+ private Integer maxInactiveInterval;
+
+ @Inject
+ @ConfigProperty(name = PORTAL_SESSION_TIMEOUT)
+ private Integer sessionTimeout;
+
+ @Inject
+ private Provider viewTransientManagerProvider;
+
+ /**
+ * @return boolean indicating whether to render the timeout-form
+ */
+ public boolean isRenderTimeoutForm() {
+ return !viewTransientManagerProvider.get().isTransientView() && 0 != getMaxInactiveInterval();
+ }
+
+ /**
+ * @return the interval to be used for determining after which time the
+ * corresponding window should show the timeout-popup
+ */
+ public int getMaxInactiveInterval() {
+ if (maxInactiveInterval > -1) {
+ return maxInactiveInterval;
+ }
+ return sessionTimeout;
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/ViewCacheManager.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/ViewCacheManager.java
new file mode 100644
index 0000000..7e36af1
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/ViewCacheManager.java
@@ -0,0 +1,80 @@
+package de.cuioss.portal.ui.runtime.common;
+
+import static de.cuioss.portal.configuration.PortalConfigurationKeys.ENABLE_CACHE;
+
+import java.io.Serializable;
+import java.util.Locale;
+
+import javax.enterprise.context.SessionScoped;
+import javax.enterprise.event.Observes;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+import org.omnifaces.util.cache.CacheFactory;
+
+import de.cuioss.portal.authentication.AuthenticatedUserInfo;
+import de.cuioss.portal.authentication.UserChangeEvent;
+import de.cuioss.portal.ui.api.events.PageRefreshEvent;
+import de.cuioss.portal.ui.api.locale.LocaleChangeEvent;
+import lombok.ToString;
+
+/**
+ * To manage the disabled property of o:cache for the header in root.xhtml and
+ * reset the cache if needed.
+ */
+@SessionScoped
+@Named
+@ToString(of = "enabled")
+public class ViewCacheManager implements Serializable {
+
+ private static final long serialVersionUID = -7261263947597749229L;
+
+ @Inject
+ @ConfigProperty(name = ENABLE_CACHE)
+ private boolean enabled;
+
+ /**
+ * @return boolean indicating whether the cache is disabled by configuration
+ */
+ public boolean isDisabled() {
+ return !enabled;
+ }
+
+ @Inject
+ private Provider contextProvider;
+
+ /**
+ * Reset the cache when the authenticated user was changed during the session
+ *
+ * @param newUserInfo ignored
+ */
+ void actOnUserChangeEvent(@Observes @UserChangeEvent final AuthenticatedUserInfo newUserInfo) {
+ resetHeaderCache();
+ }
+
+ /**
+ * Reset the cache when the locale was changed during the session
+ *
+ * @param newLocale ignored
+ */
+ void actOnLocaleChangeEvent(@Observes @LocaleChangeEvent final Locale newLocale) {
+ resetHeaderCache();
+ }
+
+ /**
+ * Reset the cache when the page was reloaded (e.g. F5 or reload button).
+ *
+ * @param pageRefreshEvent ignored
+ */
+ void actOnPageRefreshEvent(@Observes final PageRefreshEvent pageRefreshEvent) {
+ resetHeaderCache();
+ }
+
+ private void resetHeaderCache() {
+ CacheFactory.getCache(contextProvider.get(), "session").remove("header");
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/package-info.java
new file mode 100644
index 0000000..f6dc154
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/common/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Provides common structures, like
+ * {@link de.cuioss.portal.authentication.AuthenticatedUserInfo}
+ *
+ * @author Oliver Wolff
+ */
+package de.cuioss.portal.ui.runtime.common;
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/FallBackExceptionHandler.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/FallBackExceptionHandler.java
new file mode 100644
index 0000000..b9ece7d
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/FallBackExceptionHandler.java
@@ -0,0 +1,144 @@
+package de.cuioss.portal.ui.runtime.exception;
+
+import java.io.Serializable;
+import java.util.Optional;
+import java.util.UUID;
+
+import javax.enterprise.context.RequestScoped;
+import javax.faces.application.NavigationHandler;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Provider;
+
+import org.apache.deltaspike.core.api.exception.control.ExceptionHandler;
+import org.apache.deltaspike.core.api.exception.control.Handles;
+import org.apache.deltaspike.core.api.exception.control.event.ExceptionEvent;
+
+import de.cuioss.jsf.api.application.navigation.NavigationUtils;
+import de.cuioss.jsf.api.common.util.CheckContextState;
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.configuration.application.PortalProjectStageProducer;
+import de.cuioss.portal.core.storage.MapStorage;
+import de.cuioss.portal.core.storage.PortalSessionStorage;
+import de.cuioss.portal.ui.api.exceptions.DefaultErrorMessage;
+import de.cuioss.portal.ui.api.ui.context.CuiCurrentView;
+import de.cuioss.portal.ui.api.ui.context.CuiNavigationHandler;
+import de.cuioss.portal.ui.api.ui.pages.ErrorPage;
+import de.cuioss.tools.logging.CuiLogger;
+import de.cuioss.uimodel.application.CuiProjectStage;
+
+/**
+ * Defines the last line of defense, saying displaying the error page with the
+ * general message An exception occurred. "Should" not happen often. Every time
+ * this happens, a bug should be filed accordingly. This handler is only active
+ * if the {@link ProjectStage} is {@link ProjectStage#Production}. on
+ * {@link ProjectStage#Development} the default jsf error page will be shown. In
+ * case there is no view related to the exception, only logging will occur.
+ *
+ * @author Oliver Wolff
+ */
+@ExceptionHandler
+@Named
+@RequestScoped
+public class FallBackExceptionHandler implements Serializable {
+
+ private static final CuiLogger log = new CuiLogger(FallBackExceptionHandler.class);
+
+ private static final long serialVersionUID = -1197300817644970750L;
+
+ private static final String SYSTEM_ERROR = "System error";
+
+ private static final String UNSPECIFIED_EXCEPTION = "Portal-111: An unspecified exception has been caught and handled by fallback strategy while trying to access view ";
+
+ private static final String UNSPECIFIED_EXCEPTION_SUFFIX = ", errorTicket=";
+
+ private static final String UNSPECIFIED_EXCEPTION_WITHOUT_VIEW = "Portal-112: An unspecified exception has been caught and handled by fallback strategy";
+
+ private static final String EXCEPTION_HANDLING_FAILED_DUE_TO_INVALID_SESSION = "Portal-113: Detected an invalidated session, trying to recreate, reason={}";
+
+ private static final String EXCEPTION_HANDLING_FAILED_DUE_TO_INVALID_NEW_SESSION = "Portal-502: Unable to recreate session, reason={}";
+
+ private static final String PORTAL_130_ERROR_ON_ERROR_PAGE = "Portal-130: Previous error occurs on error page. This will lead to damaged output and is a sign of corrupted deployment";
+
+ @Inject
+ @PortalSessionStorage
+ private Provider> sessionStorageProvider;
+
+ @Inject
+ @CuiNavigationHandler
+ private NavigationHandler navigationHandler;
+
+ @Inject
+ @CuiCurrentView
+ private ViewDescriptor currentView;
+
+ @Inject
+ @PortalProjectStageProducer
+ private CuiProjectStage projectStage;
+
+ /**
+ * Actual handler, see class documentation for details.
+ *
+ * @param evt to be handled
+ */
+ void handleFallBack(@Handles final ExceptionEvent evt) {
+ if (projectStage.isDevelopment()) {
+ log.debug("Fallback exception handling omitted due to development stage.");
+ evt.throwOriginal();
+ return;
+ }
+
+ final var throwable = evt.getException();
+ final var msg = null != throwable.getMessage() ? throwable.getMessage() : throwable.toString();
+ final var facesContext = FacesContext.getCurrentInstance();
+ if (CheckContextState.isResponseNotComplete(facesContext)
+ && !facesContext.getExternalContext().isResponseCommitted()) {
+ var errorTicket = UUID.randomUUID().toString();
+ log.error(UNSPECIFIED_EXCEPTION + currentView + UNSPECIFIED_EXCEPTION_SUFFIX + errorTicket, throwable);
+ final var errorMessage = new DefaultErrorMessage(SYSTEM_ERROR, errorTicket,
+ throwable.getClass().getCanonicalName() + ": " + msg, "");
+ var sessionStorage = checkSessionStorage(facesContext);
+ // Put message in session scope to access it on error page.
+ sessionStorage.ifPresent(serializableSerializableMapStorage -> DefaultErrorMessage
+ .addErrorMessageToSessionStorage(errorMessage, serializableSerializableMapStorage));
+
+ if (redirectWasNotDoneFromErrorPage(facesContext)) {
+ navigationHandler.handleNavigation(facesContext, null, ErrorPage.OUTCOME);
+ } else {
+ log.error(PORTAL_130_ERROR_ON_ERROR_PAGE);
+ }
+
+ } else {
+ log.error(UNSPECIFIED_EXCEPTION_WITHOUT_VIEW, throwable);
+ }
+ evt.handled();
+ }
+
+ private boolean redirectWasNotDoneFromErrorPage(final FacesContext facesContext) {
+ final var errorPageDescriptor = NavigationUtils.lookUpToViewDescriptorBy(facesContext, ErrorPage.OUTCOME);
+
+ return !errorPageDescriptor.getViewId().equals(currentView.getViewId());
+ }
+
+ private Optional> checkSessionStorage(final FacesContext facesContext) {
+ try {
+ var sessionStorage = sessionStorageProvider.get();
+ sessionStorage.containsKey("testKey");
+ return Optional.of(sessionStorage);
+ } catch (RuntimeException e) {
+ log.warn(EXCEPTION_HANDLING_FAILED_DUE_TO_INVALID_SESSION, e.getMessage());
+ facesContext.getExternalContext().getSession(true);
+ MapStorage sessionStorage;
+ try {
+ sessionStorage = sessionStorageProvider.get();
+ sessionStorage.containsKey("testKey");
+ return Optional.of(sessionStorage);
+ } catch (RuntimeException e1) {
+ log.error(EXCEPTION_HANDLING_FAILED_DUE_TO_INVALID_NEW_SESSION, e1.getMessage());
+ }
+ return Optional.empty();
+ }
+ }
+
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/ViewRelatedExceptionHandler.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/ViewRelatedExceptionHandler.java
new file mode 100644
index 0000000..652d16a
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/ViewRelatedExceptionHandler.java
@@ -0,0 +1,185 @@
+package de.cuioss.portal.ui.runtime.exception;
+
+import java.io.Serializable;
+
+import javax.enterprise.context.RequestScoped;
+import javax.faces.application.NavigationHandler;
+import javax.faces.application.ViewExpiredException;
+import javax.faces.context.FacesContext;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import org.apache.deltaspike.core.api.exception.control.ExceptionHandler;
+import org.apache.deltaspike.core.api.exception.control.Handles;
+import org.apache.deltaspike.core.api.exception.control.event.ExceptionEvent;
+
+import de.cuioss.jsf.api.application.history.HistoryManager;
+import de.cuioss.jsf.api.application.message.MessageProducer;
+import de.cuioss.jsf.api.application.navigation.NavigationUtils;
+import de.cuioss.jsf.api.common.view.ViewDescriptor;
+import de.cuioss.portal.authentication.AuthenticatedUserInfo;
+import de.cuioss.portal.authentication.PortalUser;
+import de.cuioss.portal.ui.api.authentication.UserNotAuthenticatedException;
+import de.cuioss.portal.ui.api.authentication.UserNotAuthorizedException;
+import de.cuioss.portal.ui.api.history.PortalHistoryManager;
+import de.cuioss.portal.ui.api.message.PortalMessageProducer;
+import de.cuioss.portal.ui.api.ui.context.CuiCurrentView;
+import de.cuioss.portal.ui.api.ui.context.CuiNavigationHandler;
+import de.cuioss.portal.ui.api.ui.pages.ErrorPage;
+import de.cuioss.portal.ui.api.ui.pages.HomePage;
+import de.cuioss.portal.ui.api.ui.pages.LoginPage;
+import de.cuioss.portal.ui.api.ui.pages.LogoutPage;
+import de.cuioss.portal.ui.api.view.PortalViewRestrictionManager;
+import de.cuioss.portal.ui.api.view.ViewRestrictionManager;
+import de.cuioss.portal.ui.runtime.application.view.ViewSuppressedException;
+import de.cuioss.tools.logging.CuiLogger;
+
+/**
+ * This {@link ExceptionHandler} provides handler methods for dealing with view
+ * related exceptions, like {@link ViewSuppressedException},
+ * {@link ViewExpiredException}, {@link UserNotAuthenticatedException} and
+ * {@link UserNotAuthorizedException}
+ *
+ * @author Oliver Wolff
+ */
+@ExceptionHandler
+@Named
+@RequestScoped
+public class ViewRelatedExceptionHandler implements Serializable {
+
+ private static final CuiLogger log = new CuiLogger(ViewRelatedExceptionHandler.class);
+
+ /**
+ * Key for message to be displayed on {@link ViewSuppressedException}
+ */
+ public static final String VIEW_SUPPRESSED_KEY = "system.exception.view.suppressed";
+
+ /**
+ * Key for message to be displayed on {@link ViewExpiredException}
+ */
+ public static final String VIEW_EXPIRED_KEY = "system.exception.view.expired";
+
+ /**
+ * Key for message to be displayed on {@link UserNotAuthorizedException}
+ */
+ public static final String VIEW_INSUFFICIENT_PERMISSIONS_KEY = "system.exception.view.insufficient.permissions";
+
+ private static final String PORTAL_103 = "Portal-103: View '{}' requires the roles '{}', but user '{}' only has the roles: '{}'";
+
+ private static final String NAV_LOOP_ERROR_MSG = "Portal-505: The view '{}' is suppressed but is the designated navigation target at the same time."
+ + " This would result in a loop. The error page is displayed therefore instead.";
+
+ private static final long serialVersionUID = 2286427875463095109L;
+
+ @Inject
+ @CuiNavigationHandler
+ private NavigationHandler navigationHandler;
+
+ @Inject
+ private FacesContext facesContext;
+
+ @Inject
+ @PortalMessageProducer
+ private MessageProducer messageProducer;
+
+ @Inject
+ @PortalUser
+ private AuthenticatedUserInfo authenticatedUserInfo;
+
+ @Inject
+ @PortalHistoryManager
+ private HistoryManager historyManager;
+
+ @Inject
+ @CuiCurrentView
+ private ViewDescriptor currentView;
+
+ @Inject
+ @PortalViewRestrictionManager
+ private ViewRestrictionManager viewRestrictionManager;
+
+ /**
+ * Handles {@link ViewSuppressedException}
+ *
+ * @param event to be handled
+ */
+ void handleViewSupressedException(@Handles final ExceptionEvent event) {
+ messageProducer.setGlobalErrorMessage(VIEW_SUPPRESSED_KEY);
+ navigationHandler.handleNavigation(facesContext, null, getFallbackNavigationOutcome(event));
+ event.handled();
+ }
+
+ /**
+ * Handles {@link ViewExpiredException}. In case the user is still authenticated
+ * the previous page will be reloaded and an according message will be
+ * displayed. Otherwise the user will be redirected to the login-page.
+ *
+ * @param event to be handled
+ */
+ void handleViewExpiredException(@Handles final ExceptionEvent event) {
+ if (authenticatedUserInfo.isAuthenticated()) {
+ messageProducer.setGlobalErrorMessage(VIEW_EXPIRED_KEY);
+ historyManager.getCurrentView().redirect(facesContext);
+ } else {
+ navigationHandler.handleNavigation(facesContext, null, LoginPage.OUTCOME);
+ }
+ event.handled();
+
+ }
+
+ /**
+ * Handles {@link UserNotAuthenticatedException}. The current request URI will
+ * be stored with {@link HistoryManager} and the user will be redirected to the
+ * login-page.
+ *
+ * @param event to be handled
+ */
+ void handleUserNotAuthenticatedException(@Handles final ExceptionEvent event) {
+ log.debug("User is not logged in, redirecting to loginPage", event.getException());
+ historyManager.addCurrentUriToHistory(currentView);
+ navigationHandler.handleNavigation(facesContext, null, LoginPage.OUTCOME);
+ event.handled();
+ }
+
+ /**
+ * Handles {@link UserNotAuthorizedException}. The user will be redirected to
+ * the home-page if he has sufficient views, otherwise to the logout-page. In
+ * both cases a corresponding global-error message will be queued for display.
+ *
+ * @param event to be handled
+ */
+ void handleUserNotAuthorizedException(@Handles final ExceptionEvent event) {
+
+ log.warn(PORTAL_103, event.getException().getRequestedView().getLogicalViewId(),
+ event.getException().getRequiredRoles(), authenticatedUserInfo.getDisplayName(),
+ event.getException().getUserRoles());
+
+ messageProducer.setGlobalErrorMessage(VIEW_INSUFFICIENT_PERMISSIONS_KEY);
+ if (viewRestrictionManager.isUserAuthorizedForViewOutcome(HomePage.OUTCOME)) {
+ navigationHandler.handleNavigation(facesContext, null, HomePage.OUTCOME);
+ } else {
+ navigationHandler.handleNavigation(facesContext, null, LogoutPage.OUTCOME);
+ }
+ event.handled();
+ }
+
+ /**
+ * Helper methods that redirects to home or login, depending on authentication
+ * status.
+ */
+ private String getFallbackNavigationOutcome(final ExceptionEvent event) {
+ var outcome = HomePage.OUTCOME;
+
+ if (!authenticatedUserInfo.isAuthenticated()) {
+ outcome = LoginPage.OUTCOME;
+ } else if (null != event.getException() && null != event.getException().getSuppressedViewDescriptor()
+ && null != event.getException().getSuppressedViewDescriptor().getLogicalViewId()
+ && event.getException().getSuppressedViewDescriptor().getLogicalViewId()
+ .equals(NavigationUtils.lookUpToLogicalViewIdBy(facesContext, outcome))) {
+ log.error(NAV_LOOP_ERROR_MSG, event.getException().getSuppressedViewDescriptor().getLogicalViewId());
+ outcome = ErrorPage.OUTCOME;
+ }
+
+ return outcome;
+ }
+}
diff --git a/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/package-info.java b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/package-info.java
new file mode 100644
index 0000000..6fff40e
--- /dev/null
+++ b/modules/portal-ui-runtime/src/main/java/de/cuioss/portal/ui/runtime/exception/package-info.java
@@ -0,0 +1,24 @@
+/**
+ * Provides the deltaspike based exception handler for the portal, dealing with
+ * the following exceptions:
+ *