es.prodevelop.pui9.elasticsearch.controllers

Class PuiElasticSearchController

java.lang.Object

es.prodevelop.pui9.controller.AbstractPuiController

es.prodevelop.pui9.elasticsearch.controllers.PuiElasticSearchController

@Controller
 @RequestMapping(value="/elasticsearch")
public class PuiElasticSearchController
extends AbstractPuiController

This controller provide some useful methods to manage Elastic Search for the application. It allows to activate or deactivate it, get the information of the indexes, reindex an index, delete an index, index a new document...

Author:

Marc Gil - mgil@prodevelop.es

Field Summary

Fields inherited from class es.prodevelop.pui9.controller.AbstractPuiController

ID_FUNCTIONALITY_DELETE, ID_FUNCTIONALITY_GET, ID_FUNCTIONALITY_INSERT, ID_FUNCTIONALITY_LIST, ID_FUNCTIONALITY_UPDATE, logger, METHOD_FUNCTIONALITY_DELETE, METHOD_FUNCTIONALITY_GET, METHOD_FUNCTIONALITY_INSERT, METHOD_FUNCTIONALITY_LIST, METHOD_FUNCTIONALITY_UPDATE

Constructor Summary

Constructors

Constructor and Description
PuiElasticSearchController()

Method Summary

Modifier and Type	Method and Description
Long	count(String view, boolean hasLang) Count the number of registries in the database
void	deleteIndex(String view) Delete the index represented by the given view
void	document(DocumentOperationType type, String table, String pk) Indicate Elastic Search that a document should be inserted, updated or deleted from the index.
es.prodevelop.pui9.elasticsearch.controllers.PuiElasticSearchController.ElasticInfo	getInfo() Get a complete information about the current status of all the indexes of Elastic Search
protected String	getReadFunctionality()
protected String	getWriteFunctionality()
String	reindex(String view, boolean force) Allow to reindex the index represented by the given view name
void	setActive(Boolean active) Activate or deactivate Elastic Search for this application
void	setBlocked(String view, boolean blocked) Set an index represented by the given view as blocked of unblocked.

Methods inherited from class es.prodevelop.pui9.controller.AbstractPuiController

getDeleteFunctionality, getEventLauncher, getGetFunctionality, getInsertFunctionality, getLanguage, getListFunctionality, getSession, getUpdateFunctionality

Methods inherited from class java.lang.Object

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

Constructor Detail

PuiElasticSearchController

public PuiElasticSearchController()

Method Detail

getReadFunctionality

protected String getReadFunctionality()

Overrides:

getReadFunctionality in class AbstractPuiController

getWriteFunctionality

protected String getWriteFunctionality()

Overrides:

getWriteFunctionality in class AbstractPuiController

reindex

@GetMapping(value="/reindex",
            produces="application/json")
public String reindex(@RequestParam(required=false)
                                                                                             String view,
                                                                                             @RequestParam(required=false)
                                                                                             boolean force)

Allow to reindex the index represented by the given view name

Parameters:

view - The name of the view you want to reindex the associated index (or indexes, in case of translated view)

force - If set to true, the index will be always reindexed; if set to false, it will be reindexed only if it's not valid (distinct number of registries in the database view and in the index)

Returns:

A message saying that Elastic Search is being updated

setActive

@GetMapping(value="/setActive")
public void setActive(@RequestParam
                                                      Boolean active)

Activate or deactivate Elastic Search for this application

Parameters:

active - true to activate; false to deactivate

setBlocked

@GetMapping(value="/setBlocked")
public void setBlocked(@RequestParam
                                                        String view,
                                                        @RequestParam
                                                        boolean blocked)

Set an index represented by the given view as blocked of unblocked. Valid if you want to disable Elastic Search only for certain views

Parameters:

view - The name of the view you want to block or unblock the associated index (or indexes, in case of translated view)

blocked - true to block; false to unblock

deleteIndex

@DeleteMapping(value="/deleteIndex")
public void deleteIndex(@RequestParam
                                                             String view)
                                                      throws PuiElasticSearchNoNodesException,
                                                             PuiElasticSearchDeleteIndexException

Delete the index represented by the given view

Parameters:

view - The name of the view you want to delete the associated index (or indexes, in case of translated view)

Throws:

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

PuiElasticSearchDeleteIndexException - If any error occurs while deleting the Index

document

@PostMapping(value="/document",
             consumes="application/json")
public void document(@RequestParam
                                                                                               DocumentOperationType type,
                                                                                               @RequestParam
                                                                                               String table,
                                                                                               @RequestBody
                                                                                               String pk)
                                                                                        throws es.prodevelop.pui9.exceptions.PuiException

Indicate Elastic Search that a document should be inserted, updated or deleted from the index.

It is commonly used in applications that not only the own application manages the used database. This case, the other applications should call this method in order to maintain synchronized the Elastic Search indexes

Parameters:

type - The operation type: insert, update or delete

table - The name of the affected table

pk - The PK of the registry to be processed

Throws:

es.prodevelop.pui9.exceptions.PuiException - If Elastic Search is not enabled for the application; if the table is not mapped in the code or if the PK is not well formed for the given table

count

@GetMapping(value="/count",
            produces="application/json")
public Long count(@RequestParam
                                                                                       String view,
                                                                                       @RequestParam
                                                                                       boolean hasLang)
                                                                                throws es.prodevelop.pui9.exceptions.PuiException

Count the number of registries in the database

Parameters:

view - The view to be checked

hasLang - If want to take into account the languages or not

Returns:

The number of registries in the database

Throws:

es.prodevelop.pui9.exceptions.PuiException - If an exception occurs while counting

getInfo

@GetMapping(value="/getInfo",
            produces="application/json")
public es.prodevelop.pui9.elasticsearch.controllers.PuiElasticSearchController.ElasticInfo getInfo()
                                                                                                                                                                   throws es.prodevelop.pui9.exceptions.PuiException

Get a complete information about the current status of all the indexes of Elastic Search

Returns:

The Elastic Search information

Throws:

es.prodevelop.pui9.exceptions.PuiException - If any error occur while collecting the information