API Docs for: 2.6
Show:

server_com_sms_rest Class

Module: com_sms_rest

Provides the 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

configPrivacy

(
  • path
)

Customize the privacy used to hide phone numbers 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.

setAllRestPluginsAuthorization

(
  • comp
)
private

Sets the authorization component for all REST plugins.

Parameters:

  • comp Object

    The authorization architect component

setAllRestPluginsCompSms

(
  • comp
)
private

Sets the sms component for all REST plugins.

Parameters:

  • comp Object

    The sms architect component

setAllRestPluginsLogger

(
  • log
)
private

Call setLogger function for all REST plugins.

Parameters:

  • log Object

    The logger object.

setAllRestPluginsPrivacy

(
  • str
)
private

Calls setPrivacy function for all REST plugins.

Parameters:

  • str String

    The string used to hide last digits of phone numbers

setCompAuthorization

(
  • comp
)
static

Set the authorization architect component.

Parameters:

  • comp Object

    The architect authorization component

setCompSms

(
  • comp
)
static

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

Parameters:

  • comp Object

    The architect sms 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 REST server.

Properties

address

String private

Listening address of the REST server. It can be customized by the configuration file.

Default: "localhost"

IDLOG

String private final

The module identifier used by the logger.

Default: [server_com_sms_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. It can be customized by the configuration file.

server

Object private

The REST server.