Package org.ametys.web.filter

Class ContentFilterHelper

java.lang.Object

org.ametys.web.filter.ContentFilterHelper

All Implemented Interfaces:

Component, Serviceable

public class ContentFilterHelper
extends Object
implements Component, Serviceable

Component helper for manipulating ContentFilter

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	__LOGGER	Logger
protected ContentAccessManager	_contentAccessManager	The content access manager.
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected RenderingContextHandler	_renderingContentHandler	The rendering context handler.
static String	ROLE	The Avalon Role

Constructor Summary

Constructors

Constructor	Description
ContentFilterHelper()

Method Summary

Modifier and Type	Method	Description
List<String>	getMatchingContentIds(WebContentFilter filter, String siteName, String lang, Page page)	Get the ID of all contents matching the given filter.
protected boolean	isAccessible(Content content, Page currentPage, WebContentFilter filter)	Test if the content is accessible in accordance with the filter's access limitation policy.
boolean	isContentValid(Content content, Page currentPage, ContentFilter filter)	Test if the content is accessible in accordance with the filter options (mask orphans, access limitation policy, ...)
protected boolean	isOrphan(Content content)	Determines if a content is orphan
void	saxContent(ContentHandler handler, Content content, String viewName, boolean checkUserAccess)	SAX a content in its specific view
void	saxMatchingContents(ContentHandler handler, ContentFilter filter)	SAX all contents matching the given filter
void	saxMatchingContents(ContentHandler handler, WebContentFilter filter, String siteName, String lang, Page page)	SAX all contents matching the given filter
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon Role

__LOGGER

protected static final org.slf4j.Logger __LOGGER

Logger

_contentAccessManager

protected ContentAccessManager _contentAccessManager

The content access manager.

_renderingContentHandler

protected RenderingContextHandler _renderingContentHandler

The rendering context handler.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Detail

ContentFilterHelper

public ContentFilterHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

saxMatchingContents

public void saxMatchingContents(ContentHandler handler,
                                ContentFilter filter)
                         throws SAXException,
                                IOException

SAX all contents matching the given filter

Parameters:

handler - The content handler to SAX into

filter - The filter

Throws:

SAXException - If an error occurs while SAXing

IOException - If an error occurs while retrieving content.

saxMatchingContents

public void saxMatchingContents(ContentHandler handler,
                                WebContentFilter filter,
                                String siteName,
                                String lang,
                                Page page)
                         throws SAXException,
                                IOException

SAX all contents matching the given filter

Parameters:

handler - The content handler to SAX into

filter - The filter

siteName - The current site name. Can be null.

lang - The current language. Can be null.

page - The current page. Can be null.

Throws:

SAXException - If an error occurs while SAXing

IOException - If an error occurs while retrieving content.

getMatchingContentIds

public List<String> getMatchingContentIds(WebContentFilter filter,
                                          String siteName,
                                          String lang,
                                          Page page)

Get the ID of all contents matching the given filter. This method filters orphan contents and limits the results if necessary.

Parameters:

filter - The filter

siteName - The current site name. Can be null.

lang - The current language. Can be null.

page - The current page. Can be null.

Returns:

a List of all content IDs.

saxContent

public void saxContent(ContentHandler handler,
                       Content content,
                       String viewName,
                       boolean checkUserAccess)
                throws SAXException,
                       IOException

SAX a content in its specific view

Parameters:

handler - The content handler to SAX into

content - The content to SAX

viewName - The view to use

checkUserAccess - Set to true to check FO user access when rendering content

Throws:

SAXException - If an error occurs while SAXing

IOException - If an error occurs while retrieving content.

isContentValid

public boolean isContentValid(Content content,
                              Page currentPage,
                              ContentFilter filter)

Test if the content is accessible in accordance with the filter options (mask orphans, access limitation policy, ...)

Parameters:

content - the content to test.

currentPage - the current page.

filter - the content filter.

Returns:

true if the content is accessible, false otherwise.

isAccessible

protected boolean isAccessible(Content content,
                               Page currentPage,
                               WebContentFilter filter)

Test if the content is accessible in accordance with the filter's access limitation policy.

Parameters:

content - the content to test.

currentPage - the current page.

filter - the web content filter.

Returns:

true if the content is accessible, false otherwise.

isOrphan

protected boolean isOrphan(Content content)

Determines if a content is orphan

Parameters:

content - the content to test

Returns:

true if the content is orphan