Package org.ametys.cms.transformation

Class ConsistencyChecker

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.transformation.ConsistencyChecker

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class ConsistencyChecker
extends AbstractLogEnabled
implements Serviceable, Component

Consistency checker component. Checks the state of the links extracted as outgoing references for a content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConsistencyChecker.CHECK	The state of the check
static final record	ConsistencyChecker.CheckReport	Represent the result of a consistency check

Field Summary

Fields

Modifier and Type	Field	Description
protected URIResolverExtensionPoint	_uriResolverEP	The ametys uri resolver
protected HttpUrlUtils	_urlUtils	The URL utils
protected VersionsHandler	_versionsHandler	The version handler
static final String	CONSISTENCY_EXTERNAL_REFERENCE_TYPE	Constants for the special external type for outgoing references
static final String	ROLE	Avalon role

Constructor Summary

Constructors

Constructor	Description
ConsistencyChecker()

Method Summary

Modifier and Type	Method	Description
protected ConsistencyChecker.CheckReport	_checkHTTPLink(String linkValue, boolean shortTest)	Test an http link
ConsistencyChecker.CheckReport	checkConsistency(String referenceType, String referenceValue, String contentId, String dataPath, boolean quickTest)	Check the consistency of a reference
I18nizableText	getLabel(String referenceType, String referenceValue, String contentId, String dataPath)	Get the label of a reference.
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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

Avalon role

CONSISTENCY_EXTERNAL_REFERENCE_TYPE

public static final String CONSISTENCY_EXTERNAL_REFERENCE_TYPE

Constants for the special external type for outgoing references

See Also:

• Constant Field Values

_uriResolverEP

protected URIResolverExtensionPoint _uriResolverEP

The ametys uri resolver

_versionsHandler

protected VersionsHandler _versionsHandler

The version handler

_urlUtils

protected HttpUrlUtils _urlUtils

The URL utils

Constructor Details

ConsistencyChecker

public ConsistencyChecker()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

checkConsistency

public ConsistencyChecker.CheckReport checkConsistency(String referenceType,
 String referenceValue,
 String contentId,
 String dataPath,
 boolean quickTest)

Check the consistency of a reference

Parameters:

referenceType - The type of the reference to test (can be 'attachment', 'explorer', 'metadata', '__external', etc...)

referenceValue - The value of the reference to test

contentId - The id of the content containing the reference

dataPath - The path of the data containing the reference

quickTest - true to make a quick test, that means that long tests will return UNKNOWN immediately.

Returns:

CHECK enum value

getLabel

public I18nizableText getLabel(String referenceType,
 String referenceValue,
 String contentId,
 String dataPath)

Get the label of a reference.

Parameters:

referenceType - The type of the reference to test (can be 'attachment', 'explorer', 'metadata', '__external', etc...)

referenceValue - The value of the reference to test

contentId - The id of the content containing the reference

dataPath - The path of the data containing the reference

Returns:

the element label.

_checkHTTPLink

protected ConsistencyChecker.CheckReport _checkHTTPLink(String linkValue,
 boolean shortTest)

Test an http link

Parameters:

linkValue - The http url to test

shortTest - true to make a short test (with short timeout)

Returns:

The state. UNKNOWN if test cannot be done fully