Glassfish example source code file (HelpHandlers.java)

This example Glassfish source code file (HelpHandlers.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

classloader, consolepluginservice, consolepluginservice, handler, handlerinput, handlerinput, handleroutput, helphandlers, locale, locale, string, string, util

The Glassfish HelpHandlers.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.admingui.common.help;

import com.sun.jsftemplating.annotation.Handler;
import com.sun.jsftemplating.annotation.HandlerInput;
import com.sun.jsftemplating.annotation.HandlerOutput;
import com.sun.jsftemplating.layout.descriptors.handler.HandlerContext;

import org.glassfish.admingui.common.handlers.PluginHandlers;
import org.glassfish.admingui.plugin.ConsolePluginService;
import org.glassfish.admingui.plugin.Index;
import org.glassfish.admingui.plugin.IntegrationPoint;
import org.glassfish.admingui.plugin.TOC;

import java.util.Locale;


/**
 *  <p>	These handlers help make the help system work.

 *
 *  @author Ken Paulsen (ken.paulsen@sun.com)
 */
public class HelpHandlers {

    /**
     *	<p> This handler provides access to {@link IntegrationPoint}s for the
     *	    requested key.</p>
     *
     *	@param	handlerCtx	The <code>HandlerContext.
     */
    @Handler(id="getHelpTOC",
    	input={
            @HandlerInput(name="locale", type=Locale.class)},
        output={
            @HandlerOutput(name="toc", type=TOC.class)})
    public static void getHelpTOC(HandlerContext handlerCtx) {
	// Get the desired Locale and the ConsolePluginService...
	Locale locale = (Locale) handlerCtx.getInputValue("locale");
	ConsolePluginService cps = PluginHandlers.getPluginService(
		handlerCtx.getFacesContext());

	// Determine the correct locale for the path...
	String localePath = getHelpLocalePath(locale, cps);

	handlerCtx.setOutputValue("toc", cps.getHelpTOC(localePath));
    }

    /**
     *	<p> This handler provides access to {@link IntegrationPoint}s for the
     *	    requested key.</p>
     *
     *	@param	handlerCtx	The <code>HandlerContext.
     */
    @Handler(id="getHelpIndex",
    	input={
            @HandlerInput(name="locale", type=Locale.class)},
        output={
            @HandlerOutput(name="index", type=Index.class)})
    public static void getHelpIndex(HandlerContext handlerCtx) {
	// Get the desired Locale and the ConsolePluginService...
	Locale locale = (Locale) handlerCtx.getInputValue("locale");
	ConsolePluginService cps = PluginHandlers.getPluginService(
		handlerCtx.getFacesContext());

	// Determine the correct locale for the path...
	String localePath = getHelpLocalePath(locale, cps);

	handlerCtx.setOutputValue("index", cps.getHelpIndex(localePath));
    }

    /**
     *	<p> This method calculates the correct locale portion of the help path
     *	    for the requested locale.</p>
     */
    private static String getHelpLocalePath(Locale locale, ConsolePluginService cps) {
	// Use common toc.xml to validate locale path...
	ClassLoader loader = cps.getModuleClassLoader("common");
	String path = PluginHandlers.getHelpPathForResource(
		"toc.xml", locale, loader);
	if (path == null) {
	    // Not found, try the system default...
	    path = PluginHandlers.getHelpPathForResource(
		"toc.xml", Locale.getDefault(), loader);
	    if (path == null) {
		// Default to "en"
		path = "/en/";
	    }
	}

	// Return the locale-portion of the path
	return path.substring(1, path.indexOf('/', 1));
    }
}