org.eclipse.help.standalone.Infocenter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.help.base Show documentation
Help System Base
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.help.standalone;

import org.eclipse.help.internal.standalone.*;

/**
 * This is a standalone infocenter. It takes care of launching the Eclipse with
 * its help system implementation. This class can be instantiated and used in a
 * Java program, or can be launched from command line.
 *
 * Usage as a Java component:
 * 
 * create an instantance of this class
 * call start(), infocenter will run
 * when no longer needed call shutdown().
 * 
 */
public class Infocenter {
	private final StandaloneInfocenter infocenter;
	/**
	 * Constructs Infocenter
	 *
	 * @param options
	 *            array of String options and their values
	 *            
	 *            Option -eclipseHome dir specifies Eclipse
	 *            installation directory. This directory is a parent to
	 *            "plugins" directory and eclipse executable. The option must be
	 *            provided, when current directory from which infocenter is
	 *            launched, is not the same as Eclipse installation directory.
	 *            

	 *            Option -host helpServerHost specifies host name
	 *            of the interface that help server will use. It overrides host
	 *            name specified in the application server plugin preferences.
	 *            

	 *            Option -port helpServerPort specifies port
	 *            number that help server will use. It overrides port number
	 *            specified in the application server plugin preferences.
	 *            

	 *            Option -dir rtl sets right-to-left rendering
	 *            direction of help UI in the browser.
	 *            

	 *            Option -noexec indicates that Eclipse
	 *            executable should not be used.
	 *            

	 *            Additionally, most options accepted by Eclipse execuable are
	 *            supported.
	 */
	public Infocenter(String[] options) {
		infocenter = new StandaloneInfocenter(options);
	}
	/**
	 * Starts the stand alone infocenter.
	 */
	public void start() throws Exception {
		infocenter.start();
	}
	/**
	 * Shuts-down the stand alone infocenter.
	 */
	public void shutdown() throws Exception {
		infocenter.shutdown();
	}

	/**
	 * Controls start up and shut down of infocenter from command line.
	 *
	 * @param args
	 *            array of String containing options.

	 *            Options are:

	 *            -command start | shutdown [-eclipsehome eclipseInstallPath] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]
	 *            

	 *            where:
	 *            

	 *            eclipseInstallPath specifies Eclipse
	 *            installation directory; it must be provided, when current
	 *            directory is not the same as Eclipse installation directory,
	 *            
	 *            helpServerHost specifies host name of the
	 *            interface that help server will use, it overrides host name
	 *            specified the application server plugin preferences
	 *            helpServerPort specifies port number that
	 *            help server will use, it overrides port number specified the
	 *            application server plugin preferences.
	 *            -dir rtl sets right-to-left rendering
	 *            direction of help UI in the browser.
	 *            
-noexec option indicates that Eclipse
	 *            executable should not be used.
	 *            platform options are other options that are
	 *            supported by Eclipse Executable.
	 *            
	 */
	public static void main(String[] args) {
		StandaloneInfocenter.main(args);
	}
}