The following table describes the ZooKeeper properties for the Notification microservice:
S.NOPROPERTYDESCRIPTION
1hystrix.command.user-key.circuitBreaker.requestVolumeThresholdThis property sets the minimum number of requests in a rolling window that will trip the circuit.
2hystrix.command.user-key.circuitBreaker.sleepWindowInMillisecondsThis property sets the amount of time, after tripping the circuit, to reject requests before allowing attempts again to determine if the circuit should again be closed.
3hystrix.command.user-key.execution.isolation.thread.timeoutInMillisecondsThis property sets instance-specific values dynamically which overrides the preceding three levels of defaults.
4server.servlet.contextPathThis property holds the Spring Boot application's context path.
5server.ssl.enabledThis 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.
6server.ssl.enabled-protocolsThis property holds the SSL protocols enabled for this application. The values are given as comma-separated.
7server.ssl.key-aliasThis property holds the key store alias name set during the import using keytool utility.
8server.ssl.key-storeThis property holds the key store's PrivateKeyEntry which will be used as the SSL certificate for the microservice.
9server.ssl.key-store-passwordThis property holds the key store password for accessing the key store as mentioned in the key-store property.
10server.ssl.key-store-typeThis property holds the key store type.
11server.tomcat.accesslog.directoryThis property holds the directory in which log files are created. It can be absolute or relative to the Tomcat's base directory.
12server.tomcat.accesslog.enabledThis property controls the Tomcat logs for the Boot application.
13server.tomcat.accesslog.max-daysThe property holds the maximum number of days the rotated access logs will be retained before it is deleted. The default value is 10 days.
14server.tomcat.accesslog.patternThis property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters.
15skava.auditlog.db.driverClassNameThis property indicates the driver class name of the audit log DB.
16skava.auditlog.db.enabledThis property indicates whether the DB for the audit log is enabled or disabled.
17skava.auditlog.db.passwordThis property indicates the password of the audit log DB.
18skava.auditlog.db.urlThis property indicates the URL of the audit log DB.
19skava.auditlog.db.userNameThis property indicates the username of the audit log DB.
20skava.auditlog.mongodb.databaseThis property holds the Mongo database name for the audit log.
21skava.authorization.authExpiryTimeMinsThis property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes.
22skava.authorization.authHeaderThis 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.
23skava.authorization.enabledThis 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).
24skava.authorization.gettesttoken.enabledThis 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.
25skava.authorization.superAdminRoleNameThe property indicates the Super Admin role name for the corresponding microservice.
26skava.authorization.tokenSecretThis 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.
27skava.cache.cascadeCacheNamesThis property enables the Cascade cache by its name.
28skava.cache.enableCascadeThis property enables or disables the Cascade cache.
29skava.cache.enabledThis property enables or disables the cache.
30skava.cache.localCache.config.notificationCollections.cacheSizeThis property sets the local cache entry size of all the collections.
31skava.cache.localCache.config.notificationCollections.maxIdleInSecondsThis property sets the local cache maximum idle time (in seconds) of all the collections.
32skava.cache.localCache.config.notificationCollections.timeToLiveInSecondsThis property sets the local cache expiry time (in seconds) of all the collections.
33skava.cache.localCache.typeThis 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).
34skava.cache.maxCacheSizeThis 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.
35skava.cache.redis.cacheNamesThis property holds the Redis cache names used by the application.
36skava.cache.redis.clearCacheEventNameThis property is used to set the event name for cache clear operation.
37skava.cache.redis.clientThis property indicates the type of client for Redis connection.
38skava.cache.redis.cluster.maxRedirectsThis property contains the maximum number of redirects to follow when executing commands across the clusters of the Redis server.
39skava.cache.redis.cluster.nodesThis 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.
40skava.cache.redis.clusterEnabledThis property enables or disables the cluster of the Redis server.
41skava.cache.redis.databaseThis property holds the Redis database index used by the connection factory.
42skava.cache.redis.enabledThis 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).
43skava.cache.redis.expTimeToliveThis 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.
44skava.cache.redis.hostThis property holds the Redis server's hostname/IP for caching objects.
45skava.cache.redis.maxTimeToliveThis 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 can request Redis server to hold the objects for a specified time, but it is the LRU/LCU, which determines how long an entry survives in the cache.
46skava.cache.redis.passwordThis 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 that it should be enabled for the production environment.
47skava.cache.redis.pool.maxActiveThis 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.
48skava.cache.redis.pool.maxIdleThis property holds the maximum number of idle connections in the pool. Use a negative value to indicate an unlimited number of idle connections.
49skava.cache.redis.pool.minIdleThis property holds the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive.
50skava.cache.redis.portThis property holds the Redis server's port for the application to connect for both read and write cache operations.
51skava.cache.redis.sentinel.masterThis property contains the name of the Redis server.
52skava.cache.redis.sentinel.nodesThis property contains a list of comma-separated host:port pairs of the Redis server.
53skava.cache.redis.sslThis property enables or disables the SSL in the Redis server:
  • true - If SSL is enabled in the Redis server.
  • false - If SSL is not enabled in the Redis server.
54skava.cache.redis.timeoutThis property holds the connection timeout value of all Redis connections for both read and write.
55skava.cache.redis.urlThis property specifies the URL of the Redis server.
56skava.cache.useOnlyL1CacheThis property enables or disables the L1 cache (that is, in-memory cache).
57skava.cache.useOnlyL2CacheThis property enables or disables the L2 cache (that is, in-memory cache).
58skava.core.releasedefinition.enabledThis property enables the release definition endpoint.
59skava.cors.allowedHeadersThis property contains the value of the allowed header.
60skava.cors.allowedMethodsThis property contains the allowed methods for Spring controller.
61skava.cors.allowedOriginsThis property is used to set  allowedOrigins for the CORS request
62skava.cors.enabledThis property is used to enable or disable the CORS component.
63skava.cors.exposedHeadersThis property is used to set exposedHeaders for the CORS request.
64skava.cors.maxAgeThis property is used to set maxAge for the CORS request in seconds.
65skava.cors.pathPatternThis property holds the pattern for the CORS request.
66skava.crypto.aliasThis property sets an alias for the Crypto component.
67skava.crypto.enabledThis property enables or disables the Crypto component.
68skava.crypto.saltThis property sets the salt value for the Crypto component.
69skava.crypto.textEncryptorClass This property sets the fully qualified name of the custom implementation class.
70skava.databaseThis property sets the database name of the Mongo server.
71skava.enabledThis property enables the Mongo component.
72skava.event.classNameThis property is used to set the fully qualified name of the custom implementation class.
73skava.event.enabledThis property is used to enable or disable the event component.
74skava.event.enableExternalEventThis property enables or disables the external event component.
75skava.event.enableFatEventThis property enables or disables the fat event.
76skava.event.eventbridge.eventBusNameThis property sets the fully qualified name of the custom implementation class.
77skava.event.eventbridge.regionThis property sets the fully qualified name of the custom implementation class.
78skava.event.externalClassNameThis property sets the fully qualified name of the custom implementation class.
79skava.event.externalFatEventClassThis property sets the fully qualified name of the custom implementation class.
80skava.event.rabbitmq.addressesThis property sets the addresses for the RabbitMQ server cluster.
81skava.event.rabbitmq.cluster-enabledThis property enables or disables the cluster for the RabbitMQ server.
82skava.event.rabbitmq.concurrentConsumersThis property holds the maximum allowed concurrent consumers.
83skava.event.rabbitmq.enabledThis property is used to enable or disable the RabbitMQ server for the event component.
84skava.event.rabbitmq.hostThis property holds the hostname of the RabbitMQ server.
85skava.event.rabbitmq.passwordThis property holds the password of the RabbitMQ server.
86skava.event.rabbitmq.portThis property tells the port of the RabbitMQ server.
87skava.event.rabbitmq.queueNameThis property is used to set the queue name used by the event component.
88skava.event.rabbitmq.routingKeyThis property is used to set the routing key for the RabbitMQ server.
89skava.event.rabbitmq.ssl.algorithmThis property sets the SSL algorithm, which is used for the RabbitMQ server.
90skava.event.rabbitmq.ssl.enabledThis property enables or disables the SSL support for RabbitMQ server.
91skava.event.rabbitmq.topicExchangeThis property is used to set the topic exchange for the RabbitMQ server.
92skava.event.rabbitmq.userNameThis property has the username of the RabbitMQ server.
93skava.event.rabbitmq.virtualHostThis property is used to set the virtual host for the RabbitMQ server.
94skava.hibernate.acquireIncrementThis property determines how many connections at a time c3p0 tries to acquire when the pool is exhausted. The default value is 3.
95skava.hibernate.c3p0IdleTestPeriodThis property holds the idle time (in seconds) before a connection is validated automatically. If the given number is greater than 0, the Hibernate connection pool c3p0 tests all idle connections pooled, but validates the connections for every number of seconds.
96skava.hibernate.c3p0MaxSizeThis property holds the maximum number of JDBC connections to be held in the pool at any given time. You need to take extra care while updating this value since it has a direct impact on the performance of the application. Tune it only when there is a necessity.
97skava.hibernate.c3p0MaxStatementsThis property holds the number of prepared statements that be cached that is c3p0‘s global PreparedStatement cache. This controls the total number of Statements cached, for all Connections.
98skava.hibernate.c3p0MinSizeThis property holds the minimum number of JDBC connections to be held in the pool at any given time. You need to take extra care while updating this value since it has a direct impact on the performance of the application. Tune it only when there is a necessity.
99skava.hibernate.c3p0TimeoutThis property holds the pool’s idle connection timeout post which the connection is removed from the pool. The value mentioned here is in seconds. The value 0 indicates that idle connections never expire.
100skava.hibernate.dialectThis property represents a dialect of SQL implemented by a particular RDBMS.
101skava.hibernate.driverClassNameThis property represents the class name of the JDBC (Java Database Connectivity) driver class.
102skava.hibernate.enabledThis property enables or disables the Hibernate component.
103skava.hibernate.formatSqlThis property formats the generated SQL statement to make it more readable.
104skava.hibernate.hbm2ddlAutoThis property sets the strategies used for DDL generation.
105skava.hibernate.hibernateReader.acquireIncrementThis property determines how many connections at a time c3p0 will try to acquire when the pool is exhausted. The default value is 3.
106skava.hibernate.hibernateReader.c3p0IdleTestPeriodThis property holds the idle time (in seconds) before a connection is automatically validated.
107skava.hibernate.hibernateReader.c3p0MaxSizeThis property holds the maximum number of JDBC connections in the pool The Hibernate default value is 100.
108skava.hibernate.hibernateReader.c3p0MaxStatementsThis property holds the number of prepared statements that will be cached. If the value increased, increases performance. The Hibernate default value is 0 which indicates caching is disabled.
109skava.hibernate.hibernateReader.c3p0MinSizeThis property holds the minimum number of JDBC connections in the pool. The Hibernate default value is 1.
110skava.hibernate.hibernateReader.c3p0TimeoutThis property holds the time in seconds when an idle connection is removed from the pool. The Hibernate default value is 0 which indicates it never expires.
111skava.hibernate.hibernateReader.enabledThis property enables the Hibernate Reader DB.
112skava.hibernate.hibernateReader.initialPoolSizeThis property holds the initial pool size of the Hibernate Reader.
113skava.hibernate.hibernateReader.urlThis property is used to read the database URL.
114skava.hibernate.initialPoolSizeThis property holds the initial pool size of the Hibernate server.
115skava.hibernate.newGeneratorMappingsThis property enables or disables the generator mappings.
116skava.hibernate.packageToScanThis property indicates the Java package containing all the database entity objects to be scanned by the Hibernate component.
117skava.hibernate.passwordThis property sets the password for the Hibernate component.
118skava.hibernate.portThis property sets the port for Hibernate component.
119skava.hibernate.showSqlThis property prints the Hibernate's SQL query in the service log file when set to true.
120skava.hibernate.urlThis property holds the database JDBC URL to enable database connection.
121skava.hibernate.usernameThis property sets the username for Hibernate.
122skava.hostThis property sets the host for the MongoDB server.
123skava.keyprovider.algorithmThis property sets the algorithm to be used for encryption.
124skava.keyprovider.enabledThis property enables or disables the key provider.
125skava.keyprovider.keyProviderClassThis property sets the fully qualified name of the custom implementation class.
126skava.keyprovider.keySizeThis property sets the key size.
127skava.keyprovider.keystorePasswordThis property sets the Keystore password.
128skava.keyprovider.keystorePathThis property sets the Keystore path.
129skava.localization.default-localeThis property holds the default locale to be used for all response messages if it has not been provided in the request.
130skava.localization.enabledThis property indicates whether the localization component is enabled or not. The value true indicates it is enabled and false indicates it is disabled.
131skava.localization.externalPathThis property holds the external path from where the localized messages are to be read from.
132skava.localization.param-nameThis property holds the parameter name in which the localization component is used.
133skava.localization.resourceBundleBaseNameThis property holds the resource bundle's base name.
134skava.log.enabledThis property is used to set the resource bundle's base name.
135skava.log.fileAppenderEnabledThis 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.
136skava.log.fluentdAppenderEnabledThis property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not.
137skava.log.fluentdHostThis property holds the hostname of Fluentd server instance where the log will be aggregated.
138skava.log.fluentdPatternThis property holds the pattern for writing logs into the Fluentd server.
139skava.log.fluentdPortThis property holds the port of Fluentd server instance where the log will be aggregated.
140skava.log.fluentdTagNameThis property holds the tag name to be added to the logs.
141skava.mongoAuthRequiredThis property enables or disables the authentication for the MongoDB server.
142skava.passwordThis property sets the password for the MongoDB server.
143skava.portThis property sets the port for the MongoDB server.
144skava.resttemplate.cookiePolicyThis property sets the cookie policy.
145skava.resttemplate.cxnPoolSizeThis property sets the connection pool size.
146skava.resttemplate.cxnTimeoutMSecThis property sets the connection time out in milliseconds.
147skava.resttemplate.defaultMaxPerRouteThis property sets the maximum templates per route.
148skava.resttemplate.enabledThis property enables or disables the rest template component.
149skava.resttemplate.handleRedirectsThis property specifies whether the handle redirects or not.
150skava.resttemplate.ignoreInvalidHTTPSCertThis property specifies whether the invalid HTTPS certificate is ignored is not.
151skava.resttemplate.keyPassThis property sets the keyPass value.
152skava.resttemplate.p12FileThis property sets the p12 File path.
153skava.resttemplate.supportedProtocolsThis property sets the name of the supported protocols.
154skava.secretsmanager.classNameThis property specifies the name of the class used for the secret management.
155skava.sslEnabledThis property enables the MongoDB SSL component.
156skava.swaggerglobalparams.enabledThis 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.
157skava.usernameThis property sets the user name for the MongoDB server.
158spring.application.nameThis property holds the application name of the Spring Boot application.
159spring.autoconfigure.excludeThis property holds the classes that are to be excluded from the Spring's autoconfiguration.
160spring.cloud.zookeeper.config.enabledThis property enables or disables the base path of the ZooKeeper server.
161spring.cloud.zookeeper.config.rootThis property enables or disables the base path of the ZooKeeper server.
162spring.cloud.zookeeper.config.watcher.enabledThis property enables or disables the ZooKeeper Watcher.
163spring.cloud.zookeeper.connect-stringThis property holds a location other than localhost:2181. This configuration is required to locate the server.
164spring.cloud.zookeeper.enabledThis property is used to enable or disable the ZooKeeper server.
165spring.sleuth.trace-id128This property enables or disables the Sleuth 128-bit trace ID in the logs.
166ZK_REDIS_SSL_ENABLEDThis property enables or disables the Redis server SSL. The default value is FALSE.
167ZK_REDIS_TIMEOUTThis property holds connection timeout value of Redis in milliseconds.
The default value is 10000.
168ZK_REDIS_USERNAMEThis property holds the login username of the Redis server.
The default value is empty.
169ZK_PROTOCOLSThis property enables macro support for the TLS protocol version.
170ZK_REDIS_PASSWORDThis property holds the Redis password.
171skava.cache.redis.usernameThis property indicates the login username of the Redis server.
172endpoints.loggers.enabledThis property is used to enable or disable the logger.
173web.exposure.includeThis property is used to expose the management endpoints.
174server.max-http-header-sizeTo increase http header size we have externalize this property.
175externalEventConfig.fileHostThis property is used to set the hosting events on external website.
176externalEventConfig.tempStoragePathThis property is used to set the file path for the external events.
177skava.event.rabbitmq.amqpEnabledThis property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
  • true: The RabbitMQ is enabled.
  • false: The AMQP is enabled.
Note: To enable AMQP, contact the Infra team.


Revision History
2024-07-12 | SD – Updated ZK properties.
2024-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-05-20 | AM – Updated to a new table tool.
2019-01-23 | PLK – Content uploaded.