ServiceConfig

This topic describes the ServiceConfig element.

Description

Root of this configuration file.

Child element properties

Note: Child elements must occur in the order shown.

Child elements

Child elementMust occur at leastMay occur at mostElement type
DiscoveryService1 time1 timeNone
TokenService1 time1 timeNone
ContextService0 times (optional)1 timeNone
ContentService0 times (optional)1 timeNone
PreviewService0 times (optional)1 timeNone

Attributes

AttributeDescription and useType
ConnectionTimeout

The number of milliseconds that are allowed to elapse before the client considers the Discovery Service unavailable. Increase this value as needed if your connection times out while fetching a sitemap.

(required)
int
CacheEnabled

Whether to apply caching to the connection.

(required
Boolean
CacheExpirationDuration

The number of seconds in which the cache is considered to have expired.

(required)
int
CacheUri

The URI of an external Ehcache configuration file. If omitted, the client looks for a file called ehcache.xml or, if absent, failsafe-ehcache.xml.

(optional)
string
ServiceAvailabilityCheck

Whether or not to check for the availability of the Discovery Service. Defaults to false if not specified.

(optional)
Boolean
CacheProviderClass

The fully qualified classname of the Java class that implements client-side caching. Defaults to com.sdl.web.client.cache.GeneralCacheProvider. When using Redis, set this attribute to com.sdl.web.client.cache.distributed.RedisCacheProvider.

(optional)
string
CacheConnectionTimeout

Cache connection timeout. Used for connections to distributed cache.

(optional)
string
CacheClientId

The ID with which to identify the client. Use this attribute if you use Redis, which needs a client ID to find the proper storage.

(optional)
string
CachePassword

The password needed to access the cache. Use this attribute if you use Redis.

(optional)
string
CacheCompressionThreshold

Distributed cache compression threshold option. Sets the threshold value which defines whether compression should be used for a serialized key-value pair.

(optional)
string
CacheRedisPoolMaxTotal

Redis maximum size of connection pool for Redis cache.

(optional)
string
CacheRedisPoolTestWhileIdle

Redis cache-specific option which defines whether the client should ping Redis while the client is idle.

(optional)
string
ResolveCapability

Specific Capability that the client will be initialized with. If no Resolve Capability is specified, the client triggers the ContentServiceCapability.

(optional)
string
ServiceProxyHostName

The service proxy host name.

(optional)
string
ServiceProxyPort

The service proxy port.

(optional)
int
CheckVersionCompatibilityWhether or not to check whether the server-side microservices (CIS) have a version compatible with this client. Defaults to false if not specified.

(optional)

Boolean