Package org.alfresco.repo.security.person

Class AbstractHomeFolderProvider.V2Adaptor

java.lang.Object

org.alfresco.repo.security.person.AbstractHomeFolderProvider.V2Adaptor

All Implemented Interfaces:

HomeFolderProvider2

Enclosing class:

AbstractHomeFolderProvider

public class AbstractHomeFolderProvider.V2Adaptor
extends java.lang.Object
implements HomeFolderProvider2

Adaptor to the HomeFolderProvider2 interface.

Constructor Summary

Constructors

Constructor	Description
V2Adaptor(AbstractHomeFolderProvider abstractHomeFolderProvider)

Method Summary

Modifier and Type	Method	Description
HomeSpaceNodeRef	getHomeFolder(org.alfresco.service.cmr.repository.NodeRef person)	Callback from PortableHomeFolderManager to locate or create a home folder.
java.util.List<java.lang.String>	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.
java.lang.String	getName()	Get the name of the provider (the bean name).
PermissionsManager	getOnCreatePermissionsManager()	Gets the PermissionsManager used on creating the home folder
PermissionsManager	getOnReferencePermissionsManager()	Gets the PermissionsManager used on referencing the home folder
java.lang.String	getOwner()	Set the authority to use as the owner of all home folder nodes.
java.lang.String	getRootPath()	Get the root path in the store under which all home folders will be located.
java.lang.String	getStoreUrl()	Get the URL String of the node store that will be used.
org.alfresco.service.cmr.repository.NodeRef	getTemplateNodeRef()	Returns a node to copy (a template) for the home folder.
void	onCreateNode(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef)

Methods inherited from class java.lang.Object

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

Constructor Detail

V2Adaptor

public V2Adaptor(AbstractHomeFolderProvider abstractHomeFolderProvider)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: HomeFolderProvider2

Get the name of the provider (the bean name).

Specified by:

getName in interface HomeFolderProvider2

getStoreUrl

public java.lang.String getStoreUrl()

Description copied from interface: HomeFolderProvider2

Get the URL String of the node store that will be used.

Specified by:

getStoreUrl in interface HomeFolderProvider2

getRootPath

public java.lang.String getRootPath()

Description copied from interface: HomeFolderProvider2

Get the root path in the store under which all home folders will be located.

Specified by:

getRootPath in interface HomeFolderProvider2

getHomeFolderPath

public java.util.List<java.lang.String> 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

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.

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

Returns:

the node to copy or null if not required.

getOwner

public java.lang.String getOwner()

Description copied from interface: HomeFolderProvider2

Set the authority to use as the owner of all home folder nodes. If null the ContentModel.PROP_USERNAME value of the person is used.

Specified by:

getOwner in interface HomeFolderProvider2

getOnCreatePermissionsManager

public PermissionsManager getOnCreatePermissionsManager()

Description copied from interface: HomeFolderProvider2

Gets the PermissionsManager used on creating the home folder

Specified by:

getOnCreatePermissionsManager in interface HomeFolderProvider2

getOnReferencePermissionsManager

public PermissionsManager getOnReferencePermissionsManager()

Description copied from interface: HomeFolderProvider2

Gets the PermissionsManager used on referencing the home folder

Specified by:

getOnReferencePermissionsManager in interface HomeFolderProvider2

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(org.alfresco.repo.security.person.HomeFolderProvider2, org.alfresco.service.cmr.repository.NodeRef, boolean).

Specified by:

getHomeFolder in interface HomeFolderProvider2

onCreateNode

public void onCreateNode(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef)