org.eclipse.help
Interface IAppServer

public interface IAppServer

Interface to be implemented by an application server to be used by the help plugin.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Method Summary

boolean	add(String webAppName, String plugin, String path) Adds the specified webapp from a plugin.
String	getHost() Obtains the host name or ip the app server runs on.
int	getPort() Obtains the port number the app server listens on.
void	remove(String webApp, String plugin) Removes the specified webapp.
void	setAddress(String host, int port) Sets the host and port for the app server.

Method Detail

add

public boolean add(String webAppName,
                   String plugin,
                   String path)

Adds the specified webapp from a plugin.

It is assumed that webapp names are unique. It is suggested to create unique web app names by prefixing them with the plugin id.

Parameters:

webAppName - the name of the web application (context name)

plugin - the plugin identifier of the webapp

path - the plugin relative path where the web app WAR or directory is located

Returns:

true if the webapp was added, false otherwise

remove

public void remove(String webApp,
                   String plugin)

Removes the specified webapp.

Parameters:

webApp - the name of the web app

plugin - the plugin containg the web app. Not used now.

getHost

public String getHost()

Obtains the host name or ip the app server runs on.

Returns:

String representaion of host name of IP

getPort

public int getPort()

Obtains the port number the app server listens on.

Returns:

integer port number

setAddress

public void setAddress(String host,
                       int port)

Sets the host and port for the app server. Must be called before adding a webapp, but the call is optional.

Parameters:

host - the host name or IP address. Pass null when any address on local machine is to be used.

port - the port number to be used. Pass 0 to let the system select an available port.