java.lang.Object
- com.sodius.oslc.server.trs.store.AbstractTrsStore

All Implemented Interfaces:

ResourceEventStore, Store, TrsStore

Direct Known Subclasses:

FileTrsStore
```
public abstract class AbstractTrsStore
extends Object
implements TrsStore
```
Partial implementation of a TrsStore fulfilling the contract of ResourceEventStore.

Since:

3.3.0

Field Summary

Fields
Modifier and Type	Field	Description
`protected static int`	`BASE_BUFFER_SIZE`	Proven buffer size for base members consumption with good performance for memory and db storage.
`protected static int`	`EVENTS_BUFFER_SIZE`	Proven buffer size for resource events consumption with good performance for memory and db storage.

Constructor Summary

Constructors
Constructor Description

AbstractTrsStore()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`deleteResources(Function<Consumer<ResourceSeed>,?> seedsProvider)`	Stores deletion events for the given `resource seeds`.
`void`	`deleteResourcesOf(String projectId)`	Creates `ResourceEvent.Type.DELETED` events for all exposed resources of the given project in the store.
`boolean`	`isStoringEventsOf(Optional<String> projectAreaId)`	Determines whether the store is currently able to store events and, optionally, for a particular project.
`void`	`store(ResourceEvent... resourceEvents)`	Stores one or a few `resource events`.
`void`	`store(Function<Consumer<ResourceEvent>,?> eventsProvider)`	Stores `resource events`.
`protected abstract void`	`store(Function<Consumer<ResourceEvent>,?> eventsProvider, int bufferSize, boolean assertStoring)`	Stores the provided events using a `BufferedConsumer` of the given size and indicating whether to call the `isStoringEventsOf(Optional)` method or not.

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

Methods inherited from interface com.sodius.oslc.server.trs.store.Store
corrupt, isCorrupted

Methods inherited from interface com.sodius.oslc.server.trs.store.TrsStore
addBaseMembers, collectBaseMembers, collectChangeEventSeeds, countChangeEventSeeds, createSynchronizer, getControl, getFirstChangeEventSince, isResourceExposed, pollChangeEventSeeds, pushChangeEventSeeds, removeBaseMembers, removeChangeEventSeedsBefore, restore, saveControl, synchronizeResourceEvents

- Field Detail
  - BASE_BUFFER_SIZE
```
protected static final int BASE_BUFFER_SIZE
```
    Proven buffer size for base members consumption with good performance for memory and db storage.
    
    See Also:
    
    Constant Field Values
  - EVENTS_BUFFER_SIZE
```
protected static final int EVENTS_BUFFER_SIZE
```
    Proven buffer size for resource events consumption with good performance for memory and db storage.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractTrsStore
```
public AbstractTrsStore()
```
- Method Detail
  - isStoringEventsOf
```
public boolean isStoringEventsOf(Optional<String> projectAreaId)
```
    Description copied from interface: ResourceEventStore
    
    Determines whether the store is currently able to store events and, optionally, for a particular project.
    This method must not raise any exception, false must be returned silently if any of them occurred while computing the result.
    Implementations should use a temporary cache for keeping results for a very brief moment (at most 1s) in order to optimize performance. The intention is just to avoid multiple computations of the result during a single storage request, where it's very likely all events belong to the same project.
    
    Specified by:
    
    isStoringEventsOf in interface ResourceEventStore
    
    Parameters:
    
    projectAreaId - the optional project identifier.
    
    Returns:
    
    true if the given project is TRS exposed, the TRS store is not corrupted and the corresponding base is computed; false otherwise.
  - store
```
public void store(ResourceEvent... resourceEvents)
```
    Description copied from interface: ResourceEventStore
    
    Stores one or a few resource events. If a larger volume of events is to send at once, client is recommended to rather use the ResourceEventStore.store(Function) method.
    Implementations MUST store events, without blocking the application, only if the ResourceEventStore.isStoringEventsOf(Optional) method returns true, for each of the given event seeds, and must keep them hidden from the TRS feed up to the TrsStore.synchronizeResourceEvents(int) method is called.
    This method is intended to avoid raising TrsStoreException, if something went wrong preventing the storage of the event, implementations must corrupt the storage silently.
    
    Specified by:
    
    store in interface ResourceEventStore
    
    Parameters:
    
    resourceEvents - events to store.
  - store
```
public void store(Function<Consumer<ResourceEvent>,?> eventsProvider)
```
    Description copied from interface: ResourceEventStore
    
    Stores resource events. If only one or a few events are to report at once, client may use the simpler ResourceEventStore.store(ResourceEvent...) method.
    Implementations MUST store events, without blocking the application, only if the ResourceEventStore.isStoringEventsOf(Optional) method returns true, for each of the given event seeds, and must keep them hidden from the TRS feed up to the TrsStore.synchronizeResourceEvents(int) method is called.
    This method is intended to avoid raising TrsStoreException, if something went wrong preventing the storage of the event, implementations must corrupt the storage silently.
    The function argument provides access to change events to be added in this store. Implementation must call the apply() method of this function and use, as argument, a Consumer to get notified of events. Implementation is advised to use a BufferedConsumer for optimal performance.
    
    Specified by:
    
    store in interface ResourceEventStore
    
    Parameters:
    
    eventsProvider - a function that provides access to change events to become part of the trs:ChangeLog.
    
    See Also:
    
    BufferedConsumer, ResourceEventStore.store(ResourceEvent...)
  - deleteResourcesOf
```
public void deleteResourcesOf(String projectId)
```
    Description copied from interface: ResourceEventStore
    
    Creates ResourceEvent.Type.DELETED events for all exposed resources of the given project in the store.
    This method is convenient to un-expose all resources of a deleted project in the hosting application.
    Implementations MUST store events, without blocking the application, only if the ResourceEventStore.isStoringEventsOf(Optional) method returns true for the given project (at the beginning of the process) and MUST avoid calling it again for each individual resource event seed because the project could not be longer accessible, and therefore, the isStoringEventsOf(Optional) method could return false for some events. If implementations decide to do not call the isStoringEventsOf(Optional) method at all, because the project could not be longer accessible from the beginning, they MUST ensure that: the store is not corrupted, the base is computed and there is a TRS functional user configured before saving events. The events MUST keep hidden from the TRS feed up to the TrsStore.synchronizeResourceEvents(int) method is called.
    This method is intended to avoid raising TrsStoreException, if something went wrong preventing the storage of the event, implementations must corrupt the storage silently.
    
    Specified by:
    
    deleteResourcesOf in interface ResourceEventStore
    
    Parameters:
    
    projectId - the project identifier of the resources to un-expose.
  - deleteResources
```
public void deleteResources(Function<Consumer<ResourceSeed>,?> seedsProvider)
                     throws TrsStoreException
```
    Description copied from interface: TrsStore
    
    Stores deletion events for the given resource seeds.
    Implementations MUST store events without checking ResourceEventStore.isStoringEventsOf(Optional).
    The function argument provides access to resource seeds for which deletion events need to be added in this store. Implementation must call the apply() method of this function and use, as argument, a Consumer to get notified of seeds.
    
    Specified by:
    
    deleteResources in interface TrsStore
    
    Parameters:
    
    seedsProvider - a function that provides access to resource seeds to become part of the trs:ChangeLog.
    
    Throws:
    
    TrsStoreException - if a TRS store error occurs.
  - store
```
protected abstract void store(Function<Consumer<ResourceEvent>,?> eventsProvider,
                              int bufferSize,
                              boolean assertStoring)
```
    Stores the provided events using a BufferedConsumer of the given size and indicating whether to call the isStoringEventsOf(Optional) method or not.
    The function implementation must be thread-safe, as the store will call the Function.apply(Object) method in a dedicated thread, so that calls to this method are non blocking.
    This method is intended to avoid raising TrsStoreException, if something went wrong preventing the storage of the event, implementations must corrupt the storage silently.
    The function argument provides access to change events to be added in this store. Implementation must call the apply() method of this function and use as argument a Consumer to get notified of events. Implementation is advised to use a BufferedConsumer for optimal performance.
    
    Parameters:
    
    eventsProvider - the events provider.
    
    bufferSize - the size for the BufferedConsumer.
    
    assertStoring - whether or not to call the isStoringEventsOf(Optional) method for each event seed.

Class AbstractTrsStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.sodius.oslc.server.trs.store.Store

Methods inherited from interface com.sodius.oslc.server.trs.store.TrsStore

Field Detail

BASE_BUFFER_SIZE

EVENTS_BUFFER_SIZE

Constructor Detail

AbstractTrsStore

Method Detail

isStoringEventsOf

store

store

deleteResourcesOf

deleteResources

store