DefaultHalResourceCache (Camunda Platform Javadocs 7.16.18-ee)

java.lang.Object
- org.camunda.bpm.engine.rest.hal.cache.DefaultHalResourceCache

All Implemented Interfaces:: Cache

public class DefaultHalResourceCache
extends java.lang.Object
implements Cache

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.util.Map<java.lang.String,HalResourceCacheEntry>`	`cache`
`protected int`	`capacity`
`static java.util.Comparator<HalResourceCacheEntry>`	`COMPARATOR`
`protected long`	`secondsToLive`

Constructor Summary

Constructors
Constructor Description

DefaultHalResourceCache()

DefaultHalResourceCache(int capacity, long secondsToLive)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`destroy()`	Destroy cache.
`protected void`	`ensureCapacityLimit()`
`protected boolean`	`expired(HalResourceCacheEntry entry)`
`java.lang.Object`	`get(java.lang.String id)`	Get a resource by id.
`int`	`getCapacity()`
`long`	`getSecondsToLive()`
`void`	`put(java.lang.String id, java.lang.Object resource)`	Put a resource into the cache.
`void`	`remove(java.lang.String id)`
`void`	`setCapacity(int capacity)`
`void`	`setSecondsToLive(long secondsToLive)`
`int`	`size()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPARATOR

public static final java.util.Comparator<HalResourceCacheEntry> COMPARATOR

capacity
```
protected int capacity
```

secondsToLive
```
protected long secondsToLive
```

cache

protected java.util.Map<java.lang.String,HalResourceCacheEntry> cache

Constructor Detail

DefaultHalResourceCache
```
public DefaultHalResourceCache()
```

DefaultHalResourceCache

public DefaultHalResourceCache(int capacity,
                               long secondsToLive)

Method Detail
- getCapacity
```
public int getCapacity()
```
- setCapacity
```
public void setCapacity(int capacity)
```
- getSecondsToLive
```
public long getSecondsToLive()
```
- setSecondsToLive
```
public void setSecondsToLive(long secondsToLive)
```
- size
```
public int size()
```
- put
```
public void put(java.lang.String id,
                java.lang.Object resource)
```
  Description copied from interface: Cache
  
  Put a resource into the cache.
  
  Specified by:
  
  put in interface Cache
  
  Parameters:
  
  id - the id of the resource
  
  resource - the resource to cache
- remove
```
public void remove(java.lang.String id)
```
- get
```
public java.lang.Object get(java.lang.String id)
```
  Description copied from interface: Cache
  
  Get a resource by id.
  
  Specified by:
  
  get in interface Cache
  
  Parameters:
  
  id - the id of the resource
  
  Returns:
  
  the resource or null if non is found or the resource time to live expired
- destroy
```
public void destroy()
```
  Description copied from interface: Cache
  
  Destroy cache.
  
  Specified by:
  
  destroy in interface Cache
- ensureCapacityLimit
```
protected void ensureCapacityLimit()
```
- expired
```
protected boolean expired(HalResourceCacheEntry entry)
```