org.alfresco.repo.security.person
Class UsernameHomeFolderProvider

java.lang.Object
  extended by org.alfresco.repo.security.person.AbstractHomeFolderProvider2
      extended by org.alfresco.repo.security.person.UsernameHomeFolderProvider
All Implemented Interfaces:
HomeFolderProvider2, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean
Direct Known Subclasses:
RegexHomeFolderProvider

public class UsernameHomeFolderProvider
extends AbstractHomeFolderProvider2

Creates home folders directly under the root path, based on the username of the user.


Constructor Summary
UsernameHomeFolderProvider()
           
 
Method Summary
 HomeSpaceNodeRef getHomeFolder(org.alfresco.service.cmr.repository.NodeRef person)
          Callback from PortableHomeFolderManager to locate or create a home folder.
 java.util.List getHomeFolderPath(org.alfresco.service.cmr.repository.NodeRef person)
          Returns a preferred path (a list of folder names) for the home folder relative to the root path.
 org.alfresco.service.cmr.repository.NodeRef getTemplateNodeRef()
          Returns a node to copy (a template) for the home folder.
 void setTemplatePath(java.lang.String templatePath)
           
 
Methods inherited from class org.alfresco.repo.security.person.AbstractHomeFolderProvider2
afterPropertiesSet, getHomeFolderManager, getName, getOnCreatePermissionsManager, getOnReferencePermissionsManager, getOwner, getRootPath, getStoreUrl, setBeanName, setHomeFolderManager, setOnCreatePermissionsManager, setOnReferencePermissionsManager, setOwner, setRootPath, setStoreUrl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UsernameHomeFolderProvider

public UsernameHomeFolderProvider()
Method Detail

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)

getTemplateNodeRef

public org.alfresco.service.cmr.repository.NodeRef getTemplateNodeRef()
Description copied from interface: HomeFolderProvider2
Returns a node to copy (a template) for the home folder. Only used by HomeFolderProviders that create home folders rather than just reference existing folders.

Specified by:
getTemplateNodeRef in interface HomeFolderProvider2
Overrides:
getTemplateNodeRef in class AbstractHomeFolderProvider2
Returns:
the node to copy or null if not required.

getHomeFolderPath

public java.util.List getHomeFolderPath(org.alfresco.service.cmr.repository.NodeRef person)
Description copied from interface: HomeFolderProvider2
Returns a preferred path (a list of folder names) for the home folder relative to the root path. If all users share the root, the returned value should be an empty List or null. When all users have their own folder under the root there should be just one element in the List. Multiple elements should be returned when a nested folder structure is preferred.

Specified by:
getHomeFolderPath in interface HomeFolderProvider2
Overrides:
getHomeFolderPath in class AbstractHomeFolderProvider2
Parameters:
person - NodeRef from which a property (normally the userName) is used as a hash key to create a nested directory structure.
Returns:
the path to be used.

getHomeFolder

public HomeSpaceNodeRef getHomeFolder(org.alfresco.service.cmr.repository.NodeRef person)
Description copied from interface: HomeFolderProvider2
Callback from PortableHomeFolderManager to locate or create a home folder. Implementations normally call PortableHomeFolderManager.getHomeFolder.



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