Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.help.server
Class HelpServer

java.lang.Object
  extended by 
org.eclipse.help.server.HelpServer

public abstract class HelpServer
extends Object

Since:
3.4 Abstract class representing a web server which can be used to host the Eclipse help system using the extension point org.eclipse.help.base.server. Classes extending this abstract class must be capable of launching a Web Server and

Constructor Summary
HelpServer ()
           
 
Method Summary
abstract   String getHost ()
          Returns the host name or ip the app server runs on.
abstract  int getPort ()
          Returns the port number the app server listens on
abstract  void start ( String webappName)
          Start a server application to host the Eclipse help system.
abstract  void stop ( String webappName)
          Stop a server application.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HelpServer

public HelpServer()
Method Detail

start

public abstract void start(
String webappName)
                    throws 
Exception
Start a server application to host the Eclipse help system. The server is responsible for initializing the servlets, jsp files and other resources for the help system as defined by the extension points org.eclipse.equinox.http.registry.resources and org.eclipse.equinox.http.registry.servlets for the httpcontextId org.eclipse.help.webapp.help

Parameters:
webappName - The name of this web application
Throws:
Exception

stop

public abstract void stop(
String webappName)
                   throws 
CoreException
Stop a server application. If an application of this name has not been started do nothing

Parameters:
webappName - the name of a running web application
Throws:
CoreException

getPort

public abstract int getPort()
Returns the port number the app server listens on

Returns:
integer port number, 0 if server not started

getHost

public abstract 
String getHost()
Returns the host name or ip the app server runs on.

Returns:
String representation of host name of IP, null if server not started yet

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire