Unblu Server Configuration Validation

1. Introduction

In order to avoid miss configuration (or configuration that does not have an effect), the unblu server validates it's configuration against the configuration schema.

This document describes how configuration validation works and how it can be configured if required.

2. Default behaviour

If configuration validation is not specially configured, it behaves as follows.

When starting, the unblu server validates the given configuration against it's inherent configuration schema and logs errors (if the configuration is not valid) and warnings (if the configuration not recommended) messages to the log file (see Unblu Server Logging).

If one or more errors are detected, the unblu server will refuse to start up and will deliver 503 responses with status text CONFIGURATION_PROBLEM for all requests.

3. Validation

Configuration validation performs the following validations

  1. Use of a configuration property that is not defined in the configuration schema -> ERROR
  2. A configuration value cannot be converted to the expected type according to the configuration schema -> ERROR
  3. Use of an internal configuration property -> WARNING
  4. A set of special rules that define dependencies between configuration properties -> WARNING or ERROR

4. Configuration

Unblu configuration validation is configurable, the table below shows the most important configuration settings:

keytypedefaultValuedescription

com.unblu.configuration.validation.severityUndefinedKey

severityERRORseverity for use of a configuration property that is not defined

com.unblu.configuration.validation.severityInternalKey

severityWARNINGseverity for using internal properties

com.unblu.configuration.validation.exitOnError

booleanfalsewhether or not unblu should call System.exit if the configuration is not valid (not recommended if using in an application server!)
com.unblu.configuration.validation.failOnErrorbooleantruewhether or not unblu should deliver 503 responses if configuration is not valid

com.unblu.configuration.validation.enabled

booleanfalseenable/disable configuration validation.

How can we help?

Chat with us and we will take you through our site!

Read about how we use cookies and how you can control them by clicking "Cookie Settings." If you continue to use this site, you consent to our use of cookies.