org.eclipse.kapua.service.user.internal

Class UserDAO

java.lang.Object

org.eclipse.kapua.commons.service.internal.ServiceDAO

org.eclipse.kapua.service.user.internal.UserDAO

public class UserDAO
extends ServiceDAO

User ServiceDAO

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
UserDAO()

Method Summary

Modifier and Type	Method and Description
static long	count(EntityManager em, org.eclipse.kapua.model.query.KapuaQuery<User> userPermissionQuery) Returns the user count matching the provided query
static User	create(EntityManager em, UserCreator userCreator) Creates and return new User
static User	delete(EntityManager em, org.eclipse.kapua.model.id.KapuaId scopeId, org.eclipse.kapua.model.id.KapuaId userId) Deletes the user by user identifier
static User	find(EntityManager em, org.eclipse.kapua.model.id.KapuaId scopeId, org.eclipse.kapua.model.id.KapuaId userId) Finds the User by User identifier
static User	findByExternalId(EntityManager em, java.lang.String externalId) Finds the User by the UserAttributes external id
static User	findByName(EntityManager em, java.lang.String name) Finds the User by the KapuaNamedEntityAttributes.NAME
static UserListResult	query(EntityManager em, org.eclipse.kapua.model.query.KapuaQuery<User> userPermissionQuery) Returns the user list matching the provided query
static User	update(EntityManager em, User user) Updates the provided User

Methods inherited from class org.eclipse.kapua.commons.service.internal.ServiceDAO

count, delete, find, findByField, findByField, handleKapuaQueryGroupPredicate, query, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserDAO

public UserDAO()

Method Detail

create

public static User create(EntityManager em,
                          UserCreator userCreator)

Creates and return new User

Parameters:

em -

userCreator -

Returns:

Since:

1.0.0

update

public static User update(EntityManager em,
                          User user)
                   throws org.eclipse.kapua.KapuaException

Updates the provided User

Parameters:

em -

user -

Returns:

Throws:

org.eclipse.kapua.KapuaException

Since:

1.0.0

find

public static User find(EntityManager em,
                        org.eclipse.kapua.model.id.KapuaId scopeId,
                        org.eclipse.kapua.model.id.KapuaId userId)

Finds the User by User identifier

Parameters:

em -

scopeId -

userId -

Returns:

Since:

1.0.0

findByName

public static User findByName(EntityManager em,
                              java.lang.String name)

Finds the User by the KapuaNamedEntityAttributes.NAME

Parameters:

em -

name -

Returns:

findByExternalId

public static User findByExternalId(EntityManager em,
                                    java.lang.String externalId)

Finds the User by the UserAttributes external id

Parameters:

em - the entity manager to use

externalId - id the external ID so search for

Returns:

the user record, may be null

query

public static UserListResult query(EntityManager em,
                                   org.eclipse.kapua.model.query.KapuaQuery<User> userPermissionQuery)
                            throws org.eclipse.kapua.KapuaException

Returns the user list matching the provided query

Parameters:

em -

userPermissionQuery -

Returns:

Throws:

org.eclipse.kapua.KapuaException

count

public static long count(EntityManager em,
                         org.eclipse.kapua.model.query.KapuaQuery<User> userPermissionQuery)
                  throws org.eclipse.kapua.KapuaException

Returns the user count matching the provided query

Parameters:

em -

userPermissionQuery -

Returns:

Throws:

org.eclipse.kapua.KapuaException

delete

public static User delete(EntityManager em,
                          org.eclipse.kapua.model.id.KapuaId scopeId,
                          org.eclipse.kapua.model.id.KapuaId userId)
                   throws org.eclipse.kapua.KapuaEntityNotFoundException

Deletes the user by user identifier

Parameters:

em -

scopeId -

userId -

Returns:

the deleted User

Throws:

org.eclipse.kapua.KapuaEntityNotFoundException - If User is not found.