org.exoplatform.services.jcr.ext.hierarchy
Interface NodeHierarchyCreator

All Known Implementing Classes:

NodeHierarchyCreatorImpl

public interface NodeHierarchyCreator

This service is used as an helper to initialize the JCR Created by The eXo Platform SAS Author : Dang Van Minh minh.dang@exoplatform.com Nov 15, 2007 10:10:10 AM

Method Summary

void	addPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Registers a new plugins
String	getJcrPath(String alias) Gets the JCR path corresponding to the given alias
javax.jcr.Node	getPublicApplicationNode(SessionProvider sessionProvider) Gets the JCR node corresponding to the root node of the public applications
javax.jcr.Node	getUserApplicationNode(SessionProvider sessionProvider, String userName) Gets the JCR node corresponding to the root node of the user's applications
javax.jcr.Node	getUserNode(SessionProvider sessionProvider, String userName) Gets the JCR node corresponding to the root node of the user workspace
void	init() Initialize the current repository thanks to all the registered plugins
void	init(String repository) Deprecated. use init() instead
void	removeUserNode(SessionProvider sessionProvider, String userName) Remove the JCR node corresponding to the root node of the user workspace

Method Detail

getJcrPath

String getJcrPath(String alias)

Gets the JCR path corresponding to the given alias

Parameters:

alias - the alias of the path to retrieve

Returns:

the corresponding JCR path

init

void init(String repository)
          throws Exception

Deprecated. use init() instead

Initialize the given repository thanks to all the registered plugins

Parameters:

repository - the repository to initialize

Throws:

Exception - if an exception occurs

init

void init()
          throws Exception

Initialize the current repository thanks to all the registered plugins

Parameters:

repository - the repository to initialize

Throws:

Exception - if an exception occurs

removeUserNode

void removeUserNode(SessionProvider sessionProvider,
                    String userName)
                    throws Exception

Remove the JCR node corresponding to the root node of the user workspace

Parameters:

sessionProvider - the session provider to use to remove the root node

userName - the user name for which we want to remove the root node of his workspace

Throws:

Exception - if an exception occurs

getUserNode

javax.jcr.Node getUserNode(SessionProvider sessionProvider,
                           String userName)
                           throws Exception

Gets the JCR node corresponding to the root node of the user workspace

Parameters:

sessionProvider - the session provider to use to get the root node

userName - the user name for which we want to find the root node of his workspace

Returns:

the root node of the workspace of the given user

Throws:

Exception - if an exception occurs

getUserApplicationNode

javax.jcr.Node getUserApplicationNode(SessionProvider sessionProvider,
                                      String userName)
                                      throws Exception

Gets the JCR node corresponding to the root node of the user's applications

Parameters:

sessionProvider - the session provider to use to get the root node

userName - the user name for which we want to find the root node of his applications

Returns:

the root node of the user's applications of the given user

Throws:

Exception - if an exception occurs

getPublicApplicationNode

javax.jcr.Node getPublicApplicationNode(SessionProvider sessionProvider)
                                        throws Exception

Gets the JCR node corresponding to the root node of the public applications

Parameters:

sessionProvider - the session provider to use to get the root node

Returns:

the root node of the public applications

Throws:

Exception - if an exception occurs

addPlugin

void addPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Registers a new plugins

Parameters:

plugin - the plugin to register