|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@PublicService public interface WebProjectService
Web Project Service fundamental API.
This service API is designed to support the public facing Web Project APIs.
| Method Summary | |
|---|---|
void |
createWebApp(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String name,
java.lang.String description)
Create webapp for the given web project. |
void |
createWebApp(java.lang.String wpStoreId,
java.lang.String name,
java.lang.String description)
Create webapp for the given web project. |
WebProjectInfo |
createWebProject(java.lang.String dnsName,
java.lang.String name,
java.lang.String title,
java.lang.String description)
Create a new web project (with a default ROOT webapp) |
WebProjectInfo |
createWebProject(java.lang.String dnsName,
java.lang.String name,
java.lang.String title,
java.lang.String description,
org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
Deprecated. see createWebProject(String dnsName, WebProjectInfo wpInfo) |
WebProjectInfo |
createWebProject(java.lang.String dnsName,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String defaultWebApp,
boolean useAsTemplate,
org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
Create a new web project (with given default web app) |
WebProjectInfo |
createWebProject(WebProjectInfo wpInfo)
Create a new web project (with given web project info) |
void |
deleteWebApp(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String name)
Delete webapp from the given web project |
void |
deleteWebApp(java.lang.String wpStoreId,
java.lang.String name)
Delete webapp from the given web project |
void |
deleteWebProject(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Delete the web project |
void |
deleteWebProject(java.lang.String wpStoreId)
Delete the web project |
java.lang.String |
getPreviewProvider(java.lang.String wpStoreId)
Get preview provider name configured for given web project (if not configured then return default preview provider) |
WebProjectInfo |
getWebProject(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Gets web project info based on the DM nodeRef of a web project |
WebProjectInfo |
getWebProject(java.lang.String wpStoreId)
Gets web project info based on the store id of a web project |
org.alfresco.service.cmr.repository.NodeRef |
getWebProjectNodeFromPath(java.lang.String absoluteAVMPath)
Returns the Web Project for the given AVM path |
org.alfresco.service.cmr.repository.NodeRef |
getWebProjectNodeFromStore(java.lang.String storeName)
Returns the Web Project for the given AVM store name (sandbox store id) |
org.alfresco.service.cmr.repository.NodeRef |
getWebProjectsRoot()
Returns the Web Projects container |
int |
getWebUserCount(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Get the number of web users invited to this web project |
java.lang.String |
getWebUserRole(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName)
Gets the role of the specified user |
java.lang.String |
getWebUserRole(java.lang.String wpStoreId,
java.lang.String userName)
Gets the role of the specified user |
void |
inviteWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName,
java.lang.String userRole,
boolean autoCreateAuthorSandbox)
Invite user to web project |
void |
inviteWebUser(java.lang.String wpStoreId,
java.lang.String userName,
java.lang.String userRole)
Invite user to web project |
void |
inviteWebUser(java.lang.String wpStoreId,
java.lang.String userName,
java.lang.String userRole,
boolean autoCreateAuthorSandbox)
Invite user to web project |
void |
inviteWebUsersGroups(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.util.Map userGroupRoles,
boolean autoCreateAuthorSandbox)
Invite users/groups to web project |
void |
inviteWebUsersGroups(java.lang.String wpStoreId,
java.util.Map userGroupRoles)
Invite users/groups to web project |
void |
inviteWebUsersGroups(java.lang.String wpStoreId,
java.util.Map userGroupRoles,
boolean autoCreateAuthorSandbox)
Invite users/groups to web project |
boolean |
isContentManager(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Returns true if the current user is a manager of this web project |
boolean |
isContentManager(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName)
Returns true if the user is a manager of this web project |
boolean |
isContentManager(java.lang.String wpStoreId)
Returns true if the current user is a manager of this web project |
boolean |
isContentManager(java.lang.String wpStoreId,
java.lang.String username)
Returns true if the user is a manager of this web project |
boolean |
isWebProject(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Return true if web project node ref is a web project |
boolean |
isWebProject(java.lang.String wpStoreId)
Return true if web project node ref is a web project |
boolean |
isWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Indicates whether current user is a web user of the web project or not |
boolean |
isWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName)
Indicates whether given user is a web user of the web project or not |
boolean |
isWebUser(java.lang.String wpStoreId)
Indicates whether current user is a web user of the web project or not |
boolean |
isWebUser(java.lang.String wpStoreId,
java.lang.String userName)
Indicates whether given user is a web user of the web project or not |
java.util.List |
listWebApps(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
List webapps for the web project |
java.util.List |
listWebApps(java.lang.String wpStoreId)
List webapps for the web project |
java.util.List |
listWebProjects()
List the available web projects for the current user |
java.util.List |
listWebProjects(java.lang.String userName)
List the web projects for the given user (based on the available web projects for the current user) |
java.util.Map |
listWebUsers(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
List the web users of the web project |
java.util.Map |
listWebUsers(java.lang.String wpStoreId)
List the web users of the web project |
void |
uninviteWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName,
boolean autoDeleteAuthorSandbox)
Uninvite user from a web project |
void |
uninviteWebUser(java.lang.String wpStoreId,
java.lang.String userName)
Uninvite user from a web project |
void |
uninviteWebUser(java.lang.String wpStoreId,
java.lang.String userName,
boolean autoDeleteAuthorSandbox)
Uninvite user from a web project |
void |
updateWebProject(WebProjectInfo wpInfo)
Update the web project info |
| Method Detail |
|---|
@NotAuditable
WebProjectInfo createWebProject(java.lang.String dnsName,
java.lang.String name,
java.lang.String title,
java.lang.String description)
Note: the DNS name will be used to generate the web project store id, which can be subsequently retrieved via WebProjectInfo.getStoreId()
dnsName - DNS name (required, must be unique)name - name (required, must be unique)title - titledescription - description
@NotAuditable
WebProjectInfo createWebProject(java.lang.String dnsName,
java.lang.String name,
java.lang.String title,
java.lang.String description,
org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
Note: the DNS name will be used to generate the web project store id, which can be subsequently retrieved via WebProjectInfo.getStoreId()
dnsName - DNS name (required, must be unique)name - name (required, must be unique)title - titledescription - descriptionsourceNodeRef - web project node ref to branch from (can be null)
@NotAuditable
WebProjectInfo createWebProject(java.lang.String dnsName,
java.lang.String name,
java.lang.String title,
java.lang.String description,
java.lang.String defaultWebApp,
boolean useAsTemplate,
org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
Note: the DNS name will be used to generate the web project store id, which can be subsequently retrieved via WebProjectInfo.getStoreId()
dnsName - DNS name (required, must be unique)name - name (required, must be unique)title - titledescription - descriptiondefaultWebApp - default webapp (if null, will default to ROOT webapp)useAsTemplate - true if this web project can be used as a template to branch fromsourceNodeRef - web project node ref to branch from (can be null)
@NotAuditable WebProjectInfo createWebProject(WebProjectInfo wpInfo)
Note: the DNS name will be used to generate the web project store id, which can be subsequently retrieved via WebProjectInfo.getStoreId()
wpInfo - web project info
Note:dnsName - DNS name (required, must be unique)name - name (required, must be unique)title - titledescription - descriptiondefaultWebApp - default webapp (if null, will default to ROOT webapp)useAsTemplate - true if this web project can be used as a template to branch fromsourceNodeRef - web project node ref to branch from (can be null)previewProvider - preview URI service provider name (must correspond to registered name, if null will be set to default provider)
@NotAuditable org.alfresco.service.cmr.repository.NodeRef getWebProjectsRoot()
@NotAuditable org.alfresco.service.cmr.repository.NodeRef getWebProjectNodeFromPath(java.lang.String absoluteAVMPath)
absoluteAVMPath - the AVM path from which to determine the Web Project
@NotAuditable org.alfresco.service.cmr.repository.NodeRef getWebProjectNodeFromStore(java.lang.String storeName)
storeName - the AVM store name (sandbox store id) from which to determine the Web Project
@NotAuditable java.util.List listWebProjects()
@NotAuditable java.util.List listWebProjects(java.lang.String userName)
userName - user name
@NotAuditable boolean isWebProject(java.lang.String wpStoreId)
wpNodeRef - web project store id
@NotAuditable boolean isWebProject(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
wpNodeRef - web project node ref
@NotAuditable WebProjectInfo getWebProject(java.lang.String wpStoreId)
Returns null if the web project can not be found
wpStoreId - web project store id
@NotAuditable WebProjectInfo getWebProject(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Returns null if the web project can not be found
wpNodeRef - web project node ref
@NotAuditable java.lang.String getPreviewProvider(java.lang.String wpStoreId)
wpStoreId - web project store id
@NotAuditable void updateWebProject(WebProjectInfo wpInfo)
Note: the nodeRef and storeId (dnsName) of a web project cannot be updated once the web project has been created
wpInfo - web project info@NotAuditable void deleteWebProject(java.lang.String wpStoreId)
If the web project does not exist, will log a warning and succeed
Current user must be a content manager for the web project
name - web project store id@NotAuditable void deleteWebProject(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
If the web project does not exist, will log a warning and succeed
Current user must be a content manager for the web project
Note: this will cascade delete all sandboxes associated with a web project
name - web project node ref
@NotAuditable
void createWebApp(java.lang.String wpStoreId,
java.lang.String name,
java.lang.String description)
Current user must be a content manager for the web project
wpStoreId - web project store idname - webapp name (must be unique within a web project)description - webapp description
@NotAuditable
void createWebApp(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String name,
java.lang.String description)
Current user must be a content manager for the web project
wpNodeRef - web project node refname - webapp name (must be unique within a web project)description - webapp description@NotAuditable java.util.List listWebApps(java.lang.String wpStoreId)
wpStoreId - web project store id
@NotAuditable java.util.List listWebApps(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
wpNodeRef - web project node ref
@NotAuditable
void deleteWebApp(java.lang.String wpStoreId,
java.lang.String name)
Current user must be a content manager for the web project
Note: this will cascade delete all assets within a webapp
wpStoreId - web project store idname - webapp name
@NotAuditable
void deleteWebApp(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String name)
Current user must be a content manager for the web project
Note: this will cascade delete all assets within a webapp
wpNodeRef - web project node refname - webapp name@NotAuditable boolean isContentManager(java.lang.String wpStoreId)
Note: This includes admin users but does not include the System user
wpStoreId - web project store id
@NotAuditable boolean isContentManager(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
wpNodeRef - web project node ref
@NotAuditable
boolean isContentManager(java.lang.String wpStoreId,
java.lang.String username)
Note: This includes admin users but does not include the System user
storeName - web project store idusername - user name
@NotAuditable
boolean isContentManager(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName)
Note: This includes admin users but does not include the System user
wpNodeRef - web project node refuserName - user name
@NotAuditable java.util.Map listWebUsers(java.lang.String wpStoreId)
Current user must be a content manager for the web project
wpStoreId - web project store id
@NotAuditable java.util.Map listWebUsers(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
Current user must be a content manager for the web project
wpNodeRef - web project node ref
@NotAuditable int getWebUserCount(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
wpNodeRef - web project node ref
@NotAuditable
java.lang.String getWebUserRole(java.lang.String wpStoreId,
java.lang.String userName)
wpStoreId - web project store iduserName - user name
@NotAuditable
java.lang.String getWebUserRole(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName)
wpNodeRef - web project node refuserName - user name
@NotAuditable boolean isWebUser(java.lang.String wpStoreId)
store - id web project store id
@NotAuditable boolean isWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
wpNodeRef - web project node ref
@NotAuditable
boolean isWebUser(java.lang.String wpStoreId,
java.lang.String userName)
store - id web project store iduserName - user name
@NotAuditable
boolean isWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName)
wpNodeRef - web project node refuserName - user name
@NotAuditable
void inviteWebUsersGroups(java.lang.String wpStoreId,
java.util.Map userGroupRoles)
Note: authority name can be user or group, although a group is flattened into a set of users
Note: author sandbox will NOT be auto created for each invited user
wpStoreId - web project store iduserGroupRoles - map of
@NotAuditable
void inviteWebUsersGroups(java.lang.String wpStoreId,
java.util.Map userGroupRoles,
boolean autoCreateAuthorSandbox)
Note: authority name can be user or group, although a group is flattened into a set of users
wpStoreId - web project store iduserGroupRoles - map of autoCreateAuthorSandbox - if true then auto create an author sandbox for each invited user
@NotAuditable
void inviteWebUsersGroups(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.util.Map userGroupRoles,
boolean autoCreateAuthorSandbox)
Note: authority name can be user or group, although a group is flattened into a set of users
wpNodeRef - web project node refuserGroupRoles - map of autoCreateAuthorSandbox - if true then auto create the author sandbox for each invited user
@NotAuditable
void inviteWebUser(java.lang.String wpStoreId,
java.lang.String userName,
java.lang.String userRole)
Note: author sandbox will NOT be auto created for each invited user
wpStoreId - web project store iduserName - user name (not a group)userRole - web project role
@NotAuditable
void inviteWebUser(java.lang.String wpStoreId,
java.lang.String userName,
java.lang.String userRole,
boolean autoCreateAuthorSandbox)
wpStoreId - web project store iduserName - user name (not a group)userRole - web project roleautoCreateAuthorSandbox - if true then auto create the author sandbox for each invited user
@NotAuditable
void inviteWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName,
java.lang.String userRole,
boolean autoCreateAuthorSandbox)
wpNodeRef - web project node refuserName - user name (not a group)userRole - web project roleautoCreateAuthorSandbox - if true then auto create the author sandbox for each invited user
@NotAuditable
void uninviteWebUser(java.lang.String wpStoreId,
java.lang.String userName)
Note: author sandbox will NOT be auto deleted
wpStoreId - web project store iduserName - user name
@NotAuditable
void uninviteWebUser(java.lang.String wpStoreId,
java.lang.String userName,
boolean autoDeleteAuthorSandbox)
Note: if author sandbox is auto deleted then this will cascade delete without warning (even if there are changed items)
wpStoreId - web project store iduserName - user nameautoDeleteAuthorSandbox - if true then auto delete the author sandbox
@NotAuditable
void uninviteWebUser(org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
java.lang.String userName,
boolean autoDeleteAuthorSandbox)
Note: if author sandbox is auto deleted then this will cascade delete without warning (even if there are changed items)
wpNodeRef - web project node refuserName - user nameautoDeleteAuthorSandbox - if true then auto delete the author sandbox
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||