relax

Class Relaxer

lucee.Component
    extended by relax.Relaxer

Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- The Relaxer service

Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any DSLService


    • access = public
    • returntype = any
    • inject = APIService@relax
    true false
    any log


    • access = public
    • returntype = any
    • inject = logbox:logger:{this}
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any clearHistory()
         Clear the history stack.
    string getDSLService()
    array getHistory()
         Get the relaxer history array.
    string getLog()
    numeric getMaxHistory()
         Get the max history stack, this comes from the relax settings.
    any pushHistory(any values)
         Clear the history stack.
    any send([string method='GET'], string resource, [struct headers='[runtime expression]'], [struct params='[runtime expression]'], [string authUsername], [string authPassword], [string HTTPProxy], [numeric HTTPProxyPort='80'], [numeric timeout='20'])
         Send a Relaxer Request according to data.
    any setDSLService(any DSLService)
    any setLog(any log)
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    DSLService

    property any DSLService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - APIService@relax
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:{this}
    serializable - true

    Method Detail

    clearHistory

    public any clearHistory()

    Clear the history stack

    Returns:
    Relaxer

    getDSLService

    public string getDSLService()


    getHistory

    public array getHistory()

    Get the relaxer history array


    getLog

    public string getLog()


    getMaxHistory

    public numeric getMaxHistory()

    Get the max history stack, this comes from the relax settings


    pushHistory

    public any pushHistory(any values)

    Clear the history stack

    Parameters:
    values
    Returns:
    Relaxer

    send

    public any send([string method='GET'], string resource, [struct headers='[runtime expression]'], [struct params='[runtime expression]'], [string authUsername], [string authPassword], [string HTTPProxy], [numeric HTTPProxyPort='80'], [numeric timeout='20'])

    Send a Relaxer Request according to data

    Parameters:
    method - HTTP Method
    resource - HTTP Resource to hit
    headers - HTTP headers (struct)
    params - HTTP FORM Data (struct)
    authUsername - HTTP Basic Auth Username
    authPassword - HTTP Basic Auth password
    HTTPProxy - HTTP Proxy server host
    HTTPProxyPort - HTTP Proxy server host port
    timeout - HTTP Timeout defaults to 20

    setDSLService

    public any setDSLService(any DSLService)

    Parameters:
    DSLService

    setLog

    public any setLog(any log)

    Parameters:
    log