Index (kapua-user-api 1.0.4 API)

C D E F G N O P Q S T U V

C

create(UserCreator) - Method in interface org.eclipse.kapua.service.user.UserService: 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.

D

delete(User) - Method in interface org.eclipse.kapua.service.user.UserService: Delete the supplied User.
DISPLAY_NAME - Static variable in class org.eclipse.kapua.service.user.UserAttributes

E

EMAIL - Static variable in class org.eclipse.kapua.service.user.UserAttributes
EXPIRATION_DATE - Static variable in class org.eclipse.kapua.service.user.UserAttributes

F

find(KapuaId, KapuaId) - Method in interface org.eclipse.kapua.service.user.UserService: 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.
findByExternalId(String) - Method in interface org.eclipse.kapua.service.user.UserService: Find user by external id
findByName(String) - Method in interface org.eclipse.kapua.service.user.UserService: Returns the User with the specified username; returns null if the user is not found.

G

getActions() - Method in class org.eclipse.kapua.service.user.UserDomain
getDisplayName() - Method in interface org.eclipse.kapua.service.user.User: Return the display name (may be a friendly username to show in the UI)
getDisplayName() - Method in interface org.eclipse.kapua.service.user.UserCreator: Return the display name (may be a friendly username to show in the UI)
getEmail() - Method in interface org.eclipse.kapua.service.user.User: Get the user email
getEmail() - Method in interface org.eclipse.kapua.service.user.UserCreator: Get the email
getExpirationDate() - Method in interface org.eclipse.kapua.service.user.User
getExpirationDate() - Method in interface org.eclipse.kapua.service.user.UserCreator
getExternalId() - Method in interface org.eclipse.kapua.service.user.User: Get the external ID
getExternalId() - Method in interface org.eclipse.kapua.service.user.UserCreator: Get the external ID
getGroupable() - Method in class org.eclipse.kapua.service.user.UserDomain
getName() - Method in class org.eclipse.kapua.service.user.UserDomain
getPhoneNumber() - Method in interface org.eclipse.kapua.service.user.User: Get the phone number
getPhoneNumber() - Method in interface org.eclipse.kapua.service.user.UserCreator: Get the phone number
getStatus() - Method in interface org.eclipse.kapua.service.user.User: Return the user status
getType() - Method in interface org.eclipse.kapua.service.user.User
getUserStatus() - Method in interface org.eclipse.kapua.service.user.UserCreator
getUserType() - Method in interface org.eclipse.kapua.service.user.User: Get the user type
getUserType() - Method in interface org.eclipse.kapua.service.user.UserCreator: Get the user type

N

newCreator(KapuaId, String) - Method in interface org.eclipse.kapua.service.user.UserFactory: Creates a new UserCreator for the specified name
newQuery() - Method in class org.eclipse.kapua.service.user.UserXmlRegistry
newUser() - Method in class org.eclipse.kapua.service.user.UserXmlRegistry: Creates a new user instance
newUserCreator() - Method in class org.eclipse.kapua.service.user.UserXmlRegistry: Creates a new user creator instance
newUserListResult() - Method in class org.eclipse.kapua.service.user.UserXmlRegistry: Creates new user list result

O

org.eclipse.kapua.service.user - package org.eclipse.kapua.service.user

P

PHONE_NUMBER - Static variable in class org.eclipse.kapua.service.user.UserAttributes

Q

query(KapuaQuery<User>) - Method in interface org.eclipse.kapua.service.user.UserService: Queries for all users

S

setDisplayName(String) - Method in interface org.eclipse.kapua.service.user.User: Set the display name
setDisplayName(String) - Method in interface org.eclipse.kapua.service.user.UserCreator: Set the display name
setEmail(String) - Method in interface org.eclipse.kapua.service.user.User: Set the user email
setEmail(String) - Method in interface org.eclipse.kapua.service.user.UserCreator: Set the email
setExpirationDate(Date) - Method in interface org.eclipse.kapua.service.user.User
setExpirationDate(Date) - Method in interface org.eclipse.kapua.service.user.UserCreator
setExternalId(String) - Method in interface org.eclipse.kapua.service.user.User: Set the external ID
setExternalId(String) - Method in interface org.eclipse.kapua.service.user.UserCreator: Set the external ID
setPhoneNumber(String) - Method in interface org.eclipse.kapua.service.user.User: Set the phone number
setPhoneNumber(String) - Method in interface org.eclipse.kapua.service.user.UserCreator: Set the phone number
setStatus(UserStatus) - Method in interface org.eclipse.kapua.service.user.User: Get the user status
setUserStatus(UserStatus) - Method in interface org.eclipse.kapua.service.user.UserCreator
setUserType(UserType) - Method in interface org.eclipse.kapua.service.user.User: Set the user type
setUserType(UserType) - Method in interface org.eclipse.kapua.service.user.UserCreator: Set the user type
STATUS - Static variable in class org.eclipse.kapua.service.user.UserAttributes

T

TYPE - Static variable in interface org.eclipse.kapua.service.user.User

U

update(User) - Method in interface org.eclipse.kapua.service.user.UserService: 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.
User - Interface in org.eclipse.kapua.service.user: User entity
USER_DOMAIN - Static variable in class org.eclipse.kapua.service.user.UserDomains
UserAttributes - Class in org.eclipse.kapua.service.user
UserAttributes() - Constructor for class org.eclipse.kapua.service.user.UserAttributes
UserCreator - Interface in org.eclipse.kapua.service.user: UserCreator encapsulates all the information needed to create a new User in the system.
UserDomain - Class in org.eclipse.kapua.service.user: User domain.
Used to describe the User Domain in the UserService.
UserDomain() - Constructor for class org.eclipse.kapua.service.user.UserDomain
UserDomains - Class in org.eclipse.kapua.service.user
UserFactory - Interface in org.eclipse.kapua.service.user: User factory service definition.
UserListResult - Interface in org.eclipse.kapua.service.user: User result list definition.
UserQuery - Interface in org.eclipse.kapua.service.user: User query definition.
UserService - Interface in org.eclipse.kapua.service.user: 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.
UserStatus - Enum in org.eclipse.kapua.service.user
UserType - Enum in org.eclipse.kapua.service.user: The device user type
UserXmlRegistry - Class in org.eclipse.kapua.service.user: User xml factory class
UserXmlRegistry() - Constructor for class org.eclipse.kapua.service.user.UserXmlRegistry

V

valueOf(String) - Static method in enum org.eclipse.kapua.service.user.UserStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.kapua.service.user.UserType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.kapua.service.user.UserStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.kapua.service.user.UserType: Returns an array containing the constants of this enum type, in the order they are declared.

C D E F G N O P Q S T U V