fr.cnes.sitools.security
Interface UsersAndGroupsStore

All Known Implementing Classes:

JDBCUsersAndGroupsStore, UsersAndGroupsStoreXML

public interface UsersAndGroupsStore

Interface for user and groups management. Many implementation can be done : JDBC DB, XML, LDAP

Author:

AKKA Technologies

Method Summary

Group	createGroup(Group bean) Creates a new Group
User	createUser(User bean) Method for creating users
boolean	deleteGroup(java.lang.String name) Deletes a group
boolean	deleteUser(java.lang.String identifier) Method for deleting a user
Group	getGroupById(java.lang.String name) getGroupById : Gets group by its id (name)
java.util.List<Group>	getGroups() Gets all groups
java.util.List<Group>	getGroups(int start, int limit, java.lang.String query) getGroups
java.util.List<Group>	getGroups(ResourceCollectionFilter filter) Gets groups according to the generic filter
java.util.List<Group>	getGroupsByUser(java.lang.String identifier) getGroupsByUser Gets groups which contain specified user
java.util.List<Group>	getGroupsByUser(java.lang.String identifier, ResourceCollectionFilter filter) getGroupsByUser Gets groups which contains a user according to the specified filter
java.lang.String	getName() Store name
User	getUserById(java.lang.String identifier) Gets one user by identifier
java.util.List<User>	getUsers() Gets complete list of users
java.util.List<User>	getUsers(int start, int limit, java.lang.String query) Gets users according to the pagination and query
java.util.List<User>	getUsers(ResourceCollectionFilter filter) Gets filtered list of users
java.util.List<User>	getUsersByGroup(java.lang.String name) Gets user for a group
java.util.List<User>	getUsersByGroup(java.lang.String name, ResourceCollectionFilter filter) Gets users of a group according to the filter
boolean	isGroupModifiable() Can modify Groups (C U D)
boolean	isUserModifiable() Can modify Users (C U D)
Group	updateGroup(Group bean) Updates a Group
Group	updateGroupUsers(Group bean) Update users associated with a group
User	updateUser(User bean) Method for updating user

Method Detail

getName

java.lang.String getName()

Store name

Returns:

Store name

getUsers

java.util.List<User> getUsers()
                              throws SitoolsException

Gets complete list of users

Returns:

ArrayList

Throws:

SitoolsException - if problem

getUsers

java.util.List<User> getUsers(ResourceCollectionFilter filter)
                              throws SitoolsException

Gets filtered list of users

Parameters:

filter - criteria (pagination, ...)

Returns:

ArrayList

Throws:

SitoolsException - if problem

getUsersByGroup

java.util.List<User> getUsersByGroup(java.lang.String name)
                                     throws SitoolsException

Gets user for a group

Parameters:

name - Group name

Returns:

ArrayList

Throws:

SitoolsException - if problem

getUsersByGroup

java.util.List<User> getUsersByGroup(java.lang.String name,
                                     ResourceCollectionFilter filter)
                                     throws SitoolsException

Gets users of a group according to the filter

Parameters:

name - Group name

filter - Generic filter (pagination, query)

Returns:

ArrayList

Throws:

SitoolsException - if problem

getUsers

java.util.List<User> getUsers(int start,
                              int limit,
                              java.lang.String query)
                              throws SitoolsException

Gets users according to the pagination and query

Parameters:

start - pagination start index

limit - pagination number of items

query - filtering user

Returns:

ArrayList

Throws:

SitoolsException - if problem

getUserById

User getUserById(java.lang.String identifier)
                 throws SitoolsException

Gets one user by identifier

Parameters:

identifier - User identifier

Returns:

User

Throws:

SitoolsException - if problem

createUser

User createUser(User bean)
                throws SitoolsException

Method for creating users

Parameters:

bean - User

Returns:

User

Throws:

SitoolsException - if problem

updateUser

User updateUser(User bean)
                throws SitoolsException

Method for updating user

Parameters:

bean - User

Returns:

User

Throws:

SitoolsException - if problem

deleteUser

boolean deleteUser(java.lang.String identifier)
                   throws SitoolsException

Method for deleting a user

Parameters:

identifier - user identifier

Returns:

boolean true if deleted

Throws:

SitoolsException - if problem

getGroups

java.util.List<Group> getGroups()
                                throws SitoolsException

Gets all groups

Returns:

ArrayList

Throws:

SitoolsException - if problem

getGroups

java.util.List<Group> getGroups(ResourceCollectionFilter filter)
                                throws SitoolsException

Gets groups according to the generic filter

Parameters:

filter - Generic filter (pagination, query)

Returns:

ArrayList

Throws:

SitoolsException - if problem

getGroupsByUser

java.util.List<Group> getGroupsByUser(java.lang.String identifier)
                                      throws SitoolsException

getGroupsByUser Gets groups which contain specified user

Parameters:

identifier - User identifier

Returns:

ArrayList

Throws:

SitoolsException - if problem

getGroupsByUser

java.util.List<Group> getGroupsByUser(java.lang.String identifier,
                                      ResourceCollectionFilter filter)
                                      throws SitoolsException

getGroupsByUser Gets groups which contains a user according to the specified filter

Parameters:

identifier - User identifier

filter - Generic filter (pagination, query)

Returns:

ArrayList

Throws:

SitoolsException - if problem

getGroups

java.util.List<Group> getGroups(int start,
                                int limit,
                                java.lang.String query)
                                throws SitoolsException

getGroups

Parameters:

start - index of first item

limit - number max of items

query - LIKE String refer to Group name

Returns:

ArrayList

Throws:

SitoolsException - if problem

getGroupById

Group getGroupById(java.lang.String name)
                   throws SitoolsException

getGroupById : Gets group by its id (name)

Parameters:

name - Group name

Returns:

Group

Throws:

SitoolsException - if problem

createGroup

Group createGroup(Group bean)
                  throws SitoolsException

Creates a new Group

Parameters:

bean - input

Returns:

Group

Throws:

SitoolsException - if problem

updateGroup

Group updateGroup(Group bean)
                  throws SitoolsException

Updates a Group

Parameters:

bean - Group

Returns:

updated Group

Throws:

SitoolsException - if problem

deleteGroup

boolean deleteGroup(java.lang.String name)
                    throws SitoolsException

Deletes a group

Parameters:

name - Groups name

Returns:

true if deleted

Throws:

SitoolsException - if problem

updateGroupUsers

Group updateGroupUsers(Group bean)
                       throws SitoolsException

Update users associated with a group

Parameters:

bean - Group

Returns:

updated Group

Throws:

SitoolsException - if problem

isUserModifiable

boolean isUserModifiable()

Can modify Users (C U D)

Returns:

boolean

isGroupModifiable

boolean isGroupModifiable()

Can modify Groups (C U D)

Returns:

boolean