001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 * $Id: FacesContextMessageHelper.java 19451 2007-05-27 09:03:18Z sfermigier $
018 */
019
020package org.nuxeo.ecm.webapp.helpers;
021
022import javax.faces.application.FacesMessage;
023import javax.faces.context.FacesContext;
024
025/**
026 * Helper to generate JSF context messages.
027 * <p>
028 * Use &lt;h:messages/&gt; to display them client side.
029 *
030 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
031 */
032@Deprecated
033// TODO: remove (not used)
034public final class FacesContextMessageHelper {
035
036    // Utility class
037    private FacesContextMessageHelper() {
038    }
039
040    /**
041     * Returns a FacesMessage instance.
042     *
043     * @param content the actual message content.
044     * @return a FacesMessage instance
045     */
046    public static FacesMessage getFacesMessageFor(String content) {
047        return new FacesMessage(content);
048    }
049
050    /**
051     * Appends a FacesMessage to the set of messages associated with the specified client identifier, if clientId is not
052     * null.
053     *
054     * @param fctx the FacesContext
055     * @param content the actual message content.
056     */
057    public static void addMessageToFctx(FacesContext fctx, String clientId, String content) {
058        if (fctx != null && clientId != null) {
059            fctx.addMessage(clientId, getFacesMessageFor(content));
060        }
061    }
062
063}