org.alfresco.service.cmr.site
Interface SiteService

All Known Implementing Classes:

SiteServiceImpl

@PublicService
public interface SiteService

Site service fundamental API.

This service API is designed to support the public facing Site APIs

Method Summary

NodeRef	createContainer(java.lang.String shortName, java.lang.String componentId, QName containerType, java.util.Map containerProperties) Creates a container for a component is a site of the given container type (must be a sub-type of st:siteContainer)
SiteInfo	createSite(java.lang.String sitePreset, java.lang.String shortName, java.lang.String title, java.lang.String description, boolean isPublic) Deprecated. since version 3.2, replaced by SiteService.createSite(String, String, String, String, SiteVisibility)
SiteInfo	createSite(java.lang.String sitePreset, java.lang.String shortName, java.lang.String title, java.lang.String description, SiteVisibility visibility) Create a new site.
void	deleteSite(java.lang.String shortName) Delete the site.
NodeRef	getContainer(java.lang.String shortName, java.lang.String componentId) Gets the "container" folder for the specified component.
java.lang.String	getMembersRole(java.lang.String shortName, java.lang.String authorityName) Gets the role of the specified user.
SiteInfo	getSite(NodeRef nodeRef)
SiteInfo	getSite(java.lang.String shortName) Gets site information based on the short name of a site.
java.lang.String	getSiteGroup(java.lang.String shortName) Gets the sites group.
java.lang.String	getSiteRoleGroup(java.lang.String shortName, java.lang.String role) Gets the sites role group.
java.util.List	getSiteRoles() Gets a list of all the currently available roles that a user can perform on a site
boolean	hasContainer(java.lang.String shortName, java.lang.String componentId) Determines if a "container" folder for the specified component exists.
boolean	isMember(java.lang.String shortName, java.lang.String authorityName) Indicates whether an authority is a member of a site or not
java.util.Map	listMembers(java.lang.String shortName, java.lang.String nameFilter, java.lang.String roleFilter, int size) List the members of the site.
java.util.Map	listMembers(java.lang.String shortName, java.lang.String nameFilter, java.lang.String roleFilter, int size, boolean collapseGroups) List the members of the site.
java.util.List	listSites(java.lang.String userName) List all the sites that the specified user has a explicit membership to.
java.util.List	listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter) List the available sites.
java.util.List	listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter, int size) List the available sites.
void	removeMembership(java.lang.String shortName, java.lang.String authorityName) Clears an authorities role within a site
void	setMembership(java.lang.String shortName, java.lang.String authorityName, java.lang.String role) Sets the role of an authority within a site
void	updateSite(SiteInfo siteInfo) Update the site information.

Method Detail

createSite

SiteInfo createSite(java.lang.String sitePreset,
                    java.lang.String shortName,
                    java.lang.String title,
                    java.lang.String description,
                    boolean isPublic)

Deprecated. since version 3.2, replaced by SiteService.createSite(String, String, String, String, SiteVisibility)

Create a new site.

Parameters:

sitePreset - site preset name

shortName - site short name, must be unique

title - site title

description - site description

isPublic - whether the site is public or not (true = public, false = private)

Returns:

SiteInfo information about the created site

createSite

SiteInfo createSite(java.lang.String sitePreset,
                    java.lang.String shortName,
                    java.lang.String title,
                    java.lang.String description,
                    SiteVisibility visibility)

Create a new site.

Parameters:

sitePreset - site preset name

shortName - site short name, must be unique

title - site title

description - site description

visibility - site visibility (public|moderated|private)

Returns:

SiteInfo information about the created site

listSites

java.util.List listSites(java.lang.String nameFilter,
                         java.lang.String sitePresetFilter,
                         int size)

List the available sites. This list can optionally be filtered by site name and/or site preset.

Parameters:

nameFilter - name filter

sitePresetFilter - site preset filter

size - list maximum size or zero for all

Returns:

List list of site information

listSites

java.util.List listSites(java.lang.String nameFilter,
                         java.lang.String sitePresetFilter)

List the available sites. This list can optionally be filtered by site name and/or site preset.

Parameters:

nameFilter - name filter

sitePresetFilter - site preset filter

Returns:

List list of site information

listSites

java.util.List listSites(java.lang.String userName)

List all the sites that the specified user has a explicit membership to.

Parameters:

userName - user name

Returns:

List list of site information

getSite

SiteInfo getSite(java.lang.String shortName)

Gets site information based on the short name of a site.

Returns null if the site can not be found.

Parameters:

shortName - the site short name

Returns:

SiteInfo the site information

getSite

SiteInfo getSite(NodeRef nodeRef)

Parameters:

nodeRef -

Returns:

updateSite

void updateSite(SiteInfo siteInfo)

Update the site information.

Note that the short name and site preset of a site can not be updated once the site has been created.

Parameters:

siteInfo - site information

deleteSite

void deleteSite(java.lang.String shortName)

Delete the site.

Parameters:

shortName - site short name

listMembers

java.util.Map listMembers(java.lang.String shortName,
                          java.lang.String nameFilter,
                          java.lang.String roleFilter,
                          int size)

List the members of the site. This includes both users and groups.

Name and role filters are optional and if not specified all the members of the site are returned.

Parameters:

shortName - site short name

nameFilter - name filter

roleFilter - role filter

size - max results size crop if >0

Returns:

Map the authority name and their role

listMembers

java.util.Map listMembers(java.lang.String shortName,
                          java.lang.String nameFilter,
                          java.lang.String roleFilter,
                          int size,
                          boolean collapseGroups)

List the members of the site. This includes both users and groups if collapseGroups is set to false, otherwise all groups that are members are collapsed into their component users and listed.

Parameters:

shortName - site short name

nameFilter - name filter

roleFilter - role filter

size - max results size crop if >0

collapseGroups - true if collapse member groups into user list, false otherwise

Returns:

Map the authority name and their role

getMembersRole

java.lang.String getMembersRole(java.lang.String shortName,
                                java.lang.String authorityName)

Gets the role of the specified user.

Parameters:

shortName - site short name

authorityName - full authority name (so if it's a group then its prefixed with 'GROUP_')

Returns:

String site role, null if none

isMember

boolean isMember(java.lang.String shortName,
                 java.lang.String authorityName)

Indicates whether an authority is a member of a site or not

Parameters:

shortName - site short name

authorityName - authority name (so if it's a group then its prefixed with 'GROUP_')

Returns:

boolean true if the authority is a member of the site, false otherwise

setMembership

void setMembership(java.lang.String shortName,
                   java.lang.String authorityName,
                   java.lang.String role)

Sets the role of an authority within a site

Parameters:

shortName - site short name

authorityName - authority name (so if it's a group then its prefixed with 'GROUP_')

role - site role

removeMembership

void removeMembership(java.lang.String shortName,
                      java.lang.String authorityName)

Clears an authorities role within a site

Parameters:

shortName - site short name

authorityName - authority name (so if it's a group then its prefixed with 'GROUP_')

createContainer

NodeRef createContainer(java.lang.String shortName,
                        java.lang.String componentId,
                        QName containerType,
                        java.util.Map containerProperties)

Creates a container for a component is a site of the given container type (must be a sub-type of st:siteContainer)

If no container type is specified then a node of type st:siteContainer is created.

The map of container properties are set on the created container node. Null can be provided when no properties need to be set.

Parameters:

shortName - site short name

componentId - component id

containerType - container type to create (can be null)

containerProperties - container property values (can be null)

Returns:

noderef of container or null if a container can't be created.

getContainer

NodeRef getContainer(java.lang.String shortName,
                     java.lang.String componentId)

Gets the "container" folder for the specified component.

Parameters:

shortName - short name of site

componentId - component id

folderType - type of folder to create (if null, creates standard folder)

Returns:

noderef of container

hasContainer

boolean hasContainer(java.lang.String shortName,
                     java.lang.String componentId)

Determines if a "container" folder for the specified component exists.

Parameters:

shortName - short name of site

componentId - component id

Returns:

true => "container" folder exists for component

getSiteRoles

java.util.List getSiteRoles()

Gets a list of all the currently available roles that a user can perform on a site

Returns:

List list of available roles

getSiteGroup

java.lang.String getSiteGroup(java.lang.String shortName)

Gets the sites group. All members of the site are contained within this group.

Parameters:

shortName - site short name

Returns:

String group name

getSiteRoleGroup

java.lang.String getSiteRoleGroup(java.lang.String shortName,
                                  java.lang.String role)

Gets the sites role group. All members assigned the given role will be memebers of the returned group.

Parameters:

shortName - site short name

role - membership role

Returns:

String group name