The following table describes the ZooKeeper properties for the Notification microservice:
S.NO | PROPERTY | DESCRIPTION |
---|---|---|
1 | hystrix.command.user-key.circuitBreaker.requestVolumeThreshold | This property sets the minimum number of requests in a rolling window that will trip the circuit. |
2 | hystrix.command.user-key.circuitBreaker.sleepWindowInMilliseconds | This 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. |
3 | hystrix.command.user-key.execution.isolation.thread.timeoutInMilliseconds | This property sets instance-specific values dynamically which overrides the preceding three levels of defaults. |
4 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
5 | 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. |
6 | server.ssl.enabled-protocols | This property holds the SSL protocols enabled for this application. The values are given as comma-separated. |
7 | server.ssl.key-alias | This property holds the key store alias name set during the import using keytool utility. |
8 | server.ssl.key-store | This property holds the key store's PrivateKeyEntry which will be used as the SSL certificate for the microservice. |
9 | server.ssl.key-store-password | This property holds the key store password for accessing the key store as mentioned in the key-store property. |
10 | server.ssl.key-store-type | This property holds the key store type. |
11 | 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. |
12 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
13 | 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. |
14 | server.tomcat.accesslog.pattern | This property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters. |
15 | skava.auditlog.db.driverClassName | This property indicates the driver class name of the audit log DB. |
16 | skava.auditlog.db.enabled | This property indicates whether the DB for the audit log is enabled or disabled. |
17 | skava.auditlog.db.password | This property indicates the password of the audit log DB. |
18 | skava.auditlog.db.url | This property indicates the URL of the audit log DB. |
19 | skava.auditlog.db.userName | This property indicates the username of the audit log DB. |
20 | skava.auditlog.mongodb.database | This property holds the Mongo database name for the audit log. |
21 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
22 | 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. |
23 | 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 ). |
24 | 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. |
25 | skava.authorization.superAdminRoleName | The property indicates the Super Admin role name for the corresponding microservice. |
26 | 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. |
27 | skava.cache.cascadeCacheNames | This property enables the Cascade cache by its name. |
28 | skava.cache.enableCascade | This property enables or disables the Cascade cache. |
29 | skava.cache.enabled | This property enables or disables the cache. |
30 | skava.cache.localCache.config.notificationCollections.cacheSize | This property sets the local cache entry size of all the collections. |
31 | skava.cache.localCache.config.notificationCollections.maxIdleInSeconds | This property sets the local cache maximum idle time (in seconds) of all the collections. |
32 | skava.cache.localCache.config.notificationCollections.timeToLiveInSeconds | This property sets the local cache expiry time (in seconds) of all the collections. |
33 | 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). |
34 | 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. |
35 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by the application. |
36 | skava.cache.redis.clearCacheEventName | This property is used to set the event name for cache clear operation. |
37 | skava.cache.redis.client | This property indicates the type of client for Redis connection. |
38 | 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. |
39 | 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. |
40 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster of the Redis server. |
41 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
42 | 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). |
43 | 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. |
44 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
45 | skava.cache.redis.maxTimeTolive | 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 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. |
46 | 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 that it should be enabled for the production environment. |
47 | 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. |
48 | 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. |
49 | 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. |
50 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
51 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
52 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated host:port pairs of the Redis server. |
53 | skava.cache.redis.ssl | This property enables or disables the SSL in the Redis server:
|
54 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write. |
55 | skava.cache.redis.url | This property specifies the URL of the Redis server. |
56 | skava.cache.useOnlyL1Cache | This property enables or disables the L1 cache (that is, in-memory cache). |
57 | skava.cache.useOnlyL2Cache | This property enables or disables the L2 cache (that is, in-memory cache). |
58 | skava.core.releasedefinition.enabled | This property enables the release definition endpoint. |
59 | skava.cors.allowedHeaders | This property contains the value of the allowed header. |
60 | skava.cors.allowedMethods | This property contains the allowed methods for Spring controller. |
61 | skava.cors.allowedOrigins | This property is used to set allowedOrigins for the CORS request |
62 | skava.cors.enabled | This property is used to enable or disable the CORS component. |
63 | skava.cors.exposedHeaders | This property is used to set exposedHeaders for the CORS request. |
64 | skava.cors.maxAge | This property is used to set maxAge for the CORS request in seconds. |
65 | skava.cors.pathPattern | This property holds the pattern for the CORS request. |
66 | skava.crypto.alias | This property sets an alias for the Crypto component. |
67 | skava.crypto.enabled | This property enables or disables the Crypto component. |
68 | skava.crypto.salt | This property sets the salt value for the Crypto component. |
69 | skava.crypto.textEncryptorClass | This property sets the fully qualified name of the custom implementation class. |
70 | skava.database | This property sets the database name of the Mongo server. |
71 | skava.enabled | This property enables the Mongo component. |
72 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class. |
73 | skava.event.enabled | This property is used to enable or disable the event component. |
74 | skava.event.enableExternalEvent | This property enables or disables the external event component. |
75 | skava.event.enableFatEvent | This property enables or disables the fat event. |
76 | skava.event.eventbridge.eventBusName | This property sets the fully qualified name of the custom implementation class. |
77 | skava.event.eventbridge.region | This property sets the fully qualified name of the custom implementation class. |
78 | skava.event.externalClassName | This property sets the fully qualified name of the custom implementation class. |
79 | skava.event.externalFatEventClass | This property sets the fully qualified name of the custom implementation class. |
80 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
81 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
82 | skava.event.rabbitmq.concurrentConsumers | This property holds the maximum allowed concurrent consumers. |
83 | skava.event.rabbitmq.enabled | This property is used to enable or disable the RabbitMQ server for the event component. |
84 | skava.event.rabbitmq.host | This property holds the hostname of the RabbitMQ server. |
85 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
86 | skava.event.rabbitmq.port | This property tells the port of the RabbitMQ server. |
87 | skava.event.rabbitmq.queueName | This property is used to set the queue name used by the event component. |
88 | skava.event.rabbitmq.routingKey | This property is used to set the routing key for the RabbitMQ server. |
89 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
90 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
91 | skava.event.rabbitmq.topicExchange | This property is used to set the topic exchange for the RabbitMQ server. |
92 | skava.event.rabbitmq.userName | This property has the username of the RabbitMQ server. |
93 | skava.event.rabbitmq.virtualHost | This property is used to set the virtual host for the RabbitMQ server. |
94 | skava.hibernate.acquireIncrement | This property determines how many connections at a time c3p0 tries to acquire when the pool is exhausted. The default value is 3. |
95 | skava.hibernate.c3p0IdleTestPeriod | This 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. |
96 | skava.hibernate.c3p0MaxSize | This 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. |
97 | skava.hibernate.c3p0MaxStatements | This 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. |
98 | skava.hibernate.c3p0MinSize | This 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. |
99 | skava.hibernate.c3p0Timeout | This 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. |
100 | skava.hibernate.dialect | This property represents a dialect of SQL implemented by a particular RDBMS. |
101 | skava.hibernate.driverClassName | This property represents the class name of the JDBC (Java Database Connectivity) driver class. |
102 | skava.hibernate.enabled | This property enables or disables the Hibernate component. |
103 | skava.hibernate.formatSql | This property formats the generated SQL statement to make it more readable. |
104 | skava.hibernate.hbm2ddlAuto | This property sets the strategies used for DDL generation. |
105 | skava.hibernate.hibernateReader.acquireIncrement | This property determines how many connections at a time c3p0 will try to acquire when the pool is exhausted. The default value is 3. |
106 | skava.hibernate.hibernateReader.c3p0IdleTestPeriod | This property holds the idle time (in seconds) before a connection is automatically validated. |
107 | skava.hibernate.hibernateReader.c3p0MaxSize | This property holds the maximum number of JDBC connections in the pool The Hibernate default value is 100. |
108 | skava.hibernate.hibernateReader.c3p0MaxStatements | This 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. |
109 | skava.hibernate.hibernateReader.c3p0MinSize | This property holds the minimum number of JDBC connections in the pool. The Hibernate default value is 1. |
110 | skava.hibernate.hibernateReader.c3p0Timeout | This 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. |
111 | skava.hibernate.hibernateReader.enabled | This property enables the Hibernate Reader DB. |
112 | skava.hibernate.hibernateReader.initialPoolSize | This property holds the initial pool size of the Hibernate Reader. |
113 | skava.hibernate.hibernateReader.url | This property is used to read the database URL. |
114 | skava.hibernate.initialPoolSize | This property holds the initial pool size of the Hibernate server. |
115 | skava.hibernate.newGeneratorMappings | This property enables or disables the generator mappings. |
116 | skava.hibernate.packageToScan | This property indicates the Java package containing all the database entity objects to be scanned by the Hibernate component. |
117 | skava.hibernate.password | This property sets the password for the Hibernate component. |
118 | skava.hibernate.port | This property sets the port for Hibernate component. |
119 | skava.hibernate.showSql | This property prints the Hibernate's SQL query in the service log file when set to true. |
120 | skava.hibernate.url | This property holds the database JDBC URL to enable database connection. |
121 | skava.hibernate.username | This property sets the username for Hibernate. |
122 | skava.host | This property sets the host for the MongoDB server. |
123 | skava.keyprovider.algorithm | This property sets the algorithm to be used for encryption. |
124 | skava.keyprovider.enabled | This property enables or disables the key provider. |
125 | skava.keyprovider.keyProviderClass | This property sets the fully qualified name of the custom implementation class. |
126 | skava.keyprovider.keySize | This property sets the key size. |
127 | skava.keyprovider.keystorePassword | This property sets the Keystore password. |
128 | skava.keyprovider.keystorePath | This property sets the Keystore path. |
129 | skava.localization.default-locale | This property holds the default locale to be used for all response messages if it has not been provided in the request. |
130 | skava.localization.enabled | This property indicates whether the localization component is enabled or not. The value true indicates it is enabled and false indicates it is disabled. |
131 | skava.localization.externalPath | This property holds the external path from where the localized messages are to be read from. |
132 | skava.localization.param-name | This property holds the parameter name in which the localization component is used. |
133 | skava.localization.resourceBundleBaseName | This property holds the resource bundle's base name. |
134 | skava.log.enabled | This property is used to set the resource bundle's base name. |
135 | 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 . |
136 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not. |
137 | skava.log.fluentdHost | This property holds the hostname of Fluentd server instance where the log will be aggregated. |
138 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
139 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
140 | skava.log.fluentdTagName | This property holds the tag name to be added to the logs. |
141 | skava.mongoAuthRequired | This property enables or disables the authentication for the MongoDB server. |
142 | skava.password | This property sets the password for the MongoDB server. |
143 | skava.port | This property sets the port for the MongoDB server. |
144 | skava.resttemplate.cookiePolicy | This property sets the cookie policy. |
145 | skava.resttemplate.cxnPoolSize | This property sets the connection pool size. |
146 | skava.resttemplate.cxnTimeoutMSec | This property sets the connection time out in milliseconds. |
147 | skava.resttemplate.defaultMaxPerRoute | This property sets the maximum templates per route. |
148 | skava.resttemplate.enabled | This property enables or disables the rest template component. |
149 | skava.resttemplate.handleRedirects | This property specifies whether the handle redirects or not. |
150 | skava.resttemplate.ignoreInvalidHTTPSCert | This property specifies whether the invalid HTTPS certificate is ignored is not. |
151 | skava.resttemplate.keyPass | This property sets the keyPass value. |
152 | skava.resttemplate.p12File | This property sets the p12 File path. |
153 | skava.resttemplate.supportedProtocols | This property sets the name of the supported protocols. |
154 | skava.secretsmanager.className | This property specifies the name of the class used for the secret management. |
155 | skava.sslEnabled | This property enables the MongoDB SSL component. |
156 | 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. |
157 | skava.username | This property sets the user name for the MongoDB server. |
158 | spring.application.name | This property holds the application name of the Spring Boot application. |
159 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's autoconfiguration. |
160 | spring.cloud.zookeeper.config.enabled | This property enables or disables the base path of the ZooKeeper server. |
161 | spring.cloud.zookeeper.config.root | This property enables or disables the base path of the ZooKeeper server. |
162 | spring.cloud.zookeeper.config.watcher.enabled | This property enables or disables the ZooKeeper Watcher. |
163 | spring.cloud.zookeeper.connect-string | This property holds a location other than localhost:2181 . This configuration is required to locate the server. |
164 | spring.cloud.zookeeper.enabled | This property is used to enable or disable the ZooKeeper server. |
165 | spring.sleuth.trace-id128 | This property enables or disables the Sleuth 128-bit trace ID in the logs. |
166 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE . |
167 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
168 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
169 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
170 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
171 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
172 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
173 | web.exposure.include | This property is used to expose the management endpoints. |
174 | server.max-http-header-size | To increase http header size we have externalize this property. |
175 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
176 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
177 | skava.event.rabbitmq.amqpEnabled | This property is used to enable AMQP (Advanced Message Queuing Protocol). When the value is
|
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.