A B C D E G H I K L M N O P R S T U V W X

A

AbstractCacheProvider - Class in com.sdl.web.client.cache

Abstract CacheProvider implementation holding configuration values.

AbstractCacheProvider() - Constructor for class com.sdl.web.client.cache.AbstractCacheProvider

B

BACKUP_SUFFIX - Static variable in class com.sdl.web.client.cache.CacheUtil

Suffix which indicates a backup cache.

build() - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

Builder() - Constructor for class com.sdl.web.client.cache.distributed.RedisCache.Builder

C

CacheProvider - Interface in com.sdl.web.client.cache

Cache provider common interface.

CacheProviderInitializer - Class in com.sdl.web.client.cache

Initializes CacheProvider implementation.

CacheSecurityAwareClientPropertiesBuilder - Class in com.sdl.web.client.configuration

This builder constructs properties for the OData Client.

CacheSecurityAwareClientPropertiesBuilder() - Constructor for class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

CacheSecurityAwareClientPropertiesBuilder(Map<String, String>) - Constructor for class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

CacheUtil - Class in com.sdl.web.client.cache

Utility methods for caching.

CachingCapabilityProvider - Class in com.sdl.web.client.impl

Capability provider with caching abilities.

CachingCapabilityProvider(CapabilityProvider, Properties) - Constructor for class com.sdl.web.client.impl.CachingCapabilityProvider

CachingEntityProvider - Class in com.sdl.web.client.impl

Caching Entity Provider.

CachingEntityProvider(EntityProvider, Properties) - Constructor for class com.sdl.web.client.impl.CachingEntityProvider

CapabilityProvider - Interface in com.sdl.web.client

Provider specified for getting capabilities from discovery-service.

CapabilityProviderFactory - Class in com.sdl.web.client.impl

Factory class for creating different capability providers.

CHECK_VERSION_COMPATIBILITY - Static variable in class com.sdl.web.client.configuration.ClientConstants.Versioning

CheckVersionCompatibility.

clear() - Method in class com.sdl.web.client.cache.distributed.RedisCache

CLIENT_CACHE_COMPRESSION_THRESHOLD - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to get data compression size threshold.

CLIENT_CACHE_COMPRESSION_THRESHOLD_DEFAULT - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Default value for 'CompressionThreshold' property.

CLIENT_CACHE_CONNECTION_TIMEOUT - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Cache connection timeout.

CLIENT_CACHE_CONNECTION_TIMEOUT_DEFAULT - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Cache connection timeout default value.

CLIENT_CACHE_ENABLED - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to identify if cache is enabled.

CLIENT_CACHE_EXPIRATION_DURATION - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Cache expiration duration property (in seconds).

CLIENT_CACHE_ID - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to get distributed cache client id.

CLIENT_CACHE_ID_DEFAULT - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to get distributed cache client id.

CLIENT_CACHE_PASSWORD - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to get distributed cache password.

CLIENT_CACHE_PROVIDER_CLASSNAME - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to know if distributed cache is enabled.

CLIENT_CACHE_REDIS_POOL_MAX_TOTAL - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to get jedis poll max size.

CLIENT_CACHE_REDIS_POOL_MAX_TOTAL_DEFAULT - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Default value for 'RedisPoolMaxTotal' property.

CLIENT_CACHE_REDIS_POOL_TEST_WHILE_IDLE - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property whether defines if we should ping Redis from time to time while idle.

CLIENT_CACHE_REDIS_POOL_TEST_WHILE_IDLE_DEFAULT - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Default value for 'RedisPoolTestWhileIdle' property.

CLIENT_CACHE_SERVICE_AVAILABILITY_CHECK - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

The parameter from configuration file.

CLIENT_CACHE_URI - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Property to get cache uri.

CLIENT_ID - Static variable in class com.sdl.web.client.configuration.ClientConstants.Security

OAuth client id.

CLIENT_SECRET - Static variable in class com.sdl.web.client.configuration.ClientConstants.Security

OAuth client secret.

CLIENT_TOKEN_PROVIDER - Static variable in class com.sdl.web.client.configuration.ClientConstants.Security

OAuth custom token provider property name.

ClientConstants - Class in com.sdl.web.client.configuration

OData Client Constants.

ClientConstants.Cache - Class in com.sdl.web.client.configuration

Client caching properties.

ClientConstants.Security - Class in com.sdl.web.client.configuration

Client security properties.

ClientConstants.Versioning - Class in com.sdl.web.client.configuration

Versioning properties.

ClientException - Exception in com.sdl.web.client

Client side exception.

ClientException(String) - Constructor for exception com.sdl.web.client.ClientException

Creates a Client exception with a message.

ClientException(String, Throwable) - Constructor for exception com.sdl.web.client.ClientException

Creates a Client exception with a message with a cause.

ClientsUtil - Class in com.sdl.web.client.impl.util

Utility class for the clients.

close() - Method in class com.sdl.web.client.cache.distributed.RedisCache

com.sdl.web.client - package com.sdl.web.client

com.sdl.web.client.cache - package com.sdl.web.client.cache

com.sdl.web.client.cache.distributed - package com.sdl.web.client.cache.distributed

com.sdl.web.client.configuration - package com.sdl.web.client.configuration

com.sdl.web.client.configuration.api - package com.sdl.web.client.configuration.api

com.sdl.web.client.configuration.crypto - package com.sdl.web.client.configuration.crypto

com.sdl.web.client.impl - package com.sdl.web.client.impl

com.sdl.web.client.impl.util - package com.sdl.web.client.impl.util

com.sdl.web.client.versions - package com.sdl.web.client.versions

ConfigurationException - Exception in com.sdl.web.client.configuration.api

ConfigurationException is used to indicate an error condition that occurred during configuration.

ConfigurationException(String) - Constructor for exception com.sdl.web.client.configuration.api.ConfigurationException

Constructs a new ConfigurationException with the passed detail message and null as its embedded Throwable.

ConfigurationException(String, Throwable) - Constructor for exception com.sdl.web.client.configuration.api.ConfigurationException

Constructs a new ConfigurationException with the specified detail message and an embedded Throwable.

ConfigurationHolder - Interface in com.sdl.web.client.configuration.api

It represents a 'Configuration' holder which can hold sub-configurations and configuration values.

ConfigurationPath - Class in com.sdl.web.client.configuration

It represents a path to locate either a 'Configuration Item' or 'Configuration Value'.

ConfigurationPath(String) - Constructor for class com.sdl.web.client.configuration.ConfigurationPath

configure(Properties) - Method in class com.sdl.web.client.cache.AbstractCacheProvider

Configures the CacheProvider.

configure(Properties) - Method in interface com.sdl.web.client.cache.CacheProvider

Configures the CacheProvider.

configure(Properties) - Method in class com.sdl.web.client.cache.distributed.RedisCacheProvider

configure(Properties) - Method in class com.sdl.web.client.cache.GeneralCacheProvider

containsKey(K) - Method in class com.sdl.web.client.cache.distributed.RedisCache

containsKey(byte[]) - Method in class com.sdl.web.client.cache.distributed.RedisStorageClient

Checks whether Redis cache storage contains specified key.

ContentVersionManager - Class in com.sdl.web.client.versions

ContentVersionManager contains methods for managing CIS versions.

ContentVersionManager(String, Map<String, String>) - Constructor for class com.sdl.web.client.versions.ContentVersionManager

Read Service version by handshake request to Service.

ContentVersionManager(String, Properties) - Constructor for class com.sdl.web.client.versions.ContentVersionManager

Read Service version by handshake request to Service.

Crypto - Class in com.sdl.web.client.configuration.crypto

Generic cryptography implementation.

Crypto() - Constructor for class com.sdl.web.client.configuration.crypto.Crypto

Construct a Crypto instance with the default encryption provider.

Crypto(KeyProvider) - Constructor for class com.sdl.web.client.configuration.crypto.Crypto

Construct a Crypto instance with the given encryption provider.

D

decrypt(String) - Method in class com.sdl.web.client.configuration.crypto.Crypto

Decrypts the provided secret.

DEFAULT_CACHE_URI - Static variable in class com.sdl.web.client.configuration.ClientConstants.Cache

Default failsafe cache uri.

DEFAULT_VERSION - Static variable in class com.sdl.web.client.versions.ContentVersionManager

Default Service version.

DefaultCapabilityProvider - Class in com.sdl.web.client.impl

Provider for capabilities configurations without security.

DefaultCapabilityProvider(Properties) - Constructor for class com.sdl.web.client.impl.DefaultCapabilityProvider

DefaultDiscoveryClient - Class in com.sdl.web.client.impl

Default HTTPURLConnection based Discovery Client.

DefaultDiscoveryClient(Properties) - Constructor for class com.sdl.web.client.impl.DefaultDiscoveryClient

DefaultEntityProvider - Class in com.sdl.web.client.impl

Default Entity Provider.

DefaultEntityProvider(Properties) - Constructor for class com.sdl.web.client.impl.DefaultEntityProvider

DefaultOAuthClient - Class in com.sdl.web.client.impl

Default HTTPURLConnection based OAuth Client.

DefaultOAuthClient(Properties) - Constructor for class com.sdl.web.client.impl.DefaultOAuthClient

deregisterCacheEntryListener(CacheEntryListenerConfiguration<K, V>) - Method in class com.sdl.web.client.cache.distributed.RedisCache

DiscoveryClient - Interface in com.sdl.web.client

Discovery client will be used to obtain different resources supported by discovery-service.

doFetchOAuthToken(String, String) - Method in class com.sdl.web.client.impl.DefaultOAuthClient

doFetchOAuthToken(String, String) - Method in class com.sdl.web.client.impl.LegacyOAuthClient

E

encrypt(String) - Method in class com.sdl.web.client.configuration.crypto.Crypto

Encrypt the provided secret.

EntityProvider - Interface in com.sdl.web.client

The Entity Provider.

EntityProviderFactory - Class in com.sdl.web.client.impl

Entity Provider Factory.

EntityProviderFactory() - Constructor for class com.sdl.web.client.impl.EntityProviderFactory

ExpiredEntityListener<K,V> - Class in com.sdl.web.client.cache

Expired entity listener.

ExpiredEntityListener(CacheProvider, Class<? extends Serializable>, Class<? extends Serializable>) - Constructor for class com.sdl.web.client.cache.ExpiredEntityListener

G

GeneralCacheProvider - Class in com.sdl.web.client.cache

The CacheProvider class provides ability to use cache.

GeneralCacheProvider() - Constructor for class com.sdl.web.client.cache.GeneralCacheProvider

get(K) - Method in class com.sdl.web.client.cache.distributed.RedisCache

get(byte[]) - Method in class com.sdl.web.client.cache.distributed.RedisStorageClient

Get value by specified key.

get(Stream<byte[]>) - Method in class com.sdl.web.client.cache.distributed.RedisStorageClient

Get key/value map of all passed serialized keys.

getAll(Set<? extends K>) - Method in class com.sdl.web.client.cache.distributed.RedisCache

getAndPut(K, V) - Method in class com.sdl.web.client.cache.distributed.RedisCache

getAndRemove(K) - Method in class com.sdl.web.client.cache.distributed.RedisCache

getAndReplace(K, V) - Method in class com.sdl.web.client.cache.distributed.RedisCache

getAwareEntities(Class<T>, Optional<String>, String...) - Method in interface com.sdl.web.client.DiscoveryClient

Request for ODataIdAwareEntityies WITH security attached.

getAwareEntities(Class<T>, String...) - Method in interface com.sdl.web.client.EntityProvider

Get list of entities recognized by its class.

getAwareEntities(Class<T>, String...) - Method in class com.sdl.web.client.impl.CachingEntityProvider

getAwareEntities(Class<T>, Optional<String>, String...) - Method in class com.sdl.web.client.impl.DefaultDiscoveryClient

getAwareEntities(Class<T>, String...) - Method in class com.sdl.web.client.impl.DefaultEntityProvider

getAwareEntities(Class<T>, String...) - Method in class com.sdl.web.client.impl.SecuredEntityProvider

Provide secured aware entities.

getAwareEntity(Class<T>, Optional<String>, String...) - Method in interface com.sdl.web.client.DiscoveryClient

Request for ODataIdAwareEntityies with security attached.

getAwareEntity(Class<T>, String...) - Method in interface com.sdl.web.client.EntityProvider

Get entity recognized by its class.

getAwareEntity(Class<T>, String...) - Method in class com.sdl.web.client.impl.CachingEntityProvider

getAwareEntity(Class<T>, Optional<String>, String...) - Method in class com.sdl.web.client.impl.DefaultDiscoveryClient

getAwareEntity(Class<T>, String...) - Method in class com.sdl.web.client.impl.DefaultEntityProvider

getAwareEntity(Class<T>, String...) - Method in class com.sdl.web.client.impl.SecuredEntityProvider

Provide secured aware entity.

getBackupCacheConfiguration(Class<K>, Class<V>) - Static method in class com.sdl.web.client.cache.CacheUtil

Creates the cache configuration for backup cache.

getBackupCacheName(String) - Static method in class com.sdl.web.client.cache.CacheUtil

Returns name for backup cache.

getCacheExpirationPeriod() - Method in class com.sdl.web.client.cache.AbstractCacheProvider

getCacheExpirationPeriod() - Method in interface com.sdl.web.client.cache.CacheProvider

Cache expiration duration (in seconds).

getCacheManager() - Method in class com.sdl.web.client.cache.distributed.RedisCache

getCacheProvider(Properties) - Static method in class com.sdl.web.client.cache.CacheProviderInitializer

Returns cache provider instance depending on configuration properties.

getCacheProvider() - Method in class com.sdl.web.client.impl.CachingCapabilityProvider

getCachingDefaultCapabilityProvider(Properties) - Static method in class com.sdl.web.client.impl.CapabilityProviderFactory

Return instance of CachingCapabilityProvider that wraps DefaultCapabilityProvider.

getCachingDefaultEntityProvider(Properties) - Static method in class com.sdl.web.client.impl.EntityProviderFactory

Return instance of CachingEntityProvider that wraps DefaultEntityProvider.

getCachingSecuredCapabilityProvider(Properties) - Static method in class com.sdl.web.client.impl.CapabilityProviderFactory

Return instance of CachingCapabilityProvider.

getCachingSecuredEntityProvider(Properties) - Static method in class com.sdl.web.client.impl.EntityProviderFactory

Return instance of CachingEntityProvider.

getCapabilities(Class<T>) - Method in interface com.sdl.web.client.DiscoveryClient

Request for Capabilityies WITHOUT security attached.

getCapabilities(Class<T>, Optional<String>) - Method in interface com.sdl.web.client.DiscoveryClient

Request for Capabilityies WITH security attached.

getCapabilities(Class<T>, Optional<String>, String...) - Method in interface com.sdl.web.client.DiscoveryClient

Request for Capabilityies WITH security attached.

getCapabilities(Class<T>, Optional<String>, String...) - Method in class com.sdl.web.client.impl.DefaultDiscoveryClient

getCapability(Class<T>) - Method in interface com.sdl.web.client.CapabilityProvider

Get capability recognized by its class.

getCapability(Class<T>, String...) - Method in interface com.sdl.web.client.CapabilityProvider

Get capability recognized by its class.

getCapability(Class<T>) - Method in interface com.sdl.web.client.DiscoveryClient

Request for Capability WITHOUT security attached.

getCapability(Class<T>, Optional<String>) - Method in interface com.sdl.web.client.DiscoveryClient

Request for Capability WITH security attached.

getCapability(Class<T>, Optional<String>, String...) - Method in interface com.sdl.web.client.DiscoveryClient

Request for Capability WITH security attached and expand parameters.

getCapability(Class<T>, String...) - Method in class com.sdl.web.client.impl.CachingCapabilityProvider

getCapability(Class<T>, String...) - Method in class com.sdl.web.client.impl.DefaultCapabilityProvider

Provide secured capability.

getCapability(Class<T>, Optional<String>, String...) - Method in class com.sdl.web.client.impl.DefaultDiscoveryClient

getCapability(Class<T>, String...) - Method in class com.sdl.web.client.impl.SecuredCapabilityProvider

Provide secured capability.

getCapabilityProvider(Properties) - Static method in class com.sdl.web.client.impl.CapabilityProviderFactory

Return instance of DefaultCapabilityProvider.

getCapabilityProvider(boolean, boolean, Properties) - Static method in class com.sdl.web.client.impl.CapabilityProviderFactory

Return instance of CapabilityProvider based on flags and properties.

getClasses() - Method in class com.sdl.web.client.versions.ContentVersionManager

Get list of loaded classes.

getConfiguration(Class<C>) - Method in class com.sdl.web.client.cache.distributed.RedisCache

getConfiguration(String) - Method in interface com.sdl.web.client.configuration.api.ConfigurationHolder

Syntactic sugar for ConfigurationHolder.getConfiguration(ConfigurationPath).

getConfiguration(ConfigurationPath) - Method in interface com.sdl.web.client.configuration.api.ConfigurationHolder

Get the configuration for the given path.

getConfiguration(ConfigurationPath) - Method in class com.sdl.web.client.configuration.XMLConfigurationHolder

getDefaultTokenProvider(Properties) - Method in class com.sdl.web.client.configuration.TokenProviderFactory

getEntityProvider(Properties) - Static method in class com.sdl.web.client.impl.EntityProviderFactory

Return instance of DefaultEntityProvider.

getEntityProvider(boolean, boolean, Properties) - Static method in class com.sdl.web.client.impl.EntityProviderFactory

Return instance of EntityProvider based on flags and properties.

getInstance() - Static method in class com.sdl.web.client.configuration.TokenProviderFactory

Returns instance of TokenProviderFactory.

getKey() - Method in interface com.sdl.web.client.configuration.crypto.KeyProvider

Gets the key from the key provider.

getName() - Method in class com.sdl.web.client.cache.distributed.RedisCache

getPathSegments() - Method in class com.sdl.web.client.configuration.ConfigurationPath

Get the list of steps to walk in order to locate a configuration item or value.

getSecuredCapabilityProvider(Properties) - Static method in class com.sdl.web.client.impl.CapabilityProviderFactory

Return instance of SecuredCapabilityProvider.

getSecuredEntityProvider(Properties) - Static method in class com.sdl.web.client.impl.EntityProviderFactory

Return instance of SecuredEntityProvider.

getServiceChecker() - Method in class com.sdl.web.client.cache.AbstractCacheProvider

Returns service checker.

getServiceChecker() - Method in interface com.sdl.web.client.cache.CacheProvider

Returns service checker.

getServiceUrl() - Method in interface com.sdl.web.client.DiscoveryClient

Return the service url.

getServiceUrl() - Method in class com.sdl.web.client.impl.DefaultDiscoveryClient

getServiceVersion() - Method in class com.sdl.web.client.versions.ContentVersionManager

getToken(String, String) - Method in class com.sdl.web.client.impl.DefaultOAuthClient

getToken(String, String) - Method in class com.sdl.web.client.impl.LegacyOAuthClient

getToken() - Method in class com.sdl.web.client.impl.LegacyTokenProvider

Gets OAuth token from Token service using OAuth client.

getToken() - Method in class com.sdl.web.client.impl.OAuthTokenProvider

Gets OAuth token from Token service using OAuth client.

getToken(String, String) - Method in interface com.sdl.web.client.OAuthClient

Gets a token from the token endpoint, we first lookup the location of the token endpoint by contacting the discovery service.

getToken() - Method in interface com.sdl.web.client.TokenProvider

Gets OAuth token.

getTokenProvider(Properties) - Method in class com.sdl.web.client.configuration.TokenProviderFactory

Gets a token provider based on given properties.

getTokenServiceCapability() - Method in interface com.sdl.web.client.DiscoveryClient

Request for TokenServiceCapability.

getTokenServiceCapability() - Method in class com.sdl.web.client.impl.DefaultDiscoveryClient

getValue(String) - Method in interface com.sdl.web.client.configuration.api.ConfigurationHolder

Get the value from the current configuration node accessed by the given name.

getValue(String) - Method in class com.sdl.web.client.configuration.XMLConfigurationHolder

getValues() - Method in interface com.sdl.web.client.configuration.api.ConfigurationHolder

Get all the values from current configuration node.

getValues() - Method in class com.sdl.web.client.configuration.XMLConfigurationHolder

getVersion() - Method in class com.sdl.web.client.versions.Version

H

hasConfiguration(String) - Method in interface com.sdl.web.client.configuration.api.ConfigurationHolder

Syntactic sugar for ConfigurationHolder.hasConfiguration(ConfigurationPath).

hasConfiguration(ConfigurationPath) - Method in interface com.sdl.web.client.configuration.api.ConfigurationHolder

Helper method to check if provided path exists in the configuration.

I

invoke(K, EntryProcessor<K, V, T>, Object...) - Method in class com.sdl.web.client.cache.distributed.RedisCache

invokeAll(Set<? extends K>, EntryProcessor<K, V, T>, Object...) - Method in class com.sdl.web.client.cache.distributed.RedisCache

isCacheEnabled() - Method in class com.sdl.web.client.cache.AbstractCacheProvider

Returns whether cache is enabled.

isCacheEnabled() - Method in interface com.sdl.web.client.cache.CacheProvider

Returns whether cache is enabled.

isClosed() - Method in class com.sdl.web.client.cache.distributed.RedisCache

isClosed() - Method in class com.sdl.web.client.cache.distributed.RedisStorageClient

Checks if Redis connection pool is closed.

isCompatible() - Method in class com.sdl.web.client.versions.ContentVersionManager

Checks if all methods from current stacktrace are compatible with CIS version.

isHigherCISVersion(Version) - Method in class com.sdl.web.client.versions.ContentVersionManager

Checks if CIS version is equal to or above specified version.

isHostAvailable() - Method in class com.sdl.web.client.cache.ServiceAvailabilityChecker

Checks if the service available.

isTokenExpired() - Method in class com.sdl.web.client.impl.LegacyTokenProvider

Checks if the OAuth token is expired.

isTokenExpired() - Method in class com.sdl.web.client.impl.OAuthTokenProvider

Checks if the OAuth token is expired.

iterator() - Method in class com.sdl.web.client.cache.distributed.RedisCache

K

KeyProvider - Interface in com.sdl.web.client.configuration.crypto

Key provider interface.

L

LegacyOAuthClient - Class in com.sdl.web.client.impl

Legacy OAuth Client.

LegacyOAuthClient(Properties) - Constructor for class com.sdl.web.client.impl.LegacyOAuthClient

LegacyTokenProvider - Class in com.sdl.web.client.impl

Legacy Token Provider.

LegacyTokenProvider(String, Properties) - Constructor for class com.sdl.web.client.impl.LegacyTokenProvider

Used when you know the token service and you don't want discovery service uri to be sent when requesting token (as 'resource' parameter).

LegacyTokenProvider(Properties) - Constructor for class com.sdl.web.client.impl.LegacyTokenProvider

loadAll(Set<? extends K>, boolean, CompletionListener) - Method in class com.sdl.web.client.cache.distributed.RedisCache

loadServiceVersion(String, Map<String, String>) - Method in class com.sdl.web.client.versions.ContentVersionManager

Read CIS version by $metadata call to CIS.

LOG - Static variable in interface com.sdl.web.client.configuration.api.ConfigurationHolder

Logger.

M

makeEndWithoutSlash(String) - Static method in class com.sdl.web.client.impl.util.ClientsUtil

This method makes sure that the provided url will end without '/'.

makeEndWithSlash(String) - Static method in class com.sdl.web.client.impl.util.ClientsUtil

This method makes sure that the provided url will end with '/'.

methodsWithAnnotation(List<Class<?>>, Class<T>) - Method in class com.sdl.web.client.versions.ContentVersionManager

Find all annotated methods in classes loaded by class loader.

methodsWithoutAnnotation(List<Class<?>>, Class<T>) - Method in class com.sdl.web.client.versions.ContentVersionManager

Find all methods in classes without annotation.

N

needCheckHostAvailability() - Method in class com.sdl.web.client.cache.AbstractCacheProvider

Returns whether there is a need to check host availability.

needCheckHostAvailability() - Method in interface com.sdl.web.client.cache.CacheProvider

Returns whether there is a need to check host availability.

NOT_VERSION - Static variable in class com.sdl.web.client.versions.Version

Default range of version in SupportedCisVersion.

O

OAuthClient - Interface in com.sdl.web.client

The OAuth client can be used for obtaining an OAuth token from a token endpoint.

OAuthTokenProvider - Class in com.sdl.web.client.impl

Provider for handling OAuth token.

OAuthTokenProvider(String, Properties) - Constructor for class com.sdl.web.client.impl.OAuthTokenProvider

Used when you know the token service and you don't want discovery service uri to be sent when requesting token (as 'resource' parameter).

OAuthTokenProvider(Properties) - Constructor for class com.sdl.web.client.impl.OAuthTokenProvider

onExpired(Iterable<CacheEntryEvent<? extends K, ? extends V>>) - Method in class com.sdl.web.client.cache.ExpiredEntityListener

P

provideBackupCacheForClass(Class<K>, Class<V>) - Method in class com.sdl.web.client.cache.GeneralCacheProvider

Provides backup cache for given key and value classes.

provideCacheForClass(Class<K>, Class<V>, String) - Method in interface com.sdl.web.client.cache.CacheProvider

Returns a cache for passed as a parameter class, could be existing one or just created.

provideCacheForClass(Class<K>, Class<V>) - Method in interface com.sdl.web.client.cache.CacheProvider

Returns a cache for passed as a parameter class, could be existing one or just created.

provideCacheForClass(Class<K>, Class<V>, String) - Method in class com.sdl.web.client.cache.distributed.RedisCacheProvider

provideCacheForClass(Class<K>, Class<V>, String) - Method in class com.sdl.web.client.cache.GeneralCacheProvider

Returns a cache for passed as a parameter class, could be existing one or just created.

put(K, V) - Method in class com.sdl.web.client.cache.distributed.RedisCache

put(byte[], byte[], Integer) - Method in class com.sdl.web.client.cache.distributed.RedisStorageClient

Put key/value into Redis binary storage.

putAll(Map<? extends K, ? extends V>) - Method in class com.sdl.web.client.cache.distributed.RedisCache

putIfAbsent(K, V) - Method in class com.sdl.web.client.cache.distributed.RedisCache

R

readConfiguration(String) - Method in interface com.sdl.web.client.configuration.api.XMLConfigurationReader

Read the configuration from the given XML file.

readConfiguration(String, String) - Method in interface com.sdl.web.client.configuration.api.XMLConfigurationReader

Read the configuration from the given XML file and validate according provided schema.

readConfiguration(String) - Method in class com.sdl.web.client.configuration.XMLConfigurationReaderImpl

readConfiguration(String, String) - Method in class com.sdl.web.client.configuration.XMLConfigurationReaderImpl

RedisCache<K extends Serializable,V extends Serializable> - Class in com.sdl.web.client.cache.distributed

Distributed cache implementation.

RedisCache.Builder - Class in com.sdl.web.client.cache.distributed

Builder for RedisCache.

RedisCacheProvider - Class in com.sdl.web.client.cache.distributed

Distributed cache provider implementation that uses Redis to store serialized objects.

RedisCacheProvider() - Constructor for class com.sdl.web.client.cache.distributed.RedisCacheProvider

RedisStorageClient - Class in com.sdl.web.client.cache.distributed

Redis storage client.

RedisStorageClient(JedisPoolConfig, String, int, Long, String) - Constructor for class com.sdl.web.client.cache.distributed.RedisStorageClient

refreshToken(String, OAuthToken) - Method in class com.sdl.web.client.impl.DefaultOAuthClient

refreshToken(String, OAuthToken) - Method in class com.sdl.web.client.impl.LegacyOAuthClient

refreshToken(String, OAuthToken) - Method in interface com.sdl.web.client.OAuthClient

Obtains a refreshed token from the token endpoint.

registerCacheEntryListener(CacheEntryListenerConfiguration<K, V>) - Method in class com.sdl.web.client.cache.distributed.RedisCache

remove(K) - Method in class com.sdl.web.client.cache.distributed.RedisCache

remove(K, V) - Method in class com.sdl.web.client.cache.distributed.RedisCache

removeAll(Set<? extends K>) - Method in class com.sdl.web.client.cache.distributed.RedisCache

removeAll() - Method in class com.sdl.web.client.cache.distributed.RedisCache

removeBackupCache() - Method in class com.sdl.web.client.cache.GeneralCacheProvider

Removes all backup caches from cache manager.

replace(K, V, V) - Method in class com.sdl.web.client.cache.distributed.RedisCache

replace(K, V) - Method in class com.sdl.web.client.cache.distributed.RedisCache

S

SecuredCapabilityProvider - Class in com.sdl.web.client.impl

Provider for secured capabilities configurations.

SecuredCapabilityProvider(Properties) - Constructor for class com.sdl.web.client.impl.SecuredCapabilityProvider

SecuredEntityProvider - Class in com.sdl.web.client.impl

Secured Entity Provider.

SecuredEntityProvider(Properties) - Constructor for class com.sdl.web.client.impl.SecuredEntityProvider

ServiceAvailabilityChecker - Class in com.sdl.web.client.cache

The class responsible for checking if the service is available.

ServiceAvailabilityChecker(String, CacheProvider) - Constructor for class com.sdl.web.client.cache.ServiceAvailabilityChecker

Sets the service URL.

SupportedCisVersion - Annotation Type in com.sdl.web.client.versions

Annotation is applied to methods which are using Content Interaction Library.

T

TokenProvider - Interface in com.sdl.web.client

Provider for handling OAuth token.

TokenProviderClientException - Exception in com.sdl.web.client

Token Provider side exception.

TokenProviderClientException(String) - Constructor for exception com.sdl.web.client.TokenProviderClientException

Creates a Token Provider exception with a message.

TokenProviderClientException(String, Throwable) - Constructor for exception com.sdl.web.client.TokenProviderClientException

Creates a Token Provider exception with a message with a cause.

TokenProviderFactory - Class in com.sdl.web.client.configuration

TokenProviderFactory provides a TokenProvider based on given Token Service properties.

TokenProviderFactory() - Constructor for class com.sdl.web.client.configuration.TokenProviderFactory

toString() - Method in class com.sdl.web.client.configuration.ConfigurationPath

toString() - Method in class com.sdl.web.client.versions.Version

U

unwrap(Class<T>) - Method in class com.sdl.web.client.cache.distributed.RedisCache

V

Version - Class in com.sdl.web.client.versions

Version object contains version and methods for checking range.

Version(String) - Constructor for class com.sdl.web.client.versions.Version

Creates version based on default version format.

Versioning() - Constructor for class com.sdl.web.client.configuration.ClientConstants.Versioning

W

withCacheExpirationDuration(Integer) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withCacheExpirationDuration(Long) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

Specify the expiration time for cache entries (in seconds).

withCacheName(String) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withCaching(boolean) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

Specifies whether client caching is enabled (or not).

withCachingUri(String) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

Specifies location of cache configuration.

withClientId(String) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withClientId(String) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

Specify the oauth client id for security credentials.

withClientSecret(String) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

Specify the oauth client id for security credentials.

withClientTimeout(Integer) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

Specify a timeout period for the client (in milliseconds).

withCompressionThreshold(Integer) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withHost(String) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withJedisPoolMaxTotal(Integer) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withJedisPoolTestWhileIdle(Boolean) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withPassword(String) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withPort(Integer) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

withProxyHostName(String) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

If a proxy is used to access the OData web service this specifies it's host name / ip address.

withProxyPort(Integer) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

If a proxy is used to access the OData web service this specifies it's port number.

withServiceUri(String) - Method in class com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

Specify the OData web service URI, e.g.

withTimeout(Long) - Method in class com.sdl.web.client.cache.distributed.RedisCache.Builder

X

XMLConfigurationHolder - Class in com.sdl.web.client.configuration

It represents a XML 'Configuration' holder.

XMLConfigurationHolder(Node) - Constructor for class com.sdl.web.client.configuration.XMLConfigurationHolder

XMLConfigurationReader<T extends ConfigurationHolder> - Interface in com.sdl.web.client.configuration.api

It represents a reader able to read configurations from XML configuration files.

XMLConfigurationReaderImpl - Class in com.sdl.web.client.configuration

XMLConfigurationReader implementation.

XMLConfigurationReaderImpl() - Constructor for class com.sdl.web.client.configuration.XMLConfigurationReaderImpl

A B C D E G H I K L M N O P R S T U V W X