Skip to content

httpd

Jump to bottom
Nuno Aguiar edited this page Apr 24, 2018 · 3 revisions

HTTPd.HTTPd

HTTPd.HTTPd(aPort, aLocalInteface, keyStorePath, keyStorePassword, logFunction)

Creates a HTTP server instance on the provided port and optionally on the identified local interface. If the port provided is 0 or negative a random port will be assigned. To determine what this port is  you can use the function HTTPServer.getPort(). If keyStorePath is defined, the corresponding SSL Key Store will be used (connections will be https) with the provided keyStorePassword. Do note that the keyStorePath should be included in the OpenAF classpath. The logFunction, if defined, will be called by the server whenever there is any logging to be performed  by the HTTPServer. This function will receive 3 arguments. Example:

plugin("HTTPServer");
var s = new HTTPd(8091, undefined, undefined, undefined, function(aType, aMsg, anException) {
  if(aType.toString() != "DEBUG" && anException.getMessage() != "Broken pipe")
     logErr("Type: " + aType + " | Message: " + aMsg + anException.printStackTrace());
});
s.addEcho("/echo"); s.add("/stuff", function(req) {
  print(beautifier(req));
  return s.replyOKText("Stuff!!");
};
s.setDefault("/stuff");
\  To generate a SSL key store you can use Java's keytool:

keytool -genkey -keyalg RSA -alias selfsigned -keystore keystore.jks -storepass password -validity 360 -keysize 2048 -ext SAN=DNS:localhost,IP:127.0.0.1  -validity 9999

And then add keystore.jks to the openaf.jar and have keyStorePath = "/keystore.jks".

HTTPd.add

HTTPd.add(aURI, aFunction)

Adds a custom responder to the provided URI. Any call to the URI will trigger a call to  the provided function. The function will receive the request as an argument. For example:

 var hs = new HTTPd(1234);
 hs.add("/example", function(req) { hs.replyOKText(beautifier(req)); }

HTTPd.addEcho

HTTPd.addEcho(aURI)

Adds a echo responder to the provided URI. Useful for debugging http requests to  a server instance.

HTTPd.addFileBrowse

HTTPd.addFileBrowse(aURI, aFilepath)

Adds a responder to the provided URI that provides a very basic file browse to the provided aFilepath. Warning: keep in mind that this will expose files without any credential checking.

HTTPd.addSession

HTTPd.addSession(aSessionID)

Provides a simple session track mechanism adding the session ID provided. See HTTPServer.setSession to add data.

HTTPd.addStatus

HTTPd.addStatus(aURI)

Adds a status responder to the provided URI. Useful for debugging proposes

HTTPd.addXDTServer

HTTPd.addXDTServer(aURI, aAuthFunction, aOpsBrokerFunction)

Adds a WeDo XDT server responder to the provided URI with authentication provided by the aAuthFunction and operations provided by the aOpsBrokerFunction. For example:

 var hs = new HTTPd(1234);
 hs.addXDTServer('/xdt',
   function(auth) {
      if (auth.getUser() == 'adm' && auth.getPass() == 'Password1') {
         return true;
      } else {
      return false;
      }
   },
   function(sessionId, operation, paramIn, request) {
      switch(operation) {
         case "HelloWorld":
            return {"hello": "world!"};
         case "Ping":
            return paramIn;
         default:
            return paramIn;
      }
   }
 );

HTTPd.delSession

HTTPd.delSession(aSessionID)

Removes the provided session ID data from memory.

HTTPd.getPort

HTTPd.getPort() : number

Returns the listen port of the HTTP server instance.

HTTPd.getSession

HTTPd.getSession(aSessionID) : Object

Retrieves the current data stored for the provided session ID.

HTTPd.hasSession

HTTPd.hasSession(aSessionID) : boolean

Returns true if the provided session ID was add to memory. False otherwise.

HTTPd.reply

HTTPd.reply(data, aMimetype, aHTTPCode, aMapOfHeaders) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return aMimetype (string representation) with the provided data (string format) and the aHTTPCode and the map of extra HTTP headers.

HTTPd.replyBytes

HTTPd.replyBytes(data, aMimetype, aHTTPCode, aMapOfHeaders) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return aMimetype (string representation) with the provided data (as an array of bytes), the aHTTPCode and the map of extra HTTP headers.

HTTPd.replyOKBin

HTTPd.replyOKBin(data) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return application/octet-stream mimetype with the provided data (as an array of bytes) and a HTTP code of OK.

HTTPd.replyOKHTML

HTTPd.replyOKHTML(data) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return a HTML mimetype with the provided data (in string format) and a HTTP code of OK.

HTTPd.replyOKJSON

HTTPd.replyOKJSON(data) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return a JSON mimetype with the provided data (in string format) and a HTTP code of OK.

HTTPd.replyOKText

HTTPd.replyOKText(data) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return a text mimetype with the provided data and a HTTP code of OK.

HTTPd.replyOKXML

HTTPd.replyOKXML(data) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return a XML mimetype with the provided data (in string format) and a HTTP code of OK.

HTTPd.replyStream

HTTPd.replyStream(stream, aMimetype, aHTTPCode, aMapOfHeaders) : Object

Builds a response object suitable to provide a reply to a HTTP request for a function used with the HTTPServer.add method. It will return aMimetype (string representation) with the provided input stream, the aHTTPCode and the map of extra HTTP headers.

HTTPd.setDefault

HTTPd.setDefault(aURI)

Sets the default URI to redirect all requests that don't have a responder associated. For example:

 var hs = new HTTPd(1234);
 hs.addEcho("/echo");
 hs.setDefault("/echo");

HTTPd.setSession

HTTPd.setSession(aSessionID, anObject)

Sets the provided anObject as the session data for the session ID provided.

HTTPd.stop

HTTPd.stop()

Tries to stop the currently running HTTP server instance.

Clone this wiki locally