The following table describes the ZooKeeper properties for the Accounts microservice:
| S.NO | PROPERTY | DESCRIPTION |
|---|---|---|
| 1 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
| 2 | 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. |
| 3 | 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). |
| 4 | 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. |
| 5 | skava.authorization.superAdminRoleName | The property indicates the Super Admin role name for the corresponding microservice. |
| 6 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by the application. |
| 7 | skava.cache.redis.clearCacheEventName | This property is used to set the event name for cache clear operation. |
| 8 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 9 | 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). |
| 10 | 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. |
| 11 | skava.cache.redis.host | This property holds the Redis serverâs hostname/IP for caching objects. |
| 12 | 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. |
| 13 | skava.cache.redis.port | This property holds the Redis serverâs port for the application to connect for both read and write cache operations. |
| 14 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write. |
| 15 | 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. |
| 16 | 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. |
| 17 | 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. |
| 18 | skava.hibernate.dialect | This property represents a dialect of SQL implemented by a particular RDBMS. It holds the dialect to be used by Hibernate. The dialect specifies the type of database used in Hibernate so that Hibernate can generate appropriate type of SQL statements. |
| 19 | skava.hibernate.driverClassName | This property holds the JDBC driver class name for making the connections to the database. |
| 20 | skava.hibernate.enabled | This property indicates whether the Hibernate component is enabled or disabled for this application. It is recommended that not to update this property from the default value. |
| 21 | skava.hibernate.showSql | This property indicates whether the SQL generated by Hibernate to be printed in the log file or not. If it is set to true, will print all the SQLs generated by Hibernate as part of the dialect. |
| 22 | skava.hibernate.formatSql | This property indicates whether the SQL statements enabled for printing should be formatted or not. If this property and the property skava.hibernate.showSql is set to true then the queries are SQL formatted making it more readable. |
| 23 | skava.hibernate.hbm2ddlAuto | This property holds the strategy to be used by Hibernate on startup. The possible values are validate, update, create, or create-drop which indicate the appropriate action will be taken on startup. It is recommended that the value is to be set as none in the production and/or production-like environments because where the schema will not be created every time the application starts up. |
| 24 | skava.hibernate.newGeneratorMappings | This property holds the Hibernate setting. It indicates whether the new IdentifierGenerator implementations are used for AUTO, TABLE, and SEQUENCE or not. If it is set to false, the ID generation is left to the DB sequence or the application logic. It is recommended that this property is set as false. |
| 25 | skava.hibernate.packageToScan | This property indicates the Java package having all the database entity objects to be used by Hibernate component. |
| 26 | skava.hibernate.password | This property holds the data store password to be used by Hibernate component to connect to the database. |
| 27 | skava.hibernate.port | This property holds the port number of the database to be used by Hibernate component to connect to the database. |
| 28 | skava.hibernate.url | This property holds the database JDBC URL to enable the database connection. |
| 29 | skava.hibernate.username | This property holds the username to be used by Hibernate component to connect to the database. |
| 30 | 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. |
| 31 | 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. |
| 32 | skava.localization.externalPath | This property holds the external path from where the localized messages are to be read from. |
| 33 | skava.localization.param-name | This property holds the parameter name in which the localization component is used. |
| 34 | skava.localization.resourceBundleBaseName | This property holds the resource bundleâs base name. |
| 35 | skava.log.enabled | This property is used to set the resource bundleâs base name. |
| 36 | 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. |
| 37 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file or not. |
| 38 | skava.log.fluentdHost | This property holds the hostname of Fluentd server instance where the log will be aggregated. |
| 39 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
| 40 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
| 41 | skava.log.fluentdTagName | This property holds the tag name to be added to the logs. |
| 42 | spring.application.name | This property holds the application name of the Spring Boot application. |
| 43 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Springâs autoconfiguration. |
| 44 | server.servlet.contextPath | This property holds the Spring Boot applicationâs context path. By default, the context path is â /â. If thatâs not ideal and you need to change it â to something like /app_name, hereâs the quick and simple way to do it via properties |
| 45 | server.tomcat.accesslog.enabled | This property controls the Tomcat logs for the Boot application. |
| 46 | server.tomcat.accesslog.pattern | This property holds the pattern of the access logs to be printed. This will follow the Apache Tomcat parameters. |
| 47 | 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. |
| 48 | skava.event.rabbitmq.ssl.enabled | This property enables or disables the SSL support for RabbitMQ server. |
| 49 | skava.event.rabbitmq.ssl.algorithm | This property sets the SSL algorithm, which is used for the RabbitMQ server. |
| 50 | skava.event.rabbitmq.cluster-enabled | This property enables or disables the cluster for the RabbitMQ server. |
| 51 | skava.event.rabbitmq.addresses | This property sets the addresses for the RabbitMQ server cluster. |
| 52 | skava.accounts.liveEnvironment | This property specifies whether the deployment environment is live or authoring/staging environment. The value can be:
false. |
| 53 | skava.cache.enabled | This property is used to enable cache. |
| 54 | skava.cache.enableCascade | This property is used to enable cascade cache. |
| 55 | skava.cache.useOnlyL2Cache | This property is used to enable L2 cache. |
| 56 | skava.cache.cascadeCacheNames | This property is used to enable cascade cache by its name. |
| 57 | skava.cache.localCache.type | This property represents the local cache type for L1 cache used in cascade cache. |
| 58 | skava.cache.localCache.config.accountscollections.cacheSize | This property represents the local cache entry size. |
| 59 | skava.cache.localCache.config.accountscollections.timeToLiveInSeconds | This property represents the local cache expiry time in seconds. |
| 60 | skava.cache.localCache.config.accountscollections.maxIdleInSeconds | This property represents the local cache maximum idle time in seconds. |
| 61 | skava.cache.localCache.config.accountscollectionattributes.cacheSize | This property represents the local cache entry size. |
| 62 | skava.cache.localCache.config.accountscollectionattributes.timeToLiveInSeconds | This property represents the local cache expiry time in seconds. |
| 63 | skava.cache.localCache.config.accountscollectionattributes.maxIdleInSeconds | This property represents the local cache maximum idle time in seconds. |
| 64 | skava.cache.redis.clusterEnabled | This property represents the toggle cluster for Redis server. |
| 65 | skava.cache.redis.cluster.maxRedirects | This property represents the maximum number of redirects to follow when executing commands across the cluster. |
| 66 | skava.cache.redis.cluster.nodes | This property represents 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. |
| 67 | skava.cache.redis.sentinel.master | This property represents the name of the Redis server. |
| 68 | skava.cache.redis.sentinel.nodes | This property represents the comma-separated list of 'host:port' pairs. |
| 69 | skava.cache.redis.ssl | This property represents the enable/disable of Redis server ssl. |
| 70 | skava.cache.redis.url | This property represents the Redis server url. |
| 71 | skava.cache.redis.maxTimeTolive | This property is used to set the max time to live in minutes time for redis cache. |
| 72 | skava.cache.redis.client | This property represents the type of client for redis connection. |
| 73 | skava.swaggerglobalparams.enabled | If this property is enabled Swagger global params from the application.yml will be referred and added in the swagger-ui. |
| 74 | 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. |
| 75 | skava.hibernate.hibernateReader.enabled | This property is used to enable reader DB. |
| 76 | skava.event.enableExternalEvent | This property is used to enable/disable the external event component. |
| 77 | skava.event.enabled | This property is used to enable/disable the event component. |
| 78 | 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) |
| 79 | skava.cors.pathPattern | This property is used to set pathPattern for cors request. |
| 80 | skava.cors.allowedHeaders | This property is used to set allowedHeaders for cors request |
| 81 | 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. |
| 82 | skava.hibernate.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). |
| 83 | server.ssl.key-store | This property holds the keystore PrivateKeyEntry which will be used as the SSL certificate for the microservice. |
| 84 | skava.core.releasedefinition.enabled | This property is used to enable the release definition endpoint. |
| 85 | spring.cloud.zookeeper.config.root | This property is used to enable/disable the ZooKeeper base path. |
| 86 | server.ssl.key-store-type | This property holds the keystore type. |
| 87 | skava.hibernate.c3p0MaxStatements | This property holds the number of prepared statements that will be cached, i.e., c3p0's global PreparedStatement cache. This controls the total number of statements cached, for all connections. |
| 88 | skava.event.rabbitmq.port | This property is used to set the port for the RabbitMQ server. |
| 89 | skava.hibernate.hibernateReader.acquireIncrement | acquire increment |
| 90 | hystrix.command.user-key.circuitBreaker.requestVolumeThreshold | This property sets the minimum number of requests in a rolling window that will trip the circuit. |
| 91 | skava.auditlog.db.userName | This property is used to connect to the MySQL DB for audit logs. |
| 92 | skava.auditlog.db.url | This property is used to connect to the MySQL DB for audit logs. |
| 93 | spring.cloud.zookeeper.config.watcher.enabled | This property is used to enable/disable the ZooKeeper watcher. |
| 94 | skava.event.rabbitmq.routingKey | This property is used to set the routing key for RabbitMQ server. |
| 95 | spring.cloud.zookeeper.enabled | This property is used to enable/disable the ZooKeeper server. |
| 96 | skava.hibernate.hibernateReader.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. |
| 97 | skava.auditlog.db.driverClassName | This property is used to connect to the MySQL DB for audit logs. |
| 98 | skava.event.rabbitmq.concurrentConsumers | This property is used to set the maximum allowed concurrent consumers. |
| 99 | skava.hibernate.hibernateReader.initialPoolSize | initial PoolSize |
| 100 | server.ssl.enabled-protocols | This property holds the protocols enabled for this application. It takes comma separated values. |
| 101 | skava.event.rabbitmq.topicExchange | This property is used to set the topic exchange for RabbitMQ server. |
| 102 | skava.hibernate.acquireIncrement | acquire increment |
| 103 | skava.hibernate.initialPoolSize | initial PoolSize |
| 104 | spring.cloud.zookeeper.connect-string | This property specifies the location of the ZooKeeper server. |
| 105 | skava.event.rabbitmq.enabled | This property is used to enable/disable the RabbitMQ server for the event component. |
| 106 | skava.cors.enabled | This property is used to enable the cors component. |
| 107 | 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. |
| 108 | skava.auditlog.db.password | This property is used to connect to the MySQL DB for audit logs. |
| 109 | skava.hibernate.hibernateReader.url | This property is used to set the database URL. |
| 110 | skava.event.externalClassName | This property is used to set the fully qualified name of the custom implementation class. |
| 111 | server.ssl.key-store-password | This property holds the keystore password for opening the keystore mentioned in the key-store property. |
| 112 | skava.cors.allowedOrigins | This property is used to set allowedOrigins for cors request. |
| 113 | skava.cors.allowedMethods | This property is used to set allowedMethods for cors request. |
| 114 | skava.event.rabbitmq.queueName | This property is used to set the queue name used by the event component. |
| 115 | skava.event.rabbitmq.password | This property is used to set password for RabbitMQ server. |
| 116 | spring.sleuth.trace-id128 | This property is used to enable/disable the sleuth 128 bit traceid in the logs. |
| 117 | skava.secretsmanager.className | This property specifies the name of the class used for the secret management. |
| 118 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class. |
| 119 | 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. Value of 0 indicates that idle connections never expire. |
| 120 | skava.event.rabbitmq.userName | This property is used to set the username for RabbitMQ server. |
| 121 | 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. |
| 122 | server.ssl.key-alias | This property holds the keystore alias name set during the import using keytool utility. |
| 123 | hystrix.command.user-key.execution.isolation.thread.timeoutInMilliseconds | This property sets instance-specific values dynamically which overrides the preceding three levels of defaults. |
| 124 | server.ssl.enabled | This property controls the SSL configuration for the boot application. |
| 125 | skava.event.eventbridge.region | This property is used to set the fully qualified name of the custom implementation class. |
| 126 | skava.event.rabbitmq.host | This property is used to set the host for RabbitMQ server. |
| 127 | skava.event.externalFatEventClass | This property is used to set the fully qualified name of the custom implementation class. |
| 128 | skava.cors.exposedHeaders | This property is used to set exposedHeaders for cors request. |
| 129 | skava.auditlog.db.enabled | This property is used to enable/disable the DB for audit logs. |
| 130 | skava.event.rabbitmq.virtualHost | This property is used to set the virtual host for RabbitMQ server. |
| 131 | spring.cloud.zookeeper.config.enabled | This property is used to enable/disable the ZooKeeper base path. |
| 132 | skava.cors.maxAge | This property is used to set maxAge for cors request in seconds. |
| 133 | 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 only when there is a necessity. The hibernate default value is 100. |
| 134 | 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. |
| 135 | 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. |
| 136 | skava.hibernate.hibernateReader.c3p0MinSize | This propery holds the minimum number of JDBC connections in the pool. The default hibernate value is 1. |
| 137 | hystrix.command.user-key.circuitBreaker.sleepWindowInMilliseconds | This property sets instance-specific values dynamically which overrides the preceding three levels of defaults. |
| 138 | skava.event.enableFatEvent | This property is used to enable/disable the fat event. |
| 139 | skava.event.eventbridge.eventBusName | This property is used to set the fully qualified name of the custom implementation class. |
| 140 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 141 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 142 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 143 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 144 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 145 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 146 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 147 | web.exposure.include | This property is used to expose the management endpoints. |
| 148 | server..max-http-header-size | To increase http header size we have externalize this property. |
| 149 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 150 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 151 | 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 the ZK properties
2024-06-19 | SD – Updated the ZK properties for 8.16.0 to 8.17.2.
2023-10-22 | JP – Updated content for Release 8.15.4.
2023-01-03 | JP – Updated content for Release 8.13.0.
2022-04-09 | JP – Fixed link and http issues.
2021-12-23 | AN – Updated content for 8.11 release.
2020-12-10 | HM – Updated missing ZK 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-16 | AN – Updated to a new table tool.
2019-05-01 | PLK – Minor copyedit.
2019-01-21 | PLK – Content uploaded.