Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

Author:
Roy Wetherall

Field Summary
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)
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)
createSite(String sitePreset, String shortName, String title, String description, boolean isPublic)
          Deprecated. since version 3.2, replaced by createSite(String, String, String, String, SiteVisibility)
createSite(String sitePreset, String shortName, String title, String description, SiteVisibility visibility)
          Create a new site.
createSite(String sitePreset, String shortName, String title, String description, SiteVisibility visibility, QName siteType)
          Create a new site.
void
deleteSite(String shortName)
          Delete the site.
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.
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.
getContainer(String shortName, String componentId)
          Gets the "container" folder for the specified component.
getMembersRole(String shortName, String authorityName)
getMembersRoleInfo(String shortName, String authorityName)
          Gets the extended role information of the specified user.
getSite(NodeRef nodeRef)
          This method gets the SiteInfo for the Share Site which contains the given NodeRef.
getSite(String shortName)
          Gets site information based on the short name of a site.
getSiteGroup(String shortName)
          Gets the sites group.
getSiteRoleGroup(String shortName, String role)
          Gets the sites role group.
getSiteRoles()
          Gets a list of all the currently available roles that a user can perform on all sites
getSiteRoles(String shortName)
          Gets a list of all the currently available roles that a user can perform on a specific site.
getSiteRoot()
          Gets the reference to the folder that is the Site root node.
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.
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.
listMembers(String shortName, String nameFilter, String roleFilter, int size)
          List the members of the site.
listMembers(String shortName, String nameFilter, String roleFilter, int size, boolean collapseGroups)
          List the members of the site.
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.
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.
listSites(String userName)
          List all the sites that the specified user has a explicit membership to.
listSites(String userName, int size)
          List all the sites that the specified user has a explicit membership to.
listSites(String filter, String sitePresetFilter)
          List the available sites.
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
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.
Field Detail
DOCUMENT_LIBRARY
public static final String DOCUMENT_LIBRARY
See Also:
Constant Field Values
Method Detail
createSite
@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)
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

canAddMember
@NotAuditable
boolean canAddMember(String shortName,
                     String authorityName,
                     String role)
Can the current user add the authority "authorityName" to the site "shortName" with role "role"?
Parameters:
shortName - site short name, must be unique
authorityName - authority to add
role - site role
Returns:
true if the current user can add the authority to the site, false otherwise

createSite
@Auditable(parameters={
  "sitePreset",
  "shortName"
})
SiteInfo createSite(String sitePreset,
                    String shortName,
                    String title,
                    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

createSite
@Auditable(parameters={
  "sitePreset",
  "shortName"
})
SiteInfo createSite(String sitePreset,
                    String shortName,
                    String title,
                    String description,
                    SiteVisibility visibility,
                    QName siteType)
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)
siteType - type of site to create, must be a sub-type of st:site
Returns:
SiteInfo information about the created site

hasCreateSitePermissions
@NotAuditable
boolean hasCreateSitePermissions()
This method checks if the currently authenticated user has permission to create sites.
Returns:
true if current user can create sites, else false.
Since:
3.4

findSites
@NotAuditable
List<SiteInfofindSites(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.

Parameters:
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.
Returns:
Site objects for all matching sites up to the maximum result size.
Since:
4.0

findSites
@NotAuditable
List<SiteInfofindSites(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.

Parameters:
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.
Returns:
Site objects for all matching sites up to the maximum result size.
Since:
5.0

listSites
@NotAuditable
List<SiteInfolistSites(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).

Parameters:
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
Returns:
List list of site information

listSites
@NotAuditable
List<SiteInfolistSites(String filter,
                         String sitePresetFilter)
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.

Parameters:
filter - filter
sitePresetFilter - site preset filter
Returns:
List list of site information

listSites
@NotAuditable
List<SiteInfolistSites(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

listSites
@NotAuditable
PagingResults<SiteInfolistSites(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.
Parameters:
filterProps - property filters
sortProps - sorting options
pagingRequest - paging options
Returns:
a page of SiteInfo objects.
Since:
4.0

listSiteMemberships
@NotAuditable
List<org.alfresco.repo.site.SiteMembership> listSiteMemberships(String userName,
                                                                int size)
Lists all the memberships in sites that the specified user is in.
Parameters:
userName - String
size - list maximum size or zero for all
Returns:
a list of SiteMembership objects

listSites
@NotAuditable
List<SiteInfolistSites(String userName,
                         int size)
List all the sites that the specified user has a explicit membership to.
Parameters:
userName - user name
size - list maximum size or zero for all
Returns:
List list of site information

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

Parameters:
shortName - the site short name
Returns:
SiteInfo the site information

getSite
@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.
Parameters:
nodeRef - the node whose containing site's info is to be found.
Returns:
SiteInfo site information for the containing site or null if node is not in a site.

getSiteShortName
@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.
Parameters:
nodeRef - the node whose containing site's info is to be found.
Returns:
String site short name for the containing site or null if node is not in a site.

hasSite
@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.
Parameters:
shortName - the site short name
Returns:
true if the site exists, false otherwise

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

Parameters:
siteInfo - site information

deleteSite
@Auditable(parameters="shortName")
void deleteSite(String shortName)
Delete the site.
Parameters:
shortName - site short name

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

Parameters:
shortName - site short name
nameFilter - name filter
roleFilter - role filter
collapseGroups - true if collapse member groups into user list, false otherwise
callback - callback

listMembers
@NotAuditable
Map<StringlistMembers(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.

Parameters:
shortName - site short name
nameFilter - name filter
roleFilter - role filter
size - max results size crop if >0
Returns:
the authority name and their role

listMembers
@NotAuditable
Map<StringlistMembers(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.
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:
the authority name and their role

listMembersInfo
@NotAuditable
List<SiteMemberInfolistMembersInfo(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.
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:
List of site authorities’ information objects

listMembersPaged
@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.
Parameters:
shortName - site short name
collapseGroups - true if collapse member groups into user list, false otherwise
pagingRequest - the paging request
Returns:
the authority name and their role

getMembersRoleInfo
@NotAuditable
SiteMemberInfo getMembersRoleInfo(String shortName,
                                  String authorityName)
Gets the extended role information 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:
SiteMemberInfo site role information, null if none

isMember
@NotAuditable
boolean isMember(String shortName,
                 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
@Auditable(parameters={
  "shortName",
  "authorityName",
  "role"
})
void setMembership(String shortName,
                   String authorityName,
                   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
Throws:
org.alfresco.repo.security.authority.UnknownAuthorityException - if the site role is not supported.

removeMembership
@Auditable(parameters={
  "shortName",
  "authorityName"
})
void removeMembership(String shortName,
                      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
@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.

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
@NotAuditable
NodeRef getContainer(String shortName,
                     String componentId)
Gets the "container" folder for the specified component.
Parameters:
shortName - short name of site
componentId - component id
Returns:
noderef of container

listContainers
@NotAuditable
PagingResults<FileInfolistContainers(String shortName,
                                       PagingRequest pagingRequest)
Returns a paged list of top level containers for the site
Parameters:
shortName - short name of site
pagingRequest - paging request
Returns:
paged list of top level containers

hasContainer
@NotAuditable
boolean hasContainer(String shortName,
                     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
@NotAuditable
List<StringgetSiteRoles()
Gets a list of all the currently available roles that a user can perform on all sites
Returns:
List list of available roles

getSiteRoles
@NotAuditable
List<StringgetSiteRoles(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.
Returns:
List list of available roles

getSiteGroup
@NotAuditable
String getSiteGroup(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
@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.
Parameters:
shortName - site short name
role - membership role
Returns:
String group name

getSiteRoot
@NotAuditable
NodeRef getSiteRoot()
Gets the reference to the folder that is the Site root node.
Returns:
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.
Parameters:
relocatedNode - NodeRef
containingSite - SiteInfo
Since:
3.4.2

listSitesPaged
@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.
Parameters:
userName - user name
Returns:
PagingResults paged list of site information

resolveSite
@NotAuditable
String resolveSite(String group)

getMembersRole
@NotAuditable
String getMembersRole(String shortName,
                      String authorityName)

countAuthoritiesWithRole
@NotAuditable
int countAuthoritiesWithRole(String shortName,
                             String role)

isSiteAdmin
@NotAuditable
boolean isSiteAdmin(String userName)
Indicates whether the specified user is a site administrator or not.

Note: The super/repo admin is considered to be a site administrator too.

Parameters:
userName - The user name
Returns:
true if the specified user is a 'site administrator', false otherwise

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.