org.eclipse.kapua.service.user

Interface UserService

All Superinterfaces:

KapuaConfigurableService, KapuaEntityService<User,UserCreator>, KapuaNamedEntityService<User>, KapuaService, KapuaUpdatableEntityService<User>

public interface UserService
extends KapuaEntityService<User,UserCreator>, KapuaUpdatableEntityService<User>, KapuaNamedEntityService<User>, KapuaConfigurableService

UserService exposes APIs to manage User object under an Account.
It includes APIs to create, update, find, list and delete Users.
Instances of the UserService can be acquired through the ServiceLocator.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
User	create(UserCreator userCreator) Creates a new user under the account specified in the UserCreator. The returned User object does not have its access information, roles and permissions, loaded.
void	delete(User user) Delete the supplied User.
User	find(KapuaId accountId, KapuaId userId) Returns the User with the specified Id; returns null if the user is not found. The API does not perform any access control check and it is meant for internal use.
User	findByExternalId(String externalId) Find user by external id
User	findByName(String name) Returns the User with the specified username; returns null if the user is not found.
UserListResult	query(KapuaQuery query) Queries for all users
User	update(User user) Updates an User in the database and returns the refreshed/reloaded entity instance. The returned User object does not have its access information, roles and permissions, loaded.

Methods inherited from interface org.eclipse.kapua.service.KapuaEntityService

count, delete

Methods inherited from interface org.eclipse.kapua.service.config.KapuaConfigurableService

getConfigMetadata, getConfigValues, setConfigValues

Method Detail

create

User create(UserCreator userCreator)
     throws KapuaException

Creates a new user under the account specified in the UserCreator.
The returned User object does not have its access information, roles and permissions, loaded.

Specified by:

create in interface KapuaEntityService<User,UserCreator>

Parameters:

userCreator -

Returns:

created User

Throws:

KapuaException

update

User update(User user)
     throws KapuaException

Updates an User in the database and returns the refreshed/reloaded entity instance.
The returned User object does not have its access information, roles and permissions, loaded.

Specified by:

update in interface KapuaUpdatableEntityService<User>

Parameters:

user - to be update

Returns:

Throws:

KapuaException

delete

void delete(User user)
     throws KapuaException

Delete the supplied User.

Parameters:

user -

Throws:

KapuaException

find

User find(KapuaId accountId,
          KapuaId userId)
   throws KapuaException

Returns the User with the specified Id; returns null if the user is not found.
The API does not perform any access control check and it is meant for internal use.

Specified by:

find in interface KapuaEntityService<User,UserCreator>

Parameters:

userId -

Returns:

Throws:

KapuaException

findByName

User findByName(String name)
         throws KapuaException

Returns the User with the specified username; returns null if the user is not found.

Specified by:

findByName in interface KapuaNamedEntityService<User>

Returns:

Throws:

KapuaException

findByExternalId

User findByExternalId(String externalId)
               throws KapuaException

Find user by external id

Parameters:

externalId - the external ID to look for

Returns:

the user or null if the user could not be found

Throws:

KapuaException - in case anything goes wrong

query

UserListResult query(KapuaQuery query)
              throws KapuaException

Queries for all users

Specified by:

query in interface KapuaEntityService<User,UserCreator>

Throws:

KapuaException