Package lumis.portal.bigdata

Class BigDataManager

java.lang.Object

lumis.portal.bigdata.BigDataManager

All Implemented Interfaces:

IBigDataManager, IBigDataManagerSPI

public class BigDataManager
extends Object
implements IBigDataManagerSPI

Creates instances of concrete IBigDataRepository implementations.

Since:

8.1.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

Constructor Summary

Constructors

Constructor	Description
BigDataManager()

Method Summary

Modifier and Type	Method	Description
void	addSynonym(ISynonym synonym)	Adds the given synonyms to be used during document creation.
ISynonym	createSynonym()	Creates a new instance of ISynonym to be added later.
void	deleteSynonyms(String... synonymIds)	Removes the synonyms with the given identifiers.
void	destroy(boolean shutdown)	Destroy all repositories in this manager and free any required resources.
IBigDataRepository	getDefaultRepository()	Returns the default big data repository.
ISynonym	getSynonymById(String synonymId)	Returns the synonym with the given identifier.
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.
void	updateSynonym(ISynonym synonym)	Updates the given synonyms to be used during document creation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BigDataManager

public BigDataManager()

Method Detail

destroy

public void destroy(boolean shutdown)

Description copied from interface: IBigDataManagerSPI

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

Specified by:

destroy in interface IBigDataManagerSPI

Parameters:

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

getDefaultRepository

public IBigDataRepository getDefaultRepository()

Description copied from interface: IBigDataManager

Returns the default big data repository.

Specified by:

getDefaultRepository in interface IBigDataManager

Returns:

the default big data repository.

createSynonym

public ISynonym createSynonym()

Description copied from interface: IBigDataManager

Creates a new instance of ISynonym to be added later.

Specified by:

createSynonym in interface IBigDataManager

Returns:

a new instance of ISynonym to be added later.

addSynonym

public void addSynonym(ISynonym synonym)
                throws IllegalArgumentException,
                       TransactionRequiredException,
                       PortalException

Description copied from interface: IBigDataManager

Adds the given synonyms to be used during document creation. This operation, however, may not have an instant effect.
Before call this method, IBigDataManager.createSynonym() must be called to create a new instance, so it can be added.

When calling this method, there must be an active transaction and an active user's session. The user calling this, must have the manage portal permission.

Specified by:

addSynonym in interface IBigDataManager

Parameters:

synonym - the synonyms to be added.

Throws:

IllegalArgumentException - if the given synonym is null or invalid.

TransactionRequiredException - if there's no active transaction.

AccessDeniedException - if there's no active user session or the given session does not have the required permission.

PortalException - if other error occur.

updateSynonym

public void updateSynonym(ISynonym synonym)
                   throws IllegalArgumentException,
                          TransactionRequiredException,
                          PortalException

Description copied from interface: IBigDataManager

Updates the given synonyms to be used during document creation. This operation, however, may not have an instant effect.

When calling this method, there must be an active transaction and an active user's session. The user calling this, must have the manage portal permission.

Specified by:

updateSynonym in interface IBigDataManager

Parameters:

synonym - the synonyms to be updated -- it must have been gotten through IBigDataManager.getSynonymById(String).

Throws:

IllegalArgumentException - if the given synonym is null or invalid.

TransactionRequiredException - if there's no active transaction.

AccessDeniedException - if there's no active user session or the given session does not have the required permission.

PortalException - if other error occur.

deleteSynonyms

public void deleteSynonyms(String... synonymIds)
                    throws IllegalArgumentException,
                           TransactionRequiredException,
                           PortalException

Description copied from interface: IBigDataManager

Removes the synonyms with the given identifiers. This operation, however, may not have an instant effect.

When calling this method, there must be an active transaction and an active user's session. The user calling this, must have the manage portal permission.

Specified by:

deleteSynonyms in interface IBigDataManager

Parameters:

synonymIds - the synonyms identifier.

Throws:

IllegalArgumentException - if synonymId is null.

TransactionRequiredException - if there's no active transaction.

AccessDeniedException - if there's no active user session or the given session does not have the required permission.

PortalException - if other error occur.

getSynonymById

public ISynonym getSynonymById(String synonymId)
                        throws AccessDeniedException,
                               IllegalArgumentException,
                               TransactionRequiredException,
                               PortalObjectNotFoundException

Description copied from interface: IBigDataManager

Returns the synonym with the given identifier.

When calling this method, there must be an active transaction and an active user's session.

Specified by:

getSynonymById in interface IBigDataManager

Parameters:

synonymId - the synonym identifier.

Returns:

the synonym with the given identifier.

Throws:

AccessDeniedException - if there's no active user session.

IllegalArgumentException - if synonymId is null.

TransactionRequiredException - if there's no active transaction.

PortalObjectNotFoundException - if there's no synonym with the given identifier.

isThereSynonymsWithLocale

public boolean isThereSynonymsWithLocale(Locale locale)

Description copied from interface: IBigDataManagerSPI

Returns whether there are synonyms for the given locale.

Specified by:

isThereSynonymsWithLocale in interface IBigDataManagerSPI

Parameters:

locale - the locale.

Returns:

whether there are synonyms for the given locale.

getSynonymsStatus

public SynonymsStatus getSynonymsStatus()
                                 throws TransactionRequiredException

Description copied from interface: IBigDataManagerSPI

Returns the synonyms status.

Specified by:

getSynonymsStatus in interface IBigDataManagerSPI

Returns:

the synonyms status.

Throws:

TransactionRequiredException - if there's no current active transaction.

publishSynonyms

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

Description copied from interface: IBigDataManagerSPI

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

Specified by:

publishSynonyms in interface IBigDataManagerSPI

Parameters:

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

Throws:

TransactionRequiredException - if there's no currently active transaction.

IOException - if there was an error writing the files.

PortalException - if some error occur.

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