DESCRIPTION:

Create a Matlab wrapper for the com.sun.net.httpserver.HttpExchange java object. This object is used when a webservice is called to retrieve request info, such as the data and headers and to prepare the message to be returned. The data sent by the client are stored as redundant data in this constructor.

CALL:

obj = HttpExchange(httpExchange) obj = HttpExchange(charString)

INPUT:

OUTPUT:

Documentation for modelit.web.server.HttpExchange/HttpExchange
   doc modelit.web.server.HttpExchange

DESCRIPTION:

Default callback for webservice.

CALL:

http_callback(obj,port, callbackFcn) http_callback(obj,port, requestName, callbackFcnList)

INPUT:

callbackFcn: <@(event, port) => [msg,response,content_type]>
    function with signature:
        [msg,response,content_type]=fp_callback(event,port)

Refers to field in http-get string that corresponds
to "callbackFcnList.name". By convention either:
  empty
    ==> skip search
  char
    ==> retrieve parameter and check callbackFcnList.name for
    match
function pointer ==> check callbackFcnList.name for match with
    requestName(obj)

struct array with fields
+----name
+----action

OUTPUT:

      No output.
 
  EXAMPLE (1):
     actions        = struct('name','traveltime','action',@do_tileViewer_spt);
     actions(end+1) = struct('name','speed',     'action',@do_tileViewer_ndw);
     server = modelit.web.server.Server(hostname, port, @(e)http_callback(e, port,'maptype',actions));
     In this example the "maptype" parameter in queries will be
     matched with the "name" parameters in the struct array
     "actions".
 
     Note that a better way to divert calls to
     different callback is to use the "context" property, as in
     the next example.
 
  EXAMPLE (2):
     server = modelit.web.server.Server(hostname, port)
     addContext(obj, '/spt', @(e)http_callback(e, port,@do_tileViewer_spt) )
     addContext(obj, '/spt', @(e)http_callback(e, port,@do_tileViewer_ndw) )

DESCRIPTION:

Send the response and statuscode to the requester.

CALL:

send(obj, statuscode, response)

INPUT:

(optional, default: 200) http statuscode,
e.g. 200 ok, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

The response data
(optional, default: '')

OUTPUT:

      No output.

DESCRIPTION:

Returns the value for a given query parameter.

CALL:

value = getQueryValue(obj, name, default) value = getQueryValue(obj, name, default,query)

INPUT:

name of attribute to retrieve

Default value for this parameter, also used to convert
the value to the required format. The query values are always stored as strings.

Preprocessed value obtained with "query=getQuery(obj)"

OUTPUT:

The value for the given query name, converted to the
same format as the default value.

EXAMPLE:

DESCRIPTION:

Returns the query parameters of the http request. (The parameters after the ? in the URL).

CALL:

value = getQuery(obj)

INPUT:

OUTPUT:

One struct per parameter, value pair
fields: -name, -value

DESCRIPTION:

Convert httpget string to structure with input arguments. Take care of name completion; Supply default arguments; Cast parameters to correct type.

INPUT:

Structure with default parameters.
deftop.NAME=VALUE implies that VALUE is default parameter value
for NAME.

OUTPUT:

structure with options.

informative textual feedback in case of syntax error

text of queary after urldecode

- Current utility reads "simple" hhtp get strings, meaning that
name/value pairs are read from input string. Values must be scalar
and of type CHAR, LOGICAL, NUMERIC. LOGICAL values must be supplied
as "0" or "1"
- An equivalent function httpget2struct exists as well.
This can be used while debugging callback functions from
example query strings.

DESCRIPTION:

Returns the query parameters of the http request as a string.

CALL:

value = getQueryString(obj)

INPUT:

OUTPUT:

With name value pairs

DESCRIPTION:

Equivalent to getQueryString but returns requestBody if requestQuery is empty.

CALL:

value = char(obj)

INPUT:

OUTPUT:

With the query string or the requestBody if the
requestQuery is empty.

DESCRIPTION:

Add a header with a value to the response.

CALL:

obj = HttpExchange(httpExchange)

INPUT:

with param, value pairs.

OUTPUT:

      No output.
 

EXAMPLE:

    addResponseHeader(obj, {'contenttype', 'text/html'})
 

DESCRIPTION:

Returns the decoded path component of this URI.

CALL:

value = getPath(obj)

INPUT:

OUTPUT:

The path of the the URI.

DESCRIPTION:

Returns the response headers.

CALL:

value = getResponseHeaders(obj)

INPUT:

OUTPUT:

Map with the header
name, value pairs. Multiple values for a single name or
concatenate in a ,-separated list, e.g. "gzip, deflate, br"

DESCRIPTION:

Return the data sent with the http request.

CALL:

value = getRequestBody(obj)

INPUT:

OUTPUT:

The data as a bytearray (int8) as it was sent
with the http request.

DESCRIPTION:

Get the request headers.

CALL:

value = getRequestHeaders(obj)

INPUT:

OUTPUT:

Map with the header
name, value pairs. Multiple values for a single name or
concatenate in a ,-separated list, e.g. "gzip, deflate, br"

DESCRIPTION:

Returns the http request method.

CALL:

value = getRequestMethod(obj)

INPUT:

<modelit.webserver.HttpExchange>

OUTPUT:

The http request method. e.g. Post or Get.
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods

DESCRIPTION:

Returns the local address in the form hostname:port.

CALL:

value = getRemoteAddress(obj)

INPUT:

OUTPUT:

The local address: hostname:port

DESCRIPTION:

Returns the remote address in the form hostname:port.

CALL:

value = getRemoteAddress(obj)

INPUT:

OUTPUT:

The remote address: hostname:port

DESCRIPTION:

Returns the protocol in the form protocol/majorVersion.minorVersion.

CALL:

value = getProtocol(obj)

INPUT:

OUTPUT:

protocol/majorVersion.minorVersion. e.g. HTTP/1.1

DESCRIPTION:

Returns the HttpPrincipal or '' if no authentication is used. If an authenticator is set on the HttpContext that owns this exchange, then this method will return the HttpPrincipal that represents the authenticated user for this HttpExchange.

CALL:

value = getPrincipal(obj)

INPUT:

OUTPUT:

the name of the HttpPrincipal or '' if no
authentication was used.

DESCRIPTION:

INPUT:

http event object

1 of the following
empty string
    this will result in f_action=1 and errormsg=''
string
    this will read property <string> from event as request_type
    and then find f_action by matching request_type with
    callbackFcnList.name
function pointer
    this will result in request_type=requestName(event);
    and then find f_action by matching request_type with
    callbackFcnList.name

if requestName is nonempty. callbackFcnList.name is matched with
requesttype.

OUTPUT:

Debug message (will be displayed on console)

index in struct array "callbackFcnList"