org.ametys.web.repository.site

Class SiteManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.repository.site.SiteManager

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

public class SiteManager
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

Helper component for managing sites.

Field Summary

Fields

Modifier and Type	Field and Description
private AdminSessionProvider	_adminSessionProvider
private Context	_context
private CopySiteComponent	_copySiteComponent
private CurrentUserProvider	_currentUserProvider
private PopulationContextHelper	_populationContextHelper
private Repository	_repository
private AmetysObjectResolver	_resolver
private RightManager	_rightManager
private SynchronizeComponent	_synchronizeComponent
private WorkspaceSelector	_workspaceSelector
static String	ROLE Avalon Role
static String	ROOT_SITES sites root's JCR node name
static String	ROOT_SITES_PATH sites root's JCR path
static String	SITES_KEY Constant for storing the sites cache in request attribute.

Constructor Summary

Constructors

Constructor and Description
SiteManager()

Method Summary

Modifier and Type	Method and Description
private Request	_getRequest()
private Site	_getSite(String siteName)
private boolean	_hasSite(String siteName)
void	clearCache() Clear the site cache
void	contextualize(Context context)
Site	copySite(Site site, String siteName) Creates a site with the given name, from another site to copy
Site	copySite(Site site, String parentId, String siteName) Creates a site with the given name, from another site to copy
Site	createSite(String siteName) Creates a site with the given name.
Site	createSite(String siteName, String parentId) Creates a site with the given name.
Set<String>	getGrantedSites() Get the granted site names for the current user
Set<String>	getGrantedSites(UserIdentity user) Get the granted site names for user
ModifiableTraversableAmetysObject	getRoot() Returns the root for sites.
Collection<String>	getRootSiteNames() Returns the sites names.
AmetysObjectIterable<Site>	getRootSites() Returns the root sites.
Site	getSite(String siteName) Returns the named Site.
Collection<String>	getSiteNames() Returns the sites names.
AmetysObjectIterable<Site>	getSites() Returns the all sites.
boolean	hasSite(String siteName) Returns true if the given site exists.
boolean	isGrantedSite(UserIdentity user, String siteName) Determines if the user has granted access to the site
void	service(ServiceManager manager)

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

Avalon Role

SITES_KEY

public static final String SITES_KEY

Constant for storing the sites cache in request attribute.

ROOT_SITES

public static final String ROOT_SITES

sites root's JCR node name

See Also:

Constant Field Values

ROOT_SITES_PATH

public static final String ROOT_SITES_PATH

sites root's JCR path

See Also:

Constant Field Values

_resolver

private AmetysObjectResolver _resolver

_repository

private Repository _repository

_adminSessionProvider

private AdminSessionProvider _adminSessionProvider

_synchronizeComponent

private SynchronizeComponent _synchronizeComponent

_copySiteComponent

private CopySiteComponent _copySiteComponent

_workspaceSelector

private WorkspaceSelector _workspaceSelector

_rightManager

private RightManager _rightManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_populationContextHelper

private PopulationContextHelper _populationContextHelper

_context

private Context _context

Constructor Detail

SiteManager

public SiteManager()

Method Detail

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

_getRequest

private Request _getRequest()

getRootSiteNames

public Collection<String> getRootSiteNames()

Returns the sites names.

Returns:

the sites names.

getSiteNames

public Collection<String> getSiteNames()

Returns the sites names.

Returns:

the sites names.

getGrantedSites

public Set<String> getGrantedSites()

Get the granted site names for the current user

Returns:

The name of sites the current user can access

getGrantedSites

public Set<String> getGrantedSites(UserIdentity user)

Get the granted site names for user

Parameters:

user - The user

Returns:

The name of sites the user can access

isGrantedSite

public boolean isGrantedSite(UserIdentity user,
                             String siteName)

Determines if the user has granted access to the site

Parameters:

user - The user

siteName - The site name

Returns:

true if the user can access to the site

getRoot

public ModifiableTraversableAmetysObject getRoot()

Returns the root for sites.

Returns:

the root for sites.

getRootSites

public AmetysObjectIterable<Site> getRootSites()

Returns the root sites.

Returns:

the root sites.

getSites

public AmetysObjectIterable<Site> getSites()

Returns the all sites.

Returns:

the all sites.

createSite

public Site createSite(String siteName,
                       String parentId)
                throws RepositoryIntegrityViolationException

Creates a site with the given name.

Parameters:

siteName - the site name.

parentId - the id of the parent site. Can be null.

Returns:

the newly created Site.

Throws:

RepositoryIntegrityViolationException - if the named site already exists.

createSite

public Site createSite(String siteName)
                throws RepositoryIntegrityViolationException

Creates a site with the given name.

Parameters:

siteName - the site name.

Returns:

the newly created Site.

Throws:

RepositoryIntegrityViolationException - if the named site already exists.

copySite

public Site copySite(Site site,
                     String siteName)
              throws RepositoryIntegrityViolationException

Creates a site with the given name, from another site to copy

Parameters:

site - the site to be copied

siteName - the site name

Returns:

the newly created Site.

Throws:

RepositoryIntegrityViolationException - if the named site already exists.

copySite

public Site copySite(Site site,
                     String parentId,
                     String siteName)
              throws RepositoryIntegrityViolationException

Creates a site with the given name, from another site to copy

Parameters:

site - the site to be copied

parentId - the id of the parent site. Can be null.

siteName - the site name

Returns:

the newly created Site.

Throws:

RepositoryIntegrityViolationException - if the named site already exists.

hasSite

public boolean hasSite(String siteName)

Returns true if the given site exists.

Parameters:

siteName - the site name.

Returns:

true if the given site exists.

_hasSite

private boolean _hasSite(String siteName)

getSite

public Site getSite(String siteName)
             throws UnknownAmetysObjectException

Returns the named Site.

Parameters:

siteName - the site name.

Returns:

the named Site.

Throws:

UnknownAmetysObjectException - if the named site does not exist.

clearCache

public void clearCache()

Clear the site cache

_getSite

private Site _getSite(String siteName)
               throws UnknownAmetysObjectException

Throws:

UnknownAmetysObjectException