com.hazelcast.ringbuffer.impl

Class RingbufferStoreWrapper

java.lang.Object

com.hazelcast.ringbuffer.impl.RingbufferStoreWrapper

All Implemented Interfaces:

RingbufferStore<Data>

public final class RingbufferStoreWrapper
extends Object
implements RingbufferStore<Data>

Wrapper for the ring buffer store. In charge of creation of a ring buffer store from configuration and enforcing rules defined by the ring buffer configuration (e.g. store format) before forwarding the calls to the underlying ring buffer store.

Method Summary

Modifier and Type	Method and Description
static RingbufferStoreWrapper	create(ObjectNamespace namespace, RingbufferStoreConfig storeConfig, InMemoryFormat inMemoryFormat, SerializationService serializationService, ClassLoader classLoader) Factory method that creates a RingbufferStoreWrapper.
long	getLargestSequence() Return the largest sequence seen by the data store.
boolean	isEnabled() Is the ring buffer store enabled.
Data	load(long sequence) Loads the value of a given sequence.
void	store(long sequence, Data value) Stores one item with it's corresponding sequence.
void	storeAll(long firstItemSequence, Data[] items) Stores multiple items.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RingbufferStoreWrapper create(ObjectNamespace namespace,
                                            RingbufferStoreConfig storeConfig,
                                            InMemoryFormat inMemoryFormat,
                                            SerializationService serializationService,
                                            ClassLoader classLoader)

Factory method that creates a RingbufferStoreWrapper. It attempts to create the ring buffer store from several sources :

• checks if the config contains the store implementation
• tries to create the store from the ring buffer store class
• tries to create one from the ring buffer store factory
• tries to instantiate the factory from the factory class and create the store from the factory

Parameters:

namespace - ring buffer namespace

storeConfig - store config of ring buffer

inMemoryFormat - the format of the stored items (BINARY, OBJECT or NATIVE). NATIVE format translates into binary values on the store method calls.

serializationService - serialization service.

Returns:

returns a new instance of RingbufferStoreWrapper

isEnabled

public boolean isEnabled()

Is the ring buffer store enabled.

Returns:

if the store is enabled

store

public void store(long sequence,
                  Data value)

Description copied from interface: RingbufferStore

Stores one item with it's corresponding sequence. Exceptions thrown by this method prevent Ringbuffer from adding the item. It is the responsibility of the store to ensure that it keeps consistent with the Ringbuffer and in case of an exception is thrown, the data is not in the store.

Specified by:

store in interface RingbufferStore<Data>

Parameters:

sequence - the sequence ID of the data

value - the value of the data to store

See Also:

Ringbuffer.add(Object), Ringbuffer.addAsync(Object, com.hazelcast.ringbuffer.OverflowPolicy)

storeAll

public void storeAll(long firstItemSequence,
                     Data[] items)

Description copied from interface: RingbufferStore

Stores multiple items. Implementation of this method can optimize the store operation. Exceptions thrown by this method prevents Ringbuffer from adding any of the items. It is the responsibility of the store to ensure that it keeps consistent with the Ringbuffer and in case of an exception is thrown the passed data is not in the store.

Specified by:

storeAll in interface RingbufferStore<Data>

Parameters:

firstItemSequence - the sequence of the first item

items - the items that are being stored

See Also:

Ringbuffer.addAllAsync(java.util.Collection, com.hazelcast.ringbuffer.OverflowPolicy)

load

public Data load(long sequence)

Description copied from interface: RingbufferStore

Loads the value of a given sequence. Null value means that the item was not found. This method is invoked by the ringbuffer if an item is requested with a sequence which is no longer in the Ringbuffer.

Specified by:

load in interface RingbufferStore<Data>

Parameters:

sequence - the sequence of the requested item

Returns:

requested item, null if not found

See Also:

Ringbuffer.readOne(long), Ringbuffer.readManyAsync(long, int, int, IFunction)

getLargestSequence

public long getLargestSequence()

Description copied from interface: RingbufferStore

Return the largest sequence seen by the data store. Can return -1 if the data store doesn't have or can't access any data. Used to initialize a Ringbuffer with the previously seen largest sequence number.

Specified by:

getLargestSequence in interface RingbufferStore<Data>

Returns:

the largest sequence of the data in the data store