|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicService public interface SiteService
Site service fundamental API.
This service API is designed to support the public facing Site APIs
Method Summary | |
---|---|
org.alfresco.service.cmr.repository.NodeRef |
createContainer(java.lang.String shortName,
java.lang.String componentId,
org.alfresco.service.namespace.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. |
org.alfresco.service.cmr.repository.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(org.alfresco.service.cmr.repository.NodeRef nodeRef)
This method gets the SiteInfo for the Share Site which contains the given 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 |
hasCreateSitePermissions()
This method checks if the currently authenticated user has permission to create sites. |
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 |
---|
@Auditable(parameters={"sitePreset", "shortName"}) SiteInfo createSite(java.lang.String sitePreset, java.lang.String shortName, java.lang.String title, java.lang.String description, boolean isPublic)
SiteService.createSite(String, String, String, String, SiteVisibility)
sitePreset
- site preset nameshortName
- site short name, must be uniquetitle
- site titledescription
- site descriptionisPublic
- whether the site is public or not (true = public, false = private)
@Auditable(parameters={"sitePreset", "shortName"}) SiteInfo createSite(java.lang.String sitePreset, java.lang.String shortName, java.lang.String title, java.lang.String description, SiteVisibility visibility)
sitePreset
- site preset nameshortName
- site short name, must be uniquetitle
- site titledescription
- site descriptionvisibility
- site visibility (public|moderated|private)
@NotAuditable boolean hasCreateSitePermissions()
true
if current user can create sites, else false
.@NotAuditable java.util.List listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter, int size)
nameFilter
- name filtersitePresetFilter
- site preset filtersize
- list maximum size or zero for all
@NotAuditable java.util.List listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter)
nameFilter
- name filtersitePresetFilter
- site preset filter
@NotAuditable java.util.List listSites(java.lang.String userName)
userName
- user name
@NotAuditable SiteInfo getSite(java.lang.String shortName)
Returns null if the site can not be found.
shortName
- the site short name
@NotAuditable SiteInfo getSite(org.alfresco.service.cmr.repository.NodeRef nodeRef)
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.
null
if node is not in a site.@Auditable void updateSite(SiteInfo siteInfo)
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(java.lang.String shortName)
shortName
- site short name@NotAuditable java.util.Map listMembers(java.lang.String shortName, java.lang.String nameFilter, java.lang.String roleFilter, int size)
Name and role filters are optional and if not specified all the members of the site are returned.
shortName
- site short namenameFilter
- name filterroleFilter
- role filtersize
- max results size crop if >0
@NotAuditable java.util.Map listMembers(java.lang.String shortName, java.lang.String nameFilter, java.lang.String roleFilter, int size, boolean collapseGroups)
shortName
- site short namenameFilter
- name filterroleFilter
- role filtersize
- max results size crop if >0collapseGroups
- true if collapse member groups into user list, false otherwise
@NotAuditable java.lang.String getMembersRole(java.lang.String shortName, java.lang.String authorityName)
shortName
- site short nameauthorityName
- full authority name (so if it's a group then its prefixed with 'GROUP_')
@NotAuditable boolean isMember(java.lang.String shortName, java.lang.String authorityName)
shortName
- site short nameauthorityName
- authority name (so if it's a group then its prefixed with 'GROUP_')
@Auditable(parameters={"shortName", "authorityName", "role"}) void setMembership(java.lang.String shortName, java.lang.String authorityName, java.lang.String role)
shortName
- site short nameauthorityName
- authority name (so if it's a group then its prefixed with 'GROUP_')role
- site role@Auditable(parameters={"shortName", "authorityName"}) void removeMembership(java.lang.String shortName, java.lang.String authorityName)
shortName
- site short nameauthorityName
- authority name (so if it's a group then its prefixed with 'GROUP_')@NotAuditable org.alfresco.service.cmr.repository.NodeRef createContainer(java.lang.String shortName, java.lang.String componentId, org.alfresco.service.namespace.QName containerType, java.util.Map containerProperties)
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 namecomponentId
- component idcontainerType
- container type to create (can be null)containerProperties
- container property values (can be null)
@NotAuditable org.alfresco.service.cmr.repository.NodeRef getContainer(java.lang.String shortName, java.lang.String componentId)
shortName
- short name of sitecomponentId
- component idfolderType
- type of folder to create (if null, creates standard folder)
@NotAuditable boolean hasContainer(java.lang.String shortName, java.lang.String componentId)
shortName
- short name of sitecomponentId
- component id
@NotAuditable java.util.List getSiteRoles()
@NotAuditable java.lang.String getSiteGroup(java.lang.String shortName)
shortName
- site short name
@NotAuditable java.lang.String getSiteRoleGroup(java.lang.String shortName, java.lang.String role)
shortName
- site short namerole
- membership role
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |