org.apache.camel.impl

Class FileStateRepository

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.FileStateRepository

All Implemented Interfaces:

Service, ShutdownableService, StateRepository<String,String>, StatefulService, SuspendableService

@ManagedResource(description="File based state repository")
public class FileStateRepository
extends ServiceSupport
implements StateRepository<String,String>

This FileStateRepository class is a file-based implementation of a StateRepository.

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
FileStateRepository()
FileStateRepository(File fileStore, Map<String,String> cache)

Method Summary

Modifier and Type	Method and Description
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 FileStateRepository	fileStateRepository(File fileStore) Creates a new file based repository using as 1st level cache
static FileStateRepository	fileStateRepository(File fileStore, long maxFileStoreSize) Creates a new file based repository using a HashMap as 1st level cache.
static FileStateRepository	fileStateRepository(File store, Map<String,String> cache) Creates a new file based repository using the given Map as 1st level cache.
Map<String,String>	getCache()
String	getFilePath()
File	getFileStore()
long	getMaxFileStoreSize()
String	getState(String key) Gets the state value for the given key.
protected void	loadStore() Loads the given file store into the 1st level cache
void	reset() Resets and clears the store to force it to reload from file
void	setCache(Map<String,String> cache)
void	setFileStore(File fileStore)
void	setMaxFileStoreSize(long maxFileStoreSize) Sets the maximum file size for the file store in bytes.
void	setState(String key, String value) Sets the state value for the given key.
protected void	trunkStore() Trunks the file store when the max store size is hit by rewriting the 1st level cache to the file store.

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

FileStateRepository

public FileStateRepository()

FileStateRepository

public FileStateRepository(File fileStore,
                           Map<String,String> cache)

Method Detail

fileStateRepository

public static FileStateRepository fileStateRepository(File fileStore)

Creates a new file based repository using as 1st level cache

Parameters:

fileStore - the file store

fileStateRepository

public static FileStateRepository fileStateRepository(File fileStore,
                                                      long maxFileStoreSize)

Creates a new file based repository using a HashMap as 1st level cache.

Parameters:

fileStore - the file store

maxFileStoreSize - the max size in bytes for the fileStore file

fileStateRepository

public static FileStateRepository fileStateRepository(File store,
                                                      Map<String,String> 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

setState

@ManagedOperation(description="Adds the value of the given key to the store")
public void setState(String key,
                                                                                                   String value)

Description copied from interface: StateRepository

Sets the state value for the given key.

Specified by:

setState in interface StateRepository<String,String>

Parameters:

key - State key

value - State value

getState

@ManagedOperation(description="Gets the value of the given key from store")
public String getState(String key)

Description copied from interface: StateRepository

Gets the state value for the given key. It returns null if the key is unknown.

Specified by:

getState in interface StateRepository<String,String>

Parameters:

key - State key

Returns:

State value or null the key is unknown

reset

@ManagedOperation(description="Reset and reloads the file store")
public void reset()
                                                                             throws IOException

Resets and clears the store to force it to reload from file

Throws:

IOException

trunkStore

protected void trunkStore()

Trunks the file store when the max store size is hit by rewriting the 1st level cache to the file store.

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()

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,String> getCache()

setCache

public void setCache(Map<String,String> 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.

The default is 1mb.