org.ametys.plugins.ugc.page

Class UGCPage

java.lang.Object

org.ametys.plugins.ugc.page.UGCPage

All Implemented Interfaces:

TagAwareAmetysObject, ACLAmetysObject, AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, TraversableAmetysObject, MetadataAwarePagesContainer, Page, PagesContainer, SiteAwareAmetysObject

public class UGCPage
extends Object
implements Page, ACLAmetysObject

Page representing an UGC page.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.web.repository.page.Page

Page.LinkType, Page.PageType

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__UGC_PAGE_TEMPLATE
private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType>	_pageDataTypeExtensionPoint
private String	_path
private AmetysObjectResolver	_resolver
private Page	_root
private ServiceExtensionPoint	_serviceExtensionPoint
private SkinsManager	_skinsManager
private String	_title
private Content	_ugcContent
private UGCPageHandler	_ugcPageHandler
private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType>	_zoneDataTypeExtensionPoint
private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType>	_zoneItemDataTypeExtensionPoint

Constructor Summary

Constructors

Constructor and Description

UGCPage(Page root, Content syncContent, String path, AmetysObjectResolver resolver, UGCPageHandler ugcPageHandler, SkinsManager skinsManager, AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> pageDataTypeExtensionPoint, AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneDataTypeExtensionPoint, ServiceExtensionPoint serviceExtensionPoint, AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneItemDataTypeExtensionPoint) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<GroupIdentity>	getAllowedGroups(String profileId) Gets the groups that have the given allowed profile on this ametys object
Set<String>	getAllowedProfilesForAnonymous() Gets the allowed profiles an anonymous user has on this ametys object
Set<String>	getAllowedProfilesForAnyConnectedUser() Gets the allowed profiles any connected user has on this ametys object
Map<GroupIdentity,Set<String>>	getAllowedProfilesForGroups() Gets the groups that have allowed profiles assigned on this ametys object
Set<String>	getAllowedProfilesForUser(UserIdentity user) Gets the allowed profiles assigned on this ametys object for this user
Map<UserIdentity,Set<String>>	getAllowedProfilesForUsers() Gets the users that have allowed profiles assigned on this ametys object
Set<UserIdentity>	getAllowedUsers(String profileId) Gets the users that have the given allowed profile on this ametys object
<A extends AmetysObject> A	getChild(String path) Retrieves a given child from its relative path.
Page	getChildPageAt(int index) Gets the child Page at the given position
AmetysObjectIterable<? extends AmetysObject>	getChildren() Retrieves children of the current object.
AmetysObjectIterable<? extends Page>	getChildrenPages() Retrieves child pages.
AmetysObjectIterable<? extends Page>	getChildrenPages(boolean includeInvisiblePage) Retrieves child pages.
ModelLessDataHolder	getDataHolder() Returns the DataHolder of this AmetysObject.
Set<GroupIdentity>	getDeniedGroups(String profileId) Gets the groups that have the given allowed profile on this ametys object
Set<String>	getDeniedProfilesForAnonymous() Gets the denied profiles an anonymous user has on this ametys object
Set<String>	getDeniedProfilesForAnyConnectedUser() Gets the denied profiles any connected user has on this ametys object
Map<GroupIdentity,Set<String>>	getDeniedProfilesForGroups() Gets the groups that have allowed profiles assigned on this ametys object
Set<String>	getDeniedProfilesForUser(UserIdentity user) Gets the denied profiles assigned on this ametys object for this user
Map<UserIdentity,Set<String>>	getDeniedProfilesForUsers() Gets the users that have denied profiles assigned on this ametys object
Set<UserIdentity>	getDeniedUsers(String profileId) Gets the users that have the given denied profile on this ametys object
int	getDepth() Get the page depth
String	getId() Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
String	getLongTitle() Retrieves the long title.
String	getName() Retrieves the name of the current object.
Page	getParent() Returns the parent object in the Ametys hierarchy.
String	getParentPath() Returns the path of the parent object in the Ametys hierarchy.
String	getPath() Retrieves the path of the current object.
String	getPathInSitemap() Computes the path relative to the current sitemap.
Set<String>	getReferers() Retrieves all AmetysObject ids referencing this page.
ResourceCollection	getRootAttachments() Retrieves the attachments root node
Site	getSite() Returns this object's site.
Sitemap	getSitemap() Retrieves the sitemap containing the current sitemap.
String	getSitemapName() Returns this page's sitemap name
String	getSiteName() Returns this object's site name.
Content	getSyncContent() Returns the associated synchronizable Content.
Set<String>	getTags() Retrieves current tags.
String	getTemplate() Retrieves the template name.
String	getTitle() Retrieves the title.
Page.PageType	getType() Retrieves the type.
String	getURL() Retrieves the linked URL.
Page.LinkType	getURLType() Retrieves the linked URL type.
Zone	getZone(String name) Retrieves a given zone.
AmetysObjectIterable<? extends Zone>	getZones() Retrieves the zones.
boolean	hasChild(String name) Tests if this Object has at least one child with the given name.
boolean	hasZone(String name) Determine if a zone exists
boolean	isVisible() Determine if the page is visible into navigation elements

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject

getComposite, getRepeater, getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, getDataNames

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

toSAX, toSAX

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

dataToSAX, dataToSAX, dataToSAX, dataToSAX

Field Detail

__UGC_PAGE_TEMPLATE

private static final String __UGC_PAGE_TEMPLATE

See Also:

Constant Field Values

_root

private Page _root

_title

private String _title

_resolver

private AmetysObjectResolver _resolver

_ugcPageHandler

private UGCPageHandler _ugcPageHandler

_skinsManager

private SkinsManager _skinsManager

_path

private String _path

_ugcContent

private Content _ugcContent

_pageDataTypeExtensionPoint

private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> _pageDataTypeExtensionPoint

_zoneDataTypeExtensionPoint

private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> _zoneDataTypeExtensionPoint

_serviceExtensionPoint

private ServiceExtensionPoint _serviceExtensionPoint

_zoneItemDataTypeExtensionPoint

private AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> _zoneItemDataTypeExtensionPoint

Constructor Detail

UGCPage

public UGCPage(Page root,
               Content syncContent,
               String path,
               AmetysObjectResolver resolver,
               UGCPageHandler ugcPageHandler,
               SkinsManager skinsManager,
               AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> pageDataTypeExtensionPoint,
               AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneDataTypeExtensionPoint,
               ServiceExtensionPoint serviceExtensionPoint,
               AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> zoneItemDataTypeExtensionPoint)

Constructor.

Parameters:

root - the root page.

syncContent - the synchronized content

path - the path

resolver - the AmetysObjectResolver.

ugcPageHandler - the ugc page handler

skinsManager - the skins manager

pageDataTypeExtensionPoint - the extension point with available data types for pages

zoneDataTypeExtensionPoint - the extension point with available data types for zones

serviceExtensionPoint - the service extension point

zoneItemDataTypeExtensionPoint - the extension point with available data types for zone items

Method Detail

getSyncContent

public Content getSyncContent()

Returns the associated synchronizable Content.

Returns:

the associated synchronizable Content.

getDepth

public int getDepth()
             throws AmetysRepositoryException

Description copied from interface: Page

Get the page depth

Specified by:

getDepth in interface Page

Returns:

the page depth

Throws:

AmetysRepositoryException - if an error occurs.

getReferers

public Set<String> getReferers()
                        throws AmetysRepositoryException

Description copied from interface: Page

Retrieves all AmetysObject ids referencing this page.

Specified by:

getReferers in interface Page

Returns:

the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

getRootAttachments

public ResourceCollection getRootAttachments()
                                      throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the attachments root node

Specified by:

getRootAttachments in interface Page

Returns:

The the attachments root node

Throws:

AmetysRepositoryException - if an error occurs.

getTemplate

public String getTemplate()
                   throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the template name.

Specified by:

getTemplate in interface Page

Returns:

the template name or null if none has been set.

Throws:

AmetysRepositoryException - if an error occurs.

getTitle

public String getTitle()
                throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the title.

Specified by:

getTitle in interface Page

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getLongTitle

public String getLongTitle()
                    throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the long title.

Specified by:

getLongTitle in interface Page

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getType

public Page.PageType getType()
                      throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the type.

Specified by:

getType in interface Page

Returns:

the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

Page.PageType

getURL

public String getURL()
              throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the linked URL.

Specified by:

getURL in interface Page

Returns:

the linked URL.

Throws:

AmetysRepositoryException - if an error occurs.

getURLType

public Page.LinkType getURLType()
                         throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the linked URL type.

Specified by:

getURLType in interface Page

Returns:

the linked URL type.

Throws:

AmetysRepositoryException - if an error occurs.

getZone

public Zone getZone(String name)
             throws UnknownZoneException,
                    AmetysRepositoryException

Description copied from interface: Page

Retrieves a given zone.

Specified by:

getZone in interface Page

Parameters:

name - the name of the zone.

Returns:

the given zone.

Throws:

UnknownZoneException - if there is no zone for the given name.

AmetysRepositoryException - if an error occurs.

getZones

public AmetysObjectIterable<? extends Zone> getZones()
                                              throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the zones.

Specified by:

getZones in interface Page

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

hasZone

public boolean hasZone(String name)
                throws AmetysRepositoryException

Description copied from interface: Page

Determine if a zone exists

Specified by:

hasZone in interface Page

Parameters:

name - The name of the zone

Returns:

true if the zone exists

Throws:

AmetysRepositoryException - If an error occured

getChildrenPages

public AmetysObjectIterable<? extends Page> getChildrenPages()
                                                      throws AmetysRepositoryException

Description copied from interface: PagesContainer

Retrieves child pages.

Specified by:

getChildrenPages in interface PagesContainer

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getPathInSitemap

public String getPathInSitemap()
                        throws AmetysRepositoryException

Description copied from interface: PagesContainer

Computes the path relative to the current sitemap.

Specified by:

getPathInSitemap in interface PagesContainer

Returns:

the path relative to the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getSite

public Site getSite()
             throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Specified by:

getSite in interface SiteAwareAmetysObject

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.

getSiteName

public String getSiteName()
                   throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Specified by:

getSiteName in interface SiteAwareAmetysObject

Returns:

this object's site name.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemap

public Sitemap getSitemap()
                   throws AmetysRepositoryException

Description copied from interface: PagesContainer

Retrieves the sitemap containing the current sitemap.

Specified by:

getSitemap in interface PagesContainer

Returns:

the sitemap containing the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemapName

public String getSitemapName()
                      throws AmetysRepositoryException

Description copied from interface: PagesContainer

Returns this page's sitemap name

Specified by:

getSitemapName in interface PagesContainer

Returns:

this page's sitemap name

Throws:

AmetysRepositoryException - if an error occurs.

getChild

public <A extends AmetysObject> A getChild(String path)
                                    throws AmetysRepositoryException,
                                           UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Specified by:

getChild in interface TraversableAmetysObject

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

getChildren

public AmetysObjectIterable<? extends AmetysObject> getChildren()
                                                         throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Specified by:

getChildren in interface TraversableAmetysObject

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Specified by:

hasChild in interface TraversableAmetysObject

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Specified by:

getId in interface AmetysObject

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getParent

public Page getParent()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Specified by:

getParentPath in interface AmetysObject

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

public ModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelLessDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getTags

public Set<String> getTags()
                    throws AmetysRepositoryException

Description copied from interface: TagAwareAmetysObject

Retrieves current tags.

Specified by:

getTags in interface TagAwareAmetysObject

Returns:

the current tags.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

public AmetysObjectIterable<? extends Page> getChildrenPages(boolean includeInvisiblePage)
                                                      throws AmetysRepositoryException

Description copied from interface: PagesContainer

Retrieves child pages.

Specified by:

getChildrenPages in interface PagesContainer

Parameters:

includeInvisiblePage - true to include invisible pages

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

isVisible

public boolean isVisible()
                  throws AmetysRepositoryException

Description copied from interface: Page

Determine if the page is visible into navigation elements

Specified by:

isVisible in interface Page

Returns:

true if the page is visible.

Throws:

AmetysRepositoryException - if an error occurs.

getChildPageAt

public Page getChildPageAt(int index)
                    throws UnknownAmetysObjectException,
                           AmetysRepositoryException

Description copied from interface: PagesContainer

Gets the child Page at the given position

Specified by:

getChildPageAt in interface PagesContainer

Parameters:

index - the position of the Page within the ordered set of its sibling objects.

Returns:

the Page if found

Throws:

UnknownAmetysObjectException - if no child page was found at this position

AmetysRepositoryException - if an error occurs

getAllowedProfilesForAnyConnectedUser

public Set<String> getAllowedProfilesForAnyConnectedUser()

Description copied from interface: ACLAmetysObject

Gets the allowed profiles any connected user has on this ametys object

Specified by:

getAllowedProfilesForAnyConnectedUser in interface ACLAmetysObject

Returns:

the allowed profiles any connected user has on this ametys object

getDeniedProfilesForAnyConnectedUser

public Set<String> getDeniedProfilesForAnyConnectedUser()

Description copied from interface: ACLAmetysObject

Gets the denied profiles any connected user has on this ametys object

Specified by:

getDeniedProfilesForAnyConnectedUser in interface ACLAmetysObject

Returns:

the denied profiles any connected user has on this ametys object

getAllowedProfilesForAnonymous

public Set<String> getAllowedProfilesForAnonymous()

Description copied from interface: ACLAmetysObject

Gets the allowed profiles an anonymous user has on this ametys object

Specified by:

getAllowedProfilesForAnonymous in interface ACLAmetysObject

Returns:

the allowed profiles an anonymous user has on this ametys object

getDeniedProfilesForAnonymous

public Set<String> getDeniedProfilesForAnonymous()

Description copied from interface: ACLAmetysObject

Gets the denied profiles an anonymous user has on this ametys object

Specified by:

getDeniedProfilesForAnonymous in interface ACLAmetysObject

Returns:

the denied profiles an anonymous user has on this ametys object

getAllowedProfilesForUser

public Set<String> getAllowedProfilesForUser(UserIdentity user)

Description copied from interface: ACLAmetysObject

Gets the allowed profiles assigned on this ametys object for this user

Specified by:

getAllowedProfilesForUser in interface ACLAmetysObject

Parameters:

user - The user identity

Returns:

The allowed profiles

getAllowedProfilesForUsers

public Map<UserIdentity,Set<String>> getAllowedProfilesForUsers()

Description copied from interface: ACLAmetysObject

Gets the users that have allowed profiles assigned on this ametys object

Specified by:

getAllowedProfilesForUsers in interface ACLAmetysObject

Returns:

The map of allowed users (keys) with their assigned profiles (values)

getAllowedUsers

public Set<UserIdentity> getAllowedUsers(String profileId)

Description copied from interface: ACLAmetysObject

Gets the users that have the given allowed profile on this ametys object

Specified by:

getAllowedUsers in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The allowed users with that profile on this ametys object

getAllowedProfilesForGroups

public Map<GroupIdentity,Set<String>> getAllowedProfilesForGroups()

Description copied from interface: ACLAmetysObject

Gets the groups that have allowed profiles assigned on this ametys object

Specified by:

getAllowedProfilesForGroups in interface ACLAmetysObject

Returns:

The map of allowed groups (keys) with their assigned profiles (values)

getAllowedGroups

public Set<GroupIdentity> getAllowedGroups(String profileId)

Description copied from interface: ACLAmetysObject

Gets the groups that have the given allowed profile on this ametys object

Specified by:

getAllowedGroups in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The allowed groups with that profile on that object

getDeniedProfilesForUser

public Set<String> getDeniedProfilesForUser(UserIdentity user)

Description copied from interface: ACLAmetysObject

Gets the denied profiles assigned on this ametys object for this user

Specified by:

getDeniedProfilesForUser in interface ACLAmetysObject

Parameters:

user - The user identity

Returns:

The denied profiles

getDeniedProfilesForUsers

public Map<UserIdentity,Set<String>> getDeniedProfilesForUsers()

Description copied from interface: ACLAmetysObject

Gets the users that have denied profiles assigned on this ametys object

Specified by:

getDeniedProfilesForUsers in interface ACLAmetysObject

Returns:

The map of denied users (keys) with their assigned profiles (values)

getDeniedUsers

public Set<UserIdentity> getDeniedUsers(String profileId)

Description copied from interface: ACLAmetysObject

Gets the users that have the given denied profile on this ametys object

Specified by:

getDeniedUsers in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The denied users with that profile on this ametys object

getDeniedProfilesForGroups

public Map<GroupIdentity,Set<String>> getDeniedProfilesForGroups()

Description copied from interface: ACLAmetysObject

Gets the groups that have allowed profiles assigned on this ametys object

Specified by:

getDeniedProfilesForGroups in interface ACLAmetysObject

Returns:

The map of denied groups (keys) with their assigned profiles (values)

getDeniedGroups

public Set<GroupIdentity> getDeniedGroups(String profileId)

Description copied from interface: ACLAmetysObject

Gets the groups that have the given allowed profile on this ametys object

Specified by:

getDeniedGroups in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The denied groups with that profile on this ametys object