Package org.ametys.cms.content.consistency

Class ContentConsistencyManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.content.consistency.ContentConsistencyManager

All Implemented Interfaces:

LogEnabled, Initializable, Component, Contextualizable, Serviceable

Direct Known Subclasses:

ContentConsistencyManager

public class ContentConsistencyManager
extends AbstractLogEnabled
implements Initializable, Contextualizable, Serviceable, Component

Manage all operation related to checking the consistency of a content

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ContentConsistencyManager.ConsistenciesReport	Record holding the results of a consistency checks on multiple contents
static class	ContentConsistencyManager.ConsistencyExpression	Expression which tests if contents have consistency informations.

Field Summary

Fields

Modifier and Type	Field	Description
protected ConsistencyChecker	_consistencyChecker	The consistency checker
protected AmetysObjectResolver	_resolver	The ametys object resolver.
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
ContentConsistencyManager()

Method Summary

Modifier and Type	Method	Description
protected ContentConsistencyManager.ConsistenciesReport	_checkContents(AmetysObjectIterable<Content> contents)	Check all the content provided by the iterable for broken links.
protected AmetysObjectIterable<Content>	_getContents(Expression filterExpression)	Get the contents with inconsistency information.
ContentConsistencyManager.ConsistenciesReport	checkAllContents()	Check all contents to see if there references are consistent.
void	contextualize(Context context)
void	initialize()
protected void	removeOutdatedResult(ZonedDateTime date, Expression filterExpression)	Remove results older than a given date
Map<String,Object>	resultToJSON(ContentConsistencyResult result, List<Map<String,Object>> columns)	Serialize a content consistency result as JSON
void	service(ServiceManager manager)
protected ContentConsistencyResult	storeResult(WorkflowAwareContent content, int successCount, int unknownCount, int unauthorizedCount, int notFoundCount, int serverErrorCount)	Store the result of the consistency check done on the content

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_consistencyChecker

protected ConsistencyChecker _consistencyChecker

The consistency checker

Constructor Details

ContentConsistencyManager

public ContentConsistencyManager()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

checkAllContents

public ContentConsistencyManager.ConsistenciesReport checkAllContents()

Check all contents to see if there references are consistent. All result will also be stored in the consistency result database table for later access.

Returns:

record describing the results of the checks

removeOutdatedResult

protected void removeOutdatedResult(ZonedDateTime date,
 Expression filterExpression)

Remove results older than a given date

Parameters:

date - the threshold

filterExpression - an expression to filter the content to consider, null to consider all contents

_checkContents

protected ContentConsistencyManager.ConsistenciesReport _checkContents(AmetysObjectIterable<Content> contents)

Check all the content provided by the iterable for broken links. This method will actually provide Callable to an Executor that parallelize the checks.

Parameters:

contents - an iterable of contents to check

Returns:

record describing the results of the checks

storeResult

protected ContentConsistencyResult storeResult(WorkflowAwareContent content,
 int successCount,
 int unknownCount,
 int unauthorizedCount,
 int notFoundCount,
 int serverErrorCount)

Store the result of the consistency check done on the content

Parameters:

content - the content checked

successCount - the number of success

unknownCount - the number of unknown

unauthorizedCount - the number of unauthorized

notFoundCount - the number of not found

serverErrorCount - the number of server error

Returns:

the result

_getContents

protected AmetysObjectIterable<Content> _getContents(Expression filterExpression)

Get the contents with inconsistency information.

Parameters:

filterExpression - an expression to filter content to check, or null to check all contents

Returns:

an iterator on contents.

resultToJSON

public Map<String,Object> resultToJSON(ContentConsistencyResult result,
 List<Map<String,Object>> columns)

Serialize a content consistency result as JSON

Parameters:

result - the results to serialize

columns - the list of columns to use as "view"

Returns:

a JSON representation of the result