software.coolstuff.springframework.owncloud.service.api

Interface OwncloudUserService

All Known Subinterfaces:

OwncloudLocalUserServiceExtension, OwncloudRestUserServiceExtension

public interface OwncloudUserService

Get and modify Information of Users 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	delete(String username) Remove a User.
List<String>	findAll() Find all Users.
List<String>	findAll(String filter) Find all Users whose Display Name confirm to the Filter Criterion.
Optional<OwncloudUserDetails>	findOne(String username) Get the Details of a User or Optional.empty() if the User doesn't exist
OwncloudUserDetails	save(OwncloudModificationUser user) Create or update a User.

Method Detail

findOne

Optional<OwncloudUserDetails> findOne(String username)

Get the Details of a User or Optional.empty() if the User doesn't exist

Parameters:

username - Name of the User

Returns:

Details of the User

Throws:

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

findAll

List<String> findAll()

Find all Users.

Returns:

List of all Users

Throws:

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

findAll

List<String> findAll(String filter)

Find all Users whose Display Name confirm to the Filter Criterion.

Parameters:

filter - Filter Criterion for Display Name

Returns:

List of all Users whose Display Name confirm to the Filter Criterion

Throws:

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

save

OwncloudUserDetails save(OwncloudModificationUser user)

Create or update a User.

Parameters:

user - User Details to be saved

Returns:

saved User Details

Throws:

org.springframework.security.access.AccessDeniedException - either Modifications are not allowed OwncloudProperties.isEnableModifications() or neither an Administrator nor the Owner

OwncloudUsernameAlreadyExistsException - the User already exists (minimal chance to get this Exception)

OwncloudGroupNotFoundException - referenced Group doesn't exist (either while adding or removing Membership)

delete

void delete(String username)

Remove a User.

Parameters:

username - Name of the User to be removed

Throws:

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

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