FileIdempotentRepository (Camel

java.lang.Object
- org.apache.camel.support.ServiceSupport
- - org.apache.camel.processor.idempotent.FileIdempotentRepository

All Implemented Interfaces:

Service, ShutdownableService, IdempotentRepository<String>, StatefulService, SuspendableService
```
@ManagedResource(description="File based idempotent repository")
public class FileIdempotentRepository
extends ServiceSupport
implements IdempotentRepository<String>
```
A file based implementation of IdempotentRepository.
This implementation provides a 1st-level in-memory LRUCache for fast check of the most frequently used keys. When add(String) or contains(String) methods are being used then in case of 1st-level cache miss, the underlying file is scanned which may cost additional performance. So try to find the right balance of the size of the 1st-level cache, the default size is 1000. The file store has a maximum capacity of 32mb by default (you can turn this off and have unlimited size). If the file store grows bigger than the maximum capacity, then the getDropOldestFileStore() (is default 1000) number of entries from the file store is dropped to reduce the file store and make room for newer entries.

Version:

Field Summary
- Fields inherited from class org.apache.camel.support.ServiceSupport
  shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors
Constructor and Description

FileIdempotentRepository()

FileIdempotentRepository(File fileStore, Map<String,Object> set)

Constructors
Constructor and Description
`FileIdempotentRepository()`
`FileIdempotentRepository(File fileStore, Map<String,Object> set)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(String key)` Adds the key to the repository.
`protected void`	`appendToStore(String key)` Appends the given key to the file store
`protected void`	`cleanup()` Cleanup the 1st-level cache.
`void`	`clear()` Clear the repository.
`protected void`	`clearStore()` Clears the file-store (danger this deletes all entries)
`boolean`	`confirm(String key)` Confirms the key, after the exchange has been processed successfully.
`boolean`	`contains(String key)` Returns `true` if this repository contains the specified element.
`protected boolean`	`containsStore(String key)` Checks the file store if the key exists
`protected void`	`doStart()` Implementations override this method to support customized start/stop.
`protected void`	`doStop()` Implementations override this method to support customized start/stop.
`static IdempotentRepository<String>`	`fileIdempotentRepository(File fileStore)` Creates a new file based repository using a `LRUCache` as 1st level cache with a default of 1000 entries in the cache.
`static IdempotentRepository<String>`	`fileIdempotentRepository(File fileStore, int cacheSize)` Creates a new file based repository using a `LRUCache` as 1st level cache.
`static IdempotentRepository<String>`	`fileIdempotentRepository(File fileStore, int cacheSize, long maxFileStoreSize)` Creates a new file based repository using a `LRUCache` as 1st level cache.
`static IdempotentRepository<String>`	`fileIdempotentRepository(File store, Map<String,Object> cache)` Creates a new file based repository using the given `Map` as 1st level cache.
`Map<String,Object>`	`getCache()`
`int`	`getCacheSize()`
`long`	`getDropOldestFileStore()`
`String`	`getFilePath()`
`File`	`getFileStore()`
`long`	`getMaxFileStoreSize()`
`protected void`	`loadStore()` Loads the given file store into the 1st level cache
`boolean`	`remove(String key)` Removes the key from the repository.
`protected void`	`removeFromStore(String key)`
`void`	`reset()` Reset and clears the 1st-level cache to force it to reload from file
`void`	`setCache(Map<String,Object> cache)`
`void`	`setCacheSize(int size)` Sets the 1st-level cache size.
`void`	`setDropOldestFileStore(long dropOldestFileStore)` Sets the number of oldest entries to drop from the file store when the maximum capacity is hit to reduce disk space to allow room for new entries.
`void`	`setFileStore(File fileStore)`
`void`	`setMaxFileStoreSize(long maxFileStoreSize)` Sets the maximum file size for the file store in bytes.
`protected void`	`trunkStore()` Trunks the file store when the max store size is hit by dropping the most oldest entries.

Methods inherited from class org.apache.camel.support.ServiceSupport
doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

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

Methods inherited from interface org.apache.camel.Service
start, stop

- Constructor Detail
  - FileIdempotentRepository
```
public FileIdempotentRepository()
```
  - FileIdempotentRepository
```
public FileIdempotentRepository(File fileStore,
                                Map<String,Object> set)
```
- Method Detail
  - fileIdempotentRepository
```
public static IdempotentRepository<String> fileIdempotentRepository(File fileStore)
```
    Creates a new file based repository using a LRUCache as 1st level cache with a default of 1000 entries in the cache.
    
    Parameters:
    
    fileStore - the file store
  - fileIdempotentRepository
```
public static IdempotentRepository<String> fileIdempotentRepository(File fileStore,
                                                                    int cacheSize)
```
    Creates a new file based repository using a LRUCache as 1st level cache.
    
    Parameters:
    
    fileStore - the file store
    
    cacheSize - the cache size
  - fileIdempotentRepository
```
public static IdempotentRepository<String> fileIdempotentRepository(File fileStore,
                                                                    int cacheSize,
                                                                    long maxFileStoreSize)
```
    Creates a new file based repository using a LRUCache as 1st level cache.
    
    Parameters:
    
    fileStore - the file store
    
    cacheSize - the cache size
    
    maxFileStoreSize - the max size in bytes for the filestore file
  - fileIdempotentRepository
```
public static IdempotentRepository<String> fileIdempotentRepository(File store,
                                                                    Map<String,Object> cache)
```
    Creates a new file based repository using the given Map as 1st level cache.
    Care should be taken to use a suitable underlying Map to avoid this class being a memory leak.
    
    Parameters:
    
    store - the file store
    
    cache - the cache to use as 1st level cache
  - add
```
@ManagedOperation(description="Adds the key to the store")
public boolean add(String key)
```
    Description copied from interface: IdempotentRepository
    
    Adds the key to the repository.
    Important: Read the class javadoc about eager vs non-eager mode.
    
    Specified by:
    
    add in interface IdempotentRepository<String>
    
    Parameters:
    
    key - the key of the message for duplicate test
    
    Returns:
    
    true if this repository did not already contain the specified element
  - contains
```
@ManagedOperation(description="Does the store contain the given key")
public boolean contains(String key)
```
    Description copied from interface: IdempotentRepository
    
    Returns true if this repository contains the specified element.
    Important: Read the class javadoc about eager vs non-eager mode.
    
    Specified by:
    
    contains in interface IdempotentRepository<String>
    
    Parameters:
    
    key - the key of the message
    
    Returns:
    
    true if this repository contains the specified element
  - remove
```
@ManagedOperation(description="Remove the key from the store")
public boolean remove(String key)
```
    Description copied from interface: IdempotentRepository
    
    Removes the key from the repository.
    Is usually invoked if the exchange failed.
    Important: Read the class javadoc about eager vs non-eager mode.
    
    Specified by:
    
    remove in interface IdempotentRepository<String>
    
    Parameters:
    
    key - the key of the message for duplicate test
    
    Returns:
    
    true if the key was removed
  - confirm
```
public boolean confirm(String key)
```
    Description copied from interface: IdempotentRepository
    
    Confirms the key, after the exchange has been processed successfully.
    Important: Read the class javadoc about eager vs non-eager mode.
    
    Specified by:
    
    confirm in interface IdempotentRepository<String>
    
    Parameters:
    
    key - the key of the message for duplicate test
    
    Returns:
    
    true if the key was confirmed
  - clear
```
@ManagedOperation(description="Clear the store (danger this removes all entries)")
public void clear()
```
    Description copied from interface: IdempotentRepository
    
    Clear the repository.
    Important: Read the class javadoc about eager vs non-eager mode.
    
    Specified by:
    
    clear in interface IdempotentRepository<String>
  - getFileStore
```
public File getFileStore()
```
  - setFileStore
```
public void setFileStore(File fileStore)
```
  - getFilePath
```
@ManagedAttribute(description="The file path for the store")
public String getFilePath()
```
  - getCache
```
public Map<String,Object> getCache()
```
  - setCache
```
public void setCache(Map<String,Object> cache)
```
  - getMaxFileStoreSize
```
@ManagedAttribute(description="The maximum file size for the file store in bytes")
public long getMaxFileStoreSize()
```
  - setMaxFileStoreSize
```
@ManagedAttribute(description="The maximum file size for the file store in bytes")
public void setMaxFileStoreSize(long maxFileStoreSize)
```
    Sets the maximum file size for the file store in bytes. You can set the value to 0 or negative to turn this off, and have unlimited file store size.
    The default is 32mb.
  - getDropOldestFileStore
```
public long getDropOldestFileStore()
```
  - setDropOldestFileStore
```
@ManagedAttribute(description="Number of oldest elements to drop from file store if maximum file size reached")
public void setDropOldestFileStore(long dropOldestFileStore)
```
    Sets the number of oldest entries to drop from the file store when the maximum capacity is hit to reduce disk space to allow room for new entries.
    The default is 1000.
  - setCacheSize
```
public void setCacheSize(int size)
```
    Sets the 1st-level cache size. Setting cache size is only possible when using the default LRUCache cache implementation.
  - getCacheSize
```
@ManagedAttribute(description="The current 1st-level cache size")
public int getCacheSize()
```
  - reset
```
@ManagedOperation(description="Reset and reloads the file store")
public void reset()
                                                                             throws IOException
```
    Reset and clears the 1st-level cache to force it to reload from file
    
    Throws:
    
    IOException
  - containsStore
```
protected boolean containsStore(String key)
```
    Checks the file store if the key exists
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if exists in the file, false otherwise
  - appendToStore
```
protected void appendToStore(String key)
```
    Appends the given key to the file store
    
    Parameters:
    
    key - the key
  - removeFromStore
```
protected void removeFromStore(String key)
```
  - clearStore
```
protected void clearStore()
```
    Clears the file-store (danger this deletes all entries)
  - trunkStore
```
protected void trunkStore()
```
    Trunks the file store when the max store size is hit by dropping the most oldest entries.
  - cleanup
```
protected void cleanup()
```
    Cleanup the 1st-level cache.
  - loadStore
```
protected void loadStore()
                  throws IOException
```
    Loads the given file store into the 1st level cache
    
    Throws:
    
    IOException
  - doStart
```
protected void doStart()
                throws Exception
```
    Description copied from class: ServiceSupport
    
    Implementations override this method to support customized start/stop.
    Important: See ServiceSupport.doStop() for more details.
    
    Specified by:
    
    doStart in class ServiceSupport
    
    Throws:
    
    Exception
    
    See Also:
    
    ServiceSupport.doStop()
  - doStop
```
protected void doStop()
               throws Exception
```
    Description copied from class: ServiceSupport
    
    Implementations override this method to support customized start/stop.
    Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.
    
    Specified by:
    
    doStop in class ServiceSupport
    
    Throws:
    
    Exception
    
    See Also:
    
    ServiceSupport.doStart()

Class FileIdempotentRepository

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

Constructor Summary

Method Summary

Methods inherited from class org.apache.camel.support.ServiceSupport

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.camel.Service

Constructor Detail

FileIdempotentRepository

FileIdempotentRepository

Method Detail

fileIdempotentRepository

fileIdempotentRepository

fileIdempotentRepository

fileIdempotentRepository

add

contains

remove

confirm

clear

getFileStore

setFileStore

getFilePath

getCache

setCache

getMaxFileStoreSize

setMaxFileStoreSize

getDropOldestFileStore

setDropOldestFileStore

setCacheSize

getCacheSize

reset

containsStore

appendToStore

removeFromStore

clearStore

trunkStore

cleanup

loadStore

doStart

doStop