org.alfresco.wcm.sandbox

Class SandboxFactory

java.lang.Object

org.alfresco.repo.avm.util.AVMUtil

org.alfresco.wcm.util.WCMUtil

org.alfresco.wcm.sandbox.SandboxFactory

public final class SandboxFactory
extends WCMUtil

Helper factory to create WCM sandbox structures

Author:

Kevin Roast, janv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SandboxFactory.UserRoleWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	PERMISSIONS

Fields inherited from class org.alfresco.wcm.util.WCMUtil

DIR_ROOT, LOCK_KEY_STORE_NAME, PATTERN_ILLEGAL_SEQUENCE, ROLE_CONTENT_CONTRIBUTOR, ROLE_CONTENT_MANAGER, ROLE_CONTENT_PUBLISHER, ROLE_CONTENT_REVIEWER, SPACE_ICON_WEBSITE, STORE_PREVIEW, STORE_SEPARATOR, STORE_WORKFLOW, WORKFLOW_SUBMITDIRECT_NAME

Fields inherited from class org.alfresco.repo.avm.util.AVMUtil

AVM_PATH_SEPARATOR, AVM_PATH_SEPARATOR_CHAR, AVM_STORE_SEPARATOR, AVM_STORE_SEPARATOR_CHAR, INITIAL_SNAPSHOT

Method Summary

Methods

Modifier and Type	Method and Description
void	addStagingAreaUser(String storeId, String authority, String role)
SandboxInfo	createReadOnlyWorkflowSandbox(String storeId) Create a read-only workflow sandbox for the named store.
SandboxInfo	createStagingSandbox(String storeId, org.alfresco.service.cmr.repository.NodeRef webProjectNodeRef, String branchStoreId) Create the staging sandbox for the named store.
SandboxInfo	createUserSandbox(String storeId, String username, String role) Create a user sandbox for the named store.
String	createUserWorkflowSandbox(String stagingStore, String userStore) Creates a workflow sandbox for the given user store.
SandboxInfo	createWorkflowSandbox(String storeId) Create a workflow sandbox for the named store.
void	deleteSandbox(SandboxInfo sbInfo, boolean isSubmitDirectWorkflowSandbox, boolean removeLocks)
void	deleteSandbox(String sbStoreId)
void	deleteSandbox(String sbStoreId, boolean isSubmitDirectWorkflowSandbox)
List<SandboxInfo>	listAllSandboxes(String wpStoreId)
List<SandboxInfo>	listAllSandboxes(String wpStoreId, boolean includeWorkflowSandboxes, boolean includeLocalhostDeployed)
void	removeGroupsForStore(String storeRoot)
void	removeSandboxManagers(String storeId, List<String> managersToRemove) Update the permissions for the list of sandbox managers applied to a user sandbox.
void	setAuthorityService(AuthorityService authorityService)
void	setAvmLockingService(AVMLockingService avmLockingService)
void	setAvmService(AVMService avmService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setStagingPermissionMasks(String storeId)
void	setVirtServerRegistry(VirtServerRegistry virtServerRegistry)
void	updateSandboxManagers(String storeId, List<String> managers) Update the permissions for the list of sandbox managers applied to a user sandbox.
void	updateSandboxRoles(String wpStoreId, List<SandboxFactory.UserRoleWrapper> usersToUpdate, Set<String> permissionsList)

Methods inherited from class org.alfresco.wcm.util.WCMUtil

buildSandboxRootPath, buildStagingPreviewStoreName, buildStagingStoreName, buildStoreRootPath, buildStoreWebappPath, buildUserMainStoreName, buildUserPreviewStoreName, buildWorkflowMainStoreName, buildWorkflowPreviewStoreName, escapeStoreNameComponent, getCommonWebApp, getCorrespondingMainStoreName, getCorrespondingPath, getCorrespondingPathInMainStore, getCorrespondingPathInPreviewStore, getCorrespondingPreviewStoreName, getSandboxPath, getSandboxRelativePath, getSandboxStoreId, getStoreRelativePath, getUserName, getWebapp, getWebappPath, getWebappRelativePath, getWebProject, getWebProjectNodeFromWebProjectStore, getWebProjectStoreId, getWebProjectStoreIdFromPath, getWorkflowId, isLocalhostDeployedStore, isPreviewStore, isStagingStore, isUserStore, isWorkflowStore, listWebUserRefs, listWebUsers, lookupStoreDNS, removeAllVServerWebapps, removeVServerWebapp, updateVServerWebapp

Methods inherited from class org.alfresco.repo.avm.util.AVMUtil

addLeadingSlash, buildAVMPath, extendAVMPath, getStoreName, normalizePath, splitBase, splitPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PERMISSIONS

public static final String[] PERMISSIONS

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setAvmService

public void setAvmService(AVMService avmService)

setVirtServerRegistry

public void setVirtServerRegistry(VirtServerRegistry virtServerRegistry)

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

setAvmLockingService

public void setAvmLockingService(AVMLockingService avmLockingService)

createStagingSandbox

public SandboxInfo createStagingSandbox(String storeId,
                               org.alfresco.service.cmr.repository.NodeRef webProjectNodeRef,
                               String branchStoreId)

Create the staging sandbox for the named store. A staging sandbox is comprised of two stores, the first named 'storename-staging' with a preview store named 'storename-preview' layered over the staging store. Various store meta-data properties are set including: Identifier for store-types: .sandbox.staging.main and .sandbox.staging.preview Store-id: .sandbox-id. (unique across all stores in the sandbox) DNS: .dns. = Website Name: .website.name = website name

Parameters:

storeId - The store name to create the sandbox for.

webProjectNodeRef - The noderef for the webproject.

branchStoreId - The ID of the store to branch this staging store from.

setStagingPermissionMasks

public void setStagingPermissionMasks(String storeId)

addStagingAreaUser

public void addStagingAreaUser(String storeId,
                      String authority,
                      String role)

createUserSandbox

public SandboxInfo createUserSandbox(String storeId,
                            String username,
                            String role)

Create a user sandbox for the named store. A user sandbox is comprised of two stores, the first named 'storename--username' layered over the staging store with a preview store named 'storename--username--preview' layered over the main store. Various store meta-data properties are set including: Identifier for store-types: .sandbox.author.main and .sandbox.author.preview Store-id: .sandbox-id. (unique across all stores in the sandbox) DNS: .dns. = Website Name: .website.name = website name

Parameters:

storeId - The store id to create the sandbox for

username - Username of the user to create the sandbox for

role - Role permission for the user

Returns:

Summary information regarding the sandbox

createWorkflowSandbox

public SandboxInfo createWorkflowSandbox(String storeId)

Create a workflow sandbox for the named store. Various store meta-data properties are set including: Identifier for store-types: .sandbox.workflow.main and .sandbox.workflow.preview Store-id: .sandbox-id. (unique across all stores in the sandbox) DNS: .dns. = Website Name: .website.name = website name

Parameters:

storeId - The id of the store to create a sandbox for

Returns:

Information about the sandbox

createReadOnlyWorkflowSandbox

public SandboxInfo createReadOnlyWorkflowSandbox(String storeId)

Create a read-only workflow sandbox for the named store. Note: read-only means it's only safe to use in a workflow where the sandbox is not expected to be updated. The sandbox does not protected itself from writes. Note: this sandbox does not support the preview layer Note: a snapshot within this sandbox is NOT taken Various store meta-data properties are set including: Identifier for store-types: .sandbox.workflow.main and .sandbox.workflow.preview Store-id: .sandbox-id. (unique across all stores in the sandbox) DNS: .dns. = Website Name: .website.name = website name

Parameters:

storeId - The id of the store to create a sandbox for

Returns:

Information about the sandbox

createUserWorkflowSandbox

public String createUserWorkflowSandbox(String stagingStore,
                               String userStore)

Creates a workflow sandbox for the given user store. This will create a workflow sandbox layered over the user's main store.

Parameters:

stagingStore - The name of the staging store the user sandbox is layered over

userStore - The name of the user store to create the workflow for

Returns:

The store name of the main store in the workflow sandbox

listAllSandboxes

public List<SandboxInfo> listAllSandboxes(String wpStoreId)

listAllSandboxes

public List<SandboxInfo> listAllSandboxes(String wpStoreId,
                                 boolean includeWorkflowSandboxes,
                                 boolean includeLocalhostDeployed)

deleteSandbox

public void deleteSandbox(String sbStoreId)

deleteSandbox

public void deleteSandbox(String sbStoreId,
                 boolean isSubmitDirectWorkflowSandbox)

deleteSandbox

public void deleteSandbox(SandboxInfo sbInfo,
                 boolean isSubmitDirectWorkflowSandbox,
                 boolean removeLocks)

updateSandboxManagers

public void updateSandboxManagers(String storeId,
                         List<String> managers)

Update the permissions for the list of sandbox managers applied to a user sandbox.

Ensures that all managers in the list have full WRITE access to the specified user stores.

Parameters:

storeId - The store id of the sandbox to update

managers - The list of authorities who have ContentManager role in the web project

removeSandboxManagers

public void removeSandboxManagers(String storeId,
                         List<String> managersToRemove)

Update the permissions for the list of sandbox managers applied to a user sandbox.

Ensures that all managers in the list have full WRITE access to the specified user stores.

Parameters:

storeId - The store id of the sandbox to update

managers - The list of authorities who have ContentManager role in the web project

updateSandboxRoles

public void updateSandboxRoles(String wpStoreId,
                      List<SandboxFactory.UserRoleWrapper> usersToUpdate,
                      Set<String> permissionsList)

removeGroupsForStore

public void removeGroupsForStore(String storeRoot)