Package org.ametys.web.repository.site

Class GetSitesAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.web.repository.site.GetSitesAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetAdminSitesAction, UserSitesAction

public class GetSitesAction
extends ServiceableAction

Action for getting the list of existing Site.

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysResolver	Ametys resolver
protected GroupDirectoryContextHelper	_groupDirectoryContextHelper	The group directory context helper
protected GroupDirectoryDAO	_groupDirectoryDAO	The group directory DAO
protected PopulationContextHelper	_populationContextHelper	The population context helper
protected RightManager	_rightManager	The rights manager
protected SiteColorsComponent	_siteColors	Handle site colors
protected SiteConfigurationManager	_siteConfigurationManager	Site configuration
protected SiteManager	_siteManager	The site manager
protected SiteTypesExtensionPoint	_siteTypeExtensionPoint	Site type EP
protected SkinsManager	_skinsManager	The skins manager
protected UserPopulationDAO	_userPopulationDAO	The user population DAO
protected CurrentUserProvider	_userProvider	The current user provider

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor	Description
GetSitesAction()

Method Summary

Modifier and Type	Method	Description
protected List<Map<String,Object>>	_childSites2json(Request request, Site site, String currentSiteName, int depth, boolean readAccessOnly, boolean sharedSitesOnly)	Child site to JSON
protected AmetysObjectIterable<Site>	_getRootSites(String id)	Get root sites
protected List<Map<String,Object>>	_rootSite2json(Request request, Site site, String currentSiteName, boolean recursive, boolean readAccessOnly, boolean sharedSitesOnly, UserIdentity user)	Retrieves the JSON for a root site
protected Map<String,Object>	_site2json(Site site)	Get the JSON representation of a site
protected Map<String,Object>	_site2json(Request request, Site site, String currentSiteName, int depth, boolean readAccessOnly, boolean sharedSitesOnly)	Site to JSON
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected boolean	canRead(Site site, Request request)	Determines if the current user has a read access on site
void	service(ServiceManager smanager)

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 Details

_siteManager

protected SiteManager _siteManager

The site manager

_rightManager

protected RightManager _rightManager

The rights manager

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_populationContextHelper

protected PopulationContextHelper _populationContextHelper

The population context helper

_groupDirectoryContextHelper

protected GroupDirectoryContextHelper _groupDirectoryContextHelper

The group directory context helper

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The user population DAO

_groupDirectoryDAO

protected GroupDirectoryDAO _groupDirectoryDAO

The group directory DAO

_siteTypeExtensionPoint

protected SiteTypesExtensionPoint _siteTypeExtensionPoint

Site type EP

_siteConfigurationManager

protected SiteConfigurationManager _siteConfigurationManager

Site configuration

_ametysResolver

protected AmetysObjectResolver _ametysResolver

Ametys resolver

_siteColors

protected SiteColorsComponent _siteColors

Handle site colors

_skinsManager

protected SkinsManager _skinsManager

The skins manager

Constructor Details

GetSitesAction

public GetSitesAction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
 SourceResolver resolver,
 Map objectModel,
 String source,
 Parameters parameters)
        throws Exception

Throws:

Exception

_getRootSites

protected AmetysObjectIterable<Site> _getRootSites(String id)

Get root sites

Parameters:

id - Optionnal root id

Returns:

Ametys iterable of sites

_rootSite2json

protected List<Map<String,Object>> _rootSite2json(Request request,
 Site site,
 String currentSiteName,
 boolean recursive,
 boolean readAccessOnly,
 boolean sharedSitesOnly,
 UserIdentity user)

Retrieves the JSON for a root site

Parameters:

request - The request

site - The root site

currentSiteName - The name of the current site

recursive - True to handle child sites

readAccessOnly - Only read access site

sharedSitesOnly - Only shared sites

user - The current user

Returns:

The root site info

_childSites2json

protected List<Map<String,Object>> _childSites2json(Request request,
 Site site,
 String currentSiteName,
 int depth,
 boolean readAccessOnly,
 boolean sharedSitesOnly)

Child site to JSON

Parameters:

request - The request

site - The root site

currentSiteName - The name of the current site

depth - The depth from the root site

readAccessOnly - Only read access site

sharedSitesOnly - Only shared sites

Returns:

The child sites info

_site2json

protected Map<String,Object> _site2json(Request request,
 Site site,
 String currentSiteName,
 int depth,
 boolean readAccessOnly,
 boolean sharedSitesOnly)

Site to JSON

Parameters:

request - The request

site - The root site

currentSiteName - The name of the current site

depth - The depth from the root site

readAccessOnly - Only read access site

sharedSitesOnly - Only shared sites

Returns:

The site info

_site2json

protected Map<String,Object> _site2json(Site site)

Get the JSON representation of a site

Parameters:

site - The site

Returns:

The site as JSON object

canRead

protected boolean canRead(Site site,
 Request request)

Determines if the current user has a read access on site

Parameters:

site - the site

request - the request

Returns:

true if current user has read access