Database (cloudproof_java 3.0.0 API)

java.lang.Object
- com.cosmian.jna.findex.Database

public abstract class Database
extends Object

Constructor Summary

Constructors
Constructor and Description

Database()

Constructors
Constructor and Description
`Database()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract Set<Uid32>`	`fetchAllEntryTableUids()` Fetch all Uids of the Entry Table
`FindexNativeWrapper.FetchAllEntryTableUidsCallback`	`fetchAllEntryTableUidsCallback()`
`FindexNativeWrapper.FetchChainCallback`	`fetchChainCallback()`
`protected abstract Map<Uid32,ChainTableValue>`	`fetchChains(List<Uid32> uids)` Fetch the Chain Table lines for the list of given `Uid32`.
`protected abstract Map<Uid32,EntryTableValue>`	`fetchEntries(List<Uid32> uids)` Fetch the Entry Table lines for the list of given `Uid32`.
`FindexNativeWrapper.FetchEntryCallback`	`fetchEntryCallback()`
`protected abstract List<Location>`	`listRemovedLocations(List<Location> locations)` Determine which of the passed `Location` no longer exist in the main database/storage and return them.
`FindexNativeWrapper.ListRemovedLocationsCallback`	`listRemoveLocationsCallback()`
`FindexNativeWrapper.ProgressCallback`	`progressCallback()`
`protected abstract boolean`	`searchProgress(List<IndexedValue> indexedValues)` The Findex search mechanism will call this method as the search for keywords progresses through the search graph.
`FindexNativeWrapper.UpdateLinesCallback`	`updateLinesCallback()`
`protected abstract void`	`updateTables(List<Uid32> removedChains, Map<Uid32,EntryTableValue> newEntries, Map<Uid32,ChainTableValue> newChains)` Update the database tables with the new values.
`FindexNativeWrapper.UpsertChainCallback`	`upsertChainCallback()`
`protected abstract void`	`upsertChains(Map<Uid32,ChainTableValue> uidsAndValues)` Upsert the given lines into the Chain Table *
`protected abstract Map<Uid32,EntryTableValue>`	`upsertEntries(Map<Uid32,EntryTableValues> uidsAndValues)` Upsert the given lines into the Entry Table.
`FindexNativeWrapper.UpsertEntryCallback`	`upsertEntryCallback()`

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

- Constructor Detail
  - Database
```
public Database()
```
- Method Detail
  - fetchAllEntryTableUids
```
protected abstract Set<Uid32> fetchAllEntryTableUids()
                                              throws CloudproofException
```
    Fetch all Uids of the Entry Table
    Implementation of this method is only required to compact the index
    
    Returns:
    
    the Set of all Uid32
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - fetchEntries
```
protected abstract Map<Uid32,EntryTableValue> fetchEntries(List<Uid32> uids)
                                                    throws CloudproofException
```
    Fetch the Entry Table lines for the list of given Uid32. If a line does not exist, there should be not entry in the returned map.
    Implementation of this method is always required (to search, update or compact the index)
    
    Parameters:
    
    uids - the unique Uid32s used as line id
    
    Returns:
    
    a Map of Uid32 to EntryTableValue
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - fetchChains
```
protected abstract Map<Uid32,ChainTableValue> fetchChains(List<Uid32> uids)
                                                   throws CloudproofException
```
    Fetch the Chain Table lines for the list of given Uid32. If a line does not exist, there should be not entry in the returned map.
    Implementation of this method is only required to search or compact the index
    
    Parameters:
    
    uids - the unique Uid32s used as line id
    
    Returns:
    
    a Map of Uid32 to ChainTableValue
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - upsertEntries
```
protected abstract Map<Uid32,EntryTableValue> upsertEntries(Map<Uid32,EntryTableValues> uidsAndValues)
                                                     throws CloudproofException
```
    Upsert the given lines into the Entry Table.
    The EntryTableValues structure contains both the new value to be upserted and the previous value known at the time of fetch. To avoid concurrency issues, the new value of an existing Uid32 must not be updated if the current value in the database does not match the previous value of the structure. In such a case, the Uid32 and the current database value must be returned as part of the returned Map. *
    Implementation of this method is only required to update or compact the index
    See the Redis and Sqlite implementations for implementation examples
    
    Parameters:
    
    uidsAndValues - a Map of Uid32 to EntryTableValues
    
    Returns:
    
    a map of the Uid32 that could not be updated and the current database value for the entry.
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - upsertChains
```
protected abstract void upsertChains(Map<Uid32,ChainTableValue> uidsAndValues)
                              throws CloudproofException
```
    Upsert the given lines into the Chain Table *
    Implementation of this method is only required to update or compact the index
    
    Parameters:
    
    uidsAndValues - a Map of Uid32 to ChainTableValue
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - updateTables
```
protected abstract void updateTables(List<Uid32> removedChains,
                                     Map<Uid32,EntryTableValue> newEntries,
                                     Map<Uid32,ChainTableValue> newChains)
                              throws CloudproofException
```
    Update the database tables with the new values. This function should:
    - remove all the Index Entry Table
    - add _new_encrypted_entry_table_items_ to the Index Entry Table
    - remove _removed_chain_table_uids_ from the Index Chain Table
    - add _new_encrypted_chain_table_items_ to the Index Chain Table
    The order of these operations is not important but have some implications:
    Option 1
    Keep the database small but prevent using the index during the _update_lines_.
    - remove all the Index Entry Table
    - add _new_encrypted_entry_table_items_ to the Index Entry Table
    - remove _removed_chain_table_uids_ from the Index Chain Table
    - add _new_encrypted_chain_table_items_ to the Index Chain Table
    Option 2
    During a small duration, the index tables are much bigger but users can continue using the index during the _update_lines`.
    - save all UIDs from the current Index Entry Table
    - add _new_encrypted_entry_table_items_ to the Index Entry Table
    - add _new_encrypted_chain_table_items_ to the Index Chain Table
    - publish new label to users
    - remove old lines from the Index Entry Table (using the saved UIDs in 1.)
    - remove _removed_chain_table_uids_ from the Index Chain Table
    *
    Implementation of this method is only required to compact the index
    Parameters:
    
    removedChains - a list of lines to remove from the Chain Table
    
    newEntries - a list of lines to add to the Entry Table (after it has been dropped)
    
    newChains - a list of lines to add to the Chain Table
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - listRemovedLocations
```
protected abstract List<Location> listRemovedLocations(List<Location> locations)
                                                throws CloudproofException
```
    Determine which of the passed Location no longer exist in the main database/storage and return them. *
    Implementation of this method is only required to compact the index
    
    Parameters:
    
    locations - the list to check for existence
    
    Returns:
    
    the list of locations that no longer exist in the main database/storage
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - searchProgress
```
protected abstract boolean searchProgress(List<IndexedValue> indexedValues)
                                   throws CloudproofException
```
    The Findex search mechanism will call this method as the search for keywords progresses through the search graph.
    The user should return false to immediately have the search return and stop further progressing down the graph. *
    Implementation of this method is only required to search the index
    
    Parameters:
    
    indexedValues - A list of IndexedValue already found by the search
    
    Returns:
    
    false to stop the graph from progressing
    
    Throws:
    
    CloudproofException - if anything goes wrong
  - fetchAllEntryTableUidsCallback
```
public FindexNativeWrapper.FetchAllEntryTableUidsCallback fetchAllEntryTableUidsCallback()
```
  - fetchEntryCallback
```
public FindexNativeWrapper.FetchEntryCallback fetchEntryCallback()
```
  - fetchChainCallback
```
public FindexNativeWrapper.FetchChainCallback fetchChainCallback()
```
  - upsertEntryCallback
```
public FindexNativeWrapper.UpsertEntryCallback upsertEntryCallback()
```
  - upsertChainCallback
```
public FindexNativeWrapper.UpsertChainCallback upsertChainCallback()
```
  - updateLinesCallback
```
public FindexNativeWrapper.UpdateLinesCallback updateLinesCallback()
```
  - listRemoveLocationsCallback
```
public FindexNativeWrapper.ListRemovedLocationsCallback listRemoveLocationsCallback()
```
  - progressCallback
```
public FindexNativeWrapper.ProgressCallback progressCallback()
```

Class Database

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Database

Method Detail

fetchAllEntryTableUids

fetchEntries

fetchChains

upsertEntries

upsertChains

updateTables

listRemovedLocations

searchProgress

fetchAllEntryTableUidsCallback

fetchEntryCallback

fetchChainCallback

upsertEntryCallback

upsertChainCallback

updateLinesCallback

listRemoveLocationsCallback

progressCallback