Package org.ametys.core.group

Class GroupDirectoryContextHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.group.GroupDirectoryContextHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class GroupDirectoryContextHelper
extends AbstractLogEnabled
implements Component, Serviceable, Initializable

Helper for associating GroupDirectory(ies) to contexts.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_CONTEXT	The "admin" context
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
GroupDirectoryContextHelper()

Method Summary

Modifier and Type	Method	Description
protected Cache<String,Set<String>>	_getCache()	Get the cache
protected Map<String,Set<String>>	_getCacheAsMap()	Get the cache as map
Set<String>	getContextsForGroupDirectory(String groupDirectoryId)	Get the contexts that contain the group directory
Set<String>	getGroupDirectoriesOnContext(String context)	Gets the group directories linked to the given context
Set<String>	getGroupDirectoriesOnContext(String context, boolean checkRights)	Gets the group directories linked to the given context
Set<String>	getGroupDirectoriesOnContexts(Set<String> contexts)	Gets the group directories linked to at least one of the given contexts
Set<String>	getGroupDirectoriesOnContexts(Set<String> contexts, boolean checkRights)	Gets the group directories linked to at least one of the given contexts
protected Connection	getSQLConnection()	Get the connection to the database
void	initialize()
Set<String>	link(String context, List<String> ids)	Links given group directories to a context.
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

Avalon Role

ADMIN_CONTEXT

public static final String ADMIN_CONTEXT

The "admin" context

See Also:

• Constant Field Values

Constructor Details

GroupDirectoryContextHelper

public GroupDirectoryContextHelper()

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

getSQLConnection

protected Connection getSQLConnection()

Get the connection to the database

Returns:

the SQL connection

link

public Set<String> link(String context,
 List<String> ids)

Links given group directories to a context.

Parameters:

context - The context

ids - The ids of the group directories to link

Returns:

The ids of the linked group directories

getContextsForGroupDirectory

public Set<String> getContextsForGroupDirectory(String groupDirectoryId)

Get the contexts that contain the group directory

Parameters:

groupDirectoryId - The id of the group directory

Returns:

a Set of contexts

getGroupDirectoriesOnContext

public Set<String> getGroupDirectoriesOnContext(String context,
 boolean checkRights)
                                         throws AccessDeniedException

Gets the group directories linked to the given context

Parameters:

context - The context

checkRights - true to check the rights of the user, false otherwise

Returns:

The ids of group directories linked to the context

Throws:

AccessDeniedException - If check right is set to true and the user tried to retrieve groups from unauthorized contexts

getGroupDirectoriesOnContext

public Set<String> getGroupDirectoriesOnContext(String context)

Gets the group directories linked to the given context

Parameters:

context - The context

Returns:

The ids of group directories linked to the context

getGroupDirectoriesOnContexts

public Set<String> getGroupDirectoriesOnContexts(Set<String> contexts,
 boolean checkRights)
                                          throws AccessDeniedException

Gets the group directories linked to at least one of the given contexts

Parameters:

contexts - The contexts

checkRights - true to check the rights of the user, false otherwise

Returns:

The ids of group directories linked to the contexts

Throws:

AccessDeniedException - If check right is set to true and the user tried to retrieve groups from unauthorized contexts

getGroupDirectoriesOnContexts

public Set<String> getGroupDirectoriesOnContexts(Set<String> contexts)

Gets the group directories linked to at least one of the given contexts

Parameters:

contexts - The contexts

Returns:

The ids of group directories linked to the contexts

_getCache

protected Cache<String,Set<String>> _getCache()

Get the cache

Returns:

Non null cache

_getCacheAsMap

protected Map<String,Set<String>> _getCacheAsMap()

Get the cache as map

Returns:

Non null cache