|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.site.SiteServiceImpl
public class SiteServiceImpl
Site Service Implementation. Also bootstraps the site AVM and DM stores.
Field Summary | |
---|---|
static StoreRef |
SITE_STORE
The DM store where site's are kept |
Fields inherited from interface org.alfresco.repo.site.SiteModel |
---|
ASPECT_SITE_CONTAINER, PROP_COMPONENT_ID, PROP_SITE_PRESET, PROP_SITE_VISIBILITY, SITE_COLLABORATOR, SITE_CONSUMER, SITE_CONTRIBUTOR, SITE_CUSTOM_PROPERTY_PREFIX, SITE_CUSTOM_PROPERTY_URL, SITE_MANAGER, SITE_MODEL_PREFIX, SITE_MODEL_URL, TYPE_SITE, TYPE_SITES |
Constructor Summary | |
---|---|
SiteServiceImpl()
|
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 passedShortName,
java.lang.String title,
java.lang.String description,
boolean isPublic)
Create a new site. |
SiteInfo |
createSite(java.lang.String sitePreset,
java.lang.String passedShortName,
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. |
java.util.List |
getMembersRoles(java.lang.String shortName,
java.lang.String authorityName)
|
java.util.Comparator |
getRoleComparator()
|
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 |
getSiteGroup(java.lang.String shortName,
boolean withGroupPrefix)
Helper method to get the name of the site group |
java.lang.String |
getSiteRoleGroup(java.lang.String shortName,
java.lang.String role)
Gets the sites role group. |
java.lang.String |
getSiteRoleGroup(java.lang.String shortName,
java.lang.String permission,
boolean withGroupPrefix)
Helper method to get the name of the site permission 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. |
void |
init()
Checks that all necessary properties and services have been provided. |
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 |
setActivityService(ActivityService activityService)
Set activity service |
void |
setAuthenticationContext(AuthenticationContext authenticationContext)
Set authentication component |
void |
setAuthorityService(AuthorityService authorityService)
Set the authority service |
void |
setDictionaryService(DictionaryService dictionaryService)
Set the dictionary service |
void |
setFileFolderService(FileFolderService fileFolderService)
Set file folder service |
void |
setMembership(java.lang.String shortName,
java.lang.String authorityName,
java.lang.String role)
Sets the role of an authority within a site |
void |
setNamespaceService(NamespaceService namespaceService)
Set Namespace service |
void |
setNodeService(NodeService nodeService)
Set node service |
void |
setPermissionService(PermissionService permissionService)
Set permission service |
void |
setPersonService(PersonService personService)
Set person service |
void |
setRoleComparator(java.util.Comparator roleComparator)
|
void |
setSearchService(SearchService searchService)
Set search service |
void |
setSitesXPath(java.lang.String sitesXPath)
Set the path to the location of the sites root folder. |
void |
setTaggingService(TaggingService taggingService)
Set the tagging service |
void |
setTenantAdminService(TenantAdminService tenantAdminService)
Sets the tenant admin service |
void |
setTenantService(TenantService tenantService)
Set the tenant service |
void |
setTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)
Sets helper that provides transaction callbacks |
void |
updateSite(SiteInfo siteInfo)
Update the site information. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final StoreRef SITE_STORE
Constructor Detail |
---|
public SiteServiceImpl()
Method Detail |
---|
public void setSitesXPath(java.lang.String sitesXPath)
./app:company_home/st:sites
sitesXPath
- a valid XPathpublic void setNodeService(NodeService nodeService)
public void setFileFolderService(FileFolderService fileFolderService)
public void setSearchService(SearchService searchService)
public void setNamespaceService(NamespaceService namespaceService)
public void setPermissionService(PermissionService permissionService)
public void setActivityService(ActivityService activityService)
public void setPersonService(PersonService personService)
public void setAuthenticationContext(AuthenticationContext authenticationContext)
public void setTaggingService(TaggingService taggingService)
public void setAuthorityService(AuthorityService authorityService)
public void setDictionaryService(DictionaryService dictionaryService)
dictionaryService
- dictionary servicepublic void setTenantService(TenantService tenantService)
tenantService
- tenant servicepublic void setTenantAdminService(TenantAdminService tenantAdminService)
public void setTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)
public void setRoleComparator(java.util.Comparator roleComparator)
public java.util.Comparator getRoleComparator()
public void init()
public SiteInfo createSite(java.lang.String sitePreset, java.lang.String passedShortName, java.lang.String title, java.lang.String description, boolean isPublic)
SiteService
createSite
in interface SiteService
sitePreset
- site preset namepassedShortName
- site short name, must be uniquetitle
- site titledescription
- site descriptionisPublic
- whether the site is public or not (true = public, false = private)
SiteService.createSite(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
public SiteInfo createSite(java.lang.String sitePreset, java.lang.String passedShortName, java.lang.String title, java.lang.String description, SiteVisibility visibility)
SiteService
createSite
in interface SiteService
sitePreset
- site preset namepassedShortName
- site short name, must be uniquetitle
- site titledescription
- site descriptionvisibility
- site visibility (public|moderated|private)
SiteService.createSite(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
public java.lang.String getSiteGroup(java.lang.String shortName)
SiteService
getSiteGroup
in interface SiteService
shortName
- site short name
SiteService.getSiteGroup(java.lang.String)
public java.lang.String getSiteRoleGroup(java.lang.String shortName, java.lang.String role)
SiteService
getSiteRoleGroup
in interface SiteService
shortName
- site short namerole
- membership role
SiteService.getSiteRoleGroup(java.lang.String,
java.lang.String)
public java.lang.String getSiteGroup(java.lang.String shortName, boolean withGroupPrefix)
shortName
- site short name
public java.lang.String getSiteRoleGroup(java.lang.String shortName, java.lang.String permission, boolean withGroupPrefix)
shortName
- site short namepermission
- permission namewithGroupPrefix
- - should the name have the GROUP_ prefix?
public java.util.List listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter)
SiteService
listSites
in interface SiteService
nameFilter
- name filtersitePresetFilter
- site preset filter
SiteService.listSites(java.lang.String, java.lang.String)
public java.util.List listSites(java.lang.String nameFilter, java.lang.String sitePresetFilter, int size)
SiteService
listSites
in interface SiteService
nameFilter
- name filtersitePresetFilter
- site preset filtersize
- list maximum size or zero for all
SiteService.listSites(java.lang.String, java.lang.String, int)
public java.util.List listSites(java.lang.String userName)
SiteService
listSites
in interface SiteService
userName
- user name
SiteService.listSites(java.lang.String)
public SiteInfo getSite(java.lang.String shortName)
SiteService
Returns null if the site can not be found.
getSite
in interface SiteService
shortName
- the site short name
SiteService.getSite(java.lang.String)
public SiteInfo getSite(NodeRef nodeRef)
getSite
in interface SiteService
SiteService.getSite(org.alfresco.service.cmr.repository.NodeRef)
public void updateSite(SiteInfo siteInfo)
SiteService
Note that the short name and site preset of a site can not be updated once the site has been created.
updateSite
in interface SiteService
siteInfo
- site informationSiteService.updateSite(org.alfresco.service.cmr.site.SiteInfo)
public void deleteSite(java.lang.String shortName)
SiteService
deleteSite
in interface SiteService
shortName
- site short nameSiteService.deleteSite(java.lang.String)
public java.util.Map listMembers(java.lang.String shortName, java.lang.String nameFilter, java.lang.String roleFilter, int size)
SiteService
Name and role filters are optional and if not specified all the members of the site are returned.
listMembers
in interface SiteService
shortName
- site short namenameFilter
- name filterroleFilter
- role filtersize
- max results size crop if >0
SiteService.listMembers(java.lang.String, java.lang.String, java.lang.String, int)
public java.util.Map listMembers(java.lang.String shortName, java.lang.String nameFilter, java.lang.String roleFilter, int size, boolean collapseGroups)
SiteService
listMembers
in interface SiteService
shortName
- site short namenameFilter
- name filterroleFilter
- role filtersize
- max results size crop if >0collapseGroups
- true if collapse member groups into user list, false otherwise
SiteService.listMembers(String, String, String, int, boolean)
public java.lang.String getMembersRole(java.lang.String shortName, java.lang.String authorityName)
SiteService
getMembersRole
in interface SiteService
shortName
- site short nameauthorityName
- full authority name (so if it's a group then its prefixed with 'GROUP_')
SiteService.getMembersRole(java.lang.String,
java.lang.String)
public java.util.List getMembersRoles(java.lang.String shortName, java.lang.String authorityName)
public java.util.List getSiteRoles()
SiteService
getSiteRoles
in interface SiteService
SiteService.getSiteRoles()
public boolean isMember(java.lang.String shortName, java.lang.String authorityName)
SiteService
isMember
in interface SiteService
shortName
- site short nameauthorityName
- authority name (so if it's a group then its prefixed with 'GROUP_')
SiteService.isMember(java.lang.String, java.lang.String)
public void removeMembership(java.lang.String shortName, java.lang.String authorityName)
SiteService
removeMembership
in interface SiteService
shortName
- site short nameauthorityName
- authority name (so if it's a group then its prefixed with 'GROUP_')SiteService.removeMembership(java.lang.String, java.lang.String)
public void setMembership(java.lang.String shortName, java.lang.String authorityName, java.lang.String role)
SiteService
setMembership
in interface SiteService
shortName
- site short nameauthorityName
- authority name (so if it's a group then its prefixed with 'GROUP_')role
- site roleSiteService.setMembership(java.lang.String,
java.lang.String, java.lang.String)
public NodeRef createContainer(java.lang.String shortName, java.lang.String componentId, QName containerType, java.util.Map containerProperties)
SiteService
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.
createContainer
in interface SiteService
shortName
- site short namecomponentId
- component idcontainerType
- container type to create (can be null)containerProperties
- container property values (can be null)
SiteService.createContainer(java.lang.String,
java.lang.String, org.alfresco.service.namespace.QName,
java.util.Map)
public NodeRef getContainer(java.lang.String shortName, java.lang.String componentId)
SiteService
getContainer
in interface SiteService
shortName
- short name of sitecomponentId
- component id
org.alfresco.service.cmr.site.SiteService#getContainer(java.lang.String)
public boolean hasContainer(java.lang.String shortName, java.lang.String componentId)
SiteService
hasContainer
in interface SiteService
shortName
- short name of sitecomponentId
- component id
org.alfresco.service.cmr.site.SiteService#hasContainer(java.lang.String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |