org.gcube.rest.index.client.cache

Class IndexClient

java.lang.Object

org.gcube.rest.index.client.cache.IndexClient

public class IndexClient
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexClient()

Method Summary

Modifier and Type	Method and Description
void	clearCompletelyCache()
boolean	createIndex(org.gcube.rest.index.common.entities.CollectionInfo collectionInfo)
boolean	delete(String collectionID, String recordID)
boolean	deleteCollectionFieldsAlias(String collectionID) Deprecated.
boolean	deleteCompleteCollectionInfo(String collectionID)
boolean	dropCollection(String collectionID)
Map<String,List<org.gcube.rest.index.common.entities.fields.Field>>	getAllCollectionFields(String collectionDomain)
Map<String,Map<String,String>>	getCollectionFieldsAlias(String collectionID, boolean fromIndexToView, String collectionDomain) Deprecated.
List<String>	getCollections(String collectionDomain)
List<org.gcube.rest.index.common.entities.CollectionInfo>	getCompleteCollectionInfo(String collectionID, String collectionDomain)
EndpointProvider	getEndpointProvider()
void	initiateClient(String scope)
boolean	insertJson(String collectionID, String recordJSON) Inserts a document in the specified index (collectionID).
boolean	insertJson(String collectionID, String recordID, String recordJSON) Inserts a document in the specified index (collectionID).
boolean	reIndex(org.gcube.rest.index.common.entities.CollectionInfo newCollectionInfo)
org.gcube.rest.index.common.search.Search_Response	search(org.gcube.rest.index.common.search.Query query)
boolean	setCollectionFieldsAlias(String collectionID, Map<String,String> fieldAlias) Deprecated.
boolean	setCompleteCollectionInfo(org.gcube.rest.index.common.entities.CollectionInfo coll)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexClient

protected IndexClient()

Method Detail

initiateClient

public void initiateClient(String scope)

getEndpointProvider

public EndpointProvider getEndpointProvider()

createIndex

public boolean createIndex(org.gcube.rest.index.common.entities.CollectionInfo collectionInfo)
                    throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

reIndex

public boolean reIndex(org.gcube.rest.index.common.entities.CollectionInfo newCollectionInfo)

getCollections

public List<String> getCollections(String collectionDomain)
                            throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

getAllCollectionFields

public Map<String,List<org.gcube.rest.index.common.entities.fields.Field>> getAllCollectionFields(String collectionDomain)
                                                                                           throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

insertJson

public boolean insertJson(String collectionID,
                          String recordID,
                          String recordJSON)
                   throws NoAvailableIndexServiceInstance

Inserts a document in the specified index (collectionID). If recordID is null or empty, it will be assigned an auto-generated

Parameters:

collectionID - the name of the collection - it will map to the index name

recordID -

recordJSON - the document in json format

Returns:

true if successfull, false otherwise

Throws:

NoAvailableIndexServiceInstance

insertJson

public boolean insertJson(String collectionID,
                          String recordJSON)
                   throws NoAvailableIndexServiceInstance

Inserts a document in the specified index (collectionID). The new record will be assigned an auto-generated ID

Parameters:

collectionID - the name of the collection - it will map to the index name

recordJSON - the document in json format

Returns:

true if successfull, false otherwise

Throws:

NoAvailableIndexServiceInstance

delete

public boolean delete(String collectionID,
                      String recordID)
               throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

dropCollection

public boolean dropCollection(String collectionID)
                       throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

setCollectionFieldsAlias

@Deprecated
public boolean setCollectionFieldsAlias(String collectionID,
                                                    Map<String,String> fieldAlias)
                                             throws NoAvailableIndexServiceInstance

Deprecated.

Throws:

NoAvailableIndexServiceInstance

deleteCollectionFieldsAlias

@Deprecated
public boolean deleteCollectionFieldsAlias(String collectionID)
                                                throws NoAvailableIndexServiceInstance

Deprecated.

Throws:

NoAvailableIndexServiceInstance

getCollectionFieldsAlias

@Deprecated
public Map<String,Map<String,String>> getCollectionFieldsAlias(String collectionID,
                                                                           boolean fromIndexToView,
                                                                           String collectionDomain)
                                                                    throws NoAvailableIndexServiceInstance

Deprecated.

Throws:

NoAvailableIndexServiceInstance

getCompleteCollectionInfo

public List<org.gcube.rest.index.common.entities.CollectionInfo> getCompleteCollectionInfo(String collectionID,
                                                                                           String collectionDomain)
                                                                                    throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

setCompleteCollectionInfo

public boolean setCompleteCollectionInfo(org.gcube.rest.index.common.entities.CollectionInfo coll)
                                  throws NoAvailableIndexServiceInstance,
                                         BadCallException

Throws:

NoAvailableIndexServiceInstance

BadCallException

deleteCompleteCollectionInfo

public boolean deleteCompleteCollectionInfo(String collectionID)
                                     throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

search

public org.gcube.rest.index.common.search.Search_Response search(org.gcube.rest.index.common.search.Query query)
                                                          throws NoAvailableIndexServiceInstance

Throws:

NoAvailableIndexServiceInstance

clearCompletelyCache

@CacheEvict(value={"COMPLETE_COLLECTION_INFOS","COLLECTIONS_FIELDS_ALIASES","COLLECTIONS_FIELDS","COLLECTION_NAMES","ENDPOINTS","JSON_TRANSFORMERS"},
            allEntries=true,
            beforeInvocation=true)
public void clearCompletelyCache()