elstar IT

I was triggered by the blog entry of Michael Smith about BootAlert share my code I am using currently in some XPages apps.

Back in august 2014 I wrote already a blog about adding Growl messages to my XPages. There is also described which Bootstrap Growl library I am using.

It was easy to implement, but lets take it a step further.
The Multi Growl PhaseListner will intercept all the message

To accomplish it I added a method to my Utility class, who add a message to the FacesContext

public static void addMessage(Severity type, String msg){

    FacesContext.getCurrentInstance().addMessage(null, new javax.faces.application.FacesMessage(type, msg, ""));

}

In my Controller classes, I added one line of code to add the specific message to the FacesContext.

JSFUtil.addMessage(FacesMessage.SEVERITY_INFO, "Configuration has been updated");

The heavy lifting will be done by the phaselistner. Here is the class

package nl.elstarit.phaseListener;

import java.util.Iterator;

import javax.faces.application.FacesMessage;
import javax.faces.context.FacesContext;
import javax.faces.event.PhaseEvent;
import javax.faces.event.PhaseId;
import javax.faces.event.PhaseListener;

import nl.elstarit.utils.JSFUtil;

import com.ibm.commons.util.StringUtil;
import com.ibm.xsp.util.JSUtil;

/*
 * Enables messages to be rendered on different pages from which they were set.
 * To produce this behaviour, this class acts as a <code>PhaseListener</code>.
 * 
 * This is performed by moving the FacesMessage objects:
 * <li>After each phase where messages may be added, this moves the messages
 * from the page-scoped FacesContext to the session-scoped session map.
 * <li>Before messages are rendered, this moves the messages from the
 * session-scoped session map back to the pag e-scoped FacesContext.
 *
 * Only messages that are not associated with a particular component are ever
 * moved. These are the only messages that can be rendered on a page that is
 * different from where they originated. * To enable this behaviour, add a
 * <code>lifecycle</code> block to your faces-config.xml file. That block
 * should contain a single <code>phase-listener</code> block containing the
 * fully-qualified classname of this file.
 *
 * @author <a href="mailto:jesse@odel.on.ca">Jesse Wilson</a>
 *
 * @version This version have the bug corrected: The bug was:
 * In the same page, the FacesMessage was displayed many times,
 * with this patch, only different messages is added into new context.
 */
public class MultiGrowlMessages implements PhaseListener {

	private static final long serialVersionUID = 3328743500652081238L;

	/** a name to save messages in the session under */
	//private static final String sessionToken = "MULTI_GROWL_MESSAGES_SUPPORT";

	/**
	 * Return the identifier of the request processing phase during which this
	 * listener is interested in processing PhaseEvent events.
	 */
	public PhaseId getPhaseId() {
		return PhaseId.ANY_PHASE;
	}

	/**
	 * Handle a notification that the processing for a particular phase of the
	 * request processing lifecycle is about to begin.
	 */
	public void beforePhase(PhaseEvent event) {
		if (event.getPhaseId() == PhaseId.RENDER_RESPONSE) {

		}
	}

	/**
	 * Handle a notification that the processing for a particular phase has just
	 * been completed.
	 */
	public void afterPhase(PhaseEvent event) {
		if (event.getPhaseId() == PhaseId.APPLY_REQUEST_VALUES
				|| event.getPhaseId() == PhaseId.PROCESS_VALIDATIONS
				|| event.getPhaseId() == PhaseId.INVOKE_APPLICATION) {
			FacesContext facesContext = event.getFacesContext();
			handleMessages(facesContext);
		}
	}
	
	@SuppressWarnings("unchecked")
	    public static void handleMessages(FacesContext facesContext) {
        	    for (Iterator i = facesContext.getMessages(); i.hasNext();) {
        	        FacesMessage message = (FacesMessage) i.next();
        	        handleMessage(message);
                        i.remove();
        	    }
	    }
	
	public static void handleMessage(final FacesMessage message) {
	        String type = null;
	        if(FacesMessage.SEVERITY_ERROR.equals(message.getSeverity())) {
	            type = "danger";
	        } else if(FacesMessage.SEVERITY_FATAL.equals(message.getSeverity())) {
	            type = "danger";
	        } else if(FacesMessage.SEVERITY_INFO.equals(message.getSeverity())) {
	            type = "info";
	        } else if(FacesMessage.SEVERITY_WARN.equals(message.getSeverity())) {
	            type = "warning";
	        } else {
	            type = "success";
	        }

	        createGrowlMessage(message.getSummary(), type);
	    }
	
	public static void createGrowlMessage(final String message, final String type) {
	        StringBuilder result = new StringBuilder();
	        result.append("$.growl(\n");
	        
	        if(StringUtil.isNotEmpty(message)) {          
	            JSUtil.addString(result, message);
	        }
	        
	        if(StringUtil.isNotEmpty(type)) {
	            result.append(",{");
	            result.append("\ttype: ");
	            JSUtil.addString(result, type);
	            result.append("}");
	        }
	        
	        result.append(")\n");
	     
	        JSFUtil.getViewRoot().postScript(result.toString());
	    }
}

To use the phaselistner it needs to be registered at the Faces-Config.xml

<lifecycle>
    <phase-listener>nl.elstarit.phaseListener.MultiGrowlMessages</phase-listener>
  </lifecycle>

Happy coding……..