nxm.ice.net

Class HServer

java.lang.Object

nxm.ice.net.HServer

All Implemented Interfaces:

java.lang.Runnable

public class HServer
extends java.lang.Object
implements java.lang.Runnable

Simple implementation of an HTTP/1.1 server. For details of the HTTP/1.1 specification see RFC 2616.

Author:

J. Czechowski IV / Neon Ngo

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUF_SIZE The standard buffer size that will be allocated to read data from the socket.
static int	DEFAULT_NUM_WORKERS The default number of workers that the web server uses.
static int	DEFAULT_PORT The default port that the web server listens on.

Constructor Summary

Constructors

Constructor and Description
HServer() Initializes the new instance to listen on the default port which is set by the DEFAULT_PORT static member.
HServer(int port) Initializes the new instance to listen on the specified port.
HServer(nxm.sys.lib.Midas midas, int port, int prange) Initializes the new instance to listen on the specified port.

Method Summary

Modifier and Type	Method and Description
void	addSource(HSource source) Adds the specified HSource to the server under the given name.
void	addSource(HSource source, boolean override) Adds the specified HSource to the server under the given name.
void	addSource(java.lang.String name, HSource source) Adds the specified HSource to the server under the given name.
void	addSource(java.lang.String name, HSource source, boolean override) Adds the specified HSource to the server under the given name.
int	close()
java.lang.String	getHomeDir()
java.lang.String	getHost() Get the server's host name.
java.lang.String	getHostAddr()
static java.net.InetAddress	getHostIA()
java.lang.String	getHostPort() Get the server's host:port name.
nxm.sys.lib.Midas	getMidas() Get the servers Midas context.
int	getPort() Get the servers port number.
java.lang.Object	getResult(java.lang.String name)
nxm.sys.lib.Table	getResults()
HSource	getSource(java.lang.String req) Return the registered HSource object for the given request.
boolean	isRunning()
static HServer	launch(nxm.sys.lib.Midas midas, java.lang.String title, int port, int prange) Create an HServer and start its thread
static HServer	launch(java.lang.Object ref, java.lang.String title, int port, int prange, java.lang.String homepage, java.lang.String auxlist) Open a HTTP server.
static HServer	launch(java.lang.Object ref, java.lang.String title, int port, java.lang.String homepage, java.lang.String auxlist) Open a HTTP server.
static HServer	launch(java.lang.String title, int port) Create an HServer and start its thread.
int	open()
int	process()
void	removeSource(HSource source) Removes the specified HSource.
void	removeSource(java.lang.String name) Removes the specified HSource by name.
void	run() Begins the web server running and accepting connections on the currently configured port.
void	setAppName(java.lang.String name)
static void	setDebug(boolean val)
static void	setDebug(int val) Deprecated.
void	setHomePage(java.lang.String page)
static void	setHttps(boolean isHttps)
static void	setHTTPS(java.lang.String mode)
static void	setOneWay(boolean oneWay)
void	setParent(nxm.sys.lib.Command parent) Set the command that is running this server.
void	setTitle(java.lang.String title)
void	stopThread() Set the thread to stop executing after handling the current client.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port that the web server listens on.

See Also:

Constant Field Values

DEFAULT_NUM_WORKERS

public static final int DEFAULT_NUM_WORKERS

The default number of workers that the web server uses.

See Also:

Constant Field Values

BUF_SIZE

public static final int BUF_SIZE

The standard buffer size that will be allocated to read data from the socket.

See Also:

Constant Field Values

Constructor Detail

HServer

public HServer()

Initializes the new instance to listen on the default port which is set by the DEFAULT_PORT static member.

HServer

public HServer(int port)

Initializes the new instance to listen on the specified port. The new instance will be able to respond to requests for the root object only.

Parameters:

port - the port number, or 0 to use any free port.

HServer

public HServer(nxm.sys.lib.Midas midas,
               int port,
               int prange)

Initializes the new instance to listen on the specified port. The new instance will be able to respond to requests for the root object only.

Parameters:

midas - the midas context.

port - the port number, or 0 to use any free port.

prange - the range of port numbers above port to use if already allocated.

Since:

NeXtMidas 2.9.3

Method Detail

launch

public static HServer launch(nxm.sys.lib.Midas midas,
                             java.lang.String title,
                             int port,
                             int prange)

Create an HServer and start its thread

Parameters:

midas - Midas context

title - Title of the data sources page

port - The port to be used by this HServer

prange - The range of port numbers above port to use if already allocated

Returns:

A new, running HServer.

Since:

NeXtMidas 2.9.3

launch

public static HServer launch(java.lang.String title,
                             int port)

Create an HServer and start its thread. Note, since the Midas context is not supplied here, files from RAM AUX might not be found.

Parameters:

title - Title of the data sources page

port - The port to be used by this HServer

Returns:

A new, running HServer.

See Also:

launch(Midas, String, int, int)

launch

public static HServer launch(java.lang.Object ref,
                             java.lang.String title,
                             int port,
                             int prange,
                             java.lang.String homepage,
                             java.lang.String auxlist)

Open a HTTP server. This is only called from open(), it is separate from open() to allow subclasses to override.

Parameters:

ref - The reference (Midas context or Command).

title - The title of the server (to be displayed to users).

port - The port to be used by the server.

prange - The range of port numbers above port to use if already allocated

homepage - The home page to show (null = don't show).

auxlist - The AUX list to show. One or more AUX names separated by a "|" or "*" to serve up all AUXs in AUX.READ. (Use null or "NULL" to disable serving up of AUXs.

Returns:

A new, running HServer.

Since:

NeXtMidas 2.9.3

launch

public static HServer launch(java.lang.Object ref,
                             java.lang.String title,
                             int port,
                             java.lang.String homepage,
                             java.lang.String auxlist)

Open a HTTP server. This is only called from open(), it is separate from open() to allow subclasses to override.

Parameters:

ref - The reference (Midas context or Command).

title - The title of the server (to be displayed to users).

port - The port to be used by the server.

homepage - The home page to show (null = don't show).

auxlist - The AUX list to show. One or more AUX names separated by a "|" or "*" to serve up all AUXs in AUX.READ. (Use null or "NULL" to disable serving up of AUXs.

Returns:

A new, running HServer.

Since:

NeXtMidas 2.7.0

setTitle

public void setTitle(java.lang.String title)

getMidas

public nxm.sys.lib.Midas getMidas()

Get the servers Midas context.

Returns:

The Midas context.

getResult

public java.lang.Object getResult(java.lang.String name)

getResults

public nxm.sys.lib.Table getResults()

getPort

public int getPort()

Get the servers port number.

Returns:

The port number.

getHost

public java.lang.String getHost()

Get the server's host name.

Returns:

The server's host name or "unknown" if unknown.

getHostAddr

public java.lang.String getHostAddr()

getHostPort

public java.lang.String getHostPort()

Get the server's host:port name.

Returns:

The server's host name or "unknown" if unknown.

setAppName

public void setAppName(java.lang.String name)

setParent

public void setParent(nxm.sys.lib.Command parent)

Set the command that is running this server. This is used to determine context-sensitive pages provided, such as the home page, application name, documentation, etc. The amount of context-sensitive is reduced if the parent was not launched from a macro.

Parameters:

parent - The parent for this server. This is usually the primitive that started the service.

addSource

public void addSource(java.lang.String name,
                      HSource source,
                      boolean override)

Adds the specified HSource to the server under the given name. If the name does not begin with a slash (/), one will be added to the name. If another source already exists with a given name, that source is removed prior to adding this one. Upon returning from this method the source object will be available to clients by using the name specified by the object. This method does nothing if either name or source are null.

Parameters:

name - The name of the source.

source - The source that handles the requests.

override - If true, the source will be put on the front of the source list, if false the source will be put on the end of the source list. When a request comes in the sources are checked front-to-back to see if there is a match, if multiple sources could match the request, the first one found will be used.

Since:

NeXtMidas 2.7.1

addSource

public void addSource(java.lang.String name,
                      HSource source)

Adds the specified HSource to the server under the given name. This is identical to addSource(name,source,false).

Parameters:

name - The name of the source.

source - The source that handles the requests.

addSource

public void addSource(HSource source)

Adds the specified HSource to the server under the given name. This is identical to addSource(name,source,false) where name is equal to source.getName().

Parameters:

source - The source that handles the requests.

addSource

public void addSource(HSource source,
                      boolean override)

Adds the specified HSource to the server under the given name. This is identical to addSource(name,source,override) where name is equal to source.getName().

Parameters:

source - The source that handles the requests.

override - Override other requests?

Since:

NeXtMidas 2.7.1

removeSource

public void removeSource(java.lang.String name)

Removes the specified HSource by name.

Parameters:

name - The name of the source.

removeSource

public void removeSource(HSource source)

Removes the specified HSource.

Parameters:

source - The source to remove.

getSource

public HSource getSource(java.lang.String req)

Return the registered HSource object for the given request.

Parameters:

req - The requested path

Returns:

The reference to the registered data source or null if one cannot be found.

setHTTPS

public static void setHTTPS(java.lang.String mode)

open

public int open()

process

public int process()

close

public int close()

run

public void run()

Begins the web server running and accepting connections on the currently configured port. Assumes open() method has already been called.

Specified by:

run in interface java.lang.Runnable

stopThread

public void stopThread()

Set the thread to stop executing after handling the current client.

isRunning

public boolean isRunning()

setHomePage

public void setHomePage(java.lang.String page)

getHomeDir

public java.lang.String getHomeDir()

setDebug

public static void setDebug(boolean val)

setDebug

@Deprecated
public static void setDebug(int val)

Deprecated.

getHostIA

public static java.net.InetAddress getHostIA()

setHttps

public static void setHttps(boolean isHttps)

Parameters:

isHttps - the isHttps to set

setOneWay

public static void setOneWay(boolean oneWay)

Parameters:

oneWay - the oneWay to set