SiteService (Alfresco 5.1.4.1 Public Java API)

org.alfresco.service.cmr.site

Interface SiteService

@org.alfresco.api.AlfrescoPublicApi
public interface SiteService

Site service fundamental API.

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

Field Summary
String	DOCUMENT_LIBRARY

Method Summary
boolean	canAddMember(String shortName, String authorityName, String role) Can the current user add the authority "authorityName" to the site "shortName" with role "role"?
void	cleanSitePermissions(NodeRef relocatedNode, SiteInfo containingSite) This method cleans the permissions on the specified node.
int	countAuthoritiesWithRole(String shortName, String role)
NodeRef	createContainer(String shortName, String componentId, QName containerType, Map<QName,Serializable> 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(String sitePreset, String shortName, String title, String description, boolean isPublic) Deprecated. since version 3.2, replaced by createSite(String, String, String, String, SiteVisibility)
SiteInfo	createSite(String sitePreset, String shortName, String title, String description, SiteVisibility visibility) Create a new site.
SiteInfo	createSite(String sitePreset, String shortName, String title, String description, SiteVisibility visibility, QName siteType) Create a new site.
void	deleteSite(String shortName) Delete the site.
List<SiteInfo>	findSites(String filter, int size) This method will find all sites available to the currently authenticated user based on the specified site filter and result set size.
List<SiteInfo>	findSites(String filter, String sitePresetFilter, int size) This method will find all sites available to the currently authenticated user based on the specified site filter, site preset filter and result set size.
NodeRef	getContainer(String shortName, String componentId) Gets the "container" folder for the specified component.
String	getMembersRole(String shortName, String authorityName)
SiteMemberInfo	getMembersRoleInfo(String shortName, String authorityName) Gets the extended role information of the specified user.
SiteInfo	getSite(NodeRef nodeRef) This method gets the SiteInfo for the Share Site which contains the given NodeRef.
SiteInfo	getSite(String shortName) Gets site information based on the short name of a site.
String	getSiteGroup(String shortName) Gets the sites group.
String	getSiteRoleGroup(String shortName, String role) Gets the sites role group.
List<String>	getSiteRoles() Gets a list of all the currently available roles that a user can perform on all sites
List<String>	getSiteRoles(String shortName) Gets a list of all the currently available roles that a user can perform on a specific site.
NodeRef	getSiteRoot() Gets the reference to the folder that is the Site root node.
String	getSiteShortName(NodeRef nodeRef) This method gets the shortName for the Share Site which contains the given NodeRef.
boolean	hasContainer(String shortName, String componentId) Determines if a "container" folder for the specified component exists.
boolean	hasCreateSitePermissions() This method checks if the currently authenticated user has permission to create sites.
boolean	hasSite(String shortName) Returns true if the site exists.
boolean	isMember(String shortName, String authorityName) Indicates whether an authority is a member of a site or not
boolean	isSiteAdmin(String userName) Indicates whether the specified user is a site administrator or not.
PagingResults<FileInfo>	listContainers(String shortName, PagingRequest pagingRequest) Returns a paged list of top level containers for the site
void	listMembers(String shortName, String nameFilter, String roleFilter, boolean collapseGroups, org.alfresco.service.cmr.site.SiteService.SiteMembersCallback callback) List the members of the site.
Map<String>	listMembers(String shortName, String nameFilter, String roleFilter, int size) List the members of the site.
Map<String>	listMembers(String shortName, String nameFilter, String roleFilter, int size, boolean collapseGroups) List the members of the site.
List<SiteMemberInfo>	listMembersInfo(String shortName, String nameFilter, String roleFilter, int size, boolean collapseGroups) List the members of the site.
PagingResults<org.alfresco.repo.site.SiteMembership>	listMembersPaged(String shortName, boolean collapseGroups, List<Pair<org.alfresco.service.cmr.site.SiteService.SortFields,Boolean>> sortProps, PagingRequest pagingRequest) Gets the role of the specified user.
List<org.alfresco.repo.site.SiteMembership>	listSiteMemberships(String userName, int size) Lists all the memberships in sites that the specified user is in.
PagingResults<SiteInfo>	listSites(List<org.alfresco.repo.node.getchildren.FilterProp> filterProps, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest) This method returns paged result sets of SiteInfo objects, which should be more efficient than the unpaged methods also available on this interface.
List<SiteInfo>	listSites(String userName) List all the sites that the specified user has a explicit membership to.
List<SiteInfo>	listSites(String userName, int size) List all the sites that the specified user has a explicit membership to.
List<SiteInfo>	listSites(String filter, String sitePresetFilter) List the available sites.
List<SiteInfo>	listSites(String filter, String sitePresetFilter, int size) List the available sites.
PagingResults<org.alfresco.repo.site.SiteMembership>	listSitesPaged(String userName, List<Pair<org.alfresco.service.cmr.site.SiteService.SortFields,Boolean>> sortProps, PagingRequest pagingRequest) List all the sites that the specified user has a explicit membership to.
void	removeMembership(String shortName, String authorityName) Clears an authorities role within a site
String	resolveSite(String group)
void	setMembership(String shortName, String authorityName, String role) Sets the role of an authority within a site
void	updateSite(SiteInfo siteInfo) Update the site information.

public static final String DOCUMENT_LIBRARY

@Auditable(parameters={
  "sitePreset",
  "shortName"
})
SiteInfo createSite(String sitePreset,
                    String shortName,
                    String title,
                    String description,
                    boolean isPublic)

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

sitePreset - site preset name

shortName - site short name, must be unique

description - site description

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

SiteInfo information about the created site

@NotAuditable
boolean canAddMember(String shortName,
String authorityName,
String role)

Can the current user add the authority "authorityName" to the site "shortName" with role "role"?

shortName - site short name, must be unique

authorityName - authority to add

true if the current user can add the authority to the site, false otherwise

@Auditable(parameters={
  "sitePreset",
  "shortName"
})
SiteInfo createSite(String sitePreset,
                    String shortName,
                    String title,
                    String description,
                    SiteVisibility visibility)

sitePreset - site preset name

shortName - site short name, must be unique

description - site description

visibility - site visibility (public|moderated|private)

SiteInfo information about the created site

sitePreset - site preset name

shortName - site short name, must be unique

description - site description

visibility - site visibility (public|moderated|private)

siteType - type of site to create, must be a sub-type of st:site

SiteInfo information about the created site

hasCreateSitePermissions

@NotAuditable
boolean hasCreateSitePermissions()

This method checks if the currently authenticated user has permission to create sites.

true if current user can create sites, else false.

@NotAuditable
List<SiteInfo> findSites(String filter,
String sitePresetFilter,
int size)

This method will find all sites available to the currently authenticated user based on the specified site filter, site preset filter and result set size. The filter parameter will match any sites whose cm:name, cm:title or cm:description contain the specified string (ignoring case).

Note that this method uses Alfresco Full Text Search to retrieve results and depending on server Lucene, SOLR configuration may only offer eventually consistent results.

filter - Any supplied filter will be wrapped in asterisks (e.g. '*foo*') and used to match the sites' cm:name, cm:title or cm:description.

sitePresetFilter - a site preset filter name to match against.

size - this parameter specifies a maximum result set size.

Site objects for all matching sites up to the maximum result size.

@NotAuditable
List<SiteInfo> findSites(String filter,
int size)

This method will find all sites available to the currently authenticated user based on the specified site filter and result set size. The filter parameter will match any sites whose cm:name, cm:title or cm:description contain the specified string (ignoring case).

Note that this method uses Alfresco Full Text Search to retrieve results and depending on server Lucene, SOLR configuration may only offer eventually consistent results.

filter - Any supplied filter will be wrapped in asterisks (e.g. 'foo*') and used to match the sites' cm:name, cm:title or cm:description.

size - this parameter specifies a maximum result set size.

Site objects for all matching sites up to the maximum result size.

@NotAuditable
List<SiteInfo> listSites(String filter,
String sitePresetFilter,
int size)

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

Note: Starting with Alfresco 4.0, the filter parameter will only match sites whose cm:name or cm:title or cm:description start with the specified string (ignoring case). The listing of sites whose cm:names (or titles or descriptions) contain the specified string is no longer supported. To retrieve sites whose cm:names etc contain a substring, findSites(String, String, int) should be used instead.

THIS METHOD CAN RETURN INCOMPLETE RESULTS WHILE CACHES CATCH UP WITH REALITY (BM-0012: Run v420b1494_01: (CMIS) GetSites is Slow).

filter - filter (sites whose cm:name, cm:title or cm:description START WITH filter)

sitePresetFilter - site preset filter (sites whose preset EQUALS sitePresetFilter)

size - list maximum size or zero for all

List list of site information

@NotAuditable
List<SiteInfo> listSites(String filter,
String sitePresetFilter)

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

sitePresetFilter - site preset filter

List list of site information

@NotAuditable
List<SiteInfo> listSites(String userName)

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

userName - user name

List list of site information

@NotAuditable
PagingResults<SiteInfo> listSites(List<org.alfresco.repo.node.getchildren.FilterProp> filterProps,
List<Pair<QName,Boolean>> sortProps,
PagingRequest pagingRequest)

This method returns paged result sets of SiteInfo objects, which should be more efficient than the unpaged methods also available on this interface. It is also guaranteed to return fully consistent results.

filterProps - property filters

sortProps - sorting options

pagingRequest - paging options

a page of SiteInfo objects.

@NotAuditable
List<org.alfresco.repo.site.SiteMembership> listSiteMemberships(String userName,
int size)

Lists all the memberships in sites that the specified user is in.

size - list maximum size or zero for all

a list of SiteMembership objects

@NotAuditable
List<SiteInfo> listSites(String userName,
int size)

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

userName - user name

size - list maximum size or zero for all

List list of site information

@NotAuditable
SiteInfo getSite(String shortName)

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

Returns null if the site can not be found.

shortName - the site short name

SiteInfo the site information

@NotAuditable
SiteInfo getSite(NodeRef nodeRef)

This method gets the SiteInfo for the Share Site which contains the given NodeRef. If the given NodeRef is not contained within a Share Site, then null is returned.

nodeRef - the node whose containing site's info is to be found.

SiteInfo site information for the containing site or null if node is not in a site.

@NotAuditable
String getSiteShortName(NodeRef nodeRef)

This method gets the shortName for the Share Site which contains the given NodeRef. If the given NodeRef is not contained within a Share Site, then null is returned.

nodeRef - the node whose containing site's info is to be found.

String site short name for the containing site or null if node is not in a site.

@NotAuditable
boolean hasSite(String shortName)

Returns true if the site exists. This allows create scripts to confirm the existence of private sites - they would not normally be returned from getSite() if the user does not have permission on the site noderef.

shortName - the site short name

true if the site exists, false otherwise

@Auditable
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.

siteInfo - site information

@Auditable(parameters="shortName")
void deleteSite(String shortName)

shortName - site short name

@NotAuditable
void listMembers(String shortName,
                 String nameFilter,
                 String roleFilter,
                 boolean collapseGroups,
                 org.alfresco.service.cmr.site.SiteService.SiteMembersCallback callback)

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.

shortName - site short name

nameFilter - name filter

roleFilter - role filter

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

@NotAuditable
Map<String> listMembers(String shortName,
                        String nameFilter,
                        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.

shortName - site short name

nameFilter - name filter

roleFilter - role filter

size - max results size crop if >0

the authority name and their role

@NotAuditable
Map<String> listMembers(String shortName,
                        String nameFilter,
                        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.

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

the authority name and their role

@NotAuditable
List<SiteMemberInfo> listMembersInfo(String shortName,
                                     String nameFilter,
                                     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.

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

List of site authorities’ information objects

@NotAuditable
PagingResults<org.alfresco.repo.site.SiteMembership> listMembersPaged(String shortName,
                                                                      boolean collapseGroups,
                                                                      List<Pair<org.alfresco.service.cmr.site.SiteService.SortFields,Boolean>> sortProps,
                                                                      PagingRequest pagingRequest)

Gets the role of the specified user. Returns a paged list of 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.

shortName - site short name

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

pagingRequest - the paging request

the authority name and their role

@NotAuditable
SiteMemberInfo getMembersRoleInfo(String shortName,
String authorityName)

Gets the extended role information of the specified user.

shortName - site short name

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

SiteMemberInfo site role information, null if none

@NotAuditable
boolean isMember(String shortName,
String authorityName)

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

shortName - site short name

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

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

@Auditable(parameters={
  "shortName",
  "authorityName",
  "role"
})
void setMembership(String shortName,
                   String authorityName,
                   String role)

Sets the role of an authority within a site

shortName - site short name

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

org.alfresco.repo.security.authority.UnknownAuthorityException - if the site role is not supported.

@Auditable(parameters={
  "shortName",
  "authorityName"
})
void removeMembership(String shortName,
                      String authorityName)

Clears an authorities role within a site

shortName - site short name

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

@NotAuditable
NodeRef createContainer(String shortName,
                        String componentId,
                        QName containerType,
                        Map<QName,Serializable> 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.

shortName - site short name

componentId - component id

containerType - container type to create (can be null)

containerProperties - container property values (can be null)

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

@NotAuditable
NodeRef getContainer(String shortName,
String componentId)

Gets the "container" folder for the specified component.

shortName - short name of site

componentId - component id

noderef of container

@NotAuditable
PagingResults<FileInfo> listContainers(String shortName,
PagingRequest pagingRequest)

Returns a paged list of top level containers for the site

shortName - short name of site

pagingRequest - paging request

paged list of top level containers

@NotAuditable
boolean hasContainer(String shortName,
String componentId)

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

shortName - short name of site

componentId - component id

true => "container" folder exists for component

@NotAuditable
List<String> getSiteRoles()

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

List list of available roles

@NotAuditable
List<String> getSiteRoles(String shortName)

Gets a list of all the currently available roles that a user can perform on a specific site. This will generally only differ from getSiteRoles() if your site is of a custom type.

List list of available roles

@NotAuditable
String getSiteGroup(String shortName)

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

shortName - site short name

@NotAuditable
String getSiteRoleGroup(String shortName,
String role)

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

shortName - site short name

role - membership role

@NotAuditable
NodeRef getSiteRoot()

Gets the reference to the folder that is the Site root node.

cleanSitePermissions

void cleanSitePermissions(NodeRef relocatedNode,
SiteInfo containingSite)

This method cleans the permissions on the specified node. It is intended to be used after a node is moved or copied from one site to another. Permissions relating to the former site are removed and the node is given the default permissions for its new site.

relocatedNode - NodeRef

containingSite - SiteInfo

@NotAuditable
PagingResults<org.alfresco.repo.site.SiteMembership> listSitesPaged(String userName,
List<Pair<org.alfresco.service.cmr.site.SiteService.SortFields,Boolean>> sortProps,
PagingRequest pagingRequest)

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

userName - user name

PagingResults paged list of site information

@NotAuditable
String resolveSite(String group)

@NotAuditable
String getMembersRole(String shortName,
String authorityName)

countAuthoritiesWithRole