Package lumis.doui.service.api.rest.internal

Class RestInterfaceCacheConfig

java.lang.Object

lumis.doui.service.api.rest.internal.RestInterfaceCacheConfig

public class RestInterfaceCacheConfig
extends Object

REST interface cache configuration.

Since:

10.4.0

Version:

$Revision: 23035 $ $Date: 2019-08-05 16:55:10 -0300 (Mon, 05 Aug 2019) $

Constructor Summary

Constructors

Constructor	Description
RestInterfaceCacheConfig(Boolean cacheEnabled, Integer cacheExpiration, Set<String> businessContextKeys, Boolean inheritAllFields)	Creates a new REST interface cache configuration.

Method Summary

Modifier and Type	Method	Description
Set<String>	getBusinessContextKeys()	Returns the business context keys that will contribute to the REST interface cache key generation.
Boolean	getCacheEnabled()	Returns the cache enabled flag (if any).
Integer	getCacheExpiration()	Returns the cache expiration timeout in seconds (if any).
Boolean	getInheritAllFields()	Returns the inheritAllFields that indicates if should returns all fields in REST interface request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestInterfaceCacheConfig

public RestInterfaceCacheConfig(Boolean cacheEnabled,
                                Integer cacheExpiration,
                                Set<String> businessContextKeys,
                                Boolean inheritAllFields)

Creates a new REST interface cache configuration.

Parameters:

cacheEnabled - Indicates whether caching will be enabled for the REST interface. A null value means the standard behavior.

cacheExpiration - The cache expiration time in seconds. A null value means the standard behavior.

businessContextKeys - The business context keys that will contribute to the cache key.

inheritAllFields - Indicates if should returns all fields in REST interface request. Null is default value.

Since:

12.0.0

Method Detail

getBusinessContextKeys

public Set<String> getBusinessContextKeys()

Returns the business context keys that will contribute to the REST interface cache key generation.

Returns:

the business context keys that will contribute to the REST interface cache key generation.

Since:

10.4.0

getCacheEnabled

public Boolean getCacheEnabled()

Returns the cache enabled flag (if any).

Returns:

the cache enabled flag (if any).

Since:

10.4.0

getCacheExpiration

public Integer getCacheExpiration()

Returns the cache expiration timeout in seconds (if any).

Returns:

the cache expiration timeout in seconds (if any).

Since:

10.4.0

getInheritAllFields

public Boolean getInheritAllFields()

Returns the inheritAllFields that indicates if should returns all fields in REST interface request. Null is default value.

Returns:

the inheritAllFields that indicates if should returns all fields in REST interface request. Null is default value.

Since:

12.0.0