Package org.alfresco.rest.api.impl

Class SitesImpl

java.lang.Object

org.alfresco.rest.api.impl.SitesImpl

All Implemented Interfaces:

Sites

public class SitesImpl
extends Object
implements Sites

Centralises access to site services and maps between representations.

Since:

publicapi1.0

Author:

steveglover, janv

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorityService	authorityService
protected org.alfresco.service.cmr.dictionary.DictionaryService	dictionaryService
protected FavouritesService	favouritesService
protected ImporterService	importerService
protected Nodes	nodes
protected NodeService	nodeService
protected People	people
protected PermissionService	permissionService
protected PreferenceService	preferenceService
protected SiteService	siteService
protected SiteServiceImpl	siteServiceImpl
protected SiteSurfConfig	siteSurfConfig

Fields inherited from interface org.alfresco.rest.api.Sites

PARAM_PERMANENT, PARAM_PRESET, PARAM_SITE_DESCRIPTION, PARAM_SITE_ID, PARAM_SITE_ROLE, PARAM_SITE_TITLE, PARAM_SKIP_ADDTOFAVORITES, PARAM_SKIP_SURF_CONFIGURATION, PARAM_VISIBILITY

Constructor Summary

Constructors

Constructor	Description
SitesImpl()

Method Summary

Modifier and Type	Method	Description
void	addFavouriteSite(String personId, FavouriteSite favouriteSite)
SiteGroup	addSiteGroupMembership(String siteId, SiteGroup group)
SiteMember	addSiteMember(String siteId, SiteMember siteMember)
protected SiteInfo	createSite(Site site)	Uses site service for creating site info Extracted this call in a separate method because it might be needed to call different site service method when creating site info (e.g.
Site	createSite(Site site, Parameters parameters)	Create default/fixed preset (Share) site - with DocLib container/component
void	deleteSite(String siteId, Parameters parameters)
AuthorityService	getAuthorityService()
FavouriteSite	getFavouriteSite(String personId, String siteId)
CollectionWithPagingInfo<FavouriteSite>	getFavouriteSites(String personId, Parameters parameters)
MemberOfSite	getMemberOfSite(String personId, String siteId)	people//sites/
Site	getSite(String siteId)
Site	getSite(String siteId, boolean includeRole)
SiteContainer	getSiteContainer(String siteId, String containerId)
org.alfresco.query.PagingResults<SiteContainer>	getSiteContainers(String siteId, Paging paging)
SiteGroup	getSiteGroupMembership(String siteId, String groupId)
CollectionWithPagingInfo<SiteGroup>	getSiteGroupMemberships(String siteId, Parameters parameters)
SiteMember	getSiteMember(String personId, String siteId)
CollectionWithPagingInfo<SiteMember>	getSiteMembers(String siteId, Parameters parameters)
String	getSiteRole(String siteId)
String	getSiteRole(String siteId, String personId)
CollectionWithPagingInfo<MemberOfSite>	getSites(String personId, Parameters parameters)
CollectionWithPagingInfo<Site>	getSites(Parameters parameters)
void	removeFavouriteSite(String personId, String siteId)
void	removeSiteGroupMembership(String siteId, String groupId)
void	removeSiteMember(String personId, String siteId)
void	setAuthorityService(AuthorityService authorityService)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setFavouritesService(FavouritesService favouritesService)
void	setImporterService(ImporterService importerService)
void	setNodes(Nodes nodes)
void	setNodeService(NodeService nodeService)
void	setPeople(People people)
void	setPermissionService(PermissionService permissionService)
void	setPreferenceService(PreferenceService preferenceService)
void	setSiteService(SiteService siteService)
void	setSiteServiceImpl(SiteServiceImpl siteServiceImpl)
void	setSiteSurfConfig(SiteSurfConfig siteSurfConfig)
Site	updateSite(String siteId, SiteUpdate update, Parameters parameters)
SiteGroup	updateSiteGroupMembership(String siteId, SiteGroup group)
SiteMember	updateSiteMember(String siteId, SiteMember siteMember)
SiteInfo	validateSite(String siteId)
protected Site	validateSite(Site site)
SiteInfo	validateSite(NodeRef guid)

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected Nodes nodes

people

protected People people

nodeService

protected NodeService nodeService

dictionaryService

protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService

siteService

protected SiteService siteService

favouritesService

protected FavouritesService favouritesService

preferenceService

protected PreferenceService preferenceService

importerService

protected ImporterService importerService

siteSurfConfig

protected SiteSurfConfig siteSurfConfig

permissionService

protected PermissionService permissionService

siteServiceImpl

protected SiteServiceImpl siteServiceImpl

authorityService

protected AuthorityService authorityService

Constructor Detail

SitesImpl

public SitesImpl()

Method Detail

setPreferenceService

public void setPreferenceService(PreferenceService preferenceService)

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setNodes

public void setNodes(Nodes nodes)

setFavouritesService

public void setFavouritesService(FavouritesService favouritesService)

setPeople

public void setPeople(People people)

setNodeService

public void setNodeService(NodeService nodeService)

setSiteService

public void setSiteService(SiteService siteService)

setImporterService

public void setImporterService(ImporterService importerService)

setSiteSurfConfig

public void setSiteSurfConfig(SiteSurfConfig siteSurfConfig)

setPermissionService

public void setPermissionService(PermissionService permissionService)

setSiteServiceImpl

public void setSiteServiceImpl(SiteServiceImpl siteServiceImpl)

getAuthorityService

public AuthorityService getAuthorityService()

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

validateSite

public SiteInfo validateSite(NodeRef guid)

Specified by:

validateSite in interface Sites

validateSite

public SiteInfo validateSite(String siteId)

Specified by:

validateSite in interface Sites

getSiteMembers

public CollectionWithPagingInfo<SiteMember> getSiteMembers(String siteId,
                                                           Parameters parameters)

Specified by:

getSiteMembers in interface Sites

getSiteRole

public String getSiteRole(String siteId)

Specified by:

getSiteRole in interface Sites

getSiteRole

public String getSiteRole(String siteId,
                          String personId)

Specified by:

getSiteRole in interface Sites

getSite

public Site getSite(String siteId)

Specified by:

getSite in interface Sites

getSite

public Site getSite(String siteId,
                    boolean includeRole)

getMemberOfSite

public MemberOfSite getMemberOfSite(String personId,
                                    String siteId)

people//sites/

Specified by:

getMemberOfSite in interface Sites

Parameters:

siteId - String

personId - String

Returns:

MemberOfSite

getSiteMember

public SiteMember getSiteMember(String personId,
                                String siteId)

Specified by:

getSiteMember in interface Sites

addSiteMember

public SiteMember addSiteMember(String siteId,
                                SiteMember siteMember)

Specified by:

addSiteMember in interface Sites

removeSiteMember

public void removeSiteMember(String personId,
                             String siteId)

Specified by:

removeSiteMember in interface Sites

updateSiteMember

public SiteMember updateSiteMember(String siteId,
                                   SiteMember siteMember)

Specified by:

updateSiteMember in interface Sites

getSites

public CollectionWithPagingInfo<MemberOfSite> getSites(String personId,
                                                       Parameters parameters)

Specified by:

getSites in interface Sites

getSiteContainer

public SiteContainer getSiteContainer(String siteId,
                                      String containerId)

Specified by:

getSiteContainer in interface Sites

getSiteContainers

public org.alfresco.query.PagingResults<SiteContainer> getSiteContainers(String siteId,
                                                                         Paging paging)

Specified by:

getSiteContainers in interface Sites

getSites

public CollectionWithPagingInfo<Site> getSites(Parameters parameters)

Specified by:

getSites in interface Sites

getFavouriteSite

public FavouriteSite getFavouriteSite(String personId,
                                      String siteId)

Specified by:

getFavouriteSite in interface Sites

addFavouriteSite

public void addFavouriteSite(String personId,
                             FavouriteSite favouriteSite)

Specified by:

addFavouriteSite in interface Sites

removeFavouriteSite

public void removeFavouriteSite(String personId,
                                String siteId)

Specified by:

removeFavouriteSite in interface Sites

getFavouriteSites

public CollectionWithPagingInfo<FavouriteSite> getFavouriteSites(String personId,
                                                                 Parameters parameters)

Specified by:

getFavouriteSites in interface Sites

deleteSite

public void deleteSite(String siteId,
                       Parameters parameters)

Specified by:

deleteSite in interface Sites

createSite

protected SiteInfo createSite(Site site)

Uses site service for creating site info Extracted this call in a separate method because it might be needed to call different site service method when creating site info (e.g. siteService.createSite(String, String, String, String, SiteVisibility, QName))

Parameters:

site -

Returns:

createSite

public Site createSite(Site site,
                       Parameters parameters)

Create default/fixed preset (Share) site - with DocLib container/component

Specified by:

createSite in interface Sites

Parameters:

site -

Returns:

updateSite

public Site updateSite(String siteId,
                       SiteUpdate update,
                       Parameters parameters)

Specified by:

updateSite in interface Sites

validateSite

protected Site validateSite(Site site)

getSiteGroupMemberships

public CollectionWithPagingInfo<SiteGroup> getSiteGroupMemberships(String siteId,
                                                                   Parameters parameters)

Specified by:

getSiteGroupMemberships in interface Sites

addSiteGroupMembership

public SiteGroup addSiteGroupMembership(String siteId,
                                        SiteGroup group)

Specified by:

addSiteGroupMembership in interface Sites

getSiteGroupMembership

public SiteGroup getSiteGroupMembership(String siteId,
                                        String groupId)

Specified by:

getSiteGroupMembership in interface Sites

updateSiteGroupMembership

public SiteGroup updateSiteGroupMembership(String siteId,
                                           SiteGroup group)

Specified by:

updateSiteGroupMembership in interface Sites

removeSiteGroupMembership

public void removeSiteGroupMembership(String siteId,
                                      String groupId)

Specified by:

removeSiteGroupMembership in interface Sites