Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> help >> internal >> [ base overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.help.internal.base
Class HelpApplication  

java.lang.Object
  org.eclipse.help.internal.base.HelpApplication

All Implemented Interfaces:

org.eclipse.core.runtime.IExecutableExtension, org.eclipse.core.runtime.IPlatformRunnable

---

public class HelpApplication

extends java.lang.Object

implements org.eclipse.core.runtime.IPlatformRunnable, org.eclipse.core.runtime.IExecutableExtension

Help application. Starts webserver and help web application for use by infocenter and stand-alone help. Application takes a parameter "mode", that can take values: "infocenter" - when help system should run as infocenter, "standalone" - when help system should run as standalone.

---

Field Summary
private static java.lang.String	APPLICATION_LOCK_FILE
private  java.nio.channels.FileLock	lock
private  java.io.File	metadata
private static int	status
private static int	STATUS_EXITTING
private static int	STATUS_RESTARTING
private static int	STATUS_RUNNING

 

Fields inherited from interface org.eclipse.core.runtime.IPlatformRunnable

EXIT_OK, EXIT_RELAUNCH, EXIT_RESTART

 

Constructor Summary

HelpApplication()

 

Method Summary
static boolean	isRunning()
private  void	obtainLock()
private  void	releaseLock()
static void	restart()           Causes help service to exit and start again
java.lang.Object	run(java.lang.Object args)           Runs help service application.
void	setInitializationData(org.eclipse.core.runtime.IConfigurationElement configElement, java.lang.String propertyName, java.lang.Object data)           This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information.
static void	stop()           Causes help service to stop and exit
private  void	writeHostAndPort()

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

APPLICATION_LOCK_FILE

private static final java.lang.String APPLICATION_LOCK_FILE

See Also:

Constant Field Values

---

STATUS_EXITTING

private static final int STATUS_EXITTING

See Also:

Constant Field Values

---

STATUS_RESTARTING

private static final int STATUS_RESTARTING

See Also:

Constant Field Values

---

STATUS_RUNNING

private static final int STATUS_RUNNING

See Also:

Constant Field Values

---

status

private static int status

---

metadata

private java.io.File metadata

---

lock

private java.nio.channels.FileLock lock

Constructor Detail

HelpApplication

public HelpApplication()

Method Detail

stop

public static void stop()

Causes help service to stop and exit

---

restart

public static void restart()

Causes help service to exit and start again

---

run

public java.lang.Object run(java.lang.Object args)
                     throws java.lang.Exception

Runs help service application.

Specified by:

run in interface org.eclipse.core.runtime.IPlatformRunnable

---

setInitializationData

public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement configElement,
                                  java.lang.String propertyName,
                                  java.lang.Object data)

Description copied from interface: org.eclipse.core.runtime.IExecutableExtension

This method is called by the implementation of the method IConfigurationElement.createExecutableExtension on a newly constructed extension, passing it its relevant configuration information. Most executable extensions only make use of the first two call arguments.

Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example

     <action run="com.example.BaseAction"/>
 

In the above example, this method would be called with a reference to the <action> element (first argument), and "run" as the name of the attribute that defined this executable extension (second argument).

The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.

There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:

(1) by specifying adapter data as part of the implementation class attribute value. The Java class name can be followed by a ":" separator, followed by any adapter data in string form. For example, if the extension point specifies an attribute "run" to contain the name of the extension implementation, an adapter can be configured as

     <action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
 

(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become

     <action>
         <run class="com.xyz.ExternalAdapter">
             <parameter name="exec" value="./cmds/util.exe"/>
             <parameter name="opt"  value="3"/>
         </run>
     </action>
 

Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.

In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:

• null, if no adapter data was supplied
• in case (1), the initialization data string is passed as a String
• in case (2), the initialization data is passed as a Hashtable containing the actual parameter names and values (both Strings)

Specified by:

setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension

---

writeHostAndPort

private void writeHostAndPort()
                       throws java.io.IOException

---

obtainLock

private void obtainLock()

---

releaseLock

private void releaseLock()

---

isRunning

public static boolean isRunning()

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> help >> internal >> [ base overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---