@haxall/haxall
    Preparing search index...

    Class ObixWebMod

    ObixWebMod:

    {base}                    // lobby
    {base}/xsl // style sheet
    {base}/icon/{id}/{uri} // icon tunnel

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Get represenation of the About object. Subclasses should override this to customize their about. See make to customize vendor and product fields.

      Returns ObixObj

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Returns ObixLib

    • Get represenation of the Lobby object. Subclasses can override this to customize their lobby.

      Returns ObixObj

    • Convenience method to respond to a DELETE request. Default implementation returns a 501 Not implemented error.

      Returns void

    • Convenience method to respond to a GET request. Default implementation returns a 501 Not implemented error.

      Returns void

    • Convenience method to respond to a HEAD request. Default implementation returns a 501 Not implemented error.

      Returns void

    • Invoke the operation for the given URI and return the result. The URI is relative to the ObixMod base - see web::WebReq.modRel Throw UnresolvedErr if URI doesn't map to a valid operation.

      Parameters

      Returns ObixObj

    • Convenience method to respond to a OPTIONS request. Default implementation returns a 501 Not implemented error.

      Returns void

    • Convenience method to respond to a POST request. Default implementation returns a 501 Not implemented error.

      Returns void

    • Convenience method to respond to a PUT request. Default implementation returns a 501 Not implemented error.

      Returns void

    • Return the ObixObj representation of the given URI for the application. The URI is relative to the ObixMod base - see web::WebReq.modRel. Throw UnresolvedErr if URI doesn't map to a valid object. The resulting object must have its href set to the proper absolute URI according to 5.2 of the oBIX specification.

      Parameters

      Returns ObixObj

    • Service a web request. The default implementation routes to onGet, onPost, etc based on the request's method.

      Returns void

    • Initialization callback when web server is started.

      Returns void

    • Cleanup callback when web server is stoppped.

      Returns void

    • Convenience method to respond to a TRACE request. Default implementation returns a 501 Not implemented error.

      Returns void

    • Write the value for the given URI and return the new representation. The URI is relative to the ObixMod base - see web::WebReq.modRel. Throw UnresolvedErr if URI doesn't map to a valid object. Throw ReadonlyErr if URI doesn't map to a writable object.

      Parameters

      Returns ObixObj

    • The WebReq instance for this current web request. Raise an exception if the current actor thread is not serving a web request.

      Returns WebReq

    • The WebRes instance for this current web request. Raise an exception if the current actor thread is not serving a web request.

      Returns WebRes

    • Returns HxRuntime

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Find an existing watch by its identifier or return null.

      Parameters

      • id: string

      Returns ObixModWatch

    • Get represenation of the WatchService object. Subclasses can override this to customize their watch service.

      Returns ObixObj

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Construct with the given map for obix:About parameters:

      • serverName: defaults to Env.cur.host
      • vendorName: defaults to "Fantom"
      • vendorUrl: defaults to "https://fantom.org/"
      • productName: defaults to "Fantom"
      • productVersion: defaults to version of obix pod
      • productUrl: defaults to "https://fantom.org/"

      Parameters

      Returns ObixWebMod