software.coolstuff.springframework.owncloud.service.api

Interface OwncloudGroupService

public interface OwncloudGroupService

Get and modify Information of Groups on the Owncloud Server.

This Service is only usable when the User has been authenticated by the OwncloudAuthenticationProvider.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
void	create(String groupname) Create a new Group.
void	delete(String groupname) Remove an existing Group.
List<String>	findAll() Find all Groups.
List<String>	findAll(String filter) Find all Groups whose Name confirm to the Filter Criterion.
List<String>	findAllGroups(String username) Find all Groups of a User
List<String>	findAllUsers(String groupname) Find all Users that are members of a Group

Method Detail

findAll

List<String> findAll()

Find all Groups.

Returns:

List of all Groups

Throws:

org.springframework.security.access.AccessDeniedException - Not an Administrator

findAll

List<String> findAll(String filter)

Find all Groups whose Name confirm to the Filter Criterion.

Parameters:

filter - Filter Criterion for the Name

Returns:

List of all Groups whose Name confirm to the Filter Criterion

Throws:

org.springframework.security.access.AccessDeniedException - Not an Administrator

findAllUsers

List<String> findAllUsers(String groupname)

Find all Users that are members of a Group

Parameters:

groupname - Name of the Group

Returns:

List of all Users that are Members of the Group

Throws:

org.springframework.security.access.AccessDeniedException - Not an Administrator

OwncloudGroupNotFoundException - Group doesn't exist

findAllGroups

List<String> findAllGroups(String username)

Find all Groups of a User

Parameters:

username - Name of the User

Returns:

List of all Groups the User is a Member of

Throws:

org.springframework.security.access.AccessDeniedException - Neither an Administrator nor the Owner

org.springframework.security.core.userdetails.UsernameNotFoundException - User doesn't exist

create

void create(String groupname)

Create a new Group.

Parameters:

groupname - Name of the new Group

Throws:

org.springframework.security.access.AccessDeniedException - either Modifications are not allowed OwncloudProperties#isEnableModifications() or not an Administrator

OwncloudGroupAlreadyExistsException - Group already exists

delete

void delete(String groupname)

Remove an existing Group.

Parameters:

groupname - Name of the Group to be removed

Throws:

org.springframework.security.access.AccessDeniedException - either Modifications are not allowed OwncloudProperties#isEnableModifications() or not an Administrator

OwncloudGroupNotFoundException - Group doesn't exist anymore