org.alfresco.wcm.util

Class WCMUtil

java.lang.Object

org.alfresco.repo.avm.util.AVMUtil

org.alfresco.wcm.util.WCMUtil

Direct Known Subclasses:

SandboxFactory, WebProjectServiceImpl

public class WCMUtil
extends AVMUtil

Helper methods and constants related to WCM directories, paths and store name manipulation.

Author:

Ariel Backenroth, Kevin Roast, janv

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIR_ROOT
static String	LOCK_KEY_STORE_NAME
protected static Pattern	PATTERN_ILLEGAL_SEQUENCE Matches character sequences that must be escaped in a compound store name.
static String	ROLE_CONTENT_CONTRIBUTOR
static String	ROLE_CONTENT_MANAGER
static String	ROLE_CONTENT_PUBLISHER
static String	ROLE_CONTENT_REVIEWER
protected static String	SPACE_ICON_WEBSITE
protected static String	STORE_PREVIEW
protected static String	STORE_SEPARATOR
protected static String	STORE_WORKFLOW
static String	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

Constructor Summary

Constructors

Constructor and Description
WCMUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildSandboxRootPath(String storeName) Returns the root path for the specified sandbox name * eg.
protected static String	buildStagingPreviewStoreName(String storeId) Returns the preview store name for the specified store id.
static String	buildStagingStoreName(String wpStoreId) Returns the main staging store name for the specified web project
static String	buildStoreRootPath(String storeName) Returns the root path for the specified store name eg.
static String	buildStoreWebappPath(String storeName, String webApp) Returns the root webapp path for the specified store and webapp name
static String	buildUserMainStoreName(String storeId, String userName) Returns the user's main store name for a specific username
protected static String	buildUserPreviewStoreName(String storeId, String username) Returns the preview store name for a specific username.
protected static String	buildWorkflowMainStoreName(String storeId, String workflowId) Returns the store name for a specific workflow Id.
protected static String	buildWorkflowPreviewStoreName(String storeId, String workflowId) Returns the preview store name for a specific workflow Id.
static String	escapeStoreNameComponent(String component) Utility function for escaping part of a compound store name (delimited by STORE_SEPARATOR sequences).
static String	getCommonWebApp(String sbStoreId, List<String> storeRelativePaths)
protected static String	getCorrespondingMainStoreName(String storeName) Returns the corresponding main store name if this is a preview store name.
static String	getCorrespondingPath(String avmPath, String otherStoreName) Returns the corresponding path in the store provided.
protected static String	getCorrespondingPathInMainStore(String avmPath) Returns the corresponding path in the main store name if this is a path in a preview store.
protected static String	getCorrespondingPathInPreviewStore(String avmPath) Returns the corresponding path in the preview store name if this is a path in a main store.
protected static String	getCorrespondingPreviewStoreName(String storeName) Returns the corresponding preview store name if this is a main store name.
protected static String	getSandboxPath(String absoluteAVMPath) Returns the path portion up the sandbox
protected static String	getSandboxRelativePath(String absoluteAVMPath) Returns a path relative to the sandbox porition of the avm path.
static String	getSandboxStoreId(String avmPath) Extracts the sandbox store id from the avm path
static String	getStoreRelativePath(String absoluteAVMPath) Returns a path relative to the store portion of the avm path.
static String	getUserName(String storeName) Extracts the username from the store name.
static String	getWebapp(String absoluteAVMPath) Returns the webapp within the path
protected static String	getWebappPath(String absoluteAVMPath) Returns the path portion up the webapp
protected static String	getWebappRelativePath(String absoluteAVMPath) Returns a path relative to the webapp portion of the avm path.
static String	getWebProject(AVMService avmService, String avmStoreName) Returns web project store id for an AVM store name (or null for vanilla AVM store)
static org.alfresco.service.cmr.repository.NodeRef	getWebProjectNodeFromWebProjectStore(AVMService avmService, String wpStoreId)
static String	getWebProjectStoreId(String storeName) Extracts the web project store id from the (sandbox) store name
static String	getWebProjectStoreIdFromPath(String avmPath) Extracts the web project store id from the avm path For example, if the avm path is: teststore--admin:/www/ROOT then the web project id is: teststore
static String	getWorkflowId(String storeName) Extracts the workflow id
protected static boolean	isLocalhostDeployedStore(String wpStoreId, String storeName) http://wiki.alfresco.com/wiki/WCM_Deployment_Features#Debugging_.26_Testing Examples of locally deployed store names for web project "MyWebProj" are: MyWebProjlive MyWebProj--adminlive Note: if web project "MyWebProjlive" is pre-created then should be possible to browse staging: http://wiki.alfresco.com/wiki/WCM_Deployment_Features#Deployed_Runtime
protected static boolean	isPreviewStore(String storeName) Indicates whether the store name describes a preview store.
static boolean	isStagingStore(String storeName) Indicates whether the store name describes a staging store.
static boolean	isUserStore(String storeName) Indicates whether the store name describes a user store.
protected static boolean	isWorkflowStore(String storeName) Indicates whether the store name describes a workflow store.
protected static List<org.alfresco.service.cmr.repository.ChildAssociationRef>	listWebUserRefs(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef wpNodeRef, boolean preLoad)
protected static Map<String,String>	listWebUsers(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef wpNodeRef)
static String	lookupStoreDNS(AVMService avmService, String store)
protected static void	removeAllVServerWebapps(VirtServerRegistry vServerRegistry, String path, boolean force) Removal notification on all the virtualisation server webapp as required by the specified path
protected static void	removeVServerWebapp(VirtServerRegistry vServerRegistry, String path, boolean force) Removal notification on the virtualisation server webapp as required for the specified path
static void	updateVServerWebapp(VirtServerRegistry vServerRegistry, String path, boolean force) Update notification on the virtualisation server webapp as required for the specified path

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

STORE_SEPARATOR

protected static final String STORE_SEPARATOR

See Also:

Constant Field Values

PATTERN_ILLEGAL_SEQUENCE

protected static final Pattern PATTERN_ILLEGAL_SEQUENCE

Matches character sequences that must be escaped in a compound store name. We disallow non-ASCII characters due to Tomcat 5.5's insistence on URL decoding paths with the JVM default charset (not necessarily UTF-8)

STORE_WORKFLOW

protected static final String STORE_WORKFLOW

See Also:

Constant Field Values

STORE_PREVIEW

protected static final String STORE_PREVIEW

See Also:

Constant Field Values

DIR_ROOT

public static final String DIR_ROOT

See Also:

Constant Field Values

SPACE_ICON_WEBSITE

protected static final String SPACE_ICON_WEBSITE

See Also:

Constant Field Values

LOCK_KEY_STORE_NAME

public static final String LOCK_KEY_STORE_NAME

See Also:

Constant Field Values

ROLE_CONTENT_MANAGER

public static final String ROLE_CONTENT_MANAGER

See Also:

Constant Field Values

ROLE_CONTENT_PUBLISHER

public static final String ROLE_CONTENT_PUBLISHER

See Also:

Constant Field Values

ROLE_CONTENT_CONTRIBUTOR

public static final String ROLE_CONTENT_CONTRIBUTOR

See Also:

Constant Field Values

ROLE_CONTENT_REVIEWER

public static final String ROLE_CONTENT_REVIEWER

See Also:

Constant Field Values

WORKFLOW_SUBMITDIRECT_NAME

public static final String WORKFLOW_SUBMITDIRECT_NAME

See Also:

Constant Field Values

Constructor Detail

WCMUtil

public WCMUtil()

Method Detail

getSandboxStoreId

public static String getSandboxStoreId(String avmPath)

Extracts the sandbox store id from the avm path

Parameters:

avmPath - an absolute avm path

Returns:

the sandbox store id

getWebProjectStoreId

public static String getWebProjectStoreId(String storeName)

Extracts the web project store id from the (sandbox) store name

For example, if the (sandbox) store name is: teststore--admin then the web project store id is: teststore

Note: Although the staging sandbox store name is currently equivalent to the web project store id, it should be derived using 'buildStagingStoreName'.

Parameters:

storeName - the sandbox store id

Returns:

the web project store id

getWebProjectStoreIdFromPath

public static String getWebProjectStoreIdFromPath(String avmPath)

Extracts the web project store id from the avm path For example, if the avm path is: teststore--admin:/www/ROOT then the web project id is: teststore

Parameters:

avmPath - an absolute avm path

Returns:

the web project store id.

isPreviewStore

protected static boolean isPreviewStore(String storeName)

Indicates whether the store name describes a preview store.

Parameters:

storeName - the store name

Returns:

true if the store is a preview store, false otherwise.

isLocalhostDeployedStore

protected static boolean isLocalhostDeployedStore(String wpStoreId,
                               String storeName)

http://wiki.alfresco.com/wiki/WCM_Deployment_Features#Debugging_.26_Testing Examples of locally deployed store names for web project "MyWebProj" are: MyWebProjlive MyWebProj--adminlive Note: if web project "MyWebProjlive" is pre-created then should be possible to browse staging: http://wiki.alfresco.com/wiki/WCM_Deployment_Features#Deployed_Runtime

Parameters:

storeName -

Returns:

isWorkflowStore

protected static boolean isWorkflowStore(String storeName)

Indicates whether the store name describes a workflow store.

Parameters:

storeName - the store name

Returns:

true if the store is a workflow store, false otherwise.

isUserStore

public static boolean isUserStore(String storeName)

Indicates whether the store name describes a user store.

Parameters:

storeName - the store name

Returns:

true if the store is a user store, false otherwise.

isStagingStore

public static boolean isStagingStore(String storeName)

Indicates whether the store name describes a staging store.

Parameters:

storeName - the store name

Returns:

true if the store is a main store, false otherwise.

getUserName

public static String getUserName(String storeName)

Extracts the username from the store name.

Parameters:

storeName - the store name

Returns:

the username associated or null if this is a staging store.

getWorkflowId

public static String getWorkflowId(String storeName)

Extracts the workflow id

Parameters:

storeName -

Returns:

getCorrespondingMainStoreName

protected static String getCorrespondingMainStoreName(String storeName)

Returns the corresponding main store name if this is a preview store name.

Parameters:

storeName - the preview store name.

Returns:

the corresponding main store name.

Throws:

IllegalArgumentException - if this is not a preview store name.

getCorrespondingPreviewStoreName

protected static String getCorrespondingPreviewStoreName(String storeName)

Returns the corresponding preview store name if this is a main store name.

Parameters:

storeName - the main store name.

Returns:

the corresponding preview store name.

Throws:

IllegalArgumentException - if this is not a main store name.

getCorrespondingPathInMainStore

protected static String getCorrespondingPathInMainStore(String avmPath)

Returns the corresponding path in the main store name if this is a path in a preview store.

Parameters:

avmPath - an avm path within the main store.

Returns:

the corresponding path within the preview store.

Throws:

IllegalArgumentException - if this is not a path within the preview store.

getCorrespondingPathInPreviewStore

protected static String getCorrespondingPathInPreviewStore(String avmPath)

Returns the corresponding path in the preview store name if this is a path in a main store.

Parameters:

avmPath - an avm path within the main store.

Returns:

the corresponding path within the preview store.

Throws:

IllegalArgumentException - if this is not a path within the preview store.

getCorrespondingPath

public static String getCorrespondingPath(String avmPath,
                          String otherStoreName)

Returns the corresponding path in the store provided.

Parameters:

avmPath - an avm path

otherStore - the other store name to return the corresponding path for

Returns:

the corresponding path within the supplied store

escapeStoreNameComponent

public static final String escapeStoreNameComponent(String component)

Utility function for escaping part of a compound store name (delimited by STORE_SEPARATOR sequences). Uses ISO 9075 style encoding to escape otherwise problematic character sequences.

Parameters:

component - the component

Returns:

the escaped string

buildStagingStoreName

public static String buildStagingStoreName(String wpStoreId)

Returns the main staging store name for the specified web project

Parameters:

wpStoreId - web project store id to build staging store name for

Returns:

String main staging store name for the specified web project store id

buildStagingPreviewStoreName

protected static String buildStagingPreviewStoreName(String storeId)

Returns the preview store name for the specified store id.

Parameters:

storeId - store id to build preview store name for

Returns:

preview store name for the specified store id

buildUserMainStoreName

public static String buildUserMainStoreName(String storeId,
                            String userName)

Returns the user's main store name for a specific username

Parameters:

storeId - store id to build user store name for

username - of the user to build store name for

Returns:

the main store for the specified user and store id

buildUserPreviewStoreName

protected static String buildUserPreviewStoreName(String storeId,
                               String username)

Returns the preview store name for a specific username.

Parameters:

storeId - store id to build user preview store name for

username - of the user to build preview store name for

Returns:

the preview store for the specified user and store id

buildWorkflowMainStoreName

protected static String buildWorkflowMainStoreName(String storeId,
                                String workflowId)

Returns the store name for a specific workflow Id.

Parameters:

storeId - store id to build workflow store name for

workflowId - of the user to build workflow store name for

Returns:

the store for the specified workflow and store ids

buildWorkflowPreviewStoreName

protected static String buildWorkflowPreviewStoreName(String storeId,
                                   String workflowId)

Returns the preview store name for a specific workflow Id.

Parameters:

storeId - store id to build preview workflow store name for

workflowId - of the user to build preview workflow store name for

Returns:

the store for the specified preview workflow and store ids

buildStoreRootPath

public static String buildStoreRootPath(String storeName)

Returns the root path for the specified store name eg. mystore -> mystore:/www

Parameters:

storeName - store to build root path for

Returns:

root path for the specified store name

buildSandboxRootPath

public static String buildSandboxRootPath(String storeName)

Returns the root path for the specified sandbox name * eg. mystore -> mystore:/www/avm_webapps

Parameters:

storeName - store to build root sandbox path for

Returns:

root sandbox path for the specified store name

buildStoreWebappPath

public static String buildStoreWebappPath(String storeName,
                          String webApp)

Returns the root webapp path for the specified store and webapp name

Parameters:

storeName - store to build root webapp path for

webapp - webapp folder name

Returns:

the root webapp path for the specified store and webapp name

lookupStoreDNS

public static String lookupStoreDNS(AVMService avmService,
                    String store)

getWebProjectNodeFromWebProjectStore

public static org.alfresco.service.cmr.repository.NodeRef getWebProjectNodeFromWebProjectStore(AVMService avmService,
                                                                               String wpStoreId)

getWebProject

public static String getWebProject(AVMService avmService,
                   String avmStoreName)

Returns web project store id for an AVM store name (or null for vanilla AVM store)

getStoreRelativePath

public static String getStoreRelativePath(String absoluteAVMPath)

Returns a path relative to the store portion of the avm path.

Parameters:

absoluteAVMPath - an absolute path within the avm

Returns:

the path without the store prefix.

getWebappRelativePath

protected static String getWebappRelativePath(String absoluteAVMPath)

Returns a path relative to the webapp portion of the avm path.

Parameters:

absoluteAVMPath - an absolute path within the avm

Returns:

a relative path within the webapp.

getWebapp

public static String getWebapp(String absoluteAVMPath)

Returns the webapp within the path

Parameters:

absoluteAVMPath - the path from which to extract the webapp name

Returns:

an the webapp name contained within the path or null.

getWebappPath

protected static String getWebappPath(String absoluteAVMPath)

Returns the path portion up the webapp

Parameters:

absoluteAVMPath - the path from which to extract the webapp path

Returns:

an absolute avm path to the webapp contained within the path or null.

getSandboxRelativePath

protected static String getSandboxRelativePath(String absoluteAVMPath)

Returns a path relative to the sandbox porition of the avm path.

Parameters:

absoluteAVMPath - an absolute path within the avm

Returns:

a relative path within the sandbox.

getSandboxPath

protected static String getSandboxPath(String absoluteAVMPath)

Returns the path portion up the sandbox

Parameters:

absoluteAVMPath - the path from which to extract the sandbox path

Returns:

an absolute avm path to the sandbox contained within the path or null.

listWebUsers

protected static Map<String,String> listWebUsers(org.alfresco.service.cmr.repository.NodeService nodeService,
                              org.alfresco.service.cmr.repository.NodeRef wpNodeRef)

listWebUserRefs

protected static List<org.alfresco.service.cmr.repository.ChildAssociationRef> listWebUserRefs(org.alfresco.service.cmr.repository.NodeService nodeService,
                                                                            org.alfresco.service.cmr.repository.NodeRef wpNodeRef,
                                                                            boolean preLoad)

updateVServerWebapp

public static void updateVServerWebapp(VirtServerRegistry vServerRegistry,
                       String path,
                       boolean force)

Update notification on the virtualisation server webapp as required for the specified path

Parameters:

path - Path to match against

force - True to force update of server even if path does not match

removeAllVServerWebapps

protected static void removeAllVServerWebapps(VirtServerRegistry vServerRegistry,
                           String path,
                           boolean force)

Removal notification on all the virtualisation server webapp as required by the specified path

Parameters:

path - Path to match against

force - True to force update of server even if path does not match

removeVServerWebapp

protected static void removeVServerWebapp(VirtServerRegistry vServerRegistry,
                       String path,
                       boolean force)

Removal notification on the virtualisation server webapp as required for the specified path

Parameters:

path - Path to match against

force - True to force update of server even if path does not match

getCommonWebApp

public static String getCommonWebApp(String sbStoreId,
                     List<String> storeRelativePaths)