com.cosmian.jna.findex

Class Findex

java.lang.Object

com.cosmian.jna.findex.FindexBase

com.cosmian.jna.findex.Findex

public final class Findex
extends FindexBase

Nested Class Summary

Nested classes/interfaces inherited from class com.cosmian.jna.findex.FindexBase

FindexBase.IndexRequest<SELF extends FindexBase.IndexRequest<SELF>>, FindexBase.SearchRequest<SELF extends FindexBase.SearchRequest<SELF>>

Constructor Summary

Constructors

Constructor and Description
Findex(byte[] key, String label, EntryTableDatabase entryTable, ChainTableDatabase chainTable) Instantiate Findex using a custom backend.
Findex(byte[] key, String label, int entryTableNumber, EntryTableDatabase entryTable, ChainTableDatabase chainTable) Instantiate Findex using a custom backend.
Findex(String label, String token, String url) Instantiate Findex using a REST backend.
Findex(String label, String token, String entryUrl, String chainUrl) Instantiate Findex using a REST backend.

Method Summary

Modifier and Type	Method and Description
KeywordSet	add(Map<IndexedValue,Set<Keyword>> associations) Add the given associations to the index.
void	compact(byte[] newKey, String newLabel) Compact the index.
void	compact(byte[] newKey, String newLabel, DataFilter dataFilter) Compact the index.
void	compact(byte[] newKey, String newLabel, double compactingRate) Compact the index.
void	compact(byte[] newKey, String newLabel, double compactingRate, DataFilter dataFilter) Compact the index.
KeywordSet	deletion(Map<IndexedValue,Set<Keyword>> associations) Remove the given associations from the index.
SearchResults	search(Set<Keyword> keywords) Search the index for the given keywords, without interruption.
SearchResults	search(Set<Keyword> keywords, Interrupt interrupt) Search the index for the given keywords.
SearchResults	search(String[] keywords) Search the index for the given keywords, without interruption.
SearchResults	search(String[] keywords, Interrupt interrupt) Search the index for the given keywords.

Methods inherited from class com.cosmian.jna.findex.FindexBase

get_last_error, get_last_error, set_error, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

Findex

public Findex(byte[] key,
              String label,
              int entryTableNumber,
              EntryTableDatabase entryTable,
              ChainTableDatabase chainTable)
       throws CloudproofException

Instantiate Findex using a custom backend.

The implementation of both the Entry Table and the Chain Table passed as arguments is used in to manipulate the index.

Parameters:

key - Findex key used to encrypt the index

label - a public label used to allow compact operation without key rotation

entryTableNumber - the number of Entry Table used as backend

entryTable - Entry Table implementation

chainTable - Chain Table implementation

Throws:

CloudproofException - if anything goes wrong

Findex

public Findex(byte[] key,
              String label,
              EntryTableDatabase entryTable,
              ChainTableDatabase chainTable)
       throws CloudproofException

Instantiate Findex using a custom backend.

The implementation of both the Entry Table and the Chain Table passed as arguments is used in to manipulate the index.

Parameters:

key - Findex key used to encrypt the index

label - a public label used to allow compact operation without key rotation

entryTable - Entry Table implementation

chainTable - Chain Table implementation

Throws:

CloudproofException - if anything goes wrong

Findex

public Findex(String label,
              String token,
              String entryUrl,
              String chainUrl)
       throws CloudproofException

Instantiate Findex using a REST backend.

All manipulation of indexes is delegated to a server implementing the Findex REST API.

Parameters:

label - a public label used to allow compact operation without key rotation

token - token used for authentication to the Findex REST server

entryUrl - URL of the Findex Entry Table REST server

chainUrl - URL of the Findex Chain Table REST server

Throws:

CloudproofException - if anything goes wrong

Findex

public Findex(String label,
              String token,
              String url)
       throws CloudproofException

Instantiate Findex using a REST backend.

All manipulation of indexes is delegated to a server implementing the Findex REST API.

Parameters:

label - a public label used to allow compact operation without key rotation

token - token used for authentication to the Findex REST server

url - URL of the Findex REST server

Throws:

CloudproofException - if anything goes wrong

Method Detail

add

public KeywordSet add(Map<IndexedValue,Set<Keyword>> associations)
               throws CloudproofException

Add the given associations to the index.

Parameters:

associations - Map of IndexedValue to Set of Keyword

Returns:

the KeywordSet of new keywords added to the index

Throws:

CloudproofException - if anything goes wrong

deletion

public KeywordSet deletion(Map<IndexedValue,Set<Keyword>> associations)
                    throws CloudproofException

Remove the given associations from the index.

Parameters:

associations - Map of IndexedValue to Set of Keyword

Returns:

the KeywordSet of new keywords added to the index

Throws:

CloudproofException - if anything goes wrong

search

public SearchResults search(Set<Keyword> keywords,
                            Interrupt interrupt)
                     throws CloudproofException

Search the index for the given keywords.

Parameters:

keywords - a Set of Keyword to search

interrupt - an implementation of the Interrupt interface

Returns:

the SearchResults

Throws:

CloudproofException - if anything goes wrong

search

public SearchResults search(Set<Keyword> keywords)
                     throws CloudproofException

Search the index for the given keywords, without interruption.

Parameters:

keywords - a Set of Keyword to search

Returns:

the SearchResults

Throws:

CloudproofException - if anything goes wrong

search

public SearchResults search(String[] keywords)
                     throws CloudproofException

Search the index for the given keywords, without interruption.

Parameters:

keywords - an array of String representing the keywords to search

Returns:

the SearchResults

Throws:

CloudproofException - if anything goes wrong

search

public SearchResults search(String[] keywords,
                            Interrupt interrupt)
                     throws CloudproofException

Search the index for the given keywords.

Parameters:

keywords - an array of String representing the keywords to search

interrupt - an implementation of the Interrupt interface

Returns:

the SearchResults

Throws:

CloudproofException - if anything goes wrong

compact

public void compact(byte[] newKey,
                    String newLabel,
                    double compactingRate,
                    DataFilter dataFilter)
             throws CloudproofException

Compact the index.

At least one of the Findex key or label needs to be changed during this operation.

Parameters:

newKey - key to use as replacement to the current Findex key.

newLabel - label to use as replacement to the current Findex label.

compactingRate - minimal portion of the index to compact

dataFilter - implementation of the DataFilter interface

Throws:

CloudproofException - if anything goes wrong

compact

public void compact(byte[] newKey,
                    String newLabel,
                    double compactingRate)
             throws CloudproofException

Compact the index.

At least one of the Findex key or label needs to be changed during this operation.

No filter is applied on the list of locations collected during the compact operation.

Parameters:

newKey - key to use as replacement to the current Findex key.

newLabel - label to use as replacement to the current Findex label.

compactingRate - number of compact operation to run before going through the entire Chain Table (on average).

Throws:

CloudproofException - if anything goes wrong

compact

public void compact(byte[] newKey,
                    String newLabel,
                    DataFilter dataFilter)
             throws CloudproofException

Compact the index.

At least one of the Findex key or label needs to be changed during this operation.

Parameters:

newKey - key to use as replacement to the current Findex key.

newLabel - label to use as replacement to the current Findex label.

dataFilter - implementation of the DataFilter interface

Throws:

CloudproofException - if anything goes wrong

compact

public void compact(byte[] newKey,
                    String newLabel)
             throws CloudproofException

Compact the index.

At least one of the Findex key or label needs to be changed during this operation.

Parameters:

newKey - key to use as replacement to the current Findex key.

newLabel - label to use as replacement to the current Findex label.

Throws:

CloudproofException - if anything goes wrong