net.openhft.chronicle.engine.map

Class FilePerKeyValueStore

java.lang.Object

net.openhft.chronicle.engine.map.FilePerKeyValueStore

All Implemented Interfaces:

Closeable, AutoCloseable, java.util.function.Consumer<EngineReplication.ReplicationEntry>, KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>, StringBytesStoreKeyValueStore, SubscriptionKeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>, Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>, View, AuthenticatedKeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

public class FilePerKeyValueStore
extends Object
implements StringBytesStoreKeyValueStore, Closeable

A Map implementation that stores each entry as a file in a directory. The key is the file fullName and the value is the contents of the file.

The class is effectively an abstraction over a directory in the file system. Therefore when the underlying files are changed an event will be fired to those registered for notifications.

Updates will be fired every time the file is saved but will be suppressed if the value has not changed. To avoid temporary files (e.g. if edited in vi) being included in the map, any file starting with a '.' will be ignored.

Note the WatchService is extremely OS dependant. Mas OSX registers very few events if they are done quickly and there is a significant delay between the event and the event being triggered.

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.engine.api.map.KeyValueStore

KeyValueStore.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FilePerKeyValueStore(RequestContext context, Asset asset)

Method Summary

Modifier and Type	Method and Description
void	accept(EngineReplication.ReplicationEntry replicationEntry)
Asset	asset()
void	clear()
void	close()
boolean	containsValue(net.openhft.chronicle.bytes.Bytes value)
void	entriesFor(int segment, SubscriptionConsumer<MapEvent<String,net.openhft.chronicle.bytes.BytesStore>> kvConsumer)
Iterator<Map.Entry<String,net.openhft.chronicle.bytes.BytesStore>>	entrySetIterator()
net.openhft.chronicle.bytes.BytesStore	getAndPut(String key, net.openhft.chronicle.bytes.BytesStore value)
net.openhft.chronicle.bytes.BytesStore	getAndRemove(String key)
java.util.stream.Stream<Map.Entry<String,net.openhft.chronicle.bytes.BytesStore>>	getEntryStream()
net.openhft.chronicle.bytes.BytesStore	getUsing(String key, net.openhft.chronicle.bytes.Bytes value)
Iterator<String>	keySetIterator()
void	keysFor(int segment, SubscriptionConsumer<String> stringConsumer)
long	longSize()
boolean	put(String key, net.openhft.chronicle.bytes.BytesStore value) put an entry
boolean	remove(String key) remove a key
RawKVSSubscription<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>	subscription(boolean createIfAbsent)
KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>	underlying()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.engine.api.map.KeyValueStore

containsKey, get, isKeyType, isReadOnly, keyedView, putIfAbsent, removeIfEqual, replace, replaceIfEqual, segmentFor, segments, valuesIterator

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

FilePerKeyValueStore

public FilePerKeyValueStore(@NotNull
                            RequestContext context,
                            @NotNull
                            Asset asset)
                     throws net.openhft.chronicle.bytes.IORuntimeException

Throws:

net.openhft.chronicle.bytes.IORuntimeException

Method Detail

subscription

@NotNull
public RawKVSSubscription<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore> subscription(boolean createIfAbsent)

Specified by:

subscription in interface SubscriptionKeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

longSize

public long longSize()

Specified by:

longSize in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

getUsing

@Nullable
public net.openhft.chronicle.bytes.BytesStore getUsing(String key,
                                                                 net.openhft.chronicle.bytes.Bytes value)

Specified by:

getUsing in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

keysFor

public void keysFor(int segment,
                    @NotNull
                    SubscriptionConsumer<String> stringConsumer)

Specified by:

keysFor in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

entriesFor

public void entriesFor(int segment,
                       @NotNull
                       SubscriptionConsumer<MapEvent<String,net.openhft.chronicle.bytes.BytesStore>> kvConsumer)
                throws InvalidSubscriberException

Specified by:

entriesFor in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

Throws:

InvalidSubscriberException

keySetIterator

public Iterator<String> keySetIterator()

Specified by:

keySetIterator in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

entrySetIterator

public Iterator<Map.Entry<String,net.openhft.chronicle.bytes.BytesStore>> entrySetIterator()

Specified by:

entrySetIterator in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

getEntryStream

public java.util.stream.Stream<Map.Entry<String,net.openhft.chronicle.bytes.BytesStore>> getEntryStream()

put

public boolean put(String key,
                   @NotNull
                   net.openhft.chronicle.bytes.BytesStore value)

Description copied from interface: KeyValueStore

put an entry

Specified by:

put in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

Parameters:

key - to set

value - to set

Returns:

true if it was replaced, false if it was added.

getAndPut

@Nullable
public net.openhft.chronicle.bytes.BytesStore getAndPut(String key,
                                                                  @NotNull
                                                                  net.openhft.chronicle.bytes.BytesStore value)

Specified by:

getAndPut in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

getAndRemove

@Nullable
public net.openhft.chronicle.bytes.BytesStore getAndRemove(String key)

Specified by:

getAndRemove in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

remove

public boolean remove(String key)

Description copied from interface: KeyValueStore

remove a key

Specified by:

remove in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

Parameters:

key - to remove

Returns:

true if it was removed, false if not.

clear

public void clear()

Specified by:

clear in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

containsValue

public boolean containsValue(net.openhft.chronicle.bytes.Bytes value)

Specified by:

containsValue in interface KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

asset

public Asset asset()

Specified by:

asset in interface Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>

underlying

@Nullable
public KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore> underlying()

Specified by:

underlying in interface Assetted<KeyValueStore<String,net.openhft.chronicle.bytes.Bytes,net.openhft.chronicle.bytes.BytesStore>>

accept

public void accept(EngineReplication.ReplicationEntry replicationEntry)

Specified by:

accept in interface java.util.function.Consumer<EngineReplication.ReplicationEntry>