Package org.ametys.plugins.userdirectory

Class UserDirectoryHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.userdirectory.UserDirectoryHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Contextualizable, Serviceable

public class UserDirectoryHelper
extends AbstractLogEnabled
implements Component, Serviceable, Initializable, Contextualizable

Helper for user directory.

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected Context	_context	The context
protected ContentTypeExtensionPoint	_cTypeEP	The content type extension point
protected LanguagesManager	_languagesManager	The languages manager
protected AmetysObjectResolver	_resolver	The ametys object resolver
static final String	ABSTRACT_USER_CONTENT_TYPE	The parent content type id
static final String	ORGUNIT_CONTENT_TYPE	The orgUnit content type
static final String	ORGUNITS_ATTRIBUTE	The orgUnit parent attribute
static final String	ROLE	The avalon role.
static final String	USER_DIRECTORY_ROOT_NODE	The root node name of the plugin

Constructor Summary

Constructors

Constructor	Description
UserDirectoryHelper()

Method Summary

Modifier and Type	Method	Description
protected List<String>	_requestUserContentIds(UserIdentity user, String lang)	Request the list of user content id
void	contextualize(Context context)
List<Content>	getOrgUnits(Content user)	Get the list of orgunits content
Content	getUserContent(UserIdentity user, String givenLanguage)	Get user content from user identity
List<Content>	getUserContents(UserIdentity user, String givenLanguage)	Get user contents from user identity
AmetysObjectCollection	getUserDirectoryRootContent()	Gets the root of user directory contents
AmetysObjectCollection	getUserDirectoryRootContent(boolean create)	Gets the root of user directory contents
void	initialize()
void	invalidateUserContentCache(String lang)	Invalidate the user content cache for one language.
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 Details

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

ORGUNITS_ATTRIBUTE

public static final String ORGUNITS_ATTRIBUTE

The orgUnit parent attribute

See Also:

• Constant Field Values

ORGUNIT_CONTENT_TYPE

public static final String ORGUNIT_CONTENT_TYPE

The orgUnit content type

See Also:

• Constant Field Values

ABSTRACT_USER_CONTENT_TYPE

public static final String ABSTRACT_USER_CONTENT_TYPE

The parent content type id

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

_languagesManager

protected LanguagesManager _languagesManager

The languages manager

_context

protected Context _context

The context

Constructor Details

UserDirectoryHelper

public UserDirectoryHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

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

getOrgUnits

public List<Content> getOrgUnits(Content user)

Get the list of orgunits content

Parameters:

user - the user content

Returns:

the list of orgunits

getUserContents

public List<Content> getUserContents(UserIdentity user,
 String givenLanguage)

Get user contents from user identity

Parameters:

user - the user identity

givenLanguage - the given language

Returns:

the user contents

getUserContent

public Content getUserContent(UserIdentity user,
 String givenLanguage)

Get user content from user identity

Parameters:

user - the user identity

givenLanguage - the given language

Returns:

the user content (null if it not exist)

_requestUserContentIds

protected List<String> _requestUserContentIds(UserIdentity user,
 String lang)

Request the list of user content id

Parameters:

user - the user identity

lang - the lang

Returns:

the list of user content id (empty if it not exist)

invalidateUserContentCache

public void invalidateUserContentCache(String lang)

Invalidate the user content cache for one language. If lang is null, invalidate all

Parameters:

lang - the lang. Can be null