@haxall/haxall
    Preparing search index...

    Class AuthClientContext

    AuthClientContext used to manage the process for authenticating with HTTP/HTTPS server. Once authenticated an instance of this class is used to prepare to additional WebClient requests.

    Hierarchy (View Summary)

    • Obj
      • AuthClientContext

    Implements

    • HaystackClientAuth
    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • 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

    • Standard error to raise

      Parameters

      • msg: string

      Returns AuthErr

    • Make GET request to the server, return response content

      Parameters

      Returns string

    • 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

    • Headers we wish to use for AuthClient requests

      Returns Map<string, string>

    • Headers we wish to use for AuthClient requests

      Parameters

      • it: Map<string, string>

      Returns void

    • Have we successfully authenticated to the server

      Returns boolean

    • Have we successfully authenticated to the server

      Parameters

      • it: boolean

      Returns void

    • 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

    • Logging instance

      Returns Log

    • Plaintext password for authentication

      Returns string

    • Plaintext password for authentication

      Parameters

      • it: string

      Returns void

    post

    • post(c: WebClient, content: string): string

      Make POST request to the server, return response content

      Parameters

      Returns string

    • Prepare a WebClient instance with the auth cookies/headers

      Parameters

      Returns WebClient

    • Get a required rsponse header

      Parameters

      Returns string

    • SocketConfig for WebClient sockets

      Returns SocketConfig

    • Stash allows you to store state between messages while authenticating with the server.

      Returns Map<string, JsObj>

    • Stash allows you to store state between messages while authenticating with the server.

      Parameters

      Returns void

    • 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

    • URI used to open the connection

      Returns Uri

    • Username used for authentication

      Returns string

    • User agent string

      Returns string

    • 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

    • Parameters

      Returns void

    • Returns AtomicInt

    • Parameters

      Returns number

    • Parameters

      Returns void

    • 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

    • Debug command line tester

      Parameters

      Returns void

    • Open an authenticated context which can be used to prepare additional requests

      Parameters

      Returns AuthClientContext