Package org.ametys.plugins.core.impl.group.directory.jdbc

Class JdbcGroupDirectory

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.group.directory.jdbc.JdbcGroupDirectory

All Implemented Interfaces:

GroupDirectory, ModifiableGroupDirectory, Cacheable, LogEnabled, Disposable, Serviceable

public class JdbcGroupDirectory
extends AbstractLogEnabled
implements ModifiableGroupDirectory, Serviceable, Cacheable, Disposable

Standard implementation of GroupDirectory from the core database.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.util.Cacheable

Cacheable.SingleCacheConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected String	_dataSourceId	The identifier of data source
protected String	_groupsCompositionTableName	The name of the SQL table storing the composition (i.e.
protected String	_groupsListTableName	The name of the SQL table storing the groups
protected String	_id	The id
protected I18nizableText	_label	The label
protected ServiceManager	_manager	Avalon manager
protected ObservationManager	_observationManager	The observation manager
protected SourceResolver	_sourceResolver	The cocoon source resolver

Constructor Summary

Constructors

Constructor	Description
JdbcGroupDirectory()

Method Summary

Modifier and Type	Method	Description
protected String	_createGetGroupsClause(String dbType)	Get the sql clause that gets all groups
protected void	_fillGroup(org.ametys.plugins.core.impl.group.directory.jdbc.JdbcGroupDirectory.JdbcGroup group, Connection connection)	Fill users set in a group.
ModifiableGroup	add(String name)	Add a new group of users.
void	dispose()
AbstractCacheManager	getCacheManager()	Returns the instance of the implementation of AbstractCacheManager to use.
ModifiableGroup	getGroup(String groupID)	Returns a particular group.
String	getGroupDirectoryModelId()	Get the id of the GroupDirectoryModel extension point
Set<Group>	getGroups()	Returns all groups.
List<Group>	getGroups(int count, int offset, Map parameters)	Get groups
String	getId()	Get the id of the group directory.
I18nizableText	getLabel()	Get the label of the group directory.
Collection<Cacheable.SingleCacheConfiguration>	getManagedCaches()	Gets the managed caches.
Map<String,Object>	getParameterValues()	Get the values of parameters (from group directory model)
protected Connection	getSQLConnection()	Get the connection to the database
Set<String>	getUserGroups(UserIdentity userIdentity)	Get all groups a particular user is in.
void	init(String groupDirectoryModelId, Map<String,Object> paramValues)	Initialize the group directory with given parameter values.
void	remove(String groupID)	Remove a group of users.
void	service(ServiceManager manager)
void	setId(String id)	Set the id of the group directory.
void	setLabel(I18nizableText label)	Set the label of the group directory.
void	update(ModifiableGroup userGroup)	Modify an existing group of users.

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

Methods inherited from interface org.ametys.core.util.Cacheable

createCaches, getCache, hasComputableSize, isCachingEnabled, removeCaches

Field Details

_observationManager

protected ObservationManager _observationManager

The observation manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_sourceResolver

protected SourceResolver _sourceResolver

The cocoon source resolver

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

_dataSourceId

protected String _dataSourceId

The identifier of data source

_groupsListTableName

protected String _groupsListTableName

The name of the SQL table storing the groups

_groupsCompositionTableName

protected String _groupsCompositionTableName

The name of the SQL table storing the composition (i.e. users) of the groups

_manager

protected ServiceManager _manager

Avalon manager

_id

protected String _id

The id

_label

protected I18nizableText _label

The label

Constructor Details

JdbcGroupDirectory

public JdbcGroupDirectory()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getId

public String getId()

Description copied from interface: GroupDirectory

Get the id of the group directory.

Specified by:

getId in interface GroupDirectory

Returns:

The id of the group directory

getLabel

public I18nizableText getLabel()

Description copied from interface: GroupDirectory

Get the label of the group directory.

Specified by:

getLabel in interface GroupDirectory

Returns:

The label of the group directory

setId

public void setId(String id)

Description copied from interface: GroupDirectory

Set the id of the group directory.

Specified by:

setId in interface GroupDirectory

Parameters:

id - The id

setLabel

public void setLabel(I18nizableText label)

Description copied from interface: GroupDirectory

Set the label of the group directory.

Specified by:

setLabel in interface GroupDirectory

Parameters:

label - The label

getGroupDirectoryModelId

public String getGroupDirectoryModelId()

Description copied from interface: GroupDirectory

Get the id of the GroupDirectoryModel extension point

Specified by:

getGroupDirectoryModelId in interface GroupDirectory

Returns:

the id of extension point

getParameterValues

public Map<String,Object> getParameterValues()

Description copied from interface: GroupDirectory

Get the values of parameters (from group directory model)

Specified by:

getParameterValues in interface GroupDirectory

Returns:

the parameters' values

dispose

public void dispose()

Specified by:

dispose in interface Disposable

getManagedCaches

public Collection<Cacheable.SingleCacheConfiguration> getManagedCaches()

Description copied from interface: Cacheable

Gets the managed caches.
This is meant to be implemented in order to describe the managed caches and automatically create and remove the corresponding caches in Cacheable.createCaches() and Cacheable.removeCaches() default methods.
This is not meant to be called manually.

Specified by:

getManagedCaches in interface Cacheable

Returns:

A collection of Cacheable.SingleCacheConfigurations to manage

getCacheManager

public AbstractCacheManager getCacheManager()

Description copied from interface: Cacheable

Returns the instance of the implementation of AbstractCacheManager to use.
This is not meant to be called manually.

Specified by:

getCacheManager in interface Cacheable

Returns:

The AbstractCacheManager to bind

init

public void init(String groupDirectoryModelId,
 Map<String,Object> paramValues)

Description copied from interface: GroupDirectory

Initialize the group directory with given parameter values.

Specified by:

init in interface GroupDirectory

Parameters:

groupDirectoryModelId - The id of group directory extension point

paramValues - The parameters' values

getSQLConnection

protected Connection getSQLConnection()

Get the connection to the database

Returns:

the SQL connection

getGroup

public ModifiableGroup getGroup(String groupID)

Description copied from interface: GroupDirectory

Returns a particular group.

Specified by:

getGroup in interface GroupDirectory

Specified by:

getGroup in interface ModifiableGroupDirectory

Parameters:

groupID - The id of the group.

Returns:

The group or null if the group does not exist.

getGroups

public Set<Group> getGroups()

Description copied from interface: GroupDirectory

Returns all groups.

Specified by:

getGroups in interface GroupDirectory

Returns:

The groups as a Set of UserGroup, empty if an error occurs.

_createGetGroupsClause

protected String _createGetGroupsClause(String dbType)

Get the sql clause that gets all groups

Parameters:

dbType - The connection type

Returns:

A non null sql clause (e.g. "select ... from ... where ...")

_fillGroup

protected void _fillGroup(org.ametys.plugins.core.impl.group.directory.jdbc.JdbcGroupDirectory.JdbcGroup group,
 Connection connection)
                   throws SQLException

Fill users set in a group.

Parameters:

group - The group to fill.

connection - The SQL connection.

Throws:

SQLException - If a problem occurs.

getUserGroups

public Set<String> getUserGroups(UserIdentity userIdentity)

Description copied from interface: GroupDirectory

Get all groups a particular user is in.

Specified by:

getUserGroups in interface GroupDirectory

Parameters:

userIdentity - The identity of the user

Returns:

The groups as a Set of String (group ID), empty if the login does not match.

getGroups

public List<Group> getGroups(int count,
 int offset,
 Map parameters)

Description copied from interface: GroupDirectory

Get groups

Specified by:

getGroups in interface GroupDirectory

Parameters:

count - The maximum number of groups to sax. (-1 to sax all)

offset - The offset to start with, first is 0.

parameters - Parameters for saxing user list differently, see implementation.

Returns:

The matching groups

add

public ModifiableGroup add(String name)
                    throws InvalidModificationException

Description copied from interface: ModifiableGroupDirectory

Add a new group of users.

Specified by:

add in interface ModifiableGroupDirectory

Parameters:

name - The name of the user group to create. Cannot be null;

Returns:

The user group created

Throws:

InvalidModificationException - if the group id exists yet or if at least one of the parameter is invalid.

update

public void update(ModifiableGroup userGroup)
            throws InvalidModificationException

Description copied from interface: ModifiableGroupDirectory

Modify an existing group of users.

Specified by:

update in interface ModifiableGroupDirectory

Parameters:

userGroup - Informations about the new group. Cannot be null:

Throws:

InvalidModificationException - if the group id does not exist yet

remove

public void remove(String groupID)
            throws InvalidModificationException

Description copied from interface: ModifiableGroupDirectory

Remove a group of users.

Specified by:

remove in interface ModifiableGroupDirectory

Parameters:

groupID - The id of the group. Cannot be null;

Throws:

InvalidModificationException - if the group id does not exist.