org.alfresco.module.vti.handler.alfresco

Class VtiPathHelper

java.lang.Object

org.springframework.extensions.surf.util.AbstractLifecycleBean

org.alfresco.module.vti.handler.alfresco.VtiPathHelper

All Implemented Interfaces:

EventListener, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener

public class VtiPathHelper
extends org.springframework.extensions.surf.util.AbstractLifecycleBean

Helper for AlfrescoVtiMethodHandler. Help for path resolving and url formatting

Author:

Dmitry Lazurkin

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALTERNATE_PATH_DOCUMENT_IDENTIFICATOR
static String	ALTERNATE_PATH_SITE_IDENTIFICATOR

Fields inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

log

Constructor Summary

Constructors

Constructor and Description
VtiPathHelper()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	decomposeDocumentURL(String alfrescoContext, String uri, org.alfresco.service.namespace.QName spaceType) Breaks down the Document Context + URI into the document path and name.
protected String[]	doDecomposeURLWork(String alfrescoContext, String uri, org.alfresco.service.namespace.QName spaceType)
org.alfresco.service.cmr.repository.NodeRef	findList(org.alfresco.service.cmr.repository.NodeRef itemInList) For a given node, looks up the parent tree to find the List (Site Container) that it is part of.
String	getAlfrescoContext() Get alfresco context
String	getContextFromDocumentName(String document) Get context form document name
String	getDwsFromDocumentName(String document, org.alfresco.service.namespace.QName spaceType) Get Document Workspace site from document name
org.alfresco.service.cmr.model.FileFolderService	getFileFolderService()
String	getHostFromDocumentName(String document) Get host from document name
String	getPathForURL(String urlPath) Translates an incoming path (as used in a URL) to a repository path, taking into account any translations that may be necessary.
String	getPathFromDocumentName(String document) Get path from document name
org.alfresco.service.cmr.repository.NodeRef	getRootNodeRef()
String	getRootPath()
String	getStorePath()
String	getUserHomeLocation() Get home space for current user
protected void	onBootstrap(org.springframework.context.ApplicationEvent event)
protected void	onShutdown(org.springframework.context.ApplicationEvent event)
static String	removeSlashes(String value) Remove slashes from string
String	resolveListName(String listId) Helper method that allows to resolve list name from listId
org.alfresco.service.cmr.model.FileInfo	resolvePathFileInfo(org.alfresco.service.cmr.model.FileInfo parentFileInfo, String childName) Resolves file info for file with URL path in parent directory with file info
org.alfresco.service.cmr.model.FileInfo	resolvePathFileInfo(String initialURL) Resolve file info for file with URL path
void	setAuthenticationComponent(org.alfresco.repo.security.authentication.AuthenticationComponent authenticationComponent) Set authentication component
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService) Set file-folder service
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService) Set namespace service
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set node service
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService) Set permission service
void	setPersonService(org.alfresco.service.cmr.security.PersonService personService)
void	setRootPath(String rootPath) Set root path
void	setSearchService(org.alfresco.service.cmr.search.SearchService searchService) Set search service
void	setSingletonCache(org.alfresco.repo.cache.SimpleCache<String,org.alfresco.service.cmr.repository.NodeRef> singletonCache)
void	setStorePath(String storePath) Set store path
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
void	setUrlPathPrefix(String urlPathPrefix)
static org.alfresco.util.Pair<String,String>	splitPathParentChild(String path) Split URL path to document name and path to parent folder of that document
String	stripPathPrefix(String prefix, String path) Removes a prefix from a given path.
String	toUrlPath(org.alfresco.service.cmr.model.FileInfo fileInfo) Format FrontPageExtension URL path from file information

Methods inherited from class org.springframework.extensions.surf.util.AbstractLifecycleBean

getApplicationContext, onApplicationEvent, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

ALTERNATE_PATH_DOCUMENT_IDENTIFICATOR

public static final String ALTERNATE_PATH_DOCUMENT_IDENTIFICATOR

See Also:

Constant Field Values

ALTERNATE_PATH_SITE_IDENTIFICATOR

public static final String ALTERNATE_PATH_SITE_IDENTIFICATOR

See Also:

Constant Field Values

Constructor Detail

VtiPathHelper

public VtiPathHelper()

Method Detail

setAuthenticationComponent

public void setAuthenticationComponent(org.alfresco.repo.security.authentication.AuthenticationComponent authenticationComponent)

Set authentication component

Parameters:

authenticationComponent - the authentication component to set (AuthenticationComponent)

setNodeService

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

Set node service

Parameters:

nodeService - the node service to set (NodeService)

setFileFolderService

public void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)

Set file-folder service

Parameters:

fileFolderService - the file-folder service to set (FileFolderService)

setPermissionService

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

Set permission service

Parameters:

permissionService - the permission service to set (PermissionService)

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)

Set search service

Parameters:

searchService - the search service to set (SearchService)

setRootPath

public void setRootPath(String rootPath)

Set root path

Parameters:

rootPath - the root path to set

setStorePath

public void setStorePath(String storePath)

Set store path

Parameters:

storePath - the store path to set

setUrlPathPrefix

public void setUrlPathPrefix(String urlPathPrefix)

Parameters:

urlPathPrefix - the urlPathPrefix to set

getAlfrescoContext

public String getAlfrescoContext()

Get alfresco context

Returns:

alfresco context

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

Set namespace service

Parameters:

namespaceService - the namespace service to set (NamespaceService)

resolvePathFileInfo

public org.alfresco.service.cmr.model.FileInfo resolvePathFileInfo(String initialURL)

Resolve file info for file with URL path

Parameters:

initialURL - URL path

Returns:

FileInfo file info null if file or folder doesn't exist

resolvePathFileInfo

public org.alfresco.service.cmr.model.FileInfo resolvePathFileInfo(org.alfresco.service.cmr.model.FileInfo parentFileInfo,
                                                          String childName)

Resolves file info for file with URL path in parent directory with file info

Parameters:

parentFileInfo - file info for parent directory (FileInfo)

childName - url path relative to parent directory

Returns:

FileInfo resolved file info for childName or null, if it doesn't exist

splitPathParentChild

public static org.alfresco.util.Pair<String,String> splitPathParentChild(String path)

Split URL path to document name and path to parent folder of that document

Parameters:

path - URL path

Returns:

Pair first item of pair - path to parent folder, second item - document name

toUrlPath

public String toUrlPath(org.alfresco.service.cmr.model.FileInfo fileInfo)

Format FrontPageExtension URL path from file information

Parameters:

fileInfo - file information (FileInfo)

Returns:

URL path

getUserHomeLocation

public String getUserHomeLocation()

Get home space for current user

Returns:

String url to home space

decomposeDocumentURL

public String[] decomposeDocumentURL(String alfrescoContext,
                            String uri,
                            org.alfresco.service.namespace.QName spaceType)

Breaks down the Document Context + URI into the document path and name.

Parameters:

alfrescoContext - The alfresco context

uri - The document URI

spaceType - The type of the space

doDecomposeURLWork

protected String[] doDecomposeURLWork(String alfrescoContext,
                          String uri,
                          org.alfresco.service.namespace.QName spaceType)

getPathForURL

public String getPathForURL(String urlPath)

Translates an incoming path (as used in a URL) to a repository path, taking into account any translations that may be necessary. For example:

   /alfresco/mysite/documentLibrary/folder1/file1.txt
 

will be translated to:

   /mysite/documentLibrary/folder1/file1.txt
 

(assuming that the context-path/servletpath is /alfresco)

Parameters:

urlPath -

Returns:

stripPathPrefix

public String stripPathPrefix(String prefix,
                     String path)

Removes a prefix from a given path. For example, given the path "/red/green/blue" and prefix "/red", the method will return "green/blue" - note that this is now a relative path. If the path does not begin with the supplied prefix then the path is returned unprocessed.

Parameters:

prefix -

path -

Returns:

path without prefix

getDwsFromDocumentName

public String getDwsFromDocumentName(String document,
                            org.alfresco.service.namespace.QName spaceType)

Get Document Workspace site from document name

Parameters:

document - document

spaceType - type of space

Returns:

url to Document Workspace site

getHostFromDocumentName

public String getHostFromDocumentName(String document)

Get host from document name

Parameters:

document - document

Returns:

host

getContextFromDocumentName

public String getContextFromDocumentName(String document)

Get context form document name

Parameters:

document - document

Returns:

context

getPathFromDocumentName

public String getPathFromDocumentName(String document)

Get path from document name

Parameters:

document - document

Returns:

path

resolveListName

public String resolveListName(String listId)

Helper method that allows to resolve list name from listId

Parameters:

listId - the id of the list

Returns:

the list' name

findList

public org.alfresco.service.cmr.repository.NodeRef findList(org.alfresco.service.cmr.repository.NodeRef itemInList)

For a given node, looks up the parent tree to find the List (Site Container) that it is part of.

Parameters:

itemInList - the nodeRef of item to look parent container for

Returns:

the nodeRef of the list this item is part of, or the node itself if it isn't in one

onBootstrap

protected void onBootstrap(org.springframework.context.ApplicationEvent event)

Specified by:

onBootstrap in class org.springframework.extensions.surf.util.AbstractLifecycleBean

See Also:

AbstractLifecycleBean.onBootstrap(org.springframework.context.ApplicationEvent)

removeSlashes

public static String removeSlashes(String value)

Remove slashes from string

Parameters:

value - input string

Returns:

String output string

onShutdown

protected void onShutdown(org.springframework.context.ApplicationEvent event)

Specified by:

onShutdown in class org.springframework.extensions.surf.util.AbstractLifecycleBean

See Also:

AbstractLifecycleBean.onShutdown(org.springframework.context.ApplicationEvent)

getRootNodeRef

public org.alfresco.service.cmr.repository.NodeRef getRootNodeRef()

Returns:

Root NodeRef

getRootPath

public String getRootPath()

getStorePath

public String getStorePath()

setPersonService

public void setPersonService(org.alfresco.service.cmr.security.PersonService personService)

getFileFolderService

public org.alfresco.service.cmr.model.FileFolderService getFileFolderService()

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setSingletonCache

public void setSingletonCache(org.alfresco.repo.cache.SimpleCache<String,org.alfresco.service.cmr.repository.NodeRef> singletonCache)