Package org.ametys.plugins.userdirectory

Class UserDirectoryPageHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.userdirectory.UserDirectoryPageHandler

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class UserDirectoryPageHandler
extends AbstractLogEnabled
implements Component, Serviceable, Initializable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	UserDirectoryPageHandler.PageCacheKey	Key to index a user directory page in a cache
protected static final class	UserDirectoryPageHandler.RootPageCacheKey	Key to index a user directory root page in a cache
protected static final record	UserDirectoryPageHandler.UDPagesCache	User directory pages cache

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_abstractCacheManager	The cache manager
protected ContentTypeExtensionPoint	_contentTypeEP	The extension point for content types
protected AmetysObjectResolver	_resolver	The ametys object resolver.
protected WorkspaceSelector	_workspaceSelector	The workspace selector.
static final String	ABSTRACT_USER_CONTENT_TYPE	The parent content type id
static final String	CLASSIFICATION_ATTRIBUTE_DATA_NAME	The data name for the classification attribute of the user directory
static final String	CONTENT_TYPE_DATA_NAME	The data name for the content type of the user directory
static final String	DEPTH_DATA_NAME	The data name for the depth of the user directory
static final String	ROLE	The avalon role.
protected static final String	ROOT_PAGES_CACHE	The user directory root pages cache id
protected static final String	UD_PAGES_CACHE	The user directory user pages cache id
static final String	USER_VIEW_NAME	The data name for the users' view to use

Constructor Summary

Constructors

Constructor	Description
UserDirectoryPageHandler()

Method Summary

Modifier and Type	Method	Description
protected Map<Content,String>	_getTransformedValuesByContent(Page rootPage)	Get all transformed values by content
protected Set<Page>	_getUserDirectoryRootPages(String siteName, String sitemapName)	Get the user directory root pages, without searching in the cache.
void	clearCache(String contentTypeId)	Clear root page cache
void	clearCache(Page rootPage)	Clear root page cache
String	getClassificationAttribute(Page rootPage)	Gets the name of the classification attribute
AmetysObjectIterable<Content>	getContentsForRootPage(Page rootPage)	Get the user contents for a given root page
ContentType	getContentType(Page rootPage)	Gets the content type
String	getContentTypeId(Page rootPage)	Gets the content type id
int	getDepth(Page rootPage)	Gets the depth of the user directory root page
String	getName(String pathName)	Gets name form path name
String	getPathName(String name)	Checks if name contains only Unicode digits and if so, prefix it with "page-"
protected Cache<UserDirectoryPageHandler.RootPageCacheKey,Set<String>>	getRootPagesCache()	Cache of the user directory root pages.
String	getTransformedClassificationValue(Page rootPage, Content content)	Gets the value of the classification attribute for the given content, transformed for building tree hierarchy The transformation takes the lower-case of all characters, removes non-alphanumeric characters, and takes the first characters to not have a string with a size bigger than the depth For instance, if the value for the content is "Aéa Foo-bar" and the depth is 7, then this method will return "aeafoob"
SortedSet<String>	getTransitionalPagesName(Page rootPage, String pagePath)	Get all transitional page child from page name
protected Cache<UserDirectoryPageHandler.PageCacheKey,UserDirectoryPageHandler.UDPagesCache>	getUDPagesCache()	Cache of the user directory user pages and transitional page.
Page	getUserDirectoryRootPage(String siteName, String sitemapName, String contentTypeId)	Gets the user directory root page of a specific content type.
Set<Page>	getUserDirectoryRootPages(String contentTypeId)	Gets the user directory root pages from the given content type id, whatever the site.
Set<Page>	getUserDirectoryRootPages(String siteName, String sitemapName)	Gets the user directory root pages.
Map<String,String>	getUserPagesContent(Page rootPage, String pagePath)	Get all user page child from page name
void	initialize()
void	service(ServiceManager manager)

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.

CONTENT_TYPE_DATA_NAME

public static final String CONTENT_TYPE_DATA_NAME

The data name for the content type of the user directory

See Also:

• Constant Field Values

USER_VIEW_NAME

public static final String USER_VIEW_NAME

The data name for the users' view to use

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 user directory

See Also:

• Constant Field Values

DEPTH_DATA_NAME

public static final String DEPTH_DATA_NAME

The data name for the depth of the user directory

See Also:

• Constant Field Values

ABSTRACT_USER_CONTENT_TYPE

public static final String ABSTRACT_USER_CONTENT_TYPE

The parent content type id

See Also:

• Constant Field Values

ROOT_PAGES_CACHE

protected static final String ROOT_PAGES_CACHE

The user directory root pages cache id

UD_PAGES_CACHE

protected static final String UD_PAGES_CACHE

The user directory user pages cache id

_workspaceSelector

protected WorkspaceSelector _workspaceSelector

The workspace selector.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The extension point for content types

_abstractCacheManager

protected AbstractCacheManager _abstractCacheManager

The cache manager

Constructor Details

UserDirectoryPageHandler

public UserDirectoryPageHandler()

Method Details

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

getUserDirectoryRootPages

public Set<Page> getUserDirectoryRootPages(String contentTypeId)
                                    throws AmetysRepositoryException

Gets the user directory root pages from the given content type id, whatever the site.

Parameters:

contentTypeId - The content type id

Returns:

the user directory root pages.

Throws:

AmetysRepositoryException - if an error occured.

getUserDirectoryRootPage

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

Gets the user directory root page of a specific content type.

Parameters:

siteName - The site name

sitemapName - The sitemap

contentTypeId - The content type id

Returns:

the user directory root pages.

Throws:

AmetysRepositoryException - if an error occured.

getUserDirectoryRootPages

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

Gets the user directory root pages.

Parameters:

siteName - The site name

sitemapName - The sitemap

Returns:

the user directory root pages.

Throws:

AmetysRepositoryException - if an error occured.

_getUserDirectoryRootPages

protected Set<Page> _getUserDirectoryRootPages(String siteName,
 String sitemapName)
                                        throws AmetysRepositoryException

Get the user directory root pages, without searching in the cache.

Parameters:

siteName - the current site.

sitemapName - the sitemap name.

Returns:

the user directory root pages

Throws:

AmetysRepositoryException - if an error occured.

getDepth

public int getDepth(Page rootPage)

Gets the depth of the user directory root page

Parameters:

rootPage - The user directory root page

Returns:

the depth of the user directory root page

getClassificationAttribute

public String getClassificationAttribute(Page rootPage)

Gets the name of the classification attribute

Parameters:

rootPage - The user directory root page

Returns:

the name of the classification attribute

getContentTypeId

public String getContentTypeId(Page rootPage)

Gets the content type id

Parameters:

rootPage - The user directory root page

Returns:

the content type id

getContentType

public ContentType getContentType(Page rootPage)

Gets the content type

Parameters:

rootPage - The user directory root page

Returns:

the content type

getTransformedClassificationValue

public String getTransformedClassificationValue(Page rootPage,
 Content content)

Gets the value of the classification attribute for the given content, transformed for building tree hierarchy
The transformation takes the lower-case of all characters, removes non-alphanumeric characters, and takes the first characters to not have a string with a size bigger than the depth
For instance, if the value for the content is "Aéa Foo-bar" and the depth is 7, then this method will return "aeafoob"

Parameters:

rootPage - The user directory root page

content - The content

Returns:

the transformed value of the classification attribute for the given content. Can be null

getTransitionalPagesName

public SortedSet<String> getTransitionalPagesName(Page rootPage,
 String pagePath)

Get all transitional page child from page name

Parameters:

rootPage - the root page

pagePath - the page path

Returns:

all transitional page child from page name

getUserPagesContent

public Map<String,String> getUserPagesContent(Page rootPage,
 String pagePath)

Get all user page child from page name

Parameters:

rootPage - the root page

pagePath - the page path

Returns:

all user page child from page name

_getTransformedValuesByContent

protected Map<Content,String> _getTransformedValuesByContent(Page rootPage)

Get all transformed values by content

Parameters:

rootPage - the root page

Returns:

the map of transformed values by content

getContentsForRootPage

public AmetysObjectIterable<Content> getContentsForRootPage(Page rootPage)

Get the user contents for a given root page

Parameters:

rootPage - the root page

Returns:

the user contents

getName

public String getName(String pathName)

Gets name form path name

Parameters:

pathName - the path name

Returns:

the name

getPathName

public String getPathName(String name)

Checks if name contains only Unicode digits and if so, prefix it with "page-"

Parameters:

name - The page name

Returns:

The potentially prefixed page name

clearCache

public void clearCache(Page rootPage)

Clear root page cache

Parameters:

rootPage - the root page

clearCache

public void clearCache(String contentTypeId)

Clear root page cache

Parameters:

contentTypeId - the content type id

getRootPagesCache

protected Cache<UserDirectoryPageHandler.RootPageCacheKey,Set<String>> getRootPagesCache()

Cache of the user directory root pages. The cache store a Set of TODO indexed by the workspaceName, siteName, siteMapName

Returns:

the cache

getUDPagesCache

protected Cache<UserDirectoryPageHandler.PageCacheKey,UserDirectoryPageHandler.UDPagesCache> getUDPagesCache()

Cache of the user directory user pages and transitional page. The cache store a UserDirectoryPageHandler.UDPagesCache containing the transitional pages cache and the user pages cache. The cache is indexed by workspaceName, siteName, siteMapName, pageName.

Returns:

the cache