API Docs for:
Show:

server_com_authentication_rest Class

Provides the HTTPS REST server.

Methods

config

(
  • path
)

Configurates the REST server properties by a configuration file. The file must use the JSON syntax.

The method can throw an Exception.

Parameters:

  • path String

    The path of the configuration file

execute

() private

Executed by all REST request. It calls the appropriate REST plugin function.

setAllRestPluginsAstProxy

(
  • comp
)
private

Sets the asterisk proxy component for all the REST plugins.

Parameters:

  • comp Object

    The asterisk proxy object

setAllRestPluginsLogger

(
  • log
)
private

Call setLogger function for all REST plugins.

Parameters:

  • log Object

    The logger object.

setCompAstProxy

(
  • comp
)
static

Set the asterisk proxy architect component to be used by REST plugins.

Parameters:

  • comp Object

    The architect asterisk proxy component

setCompAuthentication

(
  • compAuthentication
)
static

Set the authentication architect component to be used by REST plugins.

Parameters:

  • compAuthentication Object

    The architect authentication component

setCompUser

(
  • comp
)
static

Set the user architect component to be used by REST plugins.

Parameters:

  • comp Object

    The user component

setCompUtil

(
  • comp
)
static

Set the utility architect component to be used by REST plugins.

Parameters:

  • comp Object

    The architect utility component

setLogger

(
  • log
)
static

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

start

() static

Start the HTTPS REST server.

Properties

address

String private

Listening address of the REST server.

IDLOG

String private final

The module identifier used by the logger.

Default: [server_com_authentication_rest]

logger

Object private

The logger. It must have at least three methods: info, warn and error.

Default: console

port

String private

Listening port of the REST server.

proto

String private

Listening protocol of the REST server.

server

Object private

The HTTPS REST server.