Configuration

This page is about HCMS setup, if you are looking for the API configuration, please have a look to model documentation.

Here is the application configuration:

generate-frisby-skeleton.output (env: GENERATE_FRISBY_SKELETON_OUTPUT)

Where to generate the skeleton (generate-frisby-skeleton command only). Default: hcms-frisby.

hcms.database-init.enabled (env: HCMS_DATABASE_INIT_ENABLED)

Should database be initialized at startup. Default: true.

hcms.database-init.ignoreErrors (env: HCMS_DATABASE_INIT_IGNOREERRORS)

When enabled is true, should errors be ignored if any. Default: false.

hcms.database-init.scripts (env: HCMS_DATABASE_INIT_SCRIPTS)

Classpath scripts to use to seed the database if create is true. Default: java.util.List.of("ddl/01-create-database.h2.sql").

hcms.database.defaultAutoCommit (env: HCMS_DATABASE_DEFAULTAUTOCOMMIT)

Should autocommit be used. Default: false.

hcms.database.driver (env: HCMS_DATABASE_DRIVER)

JDBC driver to use to get connections.

hcms.database.logAbandoned (env: HCMS_DATABASE_LOGABANDONED)

Should abandons be logged. Default: false.

hcms.database.maxActive (env: HCMS_DATABASE_MAXACTIVE)

Max active connections. Default: 100.

hcms.database.minEvictableIdleTime (env: HCMS_DATABASE_MINEVICTABLEIDLETIME)

Timeout before any eviction test for a connection. Default: 60000.

hcms.database.minIdle (env: HCMS_DATABASE_MINIDLE)

Min number of connection - even when nothing happens. Default: 2.

hcms.database.password (env: HCMS_DATABASE_PASSWORD)

Database password.

hcms.database.removeAbandoned (env: HCMS_DATABASE_REMOVEABANDONED)

Should detected as abandonned connections be dropped. Default: false.

hcms.database.removeAbandonedTimeout (env: HCMS_DATABASE_REMOVEABANDONEDTIMEOUT)

Abandon timeout. Default: 60.

hcms.database.testOnBorrow (env: HCMS_DATABASE_TESTONBORROW)

Should connections be tested when retrieved from the pool. Default: false.

hcms.database.testOnReturn (env: HCMS_DATABASE_TESTONRETURN)

Should connections be tested when returning to the pool. Default: false.

hcms.database.testWhileIdle (env: HCMS_DATABASE_TESTWHILEIDLE)

Should connections be tested when not used and in the pool. Default: true.

hcms.database.timeBetweenEvictionRuns (env: HCMS_DATABASE_TIMEBETWEENEVICTIONRUNS)

Timeout (ms) between connection tests. Default: 5000.

hcms.database.url (env: HCMS_DATABASE_URL)

JDBC URL. Can be set to - for commands other than serve to ignore database provisioning/init.

hcms.database.username (env: HCMS_DATABASE_USERNAME)

Database username.

hcms.database.validationQuery (env: HCMS_DATABASE_VALIDATIONQUERY)

Test query for eviction - if not set the driver one is used.

hcms.database.validationQueryTimeout (env: HCMS_DATABASE_VALIDATIONQUERYTIMEOUT)

Default timeout for validations. Default: 30.

hcms.devMode (env: HCMS_DEVMODE)

Should dev mode be enabled, ie reload the model on read if it changed. Default: true.

hcms.disabledRenderers (env: HCMS_DISABLEDRENDERERS)

List of disabled renderers (findById/findAll methods). Default: java.util.List.of().

hcms.maxBulkRequest (env: HCMS_MAXBULKREQUEST)

Max bulk size, i.e. how many requests can be sent at once to be executed in the same transaction. Default: 50.

hcms.modelLocation (env: HCMS_MODELLOCATION)

Path of the model to deploy. Default: conf/model.json.

hcms.password.algorithm (env: HCMS_PASSWORD_ALGORITHM)

Algorithm to use for password hashing. Default: PBKDF2WithHmacSHA256.

hcms.password.iterations (env: HCMS_PASSWORD_ITERATIONS)

Number of iterations to use for password hashing. Default: 310_000.

hcms.password.key-length (env: HCMS_PASSWORD_KEY_LENGTH)

Key length to use for password hashing. Default: 512.

hcms.password.salt-length (env: HCMS_PASSWORD_SALT_LENGTH)

Salt length to use for password hashing. Default: 16.

hcms.security.accessValidity (env: HCMS_SECURITY_ACCESSVALIDITY)

Access token validity for date validation (in seconds). Default: 900.

hcms.security.algorithm (env: HCMS_SECURITY_ALGORITHM)

JWT algorithm. Default: RS256.

hcms.security.issuer (env: HCMS_SECURITY_ISSUER)

JWT issuer. Default: https://hcms.yupiik.io/token/ .

hcms.security.keys.$index.alg (env: HCMS_SECURITY_KEYS_INDEX_ALG)

hcms.security.keys.$index.crv (env: HCMS_SECURITY_KEYS_INDEX_CRV)

hcms.security.keys.$index.e (env: HCMS_SECURITY_KEYS_INDEX_E)

hcms.security.keys.$index.kid (env: HCMS_SECURITY_KEYS_INDEX_KID)

hcms.security.keys.$index.kty (env: HCMS_SECURITY_KEYS_INDEX_KTY)

hcms.security.keys.$index.n (env: HCMS_SECURITY_KEYS_INDEX_N)

hcms.security.keys.$index.use (env: HCMS_SECURITY_KEYS_INDEX_USE)

hcms.security.keys.$index.x (env: HCMS_SECURITY_KEYS_INDEX_X)

hcms.security.keys.$index.x5c (env: HCMS_SECURITY_KEYS_INDEX_X5C)

hcms.security.keys.$index.y (env: HCMS_SECURITY_KEYS_INDEX_Y)

hcms.security.kid (env: HCMS_SECURITY_KID)

Active (signer) kid, must be found in keys to be able to validate it properly. Default: k0001.

hcms.security.privateKey (env: HCMS_SECURITY_PRIVATEKEY)

RSA PEM (private key) - ensure to set the certificate in keys with the right kid.

hcms.security.refreshValidity (env: HCMS_SECURITY_REFRESHVALIDITY)

Refresh token validity for date validation (in seconds). Default: 28_800L.

hcms.security.tolerance (env: HCMS_SECURITY_TOLERANCE)

Tolerance for date validation (in seconds). Default: 30.

tracing.accumulator-buffer-size (env: TRACING_ACCUMULATOR_BUFFER_SIZE)

How many spans can stay in memory before a forced flush. Default: 2_048.

tracing.enabled (env: TRACING_ENABLED)

Is the tracing enabled. Default: false.

tracing.flush-timeout (env: TRACING_FLUSH_TIMEOUT)

How often to force a zipkin flush. Ignored if negative. Default: 20_000L.

tracing.headers-span (env: TRACING_HEADERS_SPAN)

Zipkin span header name. Default: X-B3-SpanId.

tracing.headers-trace (env: TRACING_HEADERS_TRACE)

Zipkin trace header name. Default: X-B3-TraceId.

tracing.operation (env: TRACING_OPERATION)

Is the tracing enabled. Default: zipkin-client.

tracing.service (env: TRACING_SERVICE)

Zipkin service name. Default: zipkin-client.

tracing.skip-tls-checks (env: TRACING_SKIP_TLS_CHECKS)

Should all SSL connections be supported over HTTPS (testing only). Default: false.

tracing.timeout-connect (env: TRACING_TIMEOUT_CONNECT)

Connect timeout to Zipkin server. Default: 20_000L.

tracing.timeout-request (env: TRACING_TIMEOUT_REQUEST)

Request timeout to Zipkin server. Default: 20_000L.

tracing.urls (env: TRACING_URLS)

Zipkin URL(s) - a single successful call is kept but it enables failover. Default: java.util.List.of().