Package org.ametys.plugins.userdirectory.page

Class UserDirectoryPageResolver

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.userdirectory.page.UserDirectoryPageResolver

All Implemented Interfaces:

Initializable, Component, Contextualizable, LogEnabled, Serviceable

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

Resolves an user directory page path from the associated user content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	UserDirectoryPageResolver.UserPageElementKey

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysResolver	The ametys object resolver.
protected static String	_CACHE_KEY_EMPTY_SITE	The key cache for empty site
protected AbstractCacheManager	_cacheManager	The cache manager
protected Context	_context	The context
protected LanguagesManager	_languagesManager	The languages manager
protected UserDirectoryPageHandler	_pageHandler	The user directory page handler
static String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
UserDirectoryPageResolver()

Method Summary

Modifier and Type	Method	Description
private Cache<UserDirectoryPageResolver.UserPageElementKey,String>	_getCache()
private Set<String>	_getLanguagesToTest(String givenLang)
private UserPage	_getUserPage(String pageId)
protected String	_getUserPageId(Content userContent, String siteName, String language, String contentTypeId)	Return the user page id
private String	_getUserPath(Page userDirectoryRootPage, Content userContent)	Get the path of a user content
void	contextualize(Context context)
UserPage	getUserPage(Content userContent, String siteName, String sitemapName)	Return the user page
UserPage	getUserPage(Content userContent, String siteName, String sitemapName, String contentTypeId)	Return the user page
UserPage	getUserPage(Page userDirectoryRootPage, Content userContent)	Return the user page
String	getUserPageId(Page userDirectoryRootPage, Content userContent)	Return the user page identifier
void	initialize()
void	invalidateUserPageCache(String lang)	Invalidate the user page cache for one language.
void	service(ServiceManager serviceManager)

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 Detail

ROLE

public static final String ROLE

The avalon role.

_CACHE_KEY_EMPTY_SITE

protected static final String _CACHE_KEY_EMPTY_SITE

The key cache for empty site

See Also:

Constant Field Values

_ametysResolver

protected AmetysObjectResolver _ametysResolver

The ametys object resolver.

_pageHandler

protected UserDirectoryPageHandler _pageHandler

The user directory page handler

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

_context

protected Context _context

The context

_languagesManager

protected LanguagesManager _languagesManager

The languages manager

Constructor Detail

UserDirectoryPageResolver

public UserDirectoryPageResolver()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getUserPage

public UserPage getUserPage(Content userContent,
                            String siteName,
                            String sitemapName)

Return the user page

Parameters:

userContent - the user page content

siteName - The current site name.

sitemapName - The current sitemap name.

Returns:

the user page or null if the user page does not exist

getUserPage

public UserPage getUserPage(Content userContent,
                            String siteName,
                            String sitemapName,
                            String contentTypeId)

Return the user page

Parameters:

userContent - the user page content

siteName - The current site name.

sitemapName - The current sitemap name.

contentTypeId - the content type id

Returns:

the user page or null if the user page does not exist

_getLanguagesToTest

private Set<String> _getLanguagesToTest(String givenLang)

_getUserPageId

protected String _getUserPageId(Content userContent,
                                String siteName,
                                String language,
                                String contentTypeId)

Return the user page id

Parameters:

userContent - the user content

siteName - the site name

language - the given language

contentTypeId - the content type id

Returns:

the user page id or null if the user page does not exist

getUserPage

public UserPage getUserPage(Page userDirectoryRootPage,
                            Content userContent)

Return the user page

Parameters:

userDirectoryRootPage - the user directory root page

userContent - the user content

Returns:

the user page or null if the user page does not exist

getUserPageId

public String getUserPageId(Page userDirectoryRootPage,
                            Content userContent)

Return the user page identifier

Parameters:

userDirectoryRootPage - the user directory root page

userContent - the user content

Returns:

the user page or null if the user page does not exist

_getUserPath

private String _getUserPath(Page userDirectoryRootPage,
                            Content userContent)

Get the path of a user content

Parameters:

userDirectoryRootPage - The user directory root page where to look into

userContent - The user content

Returns:

The path or null if the user page does not exist

_getUserPage

private UserPage _getUserPage(String pageId)

_getCache

private Cache<UserDirectoryPageResolver.UserPageElementKey,String> _getCache()

invalidateUserPageCache

public void invalidateUserPageCache(String lang)

Invalidate the user page cache for one language. If lang is null, invalidate all

Parameters:

lang - the lang. Can be null