Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Mediante es módulo, los usuarios pueden definir de forma sencilla las distintas configuraciones; plataforma, usa YAML o JSON como base.

Panel de Control UI

Para crear y modificar las Configuraciones, el usuario puede dirigirse al menú DEV TOOLS > Gestión de Configuraciones.

...

Nota: estas Configuraciones emplean Yaml, la respuesta de estos servicios REST es visualmente poco amigable.

Uso del cliente Java para la gestión de configuración

Los clientes Java ofrecen una clase de Configuración Wrapper.

Configuración de la Dependencia

Para usar este API es necesario añadir el siguiente repositorio al proyecto pom.xml.

...

Code Block
languagexml
<dependency>
	  <groupId>com.minsait.onesait.platform</groupId>
	  <artifactId>onesaitplatform-java-client</artifactId>
	  <version>2.1.0-RELEASE</version>
</dependency>

Inicialización

El primer caso es crear un objeto ConfigurationManager, para poder utilizar el cliente debes introducir como argumentos el usuario, la contraseña y el servidor URL:

...

Una vez inicializado el objeto, ya se puede usar para operar con las Configuraciones de Plataforma.

Crear una Configuración

Para crear una configuración es necesario crear antes un Objeto de tipo Configuration:

...

Este método, si tiene éxito, devolverá el id de la configuración que se acaba de crear. Con este identificador se puede recuperar la configuración en un futuro, eliminarla o actualizarla.

Obtener una configuración

Hay dos métodos para recuperar una configuración:

...

En caso de no conocer la id se puede obtener la configuración mediante los parámetros en el argumento. En el caso de existir, estos métodos devuelven una instancia de la Configuración.

Obtener todas las Configuraciones

Es posible obtener una lista de Configuraciones según el usuario logado, llamando al método getConfigurations:

Code Block
languagejava
List<Configuration> configurations = manager.getConfigurations()

Editar una Configuración

Para editar una configuración es necesario conocer su id.

...

Code Block
languagejava
Configuration retrievedConfig = manager.getConfiguration(IDENTIFICATION, ConfigurationType.EXTERNAL_CONFIG, ENVIRONMENT);
log.info("Retrieved config from the platform by parameters");
retrievedConfig.setDescription("This is a new description");
log.info("Updating configuration with new description and identification {}", IDENTIFICATION);
manager.updateConfiguration(configuration, retrievedConfig.getId());

Borrar una Configuración

Para eliminar una configuración hay que llamar al método deleteConfiguration pasando el id de la configuración.

Code Block
log.info("Retrieved config from the platform by id");
Configuration retrievedConfig = manager.getConfiguration(IDENTIFICATION, ConfigurationType.EXTERNAL_CONFIG, ENVIRONMENT);
log.info("Retrieved config from the platform by parameters");
log.info("Deleting configuration with id {}", retrievedConfig .getId());
manager.deleteConfiguration(IDENTIFICATION, ConfigurationType.EXTERNAL_CONFIG, ENVIRONMENT);

Test

Hay un test dentro de la librería que sirve como ejemplo. Prueba las operaciones básicas descritas en este tutorial. En caso de tener dudas, puedes consultar el código aquí:

...