...
Nota: estas Configuraciones emplean Yaml, la respuesta de estos servicios REST es visualmente poco amigable.
Cómo configurar tu aplicación para utilizar la configuración centralizada
| Note |
|---|
Sólo para versiones a partir de la 5.0.0 |
En primer lugar tendrás que añadir al pom.xml del proyecto que va a actuar como Config Server la siguiente dependencia.
| Code Block |
|---|
<dependency>
<groupId>com.minsait.onesait.platform</groupId>
<artifactId>onesaitplatform-spring-config-client</artifactId>
<version>5.0.0</version>
</dependency> |
Y tendrás que añadir el repositorio de Plataforma al listado de repositorios dentro del pom:
| Code Block |
|---|
<repositories>
<repository>
<id>onesait platform releases</id>
<url>https://nexus.onesaitplatform.com/nexus/content/repositories/releases/</url>
</repository>
</repositories> |
Una vez añadida la dependencia tendrás que añadir las siguientes propiedades a tu application.yml
| Code Block |
|---|
onesaitplatform:
api.rest:
token: <ONESAITPLATFORM_API_KEY>
endpoint: <ONESAITPLATFORM_BASE_URL>
spring.cloud.config:
enabled: false |
Donde:
ONESAITPLATFORM_API_KEY es el API Key de un usuario con rol administrador de la Plataforma. Esta key se utilizará para gestionar la seguridad a nivel de Pltaforma para poder obtener la configuración centralizada.
ONESAITPLATFORM_BASE_URL es el endpoint del controlpanel de la Plataforma donde se encuentra la configuración centralizada que queremos utilizar.
Una vez configurado el proyecto, basta con inyectar el Bean ConfigurationManager y acceder a los métodos disponibles:
| Code Block |
|---|
|
@Autowired
ConfigurationManager configManager; |
Crear configuración
| Code Block |
|---|
|
configManager.createConfiguration(configuration) |
Dónde el objeto configuration está conpuesto por los siguientes campos:
| Code Block |
|---|
|
private String id;
private String username;
@NonNull
private ConfigurationType type;
@NonNull
private String description;
@NonNull
private String identification;
@NonNull
private String environment;
private String yml; |
Obtener configuración
Hay múltiples métodos para obtener una configuración dependiendo de los parámetros de los que se disponga:
| Code Block |
|---|
|
# Obtener configuración a través del identificador, entorno y tipo
Configuration config = configManager.getConfiguration(identification, environament, type)
# Obtener configuración por ID
Configuration config = configManager.getConfigurationById(id)
# Obtener configuración por identificador
Configuration config = configManager.getConfigurationByIdentification(identification)
# Obtener todas las configuraciones del usuario
List<Configuration> configList = configManager.getConfigurations() |
Actualizar configuración
| Code Block |
|---|
|
configManager.updateConfiguration(configuration); |
Borrar configuración
| Code Block |
|---|
|
# Borrar configuración por identificador, entorno y tipo
configManager.deleteConfiguration(identification, environment, type);
# Borrar configuración por ID
configManager.deleteConfigurationById(id); |
Uso del cliente Java para la gestión de configuración
| Note |
|---|
Seguir este apartado solo para versiones inferiores a la 3.3.2 del cliente Java. Se recomienda utilizar la versión 5.0.0 (explicado en el apartado anterior) |
Los clientes Java ofrecen una clase de Configuración Wrapper.
...