From e12127f6dd6e832a522fc0411c31cbb3cd7382f8 Mon Sep 17 00:00:00 2001 From: Joern Muehlencord Date: Wed, 26 Feb 2020 23:08:16 +0100 Subject: [PATCH] added validationFailed support --- .../muehlencord/shared/jeeutil/FacesUtil.java | 555 +++++++++--------- 1 file changed, 273 insertions(+), 282 deletions(-) diff --git a/jeeutil/src/main/java/de/muehlencord/shared/jeeutil/FacesUtil.java b/jeeutil/src/main/java/de/muehlencord/shared/jeeutil/FacesUtil.java index 1417ae6..c24022d 100644 --- a/jeeutil/src/main/java/de/muehlencord/shared/jeeutil/FacesUtil.java +++ b/jeeutil/src/main/java/de/muehlencord/shared/jeeutil/FacesUtil.java @@ -26,313 +26,304 @@ import javax.faces.context.FacesContext; */ public abstract class FacesUtil { - private FacesUtil() { - // hide constructor of abstract class - } + private FacesUtil() { + // hide constructor of abstract class + } - /** - * returns true, if the current request is in the request phase. False - * otherwise. - * - * @return true, if the current request is in the request phase. False - * otherwise. - */ - public static boolean isRenderRequest() { - return !FacesContext.getCurrentInstance().getRenderResponse(); - } + /** + * returns true, if the current request is in the request phase. False otherwise. + * + * @return true, if the current request is in the request phase. False otherwise. + */ + public static boolean isRenderRequest() { + return !FacesContext.getCurrentInstance().getRenderResponse(); + } - /** - * returns true, if the current request is in the response phase. True - * otherwise. - * - * @return true, if the current request is in the response phase. True - * otherwise. - */ - public static boolean isRenderResponse() { - return FacesContext.getCurrentInstance().getRenderResponse(); - } + /** + * returns true, if the current request is in the response phase. True otherwise. + * + * @return true, if the current request is in the response phase. True otherwise. + */ + public static boolean isRenderResponse() { + return FacesContext.getCurrentInstance().getRenderResponse(); + } - /** - * Adds the given message to the "messages" object - * - * @param message the message to display - * @deprecated use addMessage(clientId, message) or - * addGlobalMessage(message) instead - */ - @Deprecated - public static void addMessage(FacesMessage message) { - FacesContext.getCurrentInstance().addMessage("messages", message); - } + /** + * Adds the given message to the "messages" object + * + * @param message the message to display + * @deprecated use addMessage(clientId, message) or addGlobalMessage(message) instead + */ + @Deprecated + public static void addMessage(FacesMessage message) { + FacesContext.getCurrentInstance().addMessage("messages", message); + } - /** - * Adds the given message to the object with the id specified by clientId. - * - * @param clientId the id of the object to bind the message to. - * @param message the message to display - */ - public static void addMessage(String clientId, FacesMessage message) { - FacesContext.getCurrentInstance().addMessage(clientId, message); - } + /** + * Adds the given message to the object with the id specified by clientId. + * + * @param clientId the id of the object to bind the message to. + * @param message the message to display + */ + public static void addMessage(String clientId, FacesMessage message) { + FacesContext.getCurrentInstance().addMessage(clientId, message); + } - /** - * Adds the given message as global message. - * - * @param message the message to display - */ - public static void addGlobalMessage(FacesMessage message) { - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message. + * + * @param message the message to display + */ + public static void addGlobalMessage(FacesMessage message) { + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message as global message with severity "Information". - * - * @param summary the message to add - */ - public static void addGlobalInfoMessage(String summary) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, null); - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message with severity "Information". + * + * @param summary the message to add + */ + public static void addGlobalInfoMessage(String summary) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, null); + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message as global message with severity "Information". - * - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addGlobalInfoMessage(String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, detail); - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message with severity "Information". + * + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addGlobalInfoMessage(String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, detail); + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message as global message with severity "Warning". - * - * @param summary the summary message to display - */ - public static void addGlobalWarningMessage(String summary) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, null); - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message with severity "Warning". + * + * @param summary the summary message to display + */ + public static void addGlobalWarningMessage(String summary) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, null); + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message as global message with severity "Warning". - * - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addGlobalWarningMessage(String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail); - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message with severity "Warning". + * + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addGlobalWarningMessage(String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail); + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message as global message with severity "Error". - * - * @param summary the message to display - */ - public static void addGlobalErrorMessage(String summary) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, null); - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message with severity "Error". + * + * @param summary the message to display + */ + public static void addGlobalErrorMessage(String summary) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, null); + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message as global message with severity "Error". - * - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addGlobalErrorMessage(String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, detail); - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message with severity "Error". + * + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addGlobalErrorMessage(String summary, String detail) { + addGlobalErrorMessage(summary, detail, false); + } - /** - * Adds the given message as global message with severity "Fatal". - * - * @param summary the message to display - */ - public static void addGlobalFatalMessage(String summary) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, null); - FacesContext.getCurrentInstance().addMessage(null, message); + /** + * Adds the given message as global message with severity "Error". + * + * @param summary the summary message to display + * @param detail the detailed message to display + * @param valiationFailed if set to true, the method calls currentInstance().validationFailed() to invalidate the current request. + */ + public static void addGlobalErrorMessage(String summary, String detail, boolean valiationFailed) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, detail); + FacesContext.getCurrentInstance().addMessage(null, message); + if (valiationFailed) { + FacesContext.getCurrentInstance().validationFailed(); } + } - /** - * Adds the given message as global message with severity "Fatal". - * - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addGlobalFatalMessage(String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail); - FacesContext.getCurrentInstance().addMessage(null, message); - } + /** + * Adds the given message as global message with severity "Fatal". + * + * @param summary the message to display + */ + public static void addGlobalFatalMessage(String summary) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, null); + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message to the object with id "messages" and severity - * "Information". - * - * @param summary the message to display - * @deprecated use addInfoMessage(clientId, summary) or addGlobalInfoMessage - * instead - */ - @Deprecated - public static void addInfoMessage(String summary) { - addInfoMessage(summary, ""); - } + /** + * Adds the given message as global message with severity "Fatal". + * + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addGlobalFatalMessage(String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail); + FacesContext.getCurrentInstance().addMessage(null, message); + } - /** - * Adds the given message to the object with id "messages" and severity - * "Information". - * - * @param summary the summary message to display - * @param detail the detailed message to display - * @deprecated use addInfoMessage (clientId, summary, detail) or - * addGlobalInfoMessage(summary, detail) instead - */ - @Deprecated - public static void addInfoMessage(String summary, String detail) { - addInfoMessage("messages", summary, detail); - } + /** + * Adds the given message to the object with id "messages" and severity "Information". + * + * @param summary the message to display + * @deprecated use addInfoMessage(clientId, summary) or addGlobalInfoMessage instead + */ + @Deprecated + public static void addInfoMessage(String summary) { + addInfoMessage(summary, ""); + } - /** - * Adds the given message with severity "Info" to the object with the id - * specified by clientId. - * - * @param clientId the id of the object to bind the message to. - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addInfoMessage(String clientId, String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, detail); - FacesContext.getCurrentInstance().addMessage(clientId, message); - } + /** + * Adds the given message to the object with id "messages" and severity "Information". + * + * @param summary the summary message to display + * @param detail the detailed message to display + * @deprecated use addInfoMessage (clientId, summary, detail) or addGlobalInfoMessage(summary, detail) instead + */ + @Deprecated + public static void addInfoMessage(String summary, String detail) { + addInfoMessage("messages", summary, detail); + } - /** - * Adds the given message to the object with id "warnings" and severity - * "Error". - * - * @param summary the message to display - * @deprecated use addErrorMessage (clientId, summary, detail) or - * addGlobalErrorMessage(summary, detail) instead - */ - @Deprecated - public static void addErrorMessage(String summary) { - addErrorMessage("warnings", summary, ""); - } + /** + * Adds the given message with severity "Info" to the object with the id specified by clientId. + * + * @param clientId the id of the object to bind the message to. + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addInfoMessage(String clientId, String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, detail); + FacesContext.getCurrentInstance().addMessage(clientId, message); + } - /** - * Adds the given message to the object with id "warnings" and severity - * "Error". - * - * - * @param summary the summary message to display - * @param detail the detailed message to display - * @deprecated use addErrorMessage (clientId, summary, detail) or - * addGlobalErrorMessage(summary, detail) instead - */ - @Deprecated - public static void addErrorMessage(String summary, String detail) { - addErrorMessage("warnings", summary, detail); - } + /** + * Adds the given message to the object with id "warnings" and severity "Error". + * + * @param summary the message to display + * @deprecated use addErrorMessage (clientId, summary, detail) or addGlobalErrorMessage(summary, detail) instead + */ + @Deprecated + public static void addErrorMessage(String summary) { + addErrorMessage("warnings", summary, ""); + } - /** - * Adds the given message with severity "Error" to the object with the id - * specified by clientId. - * - * @param clientId the id of the object to bind the message to. - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addErrorMessage(String clientId, String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, detail); - FacesContext.getCurrentInstance().addMessage(clientId, message); - } + /** + * Adds the given message to the object with id "warnings" and severity "Error". + * + * + * @param summary the summary message to display + * @param detail the detailed message to display + * @deprecated use addErrorMessage (clientId, summary, detail) or addGlobalErrorMessage(summary, detail) instead + */ + @Deprecated + public static void addErrorMessage(String summary, String detail) { + addErrorMessage("warnings", summary, detail); + } - /** - * Adds the given message to the object with id "warnings" and severity - * "Warning". - * - * @param summary the message to display - * @deprecated use addWarningMessage (clientId, summary, detail) or - * addGlobalWarningMessage(summary, detail) instead - */ - @Deprecated - public static void addWarningMessage(String summary) { - addWarningMessage("warnings", summary, ""); - } + /** + * Adds the given message with severity "Error" to the object with the id specified by clientId. + * + * @param clientId the id of the object to bind the message to. + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addErrorMessage(String clientId, String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, detail); + FacesContext.getCurrentInstance().addMessage(clientId, message); + } - /** - * Adds the given message to the object with id "warnings" and severity - * "Warning". - * - * @param summary the summary message to display - * @param detail the detailed message to display - * @deprecated use addWarningMessage (clientId, summary, detail) or - * addGlobalWarningMessage(summary, detail) instead - */ - @Deprecated - public static void addWarningMessage(String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail); - FacesContext.getCurrentInstance().addMessage("warnings", message); - } + /** + * Adds the given message to the object with id "warnings" and severity "Warning". + * + * @param summary the message to display + * @deprecated use addWarningMessage (clientId, summary, detail) or addGlobalWarningMessage(summary, detail) instead + */ + @Deprecated + public static void addWarningMessage(String summary) { + addWarningMessage("warnings", summary, ""); + } - /** - * Adds the given message with severity "Warning" to the object with the id - * specified by clientId. - * - * @param clientId the id of the object to bind the message to. - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addWarningMessage(String clientId, String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail); - FacesContext.getCurrentInstance().addMessage(clientId, message); - } + /** + * Adds the given message to the object with id "warnings" and severity "Warning". + * + * @param summary the summary message to display + * @param detail the detailed message to display + * @deprecated use addWarningMessage (clientId, summary, detail) or addGlobalWarningMessage(summary, detail) instead + */ + @Deprecated + public static void addWarningMessage(String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail); + FacesContext.getCurrentInstance().addMessage("warnings", message); + } - /** - * Adds the given message to the object with id "warnings" and severity - * "Fatal". - * - * @param summary the summary message to display - * @param detail the detailed message to display - * @deprecated use addFatalMessage (clientId, summary, detail) or - * addGlobalFatalMessage(summary, detail) instead - */ - @Deprecated - public static void addFatalMessage(String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail); - FacesContext.getCurrentInstance().addMessage("warnings", message); - } + /** + * Adds the given message with severity "Warning" to the object with the id specified by clientId. + * + * @param clientId the id of the object to bind the message to. + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addWarningMessage(String clientId, String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail); + FacesContext.getCurrentInstance().addMessage(clientId, message); + } - /** - * Adds the given message with severity "Fatal" to the object with the id - * specified by clientId. - * - * @param clientId the id of the object to bind the message to. - * @param summary the summary message to display - * @param detail the detailed message to display - */ - public static void addFatalMessage(String clientId, String summary, String detail) { - FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail); - FacesContext.getCurrentInstance().addMessage(clientId, message); - } + /** + * Adds the given message to the object with id "warnings" and severity "Fatal". + * + * @param summary the summary message to display + * @param detail the detailed message to display + * @deprecated use addFatalMessage (clientId, summary, detail) or addGlobalFatalMessage(summary, detail) instead + */ + @Deprecated + public static void addFatalMessage(String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail); + FacesContext.getCurrentInstance().addMessage("warnings", message); + } - /** - * - * @param messages the messages to add - */ - public static void addMessages(List messages) { - messages.stream().map(msg -> msg.getFacesMessage()).forEach(msg -> { - if (msg.getSeverity() == FacesMessage.SEVERITY_ERROR) { - FacesUtil.addGlobalErrorMessage(msg.getSummary(), msg.getDetail()); - } else if (msg.getSeverity() == FacesMessage.SEVERITY_WARN) { - FacesUtil.addGlobalWarningMessage(msg.getSummary(), msg.getDetail()); - } else if (msg.getSeverity() == FacesMessage.SEVERITY_FATAL) { - FacesUtil.addGlobalFatalMessage(msg.getSummary(), msg.getDetail()); - } else { - FacesUtil.addGlobalInfoMessage(msg.getSummary(), msg.getDetail()); - } - }); - } + /** + * Adds the given message with severity "Fatal" to the object with the id specified by clientId. + * + * @param clientId the id of the object to bind the message to. + * @param summary the summary message to display + * @param detail the detailed message to display + */ + public static void addFatalMessage(String clientId, String summary, String detail) { + FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail); + FacesContext.getCurrentInstance().addMessage(clientId, message); + } + + /** + * + * @param messages the messages to add + */ + public static void addMessages(List messages) { + messages.stream().map(msg -> msg.getFacesMessage()).forEach(msg -> { + if (msg.getSeverity() == FacesMessage.SEVERITY_ERROR) { + FacesUtil.addGlobalErrorMessage(msg.getSummary(), msg.getDetail()); + } else if (msg.getSeverity() == FacesMessage.SEVERITY_WARN) { + FacesUtil.addGlobalWarningMessage(msg.getSummary(), msg.getDetail()); + } else if (msg.getSeverity() == FacesMessage.SEVERITY_FATAL) { + FacesUtil.addGlobalFatalMessage(msg.getSummary(), msg.getDetail()); + } else { + FacesUtil.addGlobalInfoMessage(msg.getSummary(), msg.getDetail()); + } + }); + } }