HPage

java.lang.Object
- nxm.ice.net.HPage

All Implemented Interfaces:

java.lang.Runnable, nxm.sys.inc.AsciiMap
```
public class HPage
extends java.lang.Object
implements java.lang.Runnable, nxm.sys.inc.AsciiMap
```
Class to parse an HTTP request, and provide handles and helper methods for an HSource class to respond to the request.

Author:

Jeff Schoen / Neon Ngo

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HPage.MultipartData
The data associated with a multi-part request.

Nested Classes
Modifier and Type	Class and Description
`static class`	`HPage.MultipartData` The data associated with a multi-part request.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte[]`	`EOL` HTTP header end-of-line (as bytes).
`static java.lang.String`	`EOLSTR` HTTP header end-of-line string (CR+LF).
`HServer`	`server` The server associated with the request.

Fields inherited from interface nxm.sys.inc.AsciiMap
BANG, BSLASH, BTIC, CARET, COLON, COMMA, CR, EQUALS, FTIC, HTAB, LBRACE, LCURLY, LF, LOWER2UPPER, LOWERA, LOWERZ, LPAREN, MINUS, NINE, NULL, PERIOD, PLUS, QUOTE, RBRACE, RCURLY, RPAREN, SCOLON, SLASH, SPACE, TILDE, UPPER2LOWER, UPPERA, UPPERZ, ZERO

Constructor Summary

Constructors
Constructor and Description

HPage(HServer server, java.net.Socket sock)

HPage(HServer server, java.net.Socket sock, java.lang.String scheme)

Constructors
Constructor and Description
`HPage(HServer server, java.net.Socket sock)`
`HPage(HServer server, java.net.Socket sock, java.lang.String scheme)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the output socket.
`void`	`closeFromBody()`
`void`	`closeSocket()` Opens the output socket, same as close().
`void`	`closeWS()`
`void`	`dumpHeader()`
`void`	`flush()` Flush the output stream.
`static boolean`	`getDebug()`
`java.lang.String`	`getHeader(java.lang.String key)`
`double`	`getHeaderD(java.lang.String key)`
`java.io.BufferedInputStream`	`getInputStream()` Gets the input stream for reading from the socket connection.
`java.lang.String`	`getMethod()` Gets the HTTP request method used.
`java.io.PrintStream`	`getOutputStream()` Gets the output stream for writing to the socket connection.
`nxm.sys.lib.Table`	`getParameters()` Gets the set of parameters passed in on the URI.
`HPage.MultipartData[]`	`getPostData()` Gets the data associated with an HTTP POST.
`HPage.MultipartData`	`getPostData(java.lang.String name)` Gets the named data associated with an HTTP POST.
`java.net.Socket`	`getSocket()`
`java.lang.String`	`getURI()` Get the HTTP URI requested by client.
`boolean`	`isClosed()`
`boolean`	`isGetRequest()` Deprecated.
`boolean`	`isHeadRequest()` Deprecated.
`boolean`	`isNotRequest()` Deprecated.
`boolean`	`isOpened()`
`void`	`open()` Opens the output socket.
`void`	`openSocket()` Opens the output socket, same as open().
`void`	`openToBody(java.lang.String title)`
`void`	`openUpToBody(java.lang.String title)`
`void`	`openWS(java.lang.String protocol)`
`int`	`recvWS(byte[] b, int off, int bytes)`
`void`	`run()`
`int`	`sendWS(byte[] b, int off, int bytes)`
`void`	`setContentLength(long bytes)` Sets the content length of the response.
`void`	`setContentRange(long firstBytePos, long lastBytePos, long totalLength)` Sets the "Content-Range" of the response (HTTP 1.1 RFC 2616 section 14.16) for a response to a Range (partial content) request.
`void`	`setContentType(java.lang.String type)` Sets the content type of the response.
`void`	`setDate(java.util.Date date)` Sets the date and time of the server in the response header.
`static void`	`setDebug(boolean val)`
`void`	`setLastModified(java.util.Date date)` Sets the last modified date and time of the response.
`void`	`setStatus(int status)` Sets the HTTP status.
`int`	`write(byte[] buf)` Writes data to the output socket.
`int`	`write(byte[] buf, int off, int len)` Writes data to the output socket.
`void`	`write(java.io.ByteArrayOutputStream baos)`
`int`	`write(java.lang.String line)` Writes text to the output socket.
`void`	`writeFile(java.lang.Object ref, java.lang.Object fname)` Writes a file to the output socket.
`int`	`writeln(java.lang.String line)` Writes text to the output socket followed by an EOL (end-of-line).
`void`	`writeNotFound()` Convenient method to write "404 Not Found" HTML to output for requested URI.

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

- Field Detail
  - EOLSTR
```
public static final java.lang.String EOLSTR
```
    HTTP header end-of-line string (CR+LF).
    
    See Also:
    
    Constant Field Values
  - EOL
```
public static final byte[] EOL
```
    HTTP header end-of-line (as bytes).
  - server
```
public final HServer server
```
    The server associated with the request.
- Constructor Detail
  - HPage
```
public HPage(HServer server,
             java.net.Socket sock)
      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - HPage
```
public HPage(HServer server,
             java.net.Socket sock,
             java.lang.String scheme)
      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - getPostData
```
public HPage.MultipartData[] getPostData()
```
    Gets the data associated with an HTTP POST.
    
    Returns:
    
    The multi-part data, if given a POST that is not multi-part this will be an array of length 1 holding the data posted. (This will return null for any non-POST request.)
    
    Since:
    
    NeXtMidas 2.7.0
  - getPostData
```
public HPage.MultipartData getPostData(java.lang.String name)
```
    Gets the named data associated with an HTTP POST. This explicitly checks looks for a Content-Disposition that is form-data with name="<name>".
    
    Parameters:
    
    name - The name of the form-data entry to get.
    
    Returns:
    
    The multi-part data that matches the given name or null if not found. (This will return null for any non-POST request.)
    
    Since:
    
    NeXtMidas 2.7.0
  - getMethod
```
public java.lang.String getMethod()
```
    Gets the HTTP request method used.
    
    Returns:
    
    The request method ("GET", "POST", etc.).
    
    Since:
    
    NeXtMidas 2.7.0
  - getParameters
```
public nxm.sys.lib.Table getParameters()
```
    Gets the set of parameters passed in on the URI. Examples:
```
        "http://localhost/"               = { }
        "http://localhost/?one=1"         = {ONE="1"}
        "http://localhost/?one=1&two=2"   = {ONE="1",TWO="2"}
        "http://localhost/?str=a+b+c"     = {STR="a b c"}
      
```
    For a POST request, this will search through the content passed and will merge in any parameters specified with a MIME type of "application/x-url-encoded" or "application/x-www-form-urlencoded". (If a Content-Disposition is specified for multi-part data, a check is also made to verify that it is "form-data".)
    
    Note that all keys will be converted to UPPERCASE while the values remain Case-Sensitive. If duplicate keys are found, only the value of the LAST one is used.
    Returns:
    
    The parameters passed in the client request.
  - setStatus
```
public void setStatus(int status)
```
    Sets the HTTP status. This must be called before open().
```
        Warning: HTTP 1.1 requires that "All 1xx (informational), 204 (no content), and
                 304 (not modified) responses MUST NOT include a message-body" (RFC 2616,
                 ftp://ftp.isi.edu/in-notes/rfc2616.txt).

                 If the status is set to one of these codes, the content length must be
                 set to 0. Failure to set the content length may cause strange errors on
                 some clients, including an occasional "java.net.SocketException:
                 Connection reset" exception on some Java clients.
      
```
    Parameters:
    
    status - One of the valid HTTP status codes from HttpURLConnection such as HTTP_OK or HTTP_NOT_FOUND.
  - setDebug
```
public static void setDebug(boolean val)
```
  - getDebug
```
public static boolean getDebug()
```
  - getURI
```
public java.lang.String getURI()
```
    Get the HTTP URI requested by client.
    
    Returns:
    
    HTTP URI String requested by client
    
    Since:
    
    NeXtMidas 2.7.1
  - isOpened
```
public boolean isOpened()
```
  - isClosed
```
public boolean isClosed()
```
  - openSocket
```
public void openSocket()
```
    Opens the output socket, same as open().
  - closeSocket
```
public void closeSocket()
```
    Opens the output socket, same as close().
  - open
```
public void open()
```
    Opens the output socket. From a macro use openSocket().
  - close
```
public void close()
```
    Closes the output socket. From a macro use closeSocket().
  - openToBody
```
public void openToBody(java.lang.String title)
```
  - openUpToBody
```
public void openUpToBody(java.lang.String title)
```
  - closeFromBody
```
public void closeFromBody()
```
  - openWS
```
public void openWS(java.lang.String protocol)
```
  - closeWS
```
public void closeWS()
```
  - recvWS
```
public int recvWS(byte[] b,
                  int off,
                  int bytes)
```
  - sendWS
```
public int sendWS(byte[] b,
                  int off,
                  int bytes)
```
  - flush
```
public void flush()
```
    Flush the output stream.
  - setContentType
```
public void setContentType(java.lang.String type)
```
    Sets the content type of the response. Must be called before the response is opened.
    
    Parameters:
    
    type - The MIME type of the content.
  - setContentLength
```
public void setContentLength(long bytes)
```
    Sets the content length of the response. Must be called before the response is opened.
    
    Parameters:
    
    bytes - The content length in bytes.
  - setContentRange
```
public void setContentRange(long firstBytePos,
                            long lastBytePos,
                            long totalLength)
```
    Sets the "Content-Range" of the response (HTTP 1.1 RFC 2616 section 14.16) for a response to a Range (partial content) request. This will also set the HTTP response status to code 206 (Partial content). If totalLength is zero or less, then response status code will be set to 416 (Request range not satisfiable). Must be called before the response is opened.
    
    Parameters:
    
    firstBytePos - absolute offset of first byte position of range
    
    lastBytePos - absolute offset of last byte position of range request
    
    totalLength - total number of bytes of media (can be negative if cannot be determined)
    
    Since:
    
    NeXtMidas 2.8.3
  - setDate
```
public void setDate(java.util.Date date)
```
    Sets the date and time of the server in the response header. This is used by some HTTP clients along with Last-Modified date/time to determine how to cache contents returned by this server. Must be called before the response is opened.
    
    Parameters:
    
    date - The last modified date and time
    
    Since:
    
    NeXtMidas 2.7.1
  - setLastModified
```
public void setLastModified(java.util.Date date)
```
    Sets the last modified date and time of the response. Must be called before the response is opened.
    
    Parameters:
    
    date - The last modified date and time
    
    Since:
    
    NeXtMidas 2.7.1
  - getHeader
```
public java.lang.String getHeader(java.lang.String key)
```
  - dumpHeader
```
public void dumpHeader()
```
  - getHeaderD
```
public double getHeaderD(java.lang.String key)
```
  - write
```
public int write(java.lang.String line)
```
    Writes text to the output socket.
    
    Parameters:
    
    line - The text to write.
    
    Returns:
    
    Number of bytes written (<0 on error).
    
    See Also:
    
    writeln(String)
  - writeln
```
public int writeln(java.lang.String line)
```
    Writes text to the output socket followed by an EOL (end-of-line). HTTP requests use a CR+LF end-of-line combination and this method follows that convention.
    
    Parameters:
    
    line - The text to write.
    
    Returns:
    
    Number of bytes written (<0 on error).
  - writeFile
```
public void writeFile(java.lang.Object ref,
                      java.lang.Object fname)
```
    Writes a file to the output socket. This will do the following:
```
        (1) Open the named file
        (2) Set the Content-Type (i.e. MIME type) of the response
            (see BaseFile.getMimeType() and setContentType(java.lang.String))
        (3) Set the Content-Length of the response in bytes
            (see IOResource.getLength() and setContentLength(long))
        (4) Open the socket (see open())
        (5) Read the raw bytes of the file (see IOResource.read(byte[], int, int)) and
            write them to the socket (see write(byte[],int,int))
        (6) Close the socket (see close())
        (7) Close the file
      
```
    Note that this method assumes that the given file is the complete response to the given request and handles it as such. Use of this method is entirely optional and users are free to use the other methods in this class for writing out data.
    Parameters:
    
    ref - The reference (usually a Command or Midas context).
    
    fname - The file name. The file must exist and be a static file that can be read for for output over the socket. (Note that the file could have been generated in response to this request and could even exist in RAM, it just needs to be "static" at the point when this method is called.)
    
    Since:
    
    NeXtMidas 2.7.0
  - write
```
public int write(byte[] buf)
```
    Writes data to the output socket. This is the same as write(buf, 0, buf.length).
    
    Parameters:
    
    buf - The data buffer.
    
    Returns:
    
    Number of bytes written (<0 on error).
  - write
```
public int write(byte[] buf,
                 int off,
                 int len)
```
    Writes data to the output socket.
    
    Parameters:
    
    buf - The data buffer.
    
    off - The offset into the buffer (usually 0).
    
    len - Number of bytes to write out (-1 -> len=buf.length).
    
    Returns:
    
    Number of bytes written (<0 on error).
  - write
```
public void write(java.io.ByteArrayOutputStream baos)
```
  - writeNotFound
```
public void writeNotFound()
```
    Convenient method to write "404 Not Found" HTML to output for requested URI. If "HEAD" request method, then this method WILL NOT output the HTML content (per RFC 2616). Note: the setStatus(HttpURLConnection.HTTP_NOT_FOUND) and open() methods SHOULD normally be called before this.
    
    Since:
    
    NeXtMidas 2.9.0
  - getInputStream
```
public java.io.BufferedInputStream getInputStream()
```
    Gets the input stream for reading from the socket connection.
    
    Returns:
    
    The input stream for reading from the socket connection.
    
    Since:
    
    NeXtMidas 1.8
  - getOutputStream
```
public java.io.PrintStream getOutputStream()
```
    Gets the output stream for writing to the socket connection.
    Note that the PrintStream returned will be set to terminate all lines with the CR + LF sequence, EOLSTR, as is required for HTTP output streams.
    
    Returns:
    
    The output stream for writing to the socket connection.
    
    Since:
    
    NeXtMidas 1.8
  - getSocket
```
public java.net.Socket getSocket()
```
  - isHeadRequest
```
@Deprecated
public boolean isHeadRequest()
```
    Deprecated.
  - isGetRequest
```
@Deprecated
public boolean isGetRequest()
```
    Deprecated.
  - isNotRequest
```
@Deprecated
public boolean isNotRequest()
```
    Deprecated.

Class HPage

Nested Class Summary

Field Summary

Fields inherited from interface nxm.sys.inc.AsciiMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EOLSTR

EOL

server

Constructor Detail

HPage

HPage

Method Detail

run

getPostData

getPostData

getMethod

getParameters

setStatus

setDebug

getDebug

getURI

isOpened

isClosed

openSocket

closeSocket

open

close

openToBody

openUpToBody

closeFromBody

openWS

closeWS

recvWS

sendWS

flush

setContentType

setContentLength

setContentRange

setDate

setLastModified

getHeader

dumpHeader

getHeaderD

write

writeln

writeFile

write

write

write

writeNotFound

getInputStream

getOutputStream

getSocket

isHeadRequest

isGetRequest

isNotRequest