The following table describes the ZooKeeper properties for the Ratings and Reviews microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
| 2 | server.tomcat.max-threads | This property sets the maximum number of threads for the embedded Tomcat server. |
| 3 | server.tomcat.accesslog.enabled | This property controls Tomcat logs for the Spring Boot application. |
| 4 | server.tomcat.accesslog.pattern | This property sets the pattern for writing logs in Tomcat. |
| 5 | server.tomcat.accesslog.directory | This property holds the directory details for storing access log. |
| 6 | server.ssl.enabled | This property controls the SSL configuration for the Spring Boot application. |
| 7 | server.ssl.key-store | This property holds the keystore PrivateKeyEntry, which will be used as the SSL certificate for the microservice. |
| 8 | server.ssl.key-store-password | This property holds the keystore password for opening the keystore mentioned in the key-store property. |
| 9 | server.ssl.key-store-type | This property holds the keystore type. |
| 10 | server.ssl.key-alias | This property holds the keystore alias name configured during import using the keytool utility. |
| 11 | server.ssl.enabled-protocols | This property controls the SSL configuration for the Spring Boot application. |
| 12 | skava.contentrepository.defaultImplClass | This property specifies the name of the default class used to select a content repository, which specifies the type of storage. |
| 13 | skava.contentrepository.enabled | This property enables or disables a content repository. The value true enables a content repository. |
| 14 | skava.contentrepository.urlEncoded | This property enables or disables the URL encoding of the content repository. |
| 15 | skava.contentrepository.properties.s3Region | This property sets the S3 region of the content repository. |
| 16 | skava.contentrepository.properties.cloudFrontDomain | This property sets the cloud front domain of the content repository. |
| 17 | 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 to and added in the Swagger UI. |
| 18 | skava.cors.enabled | This property controls the SSL configuration for the Spring Boot application. |
| 19 | skava.cors.allowedHeaders | This property contains the allowed headers value. |
| 20 | skava.cors.allowedMethods | This property contains allowed methods for the Spring Boot controller. |
| 21 | skava.cors.allowedOrigins | This property sets allowedOrigins for a CORS request. |
| 22 | skava.cors.exposedHeaders | This property sets exposedHeaders for a CORS request. |
| 23 | skava.cors.maxAge | This property sets maxAge for a CORS request. The value is mentioned in seconds. |
| 24 | skava.auditlog.enabled | This property enables or disables the audit log component. |
| 25 | skava.auditlog.file-location | This property sets the file location of the audit log component. |
| 26 | skava.auditlog.layout-type | This property sets the layout type of the audit log component. |
| 27 | skava.auditlog.customLayoutFormat | This property holds the custom layout property information. |
| 28 | skava.auditlog.db.enabled | This property specifies whether to store the audit logs in the MySQL DB or not. The value can be:
|
| 29 | skava.auditlog.db.url | This property holds the DB URL of the MySQL server. |
| 30 | skava.auditlog.db.userName | This property sets the username of the MySQL server for audit logs. |
| 31 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
| 32 | 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 Skava Framework, this property's value identifies the correct header and the header value is considered for access/authorization checks. |
| 33 | 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). |
| 34 | 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. |
| 35 | skava.authorization.superAdminRoleName | This property indicates the Super Admin role name for the corresponding microservice. |
| 36 | skava.cache.enabled | This property enables or disables the cache. |
| 37 | skava.cache.enableCascade | This property enables or disables the Cascade cache. |
| 38 | skava.cache.useOnlyL1Cache | This property enables or disables the L1 cache. |
| 39 | skava.cache.useOnlyL2Cache | This property enables or disables the L2 cache (that is, in-memory cache). |
| 40 | skava.cache.cascadeCacheNames | This property enables the Cascade cache by its name. |
| 41 | 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). |
| 42 | skava.cache.localCache.config.ratingandreviewscollectionattributes.cacheSize | This property sets the local cache entry size of the collection attributes. |
| 43 | skava.cache.localCache.config.ratingandreviewscollectionattributes.timeToLiveInSeconds | This property sets the local cache expiry time (in seconds) of the collection attributes. |
| 44 | skava.cache.localCache.config.ratingandreviewscollectionattributes.maxIdleInSeconds | This property sets the local cache maximum idle time (in seconds) of the collection attributes. |
| 45 | skava.cache.localCache.config.ratingandreviewscollection.timeToLiveInSeconds | This property sets the local cache expiry time (in seconds) of the collections. |
| 46 | skava.cache.localCache.config.ratingandreviewscollectionattributes.maxIdleInSeconds | This property sets the local cache maximum idle time (in seconds) of the collections. |
| 47 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster of the Redis server. |
| 48 | 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. |
| 49 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
| 50 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by this application. |
| 51 | skava.cache.redis.clearCacheEventName | This property sets the event name for cache clear operation. |
| 52 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 53 | skava.cache.redis.enabled | This property indicates whether the Redis component needs to be enabled or disabled for this application. It is recommended to enable (that is, setting the value true) for the production and production-grade environments (like performance). |
| 54 | 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. With this property, you can request Redis to hold the objects for the specified time, but it is the LRU/LCU which determines how long an entry survives in the cache. |
| 55 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
| 56 | 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. |
| 57 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
| 58 | skava.cache.redis.ssl | This property enables or disables the SSL in the Redis server:
|
| 59 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write operations. |
| 60 | skava.cache.redis.url | This property specifies the URL of the Redis server. |
| 61 | 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. |
| 62 | skava.event.enabled | This property enables or disables the event component. |
| 63 | skava.event.rabbitmq.enabled | This property enables or disables the RabbitMQ server for the event component. |
| 64 | skava.event.rabbitmq.host | This property holds the host name of the RabbitMQ server. |
| 65 | skava.event.rabbitmq.userName | This property holds the username of the RabbitMQ server. |
| 66 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
| 67 | skava.event.rabbitmq.port | This property holds the port of the RabbitMQ server. |
| 68 | skava.event.rabbitmq.queueName | This property sets the queue name used by the event component. |
| 69 | skava.event.rabbitmq.routingKey | This property sets the routing key for RabbitMQ server. |
| 70 | skava.event.rabbitmq.topicExchange | This property sets the topic exchange for RabbitMQ server. |
| 71 | skava.event.rabbitmq.virtualHost | This property sets the virtual host for RabbitMQ server. |
| 72 | skava.event.rabbitmq.ssl.enabled | This property enables or disables SSL (Secure Socket Layer) support in the RabbitMQ server for the event component |
| 73 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL (Secure Socket Layer) algorithm used for RabbitMQ server. |
| 74 | skava.hibernate.dialect | This property represents a dialect of SQL implemented by a particular RDBMS. |
| 75 | skava.hibernate.enabled | This property enables or disables the Hibernate component. |
| 76 | skava.hibernate.formatSql | This property formats the generated SQL statement to make it more readable. |
| 77 | skava.hibernate.hbm2ddlAuto | This property sets the strategies used for DDL generation. |
| 78 | skava.hibernate.newGeneratorMappings | This property enables or disables the generator mappings. |
| 79 | skava.hibernate.password | This property sets the password for the Hibernate component. |
| 80 | skava.hibernate.port | This property sets the port for Hibernate component. |
| 81 | skava.hibernate.showSql | This property prints the Hibernate's SQL query in the service log file when set to true. |
| 82 | skava.hibernate.url | This property sets the database URL. |
| 83 | skava.hibernate.c3p0MaxStatements | This property indicates the maximum number of prepared statements in the cache, which increases the performance. Hibernate default value is 0 and the caching is disabled. |
| 84 | 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 Hybernate connection pool c3p0 tests all idle connections pooled, but validates the connections for every number of seconds. |
| 85 | skava.hibernate.packageToScan | This property indicates the Java package containing all the database entity objects to be scanned by the Hibernate component. |
| 86 | skava.hibernate.initialPoolSize | This property contains the number of connections a pool tries to acquire upon startup. The default value is 3. |
| 87 | 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. |
| 88 | skava.hibernate.hikari.enabled | This property enables or disables the Hibernate Hikari component. |
| 89 | skava.hibernate.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. |
| 90 | skava.hibernate.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. |
| 91 | skava.hibernate.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). |
| 92 | skava.hibernate.hikari.prepStmtCacheSqlLimit | This property sets the SQL limit of the PreparedStatement to be cached. |
| 93 | skava.localization.default-locale | This property indicates whether the localization component is enabled or not. The value:
|
| 94 | skava.localization.enabled | This property indicates whether the localization component is enabled or not. The value:
|
| 95 | skava.localization.externalPath | This property holds the external path from where the localized messages are to be read from. |
| 96 | skava.localization.resourceBundleBaseName | This property holds the resource bundle using the specified base name. |
| 97 | skava.localization.cookieEnabled | This property indicates whether the localization component cookie is enabled or not. The value:
|
| 98 | skava.log.enabled | This property indicates whether the log component is enabled or not. The value:
|
| 99 | skava.log.fileAppenderEnabled | This property indicates whether the log needs to be appended to a log file or not. If set to true the log is written to the log file as specified in the log4j2.yml file. |
| 100 | skava.log.fluentdHost | This property holds the host name for Fluentd server instance where the log will be aggregated. |
| 101 | spring.sleuth.trace-id128 | This property indicates whether the sleuth 128 bit traceid in the logs is enabled or not. The default value is true. |
| 102 | spring.application.name | This property sets the application name of Spring Boot. |
| 103 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's auto-configuration. |
| 104 | spring.cloud.zookeeper.enabled | This property enables or disables the ZooKeeper server. |
| 105 | spring.cloud.zookeeper.connect-string | This property specifies the location of the server when it locates somewhere other than localhost:2181. This configuration is required to locate the server. |
| 106 | spring.cloud.zookeeper.config.enabled | This property enables or disables the base path of the ZooKeeper. |
| 107 | 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. |
| 108 | skava.hibernate.hibernateReader.enabled | This property is used to enable the reader DB. |
| 109 | skava.event.enableExternalEvent | This property is used to enable/disable the external event component. |
| 110 | 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. |
| 111 | skava.hibernate.hibernateReader.c3p0IdleTestPeriod | This property holds the idle time in seconds before a connection is automatically validated. If it is greater than 0, c3p0 will test all idle, pooled but unchecked-out connections, at the specified time period (in seconds) |
| 112 | skava.cors.pathPattern | This property is used to set pathPattern for a cors request. |
| 113 | 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 only when there is a necessity. |
| 114 | spring.cloud.zookeeper.config.root | This property is used to enable/disable the ZooKeeper base path. |
| 115 | skava.cache.redis.sentinel.nodes | This property indicates the comma-separated list of 'host:port' pairs. |
| 116 | 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. |
| 117 | skava.localization.param-name | This property is used to set the parameter name in which the localization component is used. |
| 118 | spring.cloud.zookeeper.config.watcher.enabled | This property is used to enable/disable the ZooKeeper watcher. |
| 119 | skava.hibernate.hibernateReader.c3p0Timeout | This property is used to set database connection timeout for hibernate. |
| 120 | skava.auditlog.db.driverClassName | This property is used to connect to the MySQL DB for audit logs. |
| 121 | skava.ratingsreviews.profanity | This property is used to set default profanity words. |
| 122 | skava.event.rabbitmq.concurrentConsumers | This property is used to set the maximum allowed concurrent consumers. |
| 123 | skava.hibernate.hibernateReader.initialPoolSize | The number of connections a pool tries to acquire upon startup. The default value is 3. |
| 124 | skava.cache.localCache.config.ratingandreviewscollection.cacheSize | This property specifies the local cache entry size. |
| 125 | skava.log.fluentdTagName | This property is used to set the tag name to be added in the logs. |
| 126 | skava.cache.redis.cacheNamesWithTimeToLiveMap.cache_search_count | This property is used to set the fully qualified name of the custom implementation class. |
| 127 | skava.auditlog.db.password | This property is used to connect to the MySQL DB for audit logs. |
| 128 | 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. |
| 129 | skava.hibernate.hikari.poolName | This property represents a user-defined name for the connection pool. It appears mainly in the logging and JMX management consoles to identify pools and pool configurations. The default value is auto-generated. |
| 130 | skava.hibernate.hibernateReader.url | This property is used to read the database URL. |
| 131 | skava.event.externalClassName | This property is used to set the fully qualified name of the custom implementation class. |
| 132 | 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. |
| 133 | skava.log.fluentdPort | This property is used to set the port for fluentd server. |
| 134 | skava.secretsmanager.className | This property is used to specify which class to be used for the secret management. |
| 135 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class. |
| 136 | skava.event.rabbitmq.cluster-enabled | This property is used to enable/disable cluster for the RabbitMQ server. |
| 137 | skava.hibernate.c3p0Timeout | This property holds the pools idle connection timeout post which the connection is removed from the pool. The value mentioned here is in seconds. The value of 0 indicates that idle connections never expire. |
| 138 | skava.hibernate.hikari.prepStmtCacheSize | This property sets the cache size of the PreparedStatement. |
| 139 | skava.hibernate.hibernateReader.c3p0MaxStatements | This property holds the number of prepared statements that be cached, i.e., c3p0s global PreparedStatement cache. This controls the total number of Statements cached, for all Connections. |
| 140 | skava.hibernate.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. |
| 141 | skava.cache.redis.cluster.nodes | This property indicates the comma-separated list of 'host:port' pairs to bootstrap from. This represents an 'initial' list of cluster nodes and is required to have at least one entry. |
| 142 | skava.event.eventbridge.region | This property is used to set the fully qualified name of the custom implementation class. |
| 143 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not. |
| 144 | skava.hibernate.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 will it then be removed. On a connection-by-connection basis, minor negative attenuation is applied to avoid mass-extinction in the pool. We strongly recommend setting this value, and it should be several seconds shorter than any database or infrastructure imposed connection time limit. A value of 0 indicates no maximum lifetime (infinite lifetime), subject of course to the idleTimeout setting. The default value is 1800000 (i.e., 30 minutes). |
| 145 | skava.hibernate.hikari.useServerPrepStmts | This property is used to set useServerPrepStmts. |
| 146 | skava.log.fluentdPattern | This property is used to set the pattern for writing logs in the fluentd server. |
| 147 | skava.hibernate.driverClassName | This property represents the class name of JDBC driver class. |
| 148 | skava.event.externalFatEventClass | This property is used to set the fully qualified name of the custom implementation class. |
| 149 | skava.contentrepository.properties.s3Bucket | This property sets the S3 bucket of the content repository. |
| 150 | skava.cache.redis.client | This property represents the type of client for redis connection. |
| 151 | skava.event.rabbitmq.addresses | This property is used to set the addresses for the RabbitMQ server cluster. |
| 152 | skava.cache.localCache.config.ratingandreviewscollection.maxIdleInSeconds | This property enables the local cache maximum idle time in seconds. |
| 153 | skava.hibernate.hibernateReader.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. |
| 154 | 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. |
| 155 | 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. |
| 156 | server.tomcat.accesslog.max-days | The maximum number of days rotated access logs will be retained for before being deleted. If not specified, the default value is set to 10. |
| 157 | skava.hibernate.hibernateReader.c3p0MinSize | This propery holds the minimum number of JDBC connections in the pool. The default hibernate value is 1. |
| 158 | skava.event.enableFatEvent | This property is used to enable/disable the fat event. |
| 159 | skava.event.eventbridge.eventBusName | This property is used to set the fully qualified name of the custom implementation class. |
| 160 | skava.hibernate.username | This property is used to set the username for hibernate. |
| 161 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 162 | skava.app.enabled | This property enables the app. The default value is TRUE. |
| 163 | skava.app.appClassName | This property holds the app component class name (GCP/Azure). The default value is com.skava.core.app.gcp.GCPAppComponent. |
| 164 | skava.app.host | This property holds the service endpoint URL of the App Marketplace service. The default value is ##ZK_SERVICE_END_POINT##. |
| 165 | skava.app.apiKey | This property holds the API key which is sent to the App for authentication. The default value is ##ZK_APP_API_KEY##. |
| 166 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 167 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 168 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 169 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 170 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 171 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 172 | web.exposure.include | This property is used to expose the management endpoints. |
| 173 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 174 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 175 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 176 | 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 | JP – Updated content for 8.13.0 release.
2022-04-10 | JP – Fixed link and http issues.
2021-12-27 | AN – Updated content for 8.11 release.
2020-03-05 | AN – Page created and uploaded the contents for April 2020 release.