com.sdl.web.client.configuration

Class CacheSecurityAwareClientPropertiesBuilder

java.lang.Object

com.sdl.odata.client.ClientPropertiesBuilder

com.sdl.web.client.configuration.CacheSecurityAwareClientPropertiesBuilder

public class CacheSecurityAwareClientPropertiesBuilder
extends com.sdl.odata.client.ClientPropertiesBuilder

This builder constructs properties for the OData Client. Contains also another properties for cache and security.

Constructor Summary

Constructors

Constructor and Description
CacheSecurityAwareClientPropertiesBuilder()
CacheSecurityAwareClientPropertiesBuilder(Map<String,String> configValues)

Method Summary

Modifier and Type	Method and Description
CacheSecurityAwareClientPropertiesBuilder	withCacheExpirationDuration(Long cacheExpirationTime) Specify the expiration time for cache entries (in seconds).
CacheSecurityAwareClientPropertiesBuilder	withCaching(boolean cacheEnabled) Specifies whether client caching is enabled (or not).
CacheSecurityAwareClientPropertiesBuilder	withCachingUri(String cacheUri) Specifies location of cache configuration.
CacheSecurityAwareClientPropertiesBuilder	withClientId(String clientId) Specify the oauth client id for security credentials.
CacheSecurityAwareClientPropertiesBuilder	withClientSecret(String clientSecret) Specify the oauth client id for security credentials.
CacheSecurityAwareClientPropertiesBuilder	withClientTimeout(Integer timeout) Specify a timeout period for the client (in milliseconds).
CacheSecurityAwareClientPropertiesBuilder	withProxyHostName(String proxyHostName) If a proxy is used to access the OData web service this specifies it's host name / ip address.
CacheSecurityAwareClientPropertiesBuilder	withProxyPort(Integer proxyPortNumber) If a proxy is used to access the OData web service this specifies it's port number.
CacheSecurityAwareClientPropertiesBuilder	withServiceUri(String serviceUri) Specify the OData web service URI, e.g.

Methods inherited from class com.sdl.odata.client.ClientPropertiesBuilder

build

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheSecurityAwareClientPropertiesBuilder

public CacheSecurityAwareClientPropertiesBuilder()

CacheSecurityAwareClientPropertiesBuilder

public CacheSecurityAwareClientPropertiesBuilder(Map<String,String> configValues)

Method Detail

withCaching

public CacheSecurityAwareClientPropertiesBuilder withCaching(boolean cacheEnabled)

Specifies whether client caching is enabled (or not).

Parameters:

cacheEnabled - if true caching is enabled

Returns:

the properties builder

withCachingUri

public CacheSecurityAwareClientPropertiesBuilder withCachingUri(String cacheUri)

Specifies location of cache configuration.

Parameters:

cacheUri - path to cache configuration.

Returns:

the properties builder

withCacheExpirationDuration

public CacheSecurityAwareClientPropertiesBuilder withCacheExpirationDuration(Long cacheExpirationTime)

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

Parameters:

cacheExpirationTime - the cache expiration time (in seconds).

Returns:

the properties builder

withClientId

public CacheSecurityAwareClientPropertiesBuilder withClientId(String clientId)

Specify the oauth client id for security credentials.

Parameters:

clientId - client id

Returns:

the properties builder

withClientSecret

public CacheSecurityAwareClientPropertiesBuilder withClientSecret(String clientSecret)

Specify the oauth client id for security credentials.

Parameters:

clientSecret - clientSecret

Returns:

the properties builder

withServiceUri

public CacheSecurityAwareClientPropertiesBuilder withServiceUri(String serviceUri)

Specify the OData web service URI, e.g. ""http://www.example.com/odata.svc"

Overrides:

withServiceUri in class com.sdl.odata.client.ClientPropertiesBuilder

Parameters:

serviceUri - the OData web service URI

Returns:

the properties builder

withClientTimeout

public CacheSecurityAwareClientPropertiesBuilder withClientTimeout(Integer timeout)

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

Overrides:

withClientTimeout in class com.sdl.odata.client.ClientPropertiesBuilder

Parameters:

timeout - the client timeout period (in milliseconds)

Returns:

the properties builder

withProxyHostName

public CacheSecurityAwareClientPropertiesBuilder withProxyHostName(String proxyHostName)

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

Overrides:

withProxyHostName in class com.sdl.odata.client.ClientPropertiesBuilder

Parameters:

proxyHostName - the proxy port number

Returns:

the properties builder

withProxyPort

public CacheSecurityAwareClientPropertiesBuilder withProxyPort(Integer proxyPortNumber)

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

Overrides:

withProxyPort in class com.sdl.odata.client.ClientPropertiesBuilder

Parameters:

proxyPortNumber - the proxy port number

Returns:

the properties builder