HttpWebServer (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.http.HttpWebServer

All Implemented Interfaces:

WebServerInterface
```
public class HttpWebServer
extends Object
implements WebServerInterface
```
This is an implementation of the Web Server to respond to a HTTP request. It is the Web Server provided with NetPhantom when running with HTML support.
The first character the HTTP request string is passed to the onClientRequest routine. The rest of the string is read from the socket.

Constructor Summary

Constructors
Constructor and Description

HttpWebServer()
The constructor does not take any parameters and is not currently needed.

Constructors
Constructor and Description
`HttpWebServer()` The constructor does not take any parameters and is not currently needed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCaches()` Clears the web server caches.
`MessageDigest`	`createMessageDigest()` Gets a new instance of the message digest class.
`void`	`displayWebServerCache(VirtualCListBox list)` Fills a list box with the cache information.
`void`	`dispose()` Disposes of the Web Server (to stops it).
`static boolean`	`doLogHTTPRequests()` Checks for logging of HTTP requests.
`void`	`finishedProcessingRequest()` Call this method when a request has been processed.
`int`	`getBlockSize()` Gets the block size for data to clients.
`Object`	`getCgiInstance(String name)` Gets a new instance of a CGI class.
`ClientSessionManager`	`getClientSessionManager()` Gets the client session manager.
`String`	`getDefaultDocument(String uri)` Checks if the URI points to a directory from the document root.
`String`	`getDocumentRoot()` Gets the document root.
`static String`	`getHostAddress()` Gets the host address (or null if default one is used).
`static String`	`getHostName()` Gets the host name (or null if default or raw IP is used).
`int`	`getMaximumResourceSize()` Gets the maximum size for a resource before it is sent as blocks of data directly from file rather than from cache.
`int`	`getMaximumWebServerRequests()` Gets the current count of outstanding web server requests.
`MimeTypes`	`getMimeTypes()` Gets the mime type class instance.
`HttpReply`	`getReply()` Gets the HTTP Reply helper.
`HttpResourceDefinition`	`getResourceDefinition(String name)` Finds a resource definition that matches this request.
`int`	`getWebServerRequests()` Gets the current count of outstanding web server requests.
`void`	`initialize(ClientSessionManager csm)` This method is called just after creation of the web server interface.
`boolean`	`isFileSystemCaseSensitive()` Check if the file system for root and error documents is case sensitive.
`boolean`	`isProcessingRequestAllowed()` Call this method when a request is about to be processed.
`static boolean`	`isRawIPUsed()` Checks if the web server should use raw IP addresses instead of DNS name.
`HtmlResource`	`loadAbsoluteDocument(HttpResourceParameters httpParams)` Loads a HTML resource from a specific directory.
`HtmlResource`	`loadAbsoluteDocument(String fileName)` Loads a HTML resource from a specific directory.
`HtmlResource`	`loadAbsoluteDocument(String fileName, boolean isFromRoot)` Loads a HTML resource from a specific directory.
`HtmlResource`	`loadErrorDocument(String name)` Loads a HTML resource from the 'documentError' directory.
`HttpResource`	`loadResource(HttpResourceParameters httpParams, boolean isAbsolute)` Loads a resource.
`HttpResource`	`loadResource(String name, String fileName, boolean isAbsolute)` Loads a resource.
`void`	`onClientRequest(ServerSocketInterface ssi, ISocket socket, int firstChar, String id)` This method is called whenever a web server request is called from a client.
`void`	`outOfMemoryRecover()` Recovers after out of memory by clearing caches and performing a garbage collection.
`static void`	`setLogHTTPRequests(boolean doLog)` Sets logging of HTTP requests.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpWebServer
```
public HttpWebServer()
```
    The constructor does not take any parameters and is not currently needed.
- Method Detail
  - isProcessingRequestAllowed
```
public boolean isProcessingRequestAllowed()
```
    Call this method when a request is about to be processed.
  - finishedProcessingRequest
```
public void finishedProcessingRequest()
```
    Call this method when a request has been processed.
  - doLogHTTPRequests
```
public static boolean doLogHTTPRequests()
```
    Checks for logging of HTTP requests.
  - setLogHTTPRequests
```
public static void setLogHTTPRequests(boolean doLog)
```
    Sets logging of HTTP requests.
  - isRawIPUsed
```
public static boolean isRawIPUsed()
```
    Checks if the web server should use raw IP addresses instead of DNS name.
  - getHostAddress
```
public static String getHostAddress()
```
    Gets the host address (or null if default one is used).
  - getHostName
```
public static String getHostName()
```
    Gets the host name (or null if default or raw IP is used).
  - getWebServerRequests
```
public int getWebServerRequests()
```
    Gets the current count of outstanding web server requests.
  - getMaximumWebServerRequests
```
public int getMaximumWebServerRequests()
```
    Gets the current count of outstanding web server requests.
  - initialize
```
public void initialize(ClientSessionManager csm)
                throws IOException
```
    This method is called just after creation of the web server interface.
    The web server loads the definitions of:
    - The document information of the Web Server
    - Creates the caches and the resource manager
    - Loads the mimetypes
    - The NetPhantom Applications
    - The CGI definitions.
    
    Specified by:
    
    initialize in interface WebServerInterface
    
    Throws:
    
    IOException - if there is a problem in loading the web server.
  - dispose
```
public void dispose()
```
    Disposes of the Web Server (to stops it).
    
    Specified by:
    
    dispose in interface WebServerInterface
  - getCgiInstance
```
public Object getCgiInstance(String name)
```
    Gets a new instance of a CGI class.
    The interface implemented by the class is either CgiPrintInterface, CgiHttpResourceInterface or CgiHtmlResourceInterface in case of a normal CGI.
    For HTML-included CGIs, the class must implement IncludeCgiPrintInterface or IncludeCgiHtmlResourceInterface.
    Include-type CGIs are defined by the ID "<classid>" whereas normal CGIs are defined just by "classid".
    
    Returns:
    
    null if not found or cannot be instantiated.
    
    See Also:
    
    CgiPrintInterface, CgiHttpResourceInterface, CgiHtmlResourceInterface, IncludeCgiPrintInterface, IncludeCgiHtmlResourceInterface
  - getDocumentRoot
```
public String getDocumentRoot()
```
    Gets the document root.
  - getDefaultDocument
```
public String getDefaultDocument(String uri)
```
    Checks if the URI points to a directory from the document root. If so, the index page is returned or empty string if none is found.
    
    Returns:
    
    null if the URI is not referring to a directory.
  - onClientRequest
```
public void onClientRequest(ServerSocketInterface ssi,
                            ISocket socket,
                            int firstChar,
                            String id)
                     throws IOException
```
    This method is called whenever a web server request is called from a client. When this method is called, it must release control back to the calling thread immediately, otherwise new client connections or HTTP requests will be blocked. The best way to handle this is to start a new thread directly and then return control to the calling thread.
    
    Specified by:
    
    onClientRequest in interface WebServerInterface
    
    Throws:
    
    IOException - if there is a problem in requesting the data from the server.
  - isFileSystemCaseSensitive
```
public boolean isFileSystemCaseSensitive()
```
    Check if the file system for root and error documents is case sensitive.
  - getMimeTypes
```
public MimeTypes getMimeTypes()
```
    Gets the mime type class instance.
  - getClientSessionManager
```
public ClientSessionManager getClientSessionManager()
```
    Gets the client session manager.
    
    Returns:
    
    null if the web server has been stopped.
  - getReply
```
public HttpReply getReply()
```
    Gets the HTTP Reply helper.
  - loadResource
```
public HttpResource loadResource(String name,
                                 String fileName,
                                 boolean isAbsolute)
                          throws IOException
```
    Loads a resource. If the resource is cached, a copy of one is returned and the last recently used table is updated.
    
    Returns:
    
    null if not found.
    
    Throws:
    
    IOException - for read resource failures.
  - loadResource
```
public HttpResource loadResource(HttpResourceParameters httpParams,
                                 boolean isAbsolute)
                          throws IOException
```
    Loads a resource. If the resource is cached, a copy of one is returned and the last recently used table is updated.
    
    Returns:
    
    null if not found.
    
    Throws:
    
    IOException - for read resource failures.
  - loadErrorDocument
```
public HtmlResource loadErrorDocument(String name)
                               throws IOException
```
    Loads a HTML resource from the 'documentError' directory.
    
    Throws:
    
    IOException
  - loadAbsoluteDocument
```
public HtmlResource loadAbsoluteDocument(String fileName)
                                  throws IOException
```
    Loads a HTML resource from a specific directory.
    
    Throws:
    
    IOException
  - loadAbsoluteDocument
```
public HtmlResource loadAbsoluteDocument(String fileName,
                                         boolean isFromRoot)
                                  throws IOException
```
    Loads a HTML resource from a specific directory.
    
    Throws:
    
    IOException
  - loadAbsoluteDocument
```
public HtmlResource loadAbsoluteDocument(HttpResourceParameters httpParams)
                                  throws IOException
```
    Loads a HTML resource from a specific directory.
    
    Throws:
    
    IOException
  - getResourceDefinition
```
public HttpResourceDefinition getResourceDefinition(String name)
                                             throws IOException
```
    Finds a resource definition that matches this request. This is used for authentication, redirection, etc.
    
    Returns:
    
    null if no match is found.
    
    Throws:
    
    IOException - for resource definition failures.
  - createMessageDigest
```
public MessageDigest createMessageDigest()
```
    Gets a new instance of the message digest class.
  - displayWebServerCache
```
public void displayWebServerCache(VirtualCListBox list)
```
    Fills a list box with the cache information.
  - clearCaches
```
public void clearCaches()
```
    Clears the web server caches.
  - outOfMemoryRecover
```
public void outOfMemoryRecover()
```
    Recovers after out of memory by clearing caches and performing a garbage collection.
  - getBlockSize
```
public int getBlockSize()
```
    Gets the block size for data to clients.
  - getMaximumResourceSize
```
public int getMaximumResourceSize()
```
    Gets the maximum size for a resource before it is sent as blocks of data directly from file rather than from cache.

Class HttpWebServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpWebServer

Method Detail

isProcessingRequestAllowed

finishedProcessingRequest

doLogHTTPRequests

setLogHTTPRequests

isRawIPUsed

getHostAddress

getHostName

getWebServerRequests

getMaximumWebServerRequests

initialize

dispose

getCgiInstance

getDocumentRoot

getDefaultDocument

onClientRequest

isFileSystemCaseSensitive

getMimeTypes

getClientSessionManager

getReply

loadResource

loadResource

loadErrorDocument

loadAbsoluteDocument

loadAbsoluteDocument

loadAbsoluteDocument

getResourceDefinition

createMessageDigest

displayWebServerCache

clearCaches

outOfMemoryRecover

getBlockSize

getMaximumResourceSize