The following table describes the ZooKeeper properties for the Subscription microservice:
| Sl. # | Property | Description |
|---|---|---|
| 1 | server.servlet.contextPath | This property holds the Spring Boot application's context path. |
| 2 | server.ssl.enabled | This property controls the SSL configuration for the boot application. |
| 3 | server.ssl.enabled-protocols | This property controls the SSL configuration for the Spring Boot application. |
| 4 | server.ssl.key-alias | This property holds the keystore alias name configured during the import using keytool utility. |
| 5 | server.ssl.key-store | This property holds the keystore PrivateKeyEntry, which will be used as the SSL certificate for the microservice. |
| 6 | server.ssl.key-store-password | This property holds the keystore password for opening the keystore mentioned in the key-store property. |
| 7 | server.ssl.key-store-type | This property holds the keystore type. |
| 8 | server.tomcat.accesslog.directory | This property holds the directory details for storing accesslog. |
| 9 | server.tomcat.accesslog.enabled | This property controls Tomcat logs for the Spring Boot application. |
| 10 | 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 of 10 |
| 11 | server.tomcat.accesslog.pattern | This property is used to set the pattern for writing logs in Tomcat. |
| 12 | server.tomcat.max-threads | This property controls the tomcat requst thread. |
| 13 | skava.auditlog.customLayoutFormat | This property holds the custom layout property information. |
| 14 | skava.auditlog.db.driverClassName | This property is used to connect to the mysql db for audit logs. |
| 15 | skava.auditlog.db.enabled | This property is used to enable/disable the db for audit logs. |
| 16 | skava.auditlog.db.password | This property is used to connect to the mysql db for audit logs. |
| 17 | skava.auditlog.db.url | This property is used to connect to the mysql db for audit logs. |
| 18 | skava.auditlog.db.userName | This property is used to connect to the mysql db for audit logs. |
| 19 | skava.auditlog.enabled | This property enables or disables the auditlog component. |
| 20 | skava.auditlog.file-location | This property sets the file location of the auditlog component. |
| 21 | skava.auditlog.layout-type | This property sets the layout type of the auditlog component. |
| 22 | skava.authorization.authExpiryTimeMins | This property holds the expiry time of authorization token generated using the getTestToken API call. The value is mentioned in minutes. |
| 23 | 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. |
| 24 | 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). |
| 25 | skava.authorization.gettesttoken.enabled | This property is used to enable the authorization endpoint for junit and readyapi testing |
| 26 | skava.authorization.superAdminRoleName | This property indicates the Super Admin role name for the corresponding microservice. |
| 27 | 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. |
| 28 | skava.cache.cascadeCacheNames | This property is used to enable cascade cache by its name. |
| 29 | skava.cache.enableCascade | This property is used to enable cascade cache. |
| 30 | skava.cache.enabled | This property is used to enable cache. |
| 31 | skava.cache.localCache.config.subscriptioncollection.cacheSize | This property represents the local cache entry size. |
| 32 | skava.cache.localCache.config.subscriptioncollection.maxIdleInSeconds | This property represents the local cache maximum idle time in seconds. |
| 33 | skava.cache.localCache.config.subscriptioncollection.timeToLiveInSeconds | This property represents the local cache expiry time in seconds. |
| 34 | skava.cache.localCache.type | This property represents the local cache type for L1 cache used in cascade cache. |
| 35 | 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. |
| 36 | skava.cache.redis.cacheNames | This property holds the Redis cache names used by this application. |
| 37 | skava.cache.redis.clearCacheEventName | This property sets the event name for cache clear operation. |
| 38 | skava.cache.redis.client | This property represents the type of client for redis connection. |
| 39 | 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. |
| 40 | 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. |
| 41 | skava.cache.redis.clusterEnabled | This property enables or disables the cluster of the Redis server. |
| 42 | skava.cache.redis.database | This property holds the Redis database index used by the connection factory. |
| 43 | 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). |
| 44 | 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. |
| 45 | skava.cache.redis.host | This property holds the Redis server's hostname/IP for caching objects. |
| 46 | skava.cache.redis.maxTimeTolive | This property is used to set the max time to live in minutes time for redis cache. |
| 47 | 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. |
| 48 | 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. |
| 49 | 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. |
| 50 | 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. |
| 51 | skava.cache.redis.port | This property holds the Redis server's port for the application to connect for both read and write cache operations. |
| 52 | skava.cache.redis.sentinel.master | This property contains the name of the Redis server. |
| 53 | skava.cache.redis.sentinel.nodes | This property contains a list of comma-separated host:port pairs of the Redis server. |
| 54 | skava.cache.redis.timeout | This property holds the connection timeout value of all Redis connections for both read and write operations. |
| 55 | skava.cache.useOnlyL2Cache | This property is used to enable L2 cache. |
| 56 | skava.cors.allowedHeaders | This property contains the allowed headers value. |
| 57 | skava.cors.allowedMethods | This property contains allowed methods for Spring Boot controller. |
| 58 | skava.cors.allowedOrigins | This property sets allowedOrigins for a CORS request. |
| 59 | skava.cors.enabled | This property enables or disables the CORS. |
| 60 | skava.cors.exposedHeaders | This property sets exposedHeaders for a CORS request. |
| 61 | skava.cors.maxAge | This property sets maxAge for a CORS request. The value is mentioned in seconds. |
| 62 | skava.cors.pathPattern | This property holds the pattern for a CORS request. |
| 63 | skava.crypto.alias | This property sets alias for crypto component. |
| 64 | skava.crypto.enabled | This property enables or disables the crypto component. |
| 65 | skava.crypto.salt | This property sets the salt value for crypto component. |
| 66 | skava.crypto.textEncryptorClass | This property sets the fully qualified name of the custom implementation class. |
| 67 | skava.event.className | This property is used to set the fully qualified name of the custom implementation class. |
| 68 | skava.event.enabled | This property enables or disables the event component. |
| 69 | skava.event.enableExternalEvent | This property is used to enable/disable the external event component |
| 70 | skava.event.enableFatEvent | This property is used to enable/disable the fat event |
| 71 | skava.event.eventbridge.eventBusName | This property is used to set the fully qualified name of the custom implementation class |
| 72 | skava.event.eventbridge.region | This property is used to set the fully qualified name of the custom implementation class |
| 73 | skava.event.externalClassName | This property is used to set the fully qualified name of the custom implementation class |
| 74 | skava.event.externalFatEventClass | This property is used to set the fully qualified name of the custom implementation class |
| 75 | skava.event.rabbitmq.concurrentConsumers | This property holds the value for maximum allowed concurrent consumers. |
| 76 | skava.event.rabbitmq.enabled | This property enables or disables the RabbitMQ server for the event component. |
| 77 | skava.event.rabbitmq.host | This property holds the host name of the RabbitMQ server. |
| 78 | skava.event.rabbitmq.password | This property holds the password of the RabbitMQ server. |
| 79 | skava.event.rabbitmq.port | This property holds the port of the RabbitMQ server. |
| 80 | skava.event.rabbitmq.ssl.addresses | This property is used to set the addresses for rabbitmq server cluster. |
| 81 | skava.event.rabbitmq.ssl.algorithm | This property is used to set the ssl algorithm used for rabbitmq server. |
| 82 | skava.event.rabbitmq.ssl.cluster-enabled | This property is used to enable/disable cluster for the rabbitmq server. |
| 83 | skava.event.rabbitmq.ssl.enabled | This property is used to enable/disable the rabbitmq server ssl for the event component |
| 84 | skava.event.rabbitmq.userName | This property holds the username of the RabbitMQ server. |
| 85 | skava.event.rabbitmq.virtualHost | This property sets the virtual host for RabbitMQ server. |
| 86 | skava.hibernate.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. |
| 87 | skava.hibernate.c3p0IdleTestPeriod | This property holds the idle time in seconds before a connection is automatically validated. If the given number is greater than 0, the Hybernate connection pool c3p0 will test all idle connections, pooled but unchecked-out connections, every this number of seconds. |
| 88 | skava.hibernate.c3p0MaxSize | This property sets the maxmium connection pool for Hibernate. |
| 89 | skava.hibernate.c3p0MaxStatements | This property indicates the maximum number of prepared statements in the cache. It increases the performance. Hibernate default is 0 and the caching is disabled. |
| 90 | skava.hibernate.c3p0MinSize | This property sets the minimum connection pool for Hibernate. |
| 91 | skava.hibernate.c3p0Timeout | This property sets the database connection timeout for Hibernate. |
| 92 | skava.hibernate.dialect | This property represents a dialect of SQL implemented by a particular RDBMS. |
| 93 | skava.hibernate.driverClassName | This property represents the class name of JDBC driver class. |
| 94 | skava.hibernate.enabled | This property enables or disables the Hibernate component. |
| 95 | skava.hibernate.formatSql | This property formats the generated SQL statement to make it more readable. |
| 96 | skava.hibernate.hbm2ddlAuto | This property sets the strategies used for DDL generation. |
| 97 | skava.hibernate.hibernateReader.acquireIncrement | Determines how many connections at a time c3p0 will try to acquire when the pool is exhausted. Default- 3 |
| 98 | skava.hibernate.hibernateReader.c3p0IdleTestPeriod | idle time in seconds before a connection is automatically validated |
| 99 | skava.hibernate.hibernateReader.c3p0MaxSize | This property is used to set maxmium connection pool for hibernate |
| 100 | skava.hibernate.hibernateReader.c3p0MaxStatements | Number of prepared statements will be cached. Increase performance. Hibernate default- 0 , caching is disable. |
| 101 | skava.hibernate.hibernateReader.c3p0MinSize | This property is used to set minimum connection pool for hibernate |
| 102 | skava.hibernate.hibernateReader.c3p0Timeout | This property is used to set database connection timeout for hibernate |
| 103 | skava.hibernate.hibernateReader.enabled | This property is used to enable reader DB. |
| 104 | skava.hibernate.hibernateReader.initialPoolSize | Number of Connections a pool will try to acquire upon startup. Default- 3 |
| 105 | skava.hibernate.hibernateReader.url | This property is used to set the database url |
| 106 | skava.hibernate.hikari.cache.prepStmts | This property sets whether the PreparedStatement is used or not. |
| 107 | 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. |
| 108 | skava.hibernate.hikari.enabled | This property enables or disables the Hibernate Hikari component. |
| 109 | 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). |
| 110 | skava.hibernate.hikari.maximumlifetime | This property controls the maximum lifetime of a connection in the pool. An in-use connection will never be retired, only when it is closed, it will then be removed. On a connection-by-connection basis, minor negative attenuation is applied to avoid mass-extinction in the pool. It is strongly recommend to set 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 ms (30 minutes). |
| 111 | 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. |
| 112 | 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. |
| 113 | skava.hibernate.hikari.prepStmtCachesize | This property sets the cache size of the PreparedStatement. |
| 114 | skava.hibernate.hikari.prepStmtCacheSqlLimit | This property sets the SQL limit of the PreparedStatement to be cached. |
| 115 | skava.hibernate.hikari.useServerPrepStmt | This property sets whether the server side PreparedStatement is used or not. |
| 116 | skava.hibernate.initialPoolSize | This property contains the number of connections a pool will try to acquire upon startup. The default value is 3. |
| 117 | skava.hibernate.newGeneratorMappings | This property enables or disables the generator mappings. |
| 118 | skava.hibernate.packageToScan | This property indicates the Java package having all the database entity objects to be scanned by the Hibernate component. |
| 119 | skava.hibernate.password | This property sets the password for the Hibernate component. |
| 120 | skava.hibernate.port | This property sets the port for Hibernate component. |
| 121 | skava.hibernate.showSql | This property enables or disables the Hibernate generate SQL. |
| 122 | skava.hibernate.url | This property sets the database URL. |
| 123 | skava.hibernate.username | This property sets the username for Hibernate. |
| 124 | skava.hikari.cachePrepStmts | This property is used to enable/disable true |
| 125 | skava.hikari.maxLifetime | This property controls the maximum lifetime of a connection in the pool. An in-use connection will never be retired, only when it is closed 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. Default- 1800000 (30 minutes) |
| 126 | skava.hikari.poolName | This property represents a user-defined name for the connection pool and appears mainly in logging and JMX management consoles to identify pools and pool configurations. Default- auto-generated |
| 127 | skava.hikari.prepStmtCacheSize | This property is used to set prepStmtCacheSize |
| 128 | skava.hikari.useServerPrepStmts | This property is used to set useServerPrepStmts |
| 129 | skava.keyprovider.algorithm | This property sets the algorithm to be used for encryption. |
| 130 | skava.keyprovider.enabled | This property enables or disables the key provider. |
| 131 | skava.keyprovider.keyProviderClass | This property sets the fully qualified name of the custom implementation class. |
| 132 | skava.keyprovider.keySize | This property sets the key size. |
| 133 | skava.keyprovider.keystorePassword | This property sets the keystore password. |
| 134 | skava.keyprovider.keystorePath | This property sets the keystore path. |
| 135 | skava.localization.cookieEnabled | This property indicates whether the localization component cookie is enabled or not. The value:
|
| 136 | 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. |
| 137 | skava.localization.enabled | This property indicates whether the localization component is enabled or not. The value:
|
| 138 | skava.localization.externalPath | This property holds the external path from where the localized messages are to be read from. |
| 139 | skava.localization.param-name | This property holds the parameter name in which the localization component is used. |
| 140 | skava.localization.resourceBundleBaseName | This property holds the resource bundle using the specified base name. |
| 141 | skava.log.enabled | This property indicates whether the log component is enabled or not. The value:
|
| 142 | 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 log4j2.yml. |
| 143 | skava.log.fluentdAppenderEnabled | This property indicates whether the log file should be aggregated to Fluentd directly rather than to a file. |
| 144 | skava.log.fluentdHost | This property holds the host name for Fluentd server instance where the log will be aggregated. |
| 145 | skava.log.fluentdPattern | This property holds the pattern for writing logs into the Fluentd server. |
| 146 | skava.log.fluentdPort | This property holds the port of Fluentd server instance where the log will be aggregated. |
| 147 | skava.log.fluentdTagName | This property holds the tag name to be added in the logs. |
| 148 | skava.previewmode.enabled | If the property is enabled, The preview mode of the subscription will be active. |
| 149 | skava.resttemplate.cookiePolicy | This property is used to ignore cookies |
| 150 | skava.resttemplate.cxnPoolSize | This property is used to set the connection pool size |
| 151 | skava.resttemplate.cxn-timeout-m-sec | This property is used to set connection timeout in milliseconds |
| 152 | skava.resttemplate.defaultMaxPerRoute | Set the total number of concurrent connections to a specific route, which is 2 by default |
| 153 | skava.resttemplate.enabled | This property is used to enable the resttemplate component |
| 154 | skava.resttemplate.handleRedirects | This property is used to enable the redirects for resttemplate component |
| 155 | skava.resttemplate.ignore-invalid-h-t-t-p-s-cert | This property is used to enable/disable invalid https certificate |
| 156 | skava.resttemplate.keyPass | This property is used to set the password for keystore |
| 157 | skava.resttemplate.p12File | This property is used to set the p12 file path |
| 158 | skava.resttemplate.read-timeout | This property is used to set read timeout in milliseconds |
| 159 | skava.resttemplate.supportedProtocols | This property is used to set the protocols for http calls |
| 160 | skava.secretsmanager.className | This property is used to specify which class to be used for secret management |
| 161 | skava.swaggerglobalparams.enabled | If this property is enabled Swagger global params from the application.yml will be referred and added in the swagger-ui |
| 162 | spring.application.name | This property sets the application name of Spring Boot. |
| 163 | spring.autoconfigure.exclude | This property holds the classes that are to be excluded from the Spring's autoconfiguration. |
| 164 | spring.cloud.zookeeper.config.enabled | This property is used to enable/disable the zookeeper base path. |
| 165 | spring.cloud.zookeeper.config.root | This property is used to enable/disable the zookeeper base path. |
| 166 | spring.cloud.zookeeper.config.watcher.enabled | This property is used to enable/disable the zookeeper watcher. |
| 167 | spring.cloud.zookeeper.connect-string | This property is used to located somewhere other than localhost:2181, the configuration is required to locate the server |
| 168 | spring.cloud.zookeeper.enabled | This property enables or disables the zookeeper server. |
| 169 | spring.sleuth.trace-id128 | This property is used to enable/disable the sleuth 128 bit traceid in the logs. |
| 170 | ZK_REDIS_SSL_ENABLED | This property enables or disables the Redis server SSL. The default value is FALSE. |
| 171 | ZK_REDIS_TIMEOUT | This property holds connection timeout value of Redis in milliseconds. The default value is 10000. |
| 172 | ZK_REDIS_USERNAME | This property holds the login username of the Redis server. The default value is empty. |
| 173 | ZK_PROTOCOLS | This property enables macro support for the TLS protocol version. |
| 174 | ZK_REDIS_PASSWORD | This property holds the Redis password. |
| 175 | skava.event.eventbridge.gzip.enabled | This property is used to enable/disable the event payload compression. |
| 176 | skava.event.eventbridge.gzip.minSizeForCompress | This property is used to set the minimum size of event to be send without compression. |
| 177 | skava.cache.redis.username | This property indicates the login username of the Redis server. |
| 178 | endpoints.loggers.enabled | This property is used to enable or disable the logger. |
| 179 | web.exposure.include | This property is used to expose the management endpoints. |
| 180 | server.max-http-header-size | To increase http header size we have externalize this property. |
| 181 | externalEventConfig.fileHost | This property is used to set the hosting events on external website. |
| 182 | externalEventConfig.tempStoragePath | This property is used to set the file path for the external events. |
| 183 | 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-05 | SW – 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-09 | 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-09-24 | AN – Page created and uploaded the contents for September 2019 release.