org.ametys.plugins.userdirectory

Class UserDirectoryHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.userdirectory.UserDirectoryHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class UserDirectoryHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for user directory.

Field Summary

Fields

Modifier and Type	Field and Description
protected AmetysObjectResolver	_resolver The ametys object resolver
static String	ROLE The avalon role.
static String	USER_DIRECTORY_ROOT_NODE The root node name of the plugin

Constructor Summary

Constructors

Constructor and Description
UserDirectoryHelper()

Method Summary

Modifier and Type	Method and Description
AmetysObjectCollection	getUserDirectoryRootContent() Gets the root of user directory contents
AmetysObjectCollection	getUserDirectoryRootContent(boolean create) Gets the root of user directory contents
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role.

USER_DIRECTORY_ROOT_NODE

public static final String USER_DIRECTORY_ROOT_NODE

The root node name of the plugin

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

Constructor Detail

UserDirectoryHelper

public UserDirectoryHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getUserDirectoryRootContent

public AmetysObjectCollection getUserDirectoryRootContent()

Gets the root of user directory contents

Returns:

the root of user directory contents

getUserDirectoryRootContent

public AmetysObjectCollection getUserDirectoryRootContent(boolean create)

Gets the root of user directory contents

Parameters:

create - true to create automatically the root when missing.

Returns:

the root of user directory contents