dwsconfiguration

10 min

El objeto dwsconfiguration le permite configurar el Servidor web de diagnóstico (DWS) en el reproductor.

El DWS local está deshabilitado de forma predeterminada en BOS 9.0.218 en la rama 9.0 y en BOS 9.1.75 en la rama 9.1. En versiones anteriores del OS, el LDWS está habilitado en el puerto 80, con el número de serie del reproductor como contraseña y "admin" como nombre de usuario.

IDL de dwsconfiguration

[
   GarbageCollected,
] interface DWS {
    DWSConfig defaultConfig();
    Promise<DWSConfig> getConfig();
    Promise<DWSResult> applyConfig(DWSConfigWritable config);
};

interface DWSConfig {
    attribute int port;
    attribute Password password;
    attribute Array<String> authenticationList;
};

interface DWSConfigWritable : DWSConfig {
    attribute Password password;
};

interface Password {
    attribute String value;
    attribute bool obfuscated;
};

interface DWSResult {
    attribute bool restartRequired;
};

Creación de objetos

Para crear un objeto dwsconfiguration , primero cargue el módulo brightsign/dwsconfiguration usando el método require() . Luego cree una instancia de la clase dwsconfiguration .

var DWSConfigurationClass = require("@brightsign/dwsconfiguration");
var dwsConfig = new DWSConfigurationClass();

DWS

Utilice esta interfaz para recuperar y modificar la configuración de DWS.

getConfig()

Promise <DWSConfig> getConfig()

Devuelve una interfaz DWSConfig que contiene la información actual de configuración de DWS. Si hay una contraseña establecida, getConfig() devolverá True para el parámetro contraseña . Si no hay una contraseña establecida, si hay una contraseña establecida, getConfig() devolverá False para el parámetro contraseña .

applyConfig()

Promise <DWSResult> applyConfig(DWSConfigWritable config)

Aplica la configuración de DWS al reproductor. Este método acepta una interfaz DWSConfig . Devuelve una interfaz DWSResult que indica si se requiere o no un reinicio para que los cambios surtan efecto (la persona que llama es responsable de solicitar el reinicio). La propiedad restartRequired de DWSResult indica si se requiere el reinicio.

El parámetro config debe contener la configuración completa deseada. Cualquier configuración anterior se sobrescribe. Si desea cambiar un elemento mientras mantiene el resto de la configuración igual, llame a getConfig y modifique el objeto devuelto (consulte el ejemplo en la sección Examples).

DWSConfig

Esta interfaz contiene parámetros de configuración de DWS:

puerto int: El número de puerto del DWS, ubicado en la dirección IP del reproductor. El valor predeterminado para el DWS es el puerto 80. Establecer este valor en 0 deshabilitará el DWS.
contraseña Password: Una interfaz Contraseña que contiene configuraciones de contraseña para el DWS. Recomendamos enfáticamente que establezca una contraseña segura, especialmente en escenarios de producción. Para habilitar el DWS sin protección por contraseña, establezca valor en una cadena vacía y ofuscado en false.
authenticationList Array: El esquema de autenticación para la contraseña del DWS. Esta entrada actualmente acepta solo un valor. Los siguientes son valores aceptados:
- "básico": La contraseña se validará mediante autenticación básica.
- "resumen": La contraseña se validará mediante autenticación de acceso digest.

Para habilitar el DWS sin autenticación por contraseña, establezca password.value como una cadena vacía y password.obfuscated como false al llamar al método applyConfig() .

DWSConfigWritable

contraseña Password: Una interfaz Contraseña que contiene configuraciones de contraseña para el DWS

Password

Esta interfaz contiene configuraciones de contraseña para el DWS:

valor String: La contraseña del DWS
ofuscado bool: Una marca que indica si la cadena de contraseña está ofuscada. Comuníquese con [email protected] para obtener más información sobre cómo generar una clave para la ofuscación y almacenarla en el reproductor.

DWSResult

Esta interfaz contiene resultados de una operación applyConfig().

restartRequired bool: Una marca que indica si se requiere un reinicio para que los cambios surtan efecto (el script debe realizar el reinicio)

Ejemplos

var DWSConfigurationClass = require("@brightsign/dwsconfiguration");
var dwsConfig = new DWSConfigurationClass();

var configData = {};
var pw = {};

configData.port = 1010;
configData.password = pw;
configData.authenticationList = ["basic"];

pw.value = "password";
pw.obfuscated = false;

dwsConfig.applyConfig(configData).then(
        function(data) {
            console.log(JSON.stringify(data));
        })
    .catch(
        function(data) {
            console.log(JSON.stringify(data));
        });
dwsConfig.getConfig().then(
        function(data) {
            console.log(JSON.stringify(data));
        })
    .catch(
        function(data) {
            console.log(JSON.stringify(data));
        });

Para cambiar un elemento mientras mantiene el resto de la configuración igual, llame a getConfig y modifique el objeto devuelto:

  var DWSConfigurationClass = require("@brightsign/dwsconfiguration");
  var dwsConfig = new DWSConfigurationClass();
  var pw = {};
  dwsConfig.getConfig()
  .then(function(config) {
    pw.value = "password";
    pw.obfuscated = false;
    config.password = pw;
    dwsConfig.applyConfig(config);
  })
  .then(function() {
    console.log("Success");
  })
  .catch(function(error) {
    console.log(JSON.stringify(error));
  });