Package lumis.portal.bigdata

Interface IBigDataManagerSPI

All Superinterfaces:

IBigDataManager

All Known Implementing Classes:

BigDataManager

public interface IBigDataManagerSPI
extends IBigDataManager

Provides internal operations of big data manager.

Since:

8.1.0

Version:

$Revision: 22787 $ $Date: 2019-05-31 12:04:02 -0300 (Fri, 31 May 2019) $

Method Summary

Modifier and Type	Method	Description
void	destroy(boolean shutdown)	Destroy all repositories in this manager and free any required resources.
SynonymsStatus	getSynonymsStatus()	Returns the synonyms status.
boolean	isThereSynonymsWithLocale(Locale locale)	Returns whether there are synonyms for the given locale.
void	publishSynonyms(boolean forcePublish)	Writes the synonyms files and reloaded them into the repository. If status is SynonymsStatus.UPDATED, nothing will be performed, unless forcePublish parameter is true.

Methods inherited from interface lumis.portal.bigdata.IBigDataManager

addSynonym, createSynonym, deleteSynonyms, getDefaultRepository, getSynonymById, updateSynonym

Method Detail

destroy

void destroy(boolean shutdown)

Destroy all repositories in this manager and free any required resources.

Parameters:

shutdown - whether this destroy is due to portal being shutdown. If true, this manager must not initialize any repository anymore.

Since:

8.1.0

isThereSynonymsWithLocale

boolean isThereSynonymsWithLocale(Locale locale)

Returns whether there are synonyms for the given locale.

Parameters:

locale - the locale.

Returns:

whether there are synonyms for the given locale.

Since:

11.1.0

getSynonymsStatus

SynonymsStatus getSynonymsStatus()
                          throws TransactionRequiredException

Returns the synonyms status.

Returns:

the synonyms status.

Throws:

TransactionRequiredException - if there's no current active transaction.

Since:

11.1.0

publishSynonyms

void publishSynonyms(boolean forcePublish)
              throws TransactionRequiredException,
                     IOException,
                     PortalException,
                     TimeoutException

Writes the synonyms files and reloaded them into the repository.
If status is SynonymsStatus.UPDATED, nothing will be performed, unless forcePublish parameter is true.

Parameters:

forcePublish - indicates whether the publishing must be performed, even if the synonyms are up-to-date.

Throws:

PortalException - if some error occur.

IOException - if there was an error writing the files.

TransactionRequiredException - if there's no currently active transaction.

TimeoutException - if there was a timeout while waiting all the cluster members to write the synonyms files.

Since:

11.1.0