org.alfresco.web.bean.wcm
Class AVMUtil

java.lang.Object
  extended by org.alfresco.repo.avm.util.AVMUtil
      extended by org.alfresco.wcm.util.WCMUtil
          extended by org.alfresco.web.bean.wcm.AVMUtil

public final class AVMUtil
extends org.alfresco.wcm.util.WCMUtil

Helper methods and constants related to AVM directories, paths and store name manipulation. TODO refactor ...


Nested Class Summary
static class AVMUtil.PathRelation
           
 
Field Summary
 
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
 
Constructor Summary
AVMUtil()
           
 
Method Summary
static java.lang.String buildPath(java.lang.String parentAVMPath, java.lang.String path, AVMUtil.PathRelation relation)
          Converts the provided path to an absolute path within the avm.
static java.lang.String buildSandboxRootPath(java.lang.String storeName)
           
static java.lang.String buildStagingPreviewStoreName(java.lang.String storeId)
           
static java.lang.String buildStagingStoreName(java.lang.String storeId)
           
static java.lang.String buildStoreRootPath(java.lang.String storeName)
           
static java.lang.String buildStoreWebappPath(java.lang.String storeName, java.lang.String webapp)
           
static java.lang.String buildUserMainStoreName(java.lang.String storeId, java.lang.String username)
           
static java.lang.String buildUserPreviewStoreName(java.lang.String storeId, java.lang.String username)
           
static java.lang.String buildWebappUrl(java.lang.String avmPath)
           
static java.lang.String buildWebappUrl(java.lang.String store, java.lang.String webapp)
           
static java.lang.String buildWorkflowMainStoreName(java.lang.String storeId, java.lang.String workflowId)
           
static java.lang.String buildWorkflowPreviewStoreName(java.lang.String storeId, java.lang.String workflowId)
           
static java.lang.String getCorrespondingMainStoreName(java.lang.String storeName)
           
static java.lang.String getCorrespondingPath(java.lang.String avmPath, java.lang.String otherStore)
           
static java.lang.String getCorrespondingPathInMainStore(java.lang.String avmPath)
           
static java.lang.String getCorrespondingPathInPreviewStore(java.lang.String avmPath)
           
static java.lang.String getCorrespondingPreviewStoreName(java.lang.String storeName)
           
static int getLinkValidationPollingFrequency()
          Returns the number of seconds between each call back to the server to obtain the latest status of a link validation check.
static java.lang.String getPreviewURI(java.lang.String storeNameOrAvmPath)
           
static java.lang.String getPreviewURI(java.lang.String storeId, java.lang.String assetPath)
           
static int getRemoteDeploymentPollingFrequency()
          Returns the number of seconds between each call back to the server to obtain the latest status of an in progress deployment.
static java.lang.String getSandboxPath(java.lang.String absoluteAVMPath)
           
static java.lang.String getSandboxRelativePath(java.lang.String absoluteAVMPath)
           
static java.lang.String getStoreId(java.lang.String storeName)
           
static java.lang.String getStoreName(java.lang.String avmPath)
           
static java.lang.String getStoreRelativePath(java.lang.String absoluteAVMPath)
           
static java.lang.String getUserName(java.lang.String storeName)
           
static java.lang.String getWebapp(java.lang.String absoluteAVMPath)
           
static java.lang.String getWebappPath(java.lang.String absoluteAVMPath)
           
static java.lang.String getWebappRelativePath(java.lang.String absoluteAVMPath)
           
static boolean isMainStore(java.lang.String storeName)
           
static boolean isPreviewStore(java.lang.String storeName)
           
static boolean isUserStore(java.lang.String storeName)
           
static boolean isWorkflowStore(java.lang.String storeName)
           
static void makeAllDirectories(java.lang.String avmDirectoryPath)
          Creates all directories for a path if they do not already exist.
static void removeAllVServerWebapps(java.lang.String path, boolean force)
           
static void removeVServerWebapp(java.lang.String path, boolean force)
           
static void updateVServerWebapp(java.lang.String path, boolean force)
           
 
Methods inherited from class org.alfresco.wcm.util.WCMUtil
escapeStoreNameComponent, getCommonWebApp, getSandboxStoreId, getWebProject, getWebProjectNodeFromWebProjectStore, getWebProjectStoreId, getWebProjectStoreIdFromPath, getWorkflowId, isLocalhostDeployedStore, isStagingStore, listWebUserRefs, listWebUsers, lookupStoreDNS, removeAllVServerWebapps, removeVServerWebapp, updateVServerWebapp
 
Methods inherited from class org.alfresco.repo.avm.util.AVMUtil
addLeadingSlash, buildAVMPath, extendAVMPath, normalizePath, splitBase, splitPath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AVMUtil

public AVMUtil()
Method Detail

getStoreName

public static java.lang.String getStoreName(java.lang.String avmPath)

isPreviewStore

public static boolean isPreviewStore(java.lang.String storeName)

isWorkflowStore

public static boolean isWorkflowStore(java.lang.String storeName)

isUserStore

public static boolean isUserStore(java.lang.String storeName)

isMainStore

public static boolean isMainStore(java.lang.String storeName)

getUserName

public static java.lang.String getUserName(java.lang.String storeName)

getStoreId

public static java.lang.String getStoreId(java.lang.String storeName)

getCorrespondingMainStoreName

public static java.lang.String getCorrespondingMainStoreName(java.lang.String storeName)

getCorrespondingPreviewStoreName

public static java.lang.String getCorrespondingPreviewStoreName(java.lang.String storeName)

getCorrespondingPathInMainStore

public static java.lang.String getCorrespondingPathInMainStore(java.lang.String avmPath)

getCorrespondingPathInPreviewStore

public static java.lang.String getCorrespondingPathInPreviewStore(java.lang.String avmPath)

getCorrespondingPath

public static java.lang.String getCorrespondingPath(java.lang.String avmPath,
                                                    java.lang.String otherStore)

getRemoteDeploymentPollingFrequency

public static int getRemoteDeploymentPollingFrequency()
Returns the number of seconds between each call back to the server to obtain the latest status of an in progress deployment.

This value is read from the <wcm> config section in web-client-config-wcm.xml

Returns:
Number of seconds between each call to the server (in seconds). The default is 2.

getLinkValidationPollingFrequency

public static int getLinkValidationPollingFrequency()
Returns the number of seconds between each call back to the server to obtain the latest status of a link validation check.

This value is read from the <wcm> config section in web-client-config-wcm.xml

Returns:
Number of seconds between each call to the server (in seconds). The default is 2.

buildStagingStoreName

public static java.lang.String buildStagingStoreName(java.lang.String storeId)

buildStagingPreviewStoreName

public static java.lang.String buildStagingPreviewStoreName(java.lang.String storeId)

buildUserMainStoreName

public static java.lang.String buildUserMainStoreName(java.lang.String storeId,
                                                      java.lang.String username)

buildUserPreviewStoreName

public static java.lang.String buildUserPreviewStoreName(java.lang.String storeId,
                                                         java.lang.String username)

buildWorkflowMainStoreName

public static java.lang.String buildWorkflowMainStoreName(java.lang.String storeId,
                                                          java.lang.String workflowId)

buildWorkflowPreviewStoreName

public static java.lang.String buildWorkflowPreviewStoreName(java.lang.String storeId,
                                                             java.lang.String workflowId)

buildStoreRootPath

public static java.lang.String buildStoreRootPath(java.lang.String storeName)

buildSandboxRootPath

public static java.lang.String buildSandboxRootPath(java.lang.String storeName)

buildStoreWebappPath

public static java.lang.String buildStoreWebappPath(java.lang.String storeName,
                                                    java.lang.String webapp)

buildWebappUrl

public static java.lang.String buildWebappUrl(java.lang.String avmPath)

buildWebappUrl

public static java.lang.String buildWebappUrl(java.lang.String store,
                                              java.lang.String webapp)

getPreviewURI

public static java.lang.String getPreviewURI(java.lang.String storeNameOrAvmPath)

getPreviewURI

public static java.lang.String getPreviewURI(java.lang.String storeId,
                                             java.lang.String assetPath)

buildPath

public static java.lang.String buildPath(java.lang.String parentAVMPath,
                                         java.lang.String path,
                                         AVMUtil.PathRelation relation)
Converts the provided path to an absolute path within the avm.

Parameters:
parentAVMPath - used as the parent path if the provided path is relative, otherwise used to extract the parent path portion up until the webapp directory.
path - a path relative to the parentAVMPath path, or if it is absolute, it is relative to the sandbox used in the parentAVMPath.
Returns:
an absolute path within the avm using the paths provided.

getStoreRelativePath

public static java.lang.String getStoreRelativePath(java.lang.String absoluteAVMPath)

getWebappRelativePath

public static java.lang.String getWebappRelativePath(java.lang.String absoluteAVMPath)

getWebapp

public static java.lang.String getWebapp(java.lang.String absoluteAVMPath)

getWebappPath

public static java.lang.String getWebappPath(java.lang.String absoluteAVMPath)

getSandboxRelativePath

public static java.lang.String getSandboxRelativePath(java.lang.String absoluteAVMPath)

getSandboxPath

public static java.lang.String getSandboxPath(java.lang.String absoluteAVMPath)

makeAllDirectories

public static void makeAllDirectories(java.lang.String avmDirectoryPath)
Creates all directories for a path if they do not already exist.


updateVServerWebapp

public static void updateVServerWebapp(java.lang.String path,
                                       boolean force)

removeAllVServerWebapps

public static void removeAllVServerWebapps(java.lang.String path,
                                           boolean force)

removeVServerWebapp

public static void removeVServerWebapp(java.lang.String path,
                                       boolean force)


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.