Package org.ametys.plugins.ugc.page

Class UGCPageHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.ugc.page.UGCPageHandler

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class UGCPageHandler
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Component providing methods to retrieve ugc virtual pages, such as the ugc root, transitional page and ugc content page.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected ContentTypeExtensionPoint	_cTypeEP	The content type extension point
protected ContentTypesHelper	_cTypeHelper	The content types helper
protected I18nUtils	_i18nUtils	The i18n utils
protected AmetysObjectResolver	_resolver	The ametys object resolver
static final String	ATTRIBUTE_TRANSITIONAL_PAGE_METADATA_VALUE	The attribute to get the name of transitional page
static final String	ATTRIBUTE_TRANSITIONAL_PAGE_TITLE	The attribute to get the title of transitional page
static final String	CLASSIFICATION_ATTRIBUTE_DATA_NAME	The data name for the classification attribute of the ugc
static final String	CLASSIFICATION_PAGE_VISIBLE_DATA_NAME	The data name for the visibility of transitional page of the ugc
static final String	CONTENT_TYPE_DATA_NAME	The data name for the content type of the ugc
static final String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
UGCPageHandler()

Method Summary

Modifier and Type	Method	Description
String	computePageId(String path, Page root, Content ugcContent)	Computes a page id
void	contextualize(Context context)
String	getClassificationAttribute(Page rootPage)	Gets the path of the classification attribute
AmetysObjectIterable<Content>	getContentsForRootPage(Page rootPage)	Get UGC contents from rootPage
AmetysObjectIterable<Content>	getContentsForTransitionalPage(Page rootPage, String metadataValue)	Get contents under transitional page
String	getContentTypeId(Page rootPage)	Gets the content type id
protected Logger	getLogger()	Returns the Logger.
Map<String,Map<String,String>>	getTransitionalPage(Page rootPage)	Get the map of transitional page (name : (id, title))
UGCPage	getUgcPage(String contentId, String siteName)	Gets the UGC page related to the given UG Content id
Optional<UGCPage>	getUgcPage(Content ugcContent, String site, String sitemap, String contentType)	Gets the UGC page related to the given UG Content for given site, sitemap and type
Optional<UGCPage>	getUgcPage(Page ugcRootPage, Content ugcContent)	Gets the UGC page related to the given UG Content for given UGC root
Page	getUGCRootPage(String siteName, String sitemapName, String contentTypeId)	Gets the ugc root pages from the given content type id.
Set<Page>	getUGCRootPages(String siteName, String sitemapName)	Get the ugc root pages
boolean	hasContentForRootPage(Page rootPage, Content content)	Determines if content is part of UGC root page
boolean	hasContentForTransitionalPage(Page rootPage, String metadataValue, Content content)	Determines if given content is part of a transitional page
boolean	isClassificationPagesVisible(Page rootPage)	true if the classification pages are visible
void	service(ServiceManager manager)

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

setLogger

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_TRANSITIONAL_PAGE_METADATA_VALUE

public static final String ATTRIBUTE_TRANSITIONAL_PAGE_METADATA_VALUE

The attribute to get the name of transitional page

See Also:

• Constant Field Values

ATTRIBUTE_TRANSITIONAL_PAGE_TITLE

public static final String ATTRIBUTE_TRANSITIONAL_PAGE_TITLE

The attribute to get the title of transitional page

See Also:

• Constant Field Values

ROLE

public static final String ROLE

The avalon role.

CONTENT_TYPE_DATA_NAME

public static final String CONTENT_TYPE_DATA_NAME

The data name for the content type of the ugc

See Also:

• Constant Field Values

CLASSIFICATION_ATTRIBUTE_DATA_NAME

public static final String CLASSIFICATION_ATTRIBUTE_DATA_NAME

The data name for the classification attribute of the ugc

See Also:

• Constant Field Values

CLASSIFICATION_PAGE_VISIBLE_DATA_NAME

public static final String CLASSIFICATION_PAGE_VISIBLE_DATA_NAME

The data name for the visibility of transitional page of the ugc

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point

_cTypeHelper

protected ContentTypesHelper _cTypeHelper

The content types helper

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_context

protected Context _context

The avalon context

Constructor Details

UGCPageHandler

public UGCPageHandler()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getLogger

protected Logger getLogger()

Description copied from class: AbstractLogEnabled

Returns the Logger.

Overrides:

getLogger in class AbstractLogEnabled

Returns:

the Logger.

getClassificationAttribute

public String getClassificationAttribute(Page rootPage)

Gets the path of the classification attribute

Parameters:

rootPage - The ugc root page

Returns:

the path of the classification attribute

getContentTypeId

public String getContentTypeId(Page rootPage)

Gets the content type id

Parameters:

rootPage - The ugc root page

Returns:

the content type id

isClassificationPagesVisible

public boolean isClassificationPagesVisible(Page rootPage)

true if the classification pages are visible

Parameters:

rootPage - The ugc root page

Returns:

true if the classification pages are visible

getUGCRootPage

public Page getUGCRootPage(String siteName,
 String sitemapName,
 String contentTypeId)
                    throws AmetysRepositoryException

Gets the ugc root pages from the given content type id.

Parameters:

siteName - the site name

sitemapName - the sitemap name

contentTypeId - The content type id

Returns:

the ugc root page.

Throws:

AmetysRepositoryException - if an error occured.

getUGCRootPages

public Set<Page> getUGCRootPages(String siteName,
 String sitemapName)
                          throws AmetysRepositoryException

Get the ugc root pages

Parameters:

siteName - the current site.

sitemapName - the sitemap name.

Returns:

the ugc root pages

Throws:

AmetysRepositoryException - if an error occured.

getContentsForRootPage

public AmetysObjectIterable<Content> getContentsForRootPage(Page rootPage)

Get UGC contents from rootPage

Parameters:

rootPage - the root page

Returns:

the list of UGC contents

hasContentForRootPage

public boolean hasContentForRootPage(Page rootPage,
 Content content)

Determines if content is part of UGC root page

Parameters:

rootPage - The root page

content - the content

Returns:

true if content is part of UGC root page

getTransitionalPage

public Map<String,Map<String,String>> getTransitionalPage(Page rootPage)

Get the map of transitional page (name : (id, title))

Parameters:

rootPage - the root page

Returns:

The map of transitional page

getContentsForTransitionalPage

public AmetysObjectIterable<Content> getContentsForTransitionalPage(Page rootPage,
 String metadataValue)

Get contents under transitional page

Parameters:

rootPage - the root page

metadataValue - the metadata value (linked to the transitional page)

Returns:

list of contents under transitional page

hasContentForTransitionalPage

public boolean hasContentForTransitionalPage(Page rootPage,
 String metadataValue,
 Content content)

Determines if given content is part of a transitional page

Parameters:

rootPage - the root page

metadataValue - the metadata value (linked to the transitional page). Cannot be null.

content - the content

Returns:

true if content is part of the transitional page

computePageId

public String computePageId(String path,
 Page root,
 Content ugcContent)

Computes a page id

Parameters:

path - The path

root - The root page

ugcContent - The UGC content

Returns:

The id

getUgcPage

public UGCPage getUgcPage(String contentId,
 String siteName)

Gets the UGC page related to the given UG Content id

Parameters:

contentId - the id of UG Content

siteName - The site name. Can be nul to get site from content or current site.

Returns:

the UGC page or null if not found

getUgcPage

public Optional<UGCPage> getUgcPage(Content ugcContent,
 String site,
 String sitemap,
 String contentType)

Gets the UGC page related to the given UG Content for given site, sitemap and type

Parameters:

ugcContent - the UG Content

site - the site name

sitemap - the sitemap name

contentType - the content type id

Returns:

the UGC page

getUgcPage

public Optional<UGCPage> getUgcPage(Page ugcRootPage,
 Content ugcContent)

Gets the UGC page related to the given UG Content for given UGC root

Parameters:

ugcRootPage - the UGC root page

ugcContent - the UG Content

Returns:

the UGC page