GroupCache (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.admin.user.model.GroupCache

@Technical
@Bean
@Singleton
public class GroupCache
extends Object

Cache of user groups.

Constructor Summary

Constructors
Constructor Description

GroupCache()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearCache()`	Clears the cache.
`Optional<List<String>>`	`getAllGroupIdsOfUser(String userId)`	Gets all the groups in which the specified user is part of.
`void`	`removeCacheOfUser(String userId)`	Removes from the cache the specified user and therefore the groups in which he's part of.
`List<String>`	`setAllGroupIdsOfUser(String userId, List<String> groupIds)`	Sets the specified groups as being those in which the given user is part of.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroupCache
```
public GroupCache()
```
- Method Detail
  - clearCache
```
public void clearCache()
```
    Clears the cache.
  - getAllGroupIdsOfUser
```
public Optional<List<String>> getAllGroupIdsOfUser(String userId)
```
    Gets all the groups in which the specified user is part of.
    
    Parameters:
    
    userId - the unique identifier of a user.
    
    Returns:
    
    a list of group identifiers.
  - setAllGroupIdsOfUser
```
public List<String> setAllGroupIdsOfUser(String userId,
                                         List<String> groupIds)
```
    Sets the specified groups as being those in which the given user is part of. If the user has already a list of groups set, then nothing is done and that list is returned. Otherwise, the groups are cached as being the groups in which the user is part of and then returned.
    
    Parameters:
    
    userId - the unique identifier of a user.
    
    groupIds - a list with the unique identifier of the groups.
    
    Returns:
    
    either the specified list of group identifiers or the one that is already cached.
  - removeCacheOfUser
```
public void removeCacheOfUser(String userId)
```
    Removes from the cache the specified user and therefore the groups in which he's part of.
    
    Parameters:
    
    userId - the unique identifier of a user.