CacheClearExpiredRecordsTask (Hazelcast Root 4.0-BETA-1 API)

java.lang.Object
- com.hazelcast.internal.eviction.ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
- - com.hazelcast.cache.impl.eviction.CacheClearExpiredRecordsTask

All Implemented Interfaces:

Runnable
```
public class CacheClearExpiredRecordsTask
extends ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
```
Clears expired entries.
This task provides per partition expiration operation logic. Fires cleanup operations at most partition operation thread count or some factor of it in one round.
- "hazelcast.internal.cache.expiration.task.period.seconds": Interval, in seconds, at which the background expiration task is going to run. Default value is seconds.
- "hazelcast.internal.cache.expiration.cleanup.percentage": Scannable percentage of entries in a maps' partition in each round. Default percentage is %.
- "hazelcast.internal.cache.expiration.cleanup.operation.count": Number of scannable partitions in each round. No default value exists. Dynamically calculated against partition-count or partition-thread-count.
These parameters can be set node-wide or system-wide
Node-wide setting example:
```
           Config config = new Config();
           config.setProperty("hazelcast.internal.cache.expiration.cleanup.operation.count", "3");
           Hazelcast.newHazelcastInstance(config);
 
```
System-wide setting example:
```
        System.setProperty("hazelcast.internal.cache.expiration.cleanup.operation.count", "3");
 
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask
  ClearExpiredRecordsTask.ProcessablePartitionType

Field Summary

Fields
Modifier and Type Field and Description

static String PROP_CLEANUP_OPERATION_COUNT

static String PROP_CLEANUP_PERCENTAGE

static String PROP_TASK_PERIOD_SECONDS
- Fields inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask
  containers, nodeEngine, partitionService, toBackupSender

Fields
Modifier and Type	Field and Description
`static String`	`PROP_CLEANUP_OPERATION_COUNT`
`static String`	`PROP_CLEANUP_PERCENTAGE`
`static String`	`PROP_TASK_PERIOD_SECONDS`

Constructor Summary

Constructors
Constructor and Description

CacheClearExpiredRecordsTask(CachePartitionSegment[] containers, NodeEngine nodeEngine)

Constructors
Constructor and Description
`CacheClearExpiredRecordsTask(CachePartitionSegment[] containers, NodeEngine nodeEngine)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`equalizeBackupSizeWithPrimary(CachePartitionSegment container)`
`protected long`	`getLastCleanupTime(CachePartitionSegment container)`
`protected ClearExpiredRecordsTask.ProcessablePartitionType`	`getProcessablePartitionType()`
`protected boolean`	`hasExpiredKeyToSendBackup(CachePartitionSegment container)`
`protected boolean`	`hasRunningCleanup(CachePartitionSegment container)`
`protected boolean`	`isContainerEmpty(CachePartitionSegment container)`
`protected Operation`	`newBackupExpiryOp(ICacheRecordStore store, Collection<ExpiredKey> expiredKeys)`
`protected Operation`	`newPrimaryExpiryOp(int expirationPercentage, CachePartitionSegment container)`
`protected boolean`	`notHaveAnyExpirableRecord(CachePartitionSegment container)`
`protected void`	`setHasRunningCleanup(CachePartitionSegment container)`
`protected void`	`sortPartitionContainers(List<CachePartitionSegment> containers)`
`Iterator<ICacheRecordStore>`	`storeIterator(CachePartitionSegment container)`
`String`	`toString()`
`void`	`tryToSendBackupExpiryOp(ICacheRecordStore store, boolean sendIfAtBatchSize)`

Methods inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask
newBackupExpiryOpFilter, partitionLost, run, sendQueuedExpiredKeys

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

- Field Detail
  - PROP_CLEANUP_PERCENTAGE
```
public static final String PROP_CLEANUP_PERCENTAGE
```
    See Also:
    
    Constant Field Values
  - PROP_TASK_PERIOD_SECONDS
```
public static final String PROP_TASK_PERIOD_SECONDS
```
    See Also:
    
    Constant Field Values
  - PROP_CLEANUP_OPERATION_COUNT
```
public static final String PROP_CLEANUP_OPERATION_COUNT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CacheClearExpiredRecordsTask
```
public CacheClearExpiredRecordsTask(CachePartitionSegment[] containers,
                                    NodeEngine nodeEngine)
```
- Method Detail
  - tryToSendBackupExpiryOp
```
public void tryToSendBackupExpiryOp(ICacheRecordStore store,
                                    boolean sendIfAtBatchSize)
```
    Specified by:
    
    tryToSendBackupExpiryOp in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - storeIterator
```
public Iterator<ICacheRecordStore> storeIterator(CachePartitionSegment container)
```
    Specified by:
    
    storeIterator in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - newPrimaryExpiryOp
```
protected Operation newPrimaryExpiryOp(int expirationPercentage,
                                       CachePartitionSegment container)
```
    Specified by:
    
    newPrimaryExpiryOp in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - newBackupExpiryOp
```
protected Operation newBackupExpiryOp(ICacheRecordStore store,
                                      Collection<ExpiredKey> expiredKeys)
```
    Specified by:
    
    newBackupExpiryOp in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - equalizeBackupSizeWithPrimary
```
protected void equalizeBackupSizeWithPrimary(CachePartitionSegment container)
```
    Specified by:
    
    equalizeBackupSizeWithPrimary in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - hasExpiredKeyToSendBackup
```
protected boolean hasExpiredKeyToSendBackup(CachePartitionSegment container)
```
    Specified by:
    
    hasExpiredKeyToSendBackup in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - hasRunningCleanup
```
protected boolean hasRunningCleanup(CachePartitionSegment container)
```
    Specified by:
    
    hasRunningCleanup in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - setHasRunningCleanup
```
protected void setHasRunningCleanup(CachePartitionSegment container)
```
    Specified by:
    
    setHasRunningCleanup in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - isContainerEmpty
```
protected boolean isContainerEmpty(CachePartitionSegment container)
```
    Specified by:
    
    isContainerEmpty in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - notHaveAnyExpirableRecord
```
protected boolean notHaveAnyExpirableRecord(CachePartitionSegment container)
```
    Specified by:
    
    notHaveAnyExpirableRecord in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - getLastCleanupTime
```
protected long getLastCleanupTime(CachePartitionSegment container)
```
    Specified by:
    
    getLastCleanupTime in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - sortPartitionContainers
```
protected void sortPartitionContainers(List<CachePartitionSegment> containers)
```
    Specified by:
    
    sortPartitionContainers in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - getProcessablePartitionType
```
protected ClearExpiredRecordsTask.ProcessablePartitionType getProcessablePartitionType()
```
    Specified by:
    
    getProcessablePartitionType in class ClearExpiredRecordsTask<CachePartitionSegment,ICacheRecordStore>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CacheClearExpiredRecordsTask

Nested Class Summary

Nested classes/interfaces inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask

Field Summary

Fields inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask

Constructor Summary

Method Summary

Methods inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask

Methods inherited from class java.lang.Object

Field Detail

PROP_CLEANUP_PERCENTAGE

PROP_TASK_PERIOD_SECONDS

PROP_CLEANUP_OPERATION_COUNT

Constructor Detail

CacheClearExpiredRecordsTask

Method Detail

tryToSendBackupExpiryOp

storeIterator

newPrimaryExpiryOp

newBackupExpiryOp

equalizeBackupSizeWithPrimary

hasExpiredKeyToSendBackup

hasRunningCleanup

setHasRunningCleanup

isContainerEmpty

notHaveAnyExpirableRecord

getLastCleanupTime

sortPartitionContainers

getProcessablePartitionType

toString