The following table describes the ZooKeeper properties of the Lists microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | server.servlet.contextPath | This property holds the context path of the Spring Boot application. |
| 2 | server.ssl.enabled | This property controls the SSL configuration of the Boot application. When it is set to true, the application is started in HTTPS protocol only and all HTTP request will be rejected. |
| 3 | server.ssl.enabled-protocols | This property holds the SSL protocols enabled for this application. The values are given as comma-separated. |
| 4 | server.ssl.key-alias | This property holds the key store alias name set during the import using keytool utility. |
| 5 | server.ssl.key-store | This property holds the key store's PrivateKeyEntry which will be used as the SSL certificate for the microservice. |
| 6 | server.ssl.key-store-password | This property holds the key store password for accessing the key store as mentioned in the key-store property. |
| 7 | server.ssl.key-store-type | This property holds the key store type. |
| 8 | server.tomcat.accesslog.directory | This property holds the directory in which log files are created. It can be absolute or relative to the Tomcat's base directory. |
| 9 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
| 10 | server.tomcat.accesslog.max-days | The property holds the maximum number of days the rotated access logs will be retained before it is deleted. The default value is 10 days. |
| 11 | server.tomcat.accesslog.pattern | This property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters. |
| 12 | server.tomcat.max-threads | This property controls the Tomcat request thread. |
| 13 | skava.auditlog.enabled | This property is used to enable the Mongo SSL component. It is set to enable or disable the audit log component. |
| 14 | skava.auditlog.file-location | This property enables or disables the audit log component. |
| 15 | skava.auditlog.layout-type | This property describes the layout type details. |
| 16 | skava.auditlog.mongodb.database | This property is used to set the database name for the Mongo server. |
| 17 | skava.auditlog.mongodb.enabled | This property is used to enable or disable to store the audit logs in the Mongo DB. |
| 18 | skava.auditlog.mongodb.host | This property is used to set the host for the Mongo server. |
| 19 | skava.auditlog.mongodb.mongoAuthRequired | This property is used to set the port for the Mongo server. |
| 20 | skava.auditlog.mongodb.password | This property is used to set the password for the Mongo server. |
| 21 | skava.auditlog.mongodb.port | This property is used to set the port for the Mongo server. |
| 22 | skava.auditlog.mongodb.sslEnabled | This property is used to enable the Mongo SSL component. |
| 23 | skava.auditlog.mongodb.uri | This property connects to the Mongo server. |
| 24 | skava.auditlog.mongodb.userName | This property is used to set the username for the Mongo server. |
| 25 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
| 26 | skava.authorization.authHeader | This property holds the HTTP request header name in which the authorization token (JWT) is passed by the caller. Since the functionality of validating token is inherited from the framework, this property's value is used for identifying the correct header and its value is considered for access/authorization checks. |
| 27 | skava.authorization.enabled | This property indicates whether the authorization component is enabled or disabled for the corresponding microservice. If the value is set as false, then all APIs are open to access without any authorization check and this is not recommended for the production or public APIs. For the production, production-like, or public environments, this property should be enabled (true). |
| 28 | skava.authorization.gettesttoken.enabled | This property indicates whether the authorization endpoint for test JWT tokens is enabled or not. If it is set to true, an API will be exposed to obtain test JWT tokens. |
| 29 | skava.authorization.superAdminRoleName | The property indicates the Super Admin role name for the corresponding microservice. |
| 30 | skava.authorization.tokenSecret | This property holds the secret which will be used to verify the signature of the JWT passed by the caller. Only if the JWT passed by the caller found valid with respect to signature, expiry and having necessary privileges, the request will be processed further. |
| 31 | skava.cache.cascadeCacheNames | This property enables the Cascade cache by its name. |
| 32 | skava.cache.enableCascade | This property enables or disables the Cascade cache. |
| 33 | skava.cache.enabled | This property enables or disables the cache. |
| 34 | skava.cache.localCache.config.cache_listcollection.cacheSize | This property holds the local cache entry size. |
| 35 | skava.cache.localCache.config.cache_listcollection.maxIdleInSeconds | This property holds the maximum idle time of the local cache in seconds. |
| 36 | skava.cache.localCache.config.cache_listcollection.timeToLiveInSeconds | This property holds the local cache expiry time in seconds. |
| 37 | skava.cache.localCache.type | This property sets the local cache type for L1 cache used in the cascade cache (uses both in-memory cache and server-side cache using Redis). |
| 38 | skava.cache.maxCacheSize | This property holds the cache size in bytes. If the value is greater than 0, then the cache is restricted based on the value. Otherwise, no limitation for cache. |
| 39 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by the application. |
| 40 | skava.cache.redis.clearCacheEventName | This property is used to set the event name for cache clear operation. |
| 41 | skava.cache.redis.client | This property indicates the type of client for Redis connection. |
| 42 | skava.cache.redis.cluster.maxRedirects | This property contains the maximum number of redirects to follow when executing commands across the clusters of the Redis server. |
| 43 | skava.cache.redis.cluster.nodes | This property contains a list of comma-separated host:port pairs to bootstrap from. This represents an initial list of cluster nodes. It is required to have at least one entry. |
| 44 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster of the Redis server. |
| 45 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 46 | skava.cache.redis.enabled | This property indicates whether the Redis component needs to be enabled or disabled for this application. It is recommended that it should be enabled (true) for the production and production-grade environments (like performance). |
| 47 | skava.cache.redis.expTimeTolive | This property holds the expiration time of Redis entries. That is the maximum time the objects are requested to be held in the Redis server. Using this property you are requesting Redis to hold the objects for the specified time but it is the LRU/LCU which will determine how long an entry survives in the cache. |
| 48 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
| 49 | skava.cache.redis.maxTimeTolive | This property holds the expiration time of the Redis entries. That is the maximum time the objects are requested to be held in the Redis server. Using this property you are requesting the Redis to hold the objects for the specified time but it is the LRU/LCU which will determine how long an entry survives in the cache. |
| 50 | skava.cache.redis.password | This property holds the password for connecting to the Redis server. This is required if the authentication is enabled for the Redis server. It is recommended to enable (that is, setting the value true) for the production cache server environment. |
| 51 | skava.cache.redis.pool.maxActive | This property holds the maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
| 52 | skava.cache.redis.pool.maxIdle | This property holds the maximum number of idle connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
| 53 | skava.cache.redis.pool.minIdle | This property holds the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. |
| 54 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
| 55 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
| 56 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated host:port pairs of the Redis server. |
| 57 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write. |
| 58 | skava.cache.useOnlyL2Cache | This property enables or disables the L2 cache (that is, in-memory cache). |
| 59 | skava.core.releasedefinition.enabled | This property enables the release definition endpoint. |
| 60 | skava.cors.allowedHeaders | This property is used to set the list of headers that a pre-flight request can list as allowed for use during an actual request. |
| 61 | skava.cors.allowedMethods | This property is used to set the HTTP methods to allow. For example, {@code "GET"}, {@code "POST"}, {@code "PUT"}, etc. |
| 62 | skava.cors.allowedOrigins | The list of allowed origins. For example, {@code "http://domain1.com"} for the specific origin or {@code "*"} for all the origins. |
| 63 | skava.cors.enabled | This property enables or disables the CORS component. |
| 64 | skava.cors.exposedHeaders | This property sets exposedHeaders for theCORS request. |
| 65 | skava.cors.maxAge | This property is used to configure how long in seconds the response from a preflight request can be cached by the clients. |
| 66 | skava.cors.pathPattern | This property enables the cross-origin request handling for the specified path pattern. |
| 67 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class. |
| 68 | skava.event.enabled | This property is used to enable or disable the event component. |
| 69 | skava.event.enableExternalEvent | This property enables or disables the external event component. |
| 70 | skava.event.enableFatEvent | This property enables or disables the fat event. |
| 71 | skava.event.eventbridge.eventBusName | This property sets the fully qualified name of the custom implementation class. |
| 72 | skava.event.eventbridge.region | This property sets the fully qualified name of the custom implementation class. |
| 73 | skava.event.externalClassName | This property sets the fully qualified name of the custom implementation class. |
| 74 | skava.event.externalFatEventClass | This property sets the fully qualified name of the custom implementation class. |
| 75 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
| 76 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
| 77 | skava.event.rabbitmq.concurrentConsumers | This property is used to set the maximum allowed concurrent consumers. |
| 78 | skava.event.rabbitmq.enabled | This property is used to enable or disable the RabbitMQ server for the event component. |
| 79 | skava.event.rabbitmq.host | This property is used to set the host for the RabbitMQ server. |
| 80 | skava.event.rabbitmq.password | This property is used to set password for the RabbitMQ server. |
| 81 | skava.event.rabbitmq.port | This property is used to set the port for the RabbitMQ server. |
| 82 | skava.event.rabbitmq.queueName | This property is used to set the queue name used by the event component. |
| 83 | skava.event.rabbitmq.routingKey | This property is used to set the routing key for the RabbitMQ server. |
| 84 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
| 85 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
| 86 | skava.event.rabbitmq.topicExchange | This property is used to set the topic exchange for the RabbitMQ server. |
| 87 | skava.event.rabbitmq.userName | This property is used to set the username for the RabbitMQ server. |
| 88 | skava.event.rabbitmq.virtualHost | This property is used to set the virtual host for the RabbitMQ server. |
| 89 | skava.hikari.cachePrepStmts | This property is used to set the value to true so that other configurations, like skava.hikari.prepStmtCacheSize and skava.hikari.prepStmtCacheSqlLimit have any effect. |
| 90 | skava.hikari.dataSourceClassName | This property is available only via programmatic configuration or IoC container. This property allows you to directly set the instance of the DataSource to be wrapped by the pool, rather than having HikariCP construct it via reflection. This can be useful in some dependency injection frameworks. When this property is specified, the dataSourceClassName property and all DataSource-specific properties will be ignored. There is no default value. |
| 91 | skava.hikari.enabled | This property enables or disables the Hibernate Hikari component. |
| 92 | skava.hikari.idleTimeout | This property controls the maximum amount of time that a connection is allowed to sit idle in the pool. This setting only applies when minimumIdle is defined to be less than maximumPoolSize. The idle connections will not be retired until the pool reaches minimumIdle connections. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 indicates the idle connections are never removed from the pool. The minimum allowed value is 10000ms (10 seconds). The default value is 600000 ms (10 minutes). |
| 93 | skava.hikari.maximumPoolSize | This property controls the maximum size of the pool, including both idle and in-use connections. This value determines the maximum number of actual connections to the database backend. The value is determined by your execution environment. When the pool reaches to this size and no idle connections are available, the call getConnection() block for up to connectionTimeout milliseconds before timing out. The default value is 10. |
| 94 | skava.hikari.maxLifetime | This property controls the maximum lifetime of a connection in the pool. An in-use connection will never be retired. Only when it is closed, it will be removed. On a connection-by-connection basis, minor negative attenuation is applied to avoid mass extinction in the pool. It is strongly recommended to set this value. The value should be several seconds shorter than any database or infrastructure-imposed connection time limit. The value 0 indicates no maximum lifetime (infinite lifetime) and is subject to the idleTimeout setting. The default value is 1800000 (30 minutes). |
| 95 | skava.hikari.prepStmtCacheSize | This property sets the cache size of the PreparedStatement. |
| 96 | skava.hikari.prepStmtCacheSqlLimit | This property sets the SQL limit of the PreparedStatement to be cached. |
| 97 | skava.hikari.useServerPrepStmts | This property is used to set useServerPrepStmts |
| 98 | skava.localization.cookieEnabled | This property enables fetching locale from the cookie. |
| 99 | skava.localization.defaultEncoding | This property sets the default encoding. |
| 100 | skava.localization.default-locale | This property sets the default locale. |
| 101 | skava.localization.enabled | This property enables or disables the localization component. |
| 102 | skava.localization.externalPath | This property sets the external path from which the messages are read. |
| 103 | skava.localization.param-name | This property holds the parameter name in which the localization component is used. |
| 104 | skava.localization.resourceBundleBaseName | This property sets the resource bundle base name. |
| 105 | skava.localization.useCodeAsDefaultMessage | This property sets the code as the default message. |
| 106 | skava.log.enabled | This property is used to set the resource bundles base name. |
| 107 | skava.log.fileAppenderEnabled | This property indicates whether the log needs to be appended to a log file or not. If it is set to true the log is written to the log file as specified in log4j2.yml. |
| 108 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not. |
| 109 | skava.log.fluentdHost | This property holds the hostname of Fluentd server instance where the log will be aggregated. |
| 110 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
| 111 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
| 112 | skava.log.fluentdTagName | This property holds the tag name to be added to the logs. |
| 113 | skava.mongo.database | This property is used to set the database name for the Mongo server. |
| 114 | skava.mongo.uri | This property connects to the MongoDB server. |
| 115 | skava.secretsmanager.className | this property specifies the class to be used for secret management. |
| 116 | skava.sleuth.trace-id128 | This property enables or disables the sleuth 128 bit trace ID in the logs. |
| 117 | skava.swaggerglobalparams.enabled | This property indicates the Swagger global params. The default value is false. If this property value is set to true, the Swagger global params from the application .yml will be referred and added in the Swagger UI. |
| 118 | spring.application.name | This property holds the application name of the Spring Boot application. |
| 119 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's autoconfiguration. |
| 120 | spring.cloud.zookeeper.config.enabled | This property is used to enable or disable the ZooKeeper. |
| 121 | spring.cloud.zookeeper.config.root | This property is used to enable or disable the ZooKeeper's base path. |
| 122 | spring.cloud.zookeeper.config.watcher.enabled | This property indicates whether the ZooKeeper watcher has been enabled or not. If it is set to true, the watcher is enabled and if there is any change in the ZooKeeper configuration is communicated to the server. Updated properties are loaded automatically if the implementation allows it. |
| 123 | spring.cloud.zookeeper.connect-string | This property is used to specify the location if the server locates somewhere other than localhost:2181. This configuration is required to locate the server. |
| 124 | spring.cloud.zookeeper.enabled | This property is used to enable or disable the ZooKeeper server. |
| 125 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 126 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 127 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 128 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 129 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 130 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 131 | skava.localization.additionalLocales | This property is used to set the additional locales. |
| 132 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 133 | web.exposure.include | This property is used to expose the management endpoints. |
| 134 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 135 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 136 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 137 | skava.event.rabbitmq.amqpEnabled | This property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
|
Revision History2024-06-19 | SD – Updated ZK properties for 8.17.0 to 8.16.0.
2023-10-22 | JP – Updated content for 8.15.4 release.
2023-01-06 | AN – Updated content for 8.13 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-12-10 | AN – Added the missing properties.
2020-03-09 | AN – Updated content for April 2020 release.
2020-01-14 | AN – Updated content for February 2020 release.
2019-07-09 | AM – Updated ZK properties for July 2019 release.
2019-06-09 | PLK – Minor copyedits.
2019-05-16 | AN – Updated to a new table tool.
2019-01-23 | PLK – Page created and content uploaded.